> ## Documentation Index
> Fetch the complete documentation index at: https://generaltranslation.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.

<div id="constructors">
  ## Constructores
</div>

<div id="constructor">
  ### constructor
</div>

• **new ListsClient**(`client`): [`ListsClient`](/es/xdks/typescript/reference/classes/ListsClient)

Crea una nueva instancia de ListsClient.

<div id="parameters">
  #### Parámetros
</div>

| Nombre   | Tipo                                                     | Descripción                               |
| :------- | :------------------------------------------------------- | :---------------------------------------- |
| `client` | [`Client`](/es/xdks/typescript/reference/classes/Client) | La instancia principal de Client de X API |

<div id="returns">
  #### Devuelve
</div>

[`ListsClient`](/es/xdks/typescript/reference/classes/ListsClient)

<div id="defined-in">
  #### Definido en
</div>

[lists/client.ts:294](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/lists/client.ts#L294)

<div id="methods">
  ## Métodos
</div>

<div id="getfollowers">
  ### getFollowers
</div>

▸ **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.

<div id="parameters">
  #### Parámetros
</div>

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

<div id="returns">
  #### Devuelve
</div>

`Promise`\<`Response`>

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

<div id="defined-in">
  #### Definido en
</div>

[lists/client.ts:339](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/lists/client.ts#L339)

▸ **getFollowers**(`id`, `options?`): `Promise`\<[`Get2ListsIdFollowersResponse`](/es/xdks/typescript/reference/interfaces/Schemas.Get2ListsIdFollowersResponse)>

<div id="parameters">
  #### Parámetros
</div>

| Nombre     | Tipo                  |
| :--------- | :-------------------- |
| `id`       | `string`              |
| `options?` | `GetFollowersOptions` |

<div id="returns">
  #### Devuelve
</div>

`Promise`\<[`Get2ListsIdFollowersResponse`](/es/xdks/typescript/reference/interfaces/Schemas.Get2ListsIdFollowersResponse)>

<div id="defined-in">
  #### Definido en
</div>

[lists/client.ts:352](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/lists/client.ts#L352)

***

<div id="create">
  ### create
</div>

▸ **create**(`options`): `Promise`\<`Response`>

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

<div id="parameters">
  #### Parámetros
</div>

| 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`

<div id="defined-in">
  #### Definido en
</div>

[lists/client.ts:560](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/lists/client.ts#L560)

▸ **create**(`options?`): `Promise`\<[`ListCreateResponse`](/es/xdks/typescript/reference/interfaces/Schemas.ListCreateResponse)>

<div id="parameters">
  #### Parámetros
</div>

| Nombre     | type            |
| :--------- | :-------------- |
| `options?` | `CreateOptions` |

<div id="returns">
  #### Devuelve
</div>

`Promise`\<[`ListCreateResponse`](/es/xdks/typescript/reference/interfaces/Schemas.ListCreateResponse)>

<div id="defined-in">
  #### Definido en
</div>

[lists/client.ts:569](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/lists/client.ts#L569)

***

<div id="getmembers">
  ### getMembers
</div>

▸ **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.

<div id="parameters">
  #### Parámetros
</div>

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

<div id="returns">
  #### Devuelve
</div>

`Promise`\<`Response`>

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

<div id="defined-in">
  #### Definido en
</div>

[lists/client.ts:665](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/lists/client.ts#L665)

▸ **getMembers**(`id`, `options?`): `Promise`\<[`Get2ListsIdMembersResponse`](/es/xdks/typescript/reference/interfaces/Schemas.Get2ListsIdMembersResponse)>

<div id="parameters">
  #### Parámetros
</div>

| Nombre     | Tipo                |
| :--------- | :------------------ |
| `id`       | `string`            |
| `options?` | `GetMembersOptions` |

<div id="returns">
  #### Devuelve
</div>

`Promise`\<[`Get2ListsIdMembersResponse`](/es/xdks/typescript/reference/interfaces/Schemas.Get2ListsIdMembersResponse)>

<div id="defined-in">
  #### Definido en
</div>

[lists/client.ts:678](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/lists/client.ts#L678)

***

<div id="addmember">
  ### addMember
</div>

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

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

<div id="parameters">
  #### Parámetros
</div>

| 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

<div id="defined-in">
  #### Definido en
</div>

[lists/client.ts:890](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/lists/client.ts#L890)

▸ **addMember**(`id`, `options?`): `Promise`\<[`ListMutateResponse`](/es/xdks/typescript/reference/interfaces/Schemas.ListMutateResponse)>

<div id="parameters">
  #### Parámetros
</div>

| Nombre     | Tipo               |
| :--------- | :----------------- |
| `id`       | `string`           |
| `options?` | `AddMemberOptions` |

<div id="returns">
  #### Devuelve
</div>

`Promise`\<[`ListMutateResponse`](/es/xdks/typescript/reference/interfaces/Schemas.ListMutateResponse)>

<div id="defined-in">
  #### Definido en
</div>

[lists/client.ts:903](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/lists/client.ts#L903)

***

<div id="getposts">
  ### getPosts
</div>

▸ **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.

<div id="parameters">
  #### Parámetros
</div>

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

<div id="returns">
  #### Devuelve
</div>

`Promise`\<`Response`>

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

<div id="defined-in">
  #### Definido en
</div>

[lists/client.ts:1011](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/lists/client.ts#L1011)

▸ **getPosts**(`id`, `options?`): `Promise`\<[`Get2ListsIdTweetsResponse`](/es/xdks/typescript/reference/interfaces/Schemas.Get2ListsIdTweetsResponse)>

<div id="parameters">
  #### Parámetros
</div>

| Nombre     | Tipo              |
| :--------- | :---------------- |
| `id`       | `string`          |
| `options?` | `GetPostsOptions` |

<div id="returns">
  #### Devuelve
</div>

`Promise`\<[`Get2ListsIdTweetsResponse`](/es/xdks/typescript/reference/interfaces/Schemas.Get2ListsIdTweetsResponse)>

<div id="defined-in">
  #### Definido en
</div>

[lists/client.ts:1024](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/lists/client.ts#L1024)

***

<div id="removememberbyuserid">
  ### removeMemberByUserId
</div>

▸ **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.

<div id="parameters">
  #### Parámetros
</div>

| 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`   | -                                                    |

<div id="returns">
  #### Devuelve
</div>

`Promise`\<`Response`>

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

<div id="defined-in">
  #### Definido en
</div>

[lists/client.ts:1303](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/lists/client.ts#L1303)

▸ **removeMemberByUserId**(`id`, `userId`): `Promise`\<[`ListMutateResponse`](/es/xdks/typescript/reference/interfaces/Schemas.ListMutateResponse)>

<div id="parameters">
  #### Parámetros
</div>

| Nombre   | Tipo     |
| :------- | :------- |
| `id`     | `string` |
| `userId` | `string` |

<div id="returns">
  #### Devuelve
</div>

`Promise`\<[`ListMutateResponse`](/es/xdks/typescript/reference/interfaces/Schemas.ListMutateResponse)>

<div id="defined-in">
  #### Definido en
</div>

[lists/client.ts:1320](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/lists/client.ts#L1320)

***

<div id="getbyid">
  ### getById
</div>

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

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

<div id="parameters">
  #### Parámetros
</div>

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

<div id="returns">
  #### Devuelve
</div>

`Promise`\<`Response`>

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

<div id="defined-in">
  #### Definido en
</div>

[lists/client.ts:1423](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/lists/client.ts#L1423)

▸ **getById**(`id`, `options?`): `Promise`\<[`Get2ListsIdResponse`](/es/xdks/typescript/reference/interfaces/Schemas.Get2ListsIdResponse)>

<div id="parameters">
  #### Parámetros
</div>

| Nombre     | Tipo             |
| :--------- | :--------------- |
| `id`       | `string`         |
| `options?` | `GetByIdOptions` |

<div id="returns">
  #### Devuelve
</div>

`Promise`\<[`Get2ListsIdResponse`](/es/xdks/typescript/reference/interfaces/Schemas.Get2ListsIdResponse)>

<div id="defined-in">
  #### Definido en
</div>

[lists/client.ts:1436](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/lists/client.ts#L1436)

***

<div id="update">
  ### update
</div>

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

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

<div id="parameters">
  #### Parámetros
</div>

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

<div id="returns">
  #### Devuelve
</div>

`Promise`\<`Response`>

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

<div id="defined-in">
  #### Definido en
</div>

[lists/client.ts:1610](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/lists/client.ts#L1610)

▸ **update**(`id`, `options?`): `Promise`\<[`ListUpdateResponse`](/es/xdks/typescript/reference/interfaces/Schemas.ListUpdateResponse)>

<div id="parameters">
  #### Parámetros
</div>

| Nombre     | Tipo            |
| :--------- | :-------------- |
| `id`       | `string`        |
| `options?` | `UpdateOptions` |

<div id="returns">
  #### Devuelve
</div>

`Promise`\<[`ListUpdateResponse`](/es/xdks/typescript/reference/interfaces/Schemas.ListUpdateResponse)>

<div id="defined-in">
  #### Definido en
</div>

[lists/client.ts:1623](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/lists/client.ts#L1623)

***

<div id="delete">
  ### delete
</div>

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

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

<div id="parameters">
  #### Parámetros
</div>

| 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`   | -                                                  |

<div id="returns">
  #### Devuelve
</div>

`Promise`\<`Response`>

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

<div id="defined-in">
  #### Definido en
</div>

[lists/client.ts:1731](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/lists/client.ts#L1731)

▸ **delete**(`id`): `Promise`\<[`ListDeleteResponse`](/es/xdks/typescript/reference/interfaces/Schemas.ListDeleteResponse)>

<div id="parameters">
  #### Parámetros
</div>

| Nombre | Tipo     |
| :----- | :------- |
| `id`   | `string` |

<div id="returns">
  #### Devuelve
</div>

`Promise`\<[`ListDeleteResponse`](/es/xdks/typescript/reference/interfaces/Schemas.ListDeleteResponse)>

<div id="defined-in">
  #### Definido en
</div>

[lists/client.ts:1744](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/lists/client.ts#L1744)