ListsClient

Client para operaciones con listas

Este Client proporciona métodos para interactuar con los endpoints de listas de la X API. Se encarga de la autenticación, el formato de las solicitudes y el análisis de las respuestas para todas las operaciones relacionadas con las listas.

Constructores

constructor

• new ListsClient(client): ListsClient

Crea una nueva instancia de ListsClient.

Parámetros

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

Devuelve

ListsClient

Definido en

lists/client.ts:294

Métodos

getFollowers

▸ getFollowers(id, options): Promise<Response>

Obtiene los seguidores de una Lista Obtiene una lista de usuarios que siguen una Lista específica por su ID.

Parámetros

Nombre	Tipo	Descripción
id	string	El identificador de la Lista.
options	GetFollowersOptions & { requestOptions: { raw: true } }	-

Devuelve

Promise<Response>

Promesa que se resuelve en la respuesta de la API, o en el objeto Response sin procesar si requestOptions.raw es true

Definido en

lists/client.ts:339

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

Parámetros

Nombre	Tipo
id	string
options?	GetFollowersOptions

Devuelve

Promise<Get2ListsIdFollowersResponse>

Definido en

lists/client.ts:352

---

create

▸ create(options): Promise<Response>

Crear una Lista Crea una nueva Lista para el usuario autenticado.

Parámetros

Nombre	type
options	CreateOptions & { requestOptions: { raw: true } }

Returns

Promise<Response>

Promesa que se resuelve con la respuesta de la API, o con el objeto Response sin procesar si requestOptions.raw es true

Definido en

lists/client.ts:560

▸ create(options?): Promise<ListCreateResponse>

Parámetros

Nombre	type
options?	CreateOptions

Devuelve

Promise<ListCreateResponse>

Definido en

lists/client.ts:569

---

getMembers

▸ getMembers(id, options): Promise<Response>

Obtener los miembros de una Lista Recupera los usuarios que son miembros de una Lista específica según su id.

Parámetros

Nombre	Tipo	Descripción
id	string	El id de la Lista.
options	GetMembersOptions & { requestOptions: { raw: true } }	-

Devuelve

Promise<Response>

Promesa que se resuelve con la respuesta de la API, o con el objeto Response sin procesar si requestOptions.raw es true

Definido en

lists/client.ts:665

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

Parámetros

Nombre	Tipo
id	string
options?	GetMembersOptions

Devuelve

Promise<Get2ListsIdMembersResponse>

Definido en

lists/client.ts:678

---

addMember

▸ addMember(id, options): Promise<Response>

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

Parámetros

Name	Type	Description
id	string	El id de la Lista a la que se agregará un miembro.
options	AddMemberOptions & { requestOptions: { raw: true } }	-

Returns

Promise<Response>

Promise que se resuelve en la respuesta de la API, o en el objeto Response sin procesar si requestOptions.raw es true

Definido en

lists/client.ts:890

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

Parámetros

Nombre	Tipo
id	string
options?	AddMemberOptions

Devuelve

Promise<ListMutateResponse>

Definido en

lists/client.ts:903

---

getPosts

▸ getPosts(id, options): Promise<Response>

Obtener Publicaciones de una Lista
Obtiene una lista de Publicaciones asociadas a una Lista específica identificada por su ID.

Parámetros

Nombre	Tipo	Descripción
id	string	El id de la Lista.
options	GetPostsOptions & { requestOptions: { raw: true } }	-

Devuelve

Promise<Response>

Promesa que se resuelve en la respuesta de la API, o en el objeto Response sin procesar si requestOptions.raw es true

Definido en

lists/client.ts:1011

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

Parámetros

Nombre	Tipo
id	string
options?	GetPostsOptions

Devuelve

Promise<Get2ListsIdTweetsResponse>

Definido en

lists/client.ts:1024

---

removeMemberByUserId

▸ removeMemberByUserId(id, userId, options): Promise<Response>

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

Parámetros

Name	Type	Description
id	string	El id de la Lista de la que se eliminará un miembro.
userId	string	El id del Usuario que se eliminará de la Lista.
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

Devuelve

Promise<Response>

Promesa que se resuelve con la respuesta de la API, o con el objeto Response sin procesar si requestOptions.raw es true

Definido en

lists/client.ts:1303

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

Parámetros

Nombre	Tipo
id	string
userId	string

Devuelve

Promise<ListMutateResponse>

Definido en

lists/client.ts:1320

---

getById

▸ getById(id, options): Promise<Response>

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

Parámetros

Nombre	Tipo	Descripción
id	string	El identificador de la Lista.
options	GetByIdOptions & { requestOptions: { raw: true } }	-

Devuelve

Promise<Response>

Promesa que se resuelve con la respuesta de la API, o con el objeto Response sin procesar si requestOptions.raw es true

Definido en

lists/client.ts:1423

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

Parámetros

Nombre	Tipo
id	string
options?	GetByIdOptions

Devuelve

Promise<Get2ListsIdResponse>

Definido en

lists/client.ts:1436

---

update

▸ update(id, options): Promise<Response>

Actualizar lista Actualiza los detalles de una lista específica, propiedad del usuario autenticado, identificada por su id.

Parámetros

Nombre	Tipo	Descripción
id	string	El identificador de la Lista que se va a actualizar.
options	UpdateOptions & { requestOptions: { raw: true } }	-

Devuelve

Promise<Response>

Promesa que se resuelve con la respuesta de la API, o con el objeto Response sin procesar si requestOptions.raw es true

Definido en

lists/client.ts:1610

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

Parámetros

Nombre	Tipo
id	string
options?	UpdateOptions

Devuelve

Promise<ListUpdateResponse>

Definido en

lists/client.ts:1623

---

delete

▸ delete(id, options): Promise<Response>

Eliminar Lista Elimina una Lista específica propiedad del usuario autenticado mediante su id.

Parámetros

Nombre	Tipo	Descripción
id	string	El identificador de la Lista que se va a eliminar.
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

Devuelve

Promise<Response>

Promesa que se resuelve con la respuesta de la API, o un Response sin procesar si requestOptions.raw es true

Definido en

lists/client.ts:1731

▸ delete(id): Promise<ListDeleteResponse>

Parámetros

Nombre	Tipo
id	string

Devuelve

Promise<ListDeleteResponse>

Definido en

lists/client.ts:1744