ListsClient

Cliente para operaciones de lists This client provides methods for interacting with the lists endpoints of the X API. It handles authentication, request formatting, and response parsing for all lists related operations.

​

Constructores

​

constructor

• new ListsClient(client): ListsClient Creates a new lists client instance

​

Parámetros

​

Devuelve

ListsClient

​

Definido en

lists/client.ts:294

​

Métodos

​

getFollowers

▸ getFollowers(id, options): Promise<Response> Get List followers Retrieves a list of Users who follow a specific List by its ID.

​

Parámetros

​

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

​

Definido en

lists/client.ts:339 ▸ getFollowers(id, options?): Promise<Get2ListsIdFollowersResponse>

​

Parámetros

​

Devuelve

Promise<Get2ListsIdFollowersResponse>

​

Definido en

lists/client.ts:352

---

​

create

▸ create(options): Promise<Response> Create List Creates a new List for the authenticated user.

​

Parámetros

​

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

​

Definido en

lists/client.ts:560 ▸ create(options?): Promise<ListCreateResponse>

​

Parámetros

​

Devuelve

Promise<ListCreateResponse>

​

Definido en

lists/client.ts:569

---

​

getMembers

▸ getMembers(id, options): Promise<Response> Get List members Retrieves a list of Users who are members of a specific List by its ID.

​

Parámetros

​

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

​

Definido en

lists/client.ts:665 ▸ getMembers(id, options?): Promise<Get2ListsIdMembersResponse>

​

Parámetros

​

Devuelve

Promise<Get2ListsIdMembersResponse>

​

Definido en

lists/client.ts:678

---

​

addMember

▸ addMember(id, options): Promise<Response> Add List member Adds a User to a specific List by its ID.

​

Parámetros

​

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

​

Definido en

lists/client.ts:890 ▸ addMember(id, options?): Promise<ListMutateResponse>

​

Parámetros

​

Devuelve

Promise<ListMutateResponse>

​

Definido en

lists/client.ts:903

---

​

getPosts

▸ getPosts(id, options): Promise<Response> Get List Posts Retrieves a list of Posts associated with a specific List by its ID.

​

Parámetros

​

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

​

Definido en

lists/client.ts:1011 ▸ getPosts(id, options?): Promise<Get2ListsIdTweetsResponse>

​

Parámetros

​

Devuelve

Promise<Get2ListsIdTweetsResponse>

​

Definido en

lists/client.ts:1024

---

​

removeMemberByUserId

▸ removeMemberByUserId(id, userId, options): Promise<Response> Remove List member Removes a User from a specific List by its ID and the User’s ID.

​

Parámetros

​

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

​

Definido en

lists/client.ts:1303 ▸ removeMemberByUserId(id, userId): Promise<ListMutateResponse>

​

Parámetros

​

Devuelve

Promise<ListMutateResponse>

​

Definido en

lists/client.ts:1320

---

​

getById

▸ getById(id, options): Promise<Response> Get List by ID Retrieves details of a specific List by its ID.

​

Parámetros

​

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

​

Definido en

lists/client.ts:1423 ▸ getById(id, options?): Promise<Get2ListsIdResponse>

​

Parámetros

​

Devuelve

Promise<Get2ListsIdResponse>

​

Definido en

lists/client.ts:1436

---

​

update

▸ update(id, options): Promise<Response> Update List Updates the details of a specific List owned by the authenticated user by its ID.

​

Parámetros

​

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

​

Definido en

lists/client.ts:1610 ▸ update(id, options?): Promise<ListUpdateResponse>

​

Parámetros

​

Devuelve

Promise<ListUpdateResponse>

​

Definido en

lists/client.ts:1623

---

​

delete

▸ delete(id, options): Promise<Response> Delete List Deletes a specific List owned by the authenticated user by its ID.

​

Parámetros

​

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

​

Definido en

lists/client.ts:1731 ▸ delete(id): Promise<ListDeleteResponse>

​

Parámetros

​

Devuelve

Promise<ListDeleteResponse>

​

Definido en

lists/client.ts:1744