ListsClient

Cliente para operaciones con listas

Este cliente proporciona métodos para interactuar con los endpoints de listas de la X API. Se encarga de la autenticación, el formateo de las solicitudes y el procesamiento de las respuestas para todas las operaciones relacionadas con listas.

​

Constructores

​

constructor

• new ListsClient(client): ListsClient

Crea una nueva instancia del cliente de listas

​

Parámetros

Nombre	Tipo	Descripción
client	Client	La instancia principal del cliente de la X API

​

Devuelve

ListsClient

​

Definido en

lists/client.ts:188

​

Métodos

​

getFollowers

▸ getFollowers(id, options?): Promise<Get2ListsIdFollowersResponse>

Obtener seguidores de la lista Recupera a los usuarios que siguen una lista específica por su id.

​

Parámetros

Nombre	Tipo	Descripción
id	string	El id de la Lista.
options	GetFollowersOptions	-

​

Devuelve

Promise<Get2ListsIdFollowersResponse>

Promesa que se resuelve con la respuesta de la API

​

Definido en

lists/client.ts:205

---

​

getMembers

▸ getMembers(id, options?): Promise<Get2ListsIdMembersResponse>

Obtener miembros de la lista Recupera a los usuarios que son miembros de una lista específica por su id.

​

Parámetros

Nombre	Tipo	Descripción
id	string	El id de la lista.
options	GetMembersOptions	-

​

Devuelve

Promise<Get2ListsIdMembersResponse>

Promesa que se resuelve con la respuesta de la API

​

Definido en

lists/client.ts:279

---

​

addMember

▸ addMember(id, options?): Promise<ListMutateResponse>

Agregar miembro a la lista Agrega un usuario a una lista específica por su id.

​

Parámetros

Nombre	Tipo	Descripción
id	string	El ID de la lista a la que se añadirá un miembro.
options	AddMemberOptions	-

​

Devuelve

Promise<ListMutateResponse>

Promesa que se resuelve con la respuesta de la API

​

Definido en

lists/client.ts:353

---

​

removeMemberByUserId

▸ removeMemberByUserId(id, userId): Promise<ListMutateResponse>

Eliminar miembro de la lista Elimina a un usuario de una lista específica usando su ID y el ID del usuario.

​

Parámetros

Nombre	Tipo	Descripción
id	string	El id de la lista de la que se eliminará un miembro.
userId	string	El id del usuario que será eliminado de la lista.

​

Devuelve

Promise<ListMutateResponse>

Promesa que se resuelve con la respuesta de la API

​

Definido en

lists/client.ts:405

---

​

getPosts

▸ getPosts(id, options?): Promise<Get2ListsIdTweetsResponse>

Obtener Posts de la lista Recupera una lista de Posts asociados a una lista específica por su id.

​

Parámetros

Nombre	Tipo	Descripción
id	string	El id de la lista.
options	GetPostsOptions	-

​

Devuelve

Promise<Get2ListsIdTweetsResponse>

Promesa que se resuelve con la respuesta de la API

​

Definido en

lists/client.ts:448

---

​

getById

▸ getById(id, options?): Promise<Get2ListsIdResponse>

Obtener una Lista por id Recupera los detalles de una Lista específica por su id.

​

Parámetros

Nombre	Tipo	Descripción
id	string	El id de la lista.
options	GetByIdOptions	-

​

Devuelve

Promise<Get2ListsIdResponse>

Promesa que se resuelve con la respuesta de la API

​

Definido en

lists/client.ts:540

---

​

update

▸ update(id, options?): Promise<ListUpdateResponse>

Actualizar Lista Actualiza los detalles de una Lista específica, propiedad del usuario autenticado, mediante su id.

​

Parámetros

Nombre	Tipo	Descripción
id	string	El id de la Lista que se va a modificar.
options	UpdateOptions	-

​

Devuelve

Promise<ListUpdateResponse>

Promesa que se resuelve con la respuesta de la API

​

Definido en

lists/client.ts:602

---

​

delete

▸ delete(id): Promise<ListDeleteResponse>

Eliminar lista Elimina una lista específica, propiedad del usuario autenticado, por su id.

​

Parámetros

Nombre	Tipo	Descripción
id	string	El id de la lista que se va a eliminar.

​

Devuelve

Promise<ListDeleteResponse>

Promesa que se resuelve con la respuesta de la API

​

Definido en

lists/client.ts:650

---

​

create

▸ create(options?): Promise<ListCreateResponse>

Crear lista Crea una nueva lista para el usuario autenticado.

​

Parámetros

Nombre	Tipo
options	CreateOptions

​

Devuelve

Promise<ListCreateResponse>

Promesa que se resuelve con la respuesta de la API

​

Definido en

lists/client.ts:684