> ## 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 pour les opérations sur les listes

Ce client fournit des méthodes pour interagir avec les endpoints de listes
de la X API. Il gère l'authentification, le formatage des requêtes et l'analyse des réponses
pour toutes les opérations liées aux listes.

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

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

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

Crée une nouvelle instance de ListsClient.

<div id="parameters">
  #### Paramètres
</div>

| Nom      | Type                                                     | Description                           |
| :------- | :------------------------------------------------------- | :------------------------------------ |
| `client` | [`Client`](/fr/xdks/typescript/reference/classes/Client) | L'instance principale du Client X API |

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

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

#### Défini dans

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

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

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

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

Récupérer les abonnés de la Liste
Récupère une liste d’utilisateurs qui suivent une Liste spécifique via son identifiant.

<div id="parameters">
  #### Paramètres
</div>

| Nom       | Type                                                                | Description                |
| :-------- | :------------------------------------------------------------------ | :------------------------- |
| `id`      | `string`                                                            | L'identifiant de la Liste. |
| `options` | `GetFollowersOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                          |

#### Renvoie

`Promise`\<`Response`>

Promise résolue avec la réponse de l’API, ou l’objet `Response` brut si `requestOptions.raw` vaut `true`

#### Défini dans

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

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

<div id="parameters">
  #### Paramètres
</div>

| Nom        | Type                  |
| :--------- | :-------------------- |
| `id`       | `string`              |
| `options?` | `GetFollowersOptions` |

#### Renvoie

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

#### Défini dans

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

Créer une Liste
Crée une nouvelle Liste pour l’utilisateur authentifié.

<div id="parameters">
  #### Paramètres
</div>

| Nom       | Type                                                          |
| :-------- | :------------------------------------------------------------ |
| `options` | `CreateOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } |

#### Renvoie

`Promise`\<`Response`>

Promise qui se résout avec la réponse de l’API, ou l’objet Response brut si `requestOptions.raw` vaut `true`

#### Défini dans

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

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

<div id="parameters">
  #### Paramètres
</div>

| Nom        | Type            |
| :--------- | :-------------- |
| `options?` | `CreateOptions` |

#### Renvoie

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

#### Défini dans

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

Obtenir les membres d’une liste
Récupère les utilisateurs qui sont membres d’une liste spécifique à partir de son id.

<div id="parameters">
  #### Paramètres
</div>

| Nom       | Type                                                              | Description                |
| :-------- | :---------------------------------------------------------------- | :------------------------- |
| `id`      | `string`                                                          | L'identifiant de la Liste. |
| `options` | `GetMembersOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                          |

#### Renvoie

`Promise`\<`Response`>

Promise qui se résout avec la réponse de l'API, ou `Response` brut si `requestOptions.raw` est à `true`

#### Défini dans

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

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

<div id="parameters">
  #### Paramètres
</div>

| Nom        | Type                |
| :--------- | :------------------ |
| `id`       | `string`            |
| `options?` | `GetMembersOptions` |

#### Renvoie

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

#### Défini dans

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

Ajouter un membre à une Liste
Ajoute un utilisateur à une Liste spécifique à l’aide de son identifiant.

#### Parameters

| Name      | Type                                                             | Description                                             |
| :-------- | :--------------------------------------------------------------- | :------------------------------------------------------ |
| `id`      | `string`                                                         | L'identifiant de la liste à laquelle ajouter un membre. |
| `options` | `AddMemberOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                                                       |

#### Returns

`Promise`\<`Response`>

Promise qui se résout avec la réponse de l’API, ou avec l’objet `Response` brut si `requestOptions.raw` vaut `true`

<div id="defined-in">
  #### Définie dans
</div>

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

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

<div id="parameters">
  #### Paramètres
</div>

| Nom        | Type               |
| :--------- | :----------------- |
| `id`       | `string`           |
| `options?` | `AddMemberOptions` |

#### Renvoie

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

#### Défini dans

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

Récupérer les publications d’une Liste\
Récupère les publications associées à une Liste spécifique via son identifiant.

<div id="parameters">
  #### Paramètres
</div>

| Nom       | Type                                                            | Description                |
| :-------- | :-------------------------------------------------------------- | :------------------------- |
| `id`      | `string`                                                        | L’identifiant de la Liste. |
| `options` | `GetPostsOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                          |

#### Returns

`Promise`\<`Response`>

Promise renvoyant la réponse de l’API, ou l’objet `Response` brut si `requestOptions.raw` est à `true`

#### Défini dans

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

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

<div id="parameters">
  #### Paramètres
</div>

| Nom        | Type              |
| :--------- | :---------------- |
| `id`       | `string`          |
| `options?` | `GetPostsOptions` |

#### Renvoie

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

#### Défini dans

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

Supprimer un membre d’une Liste
Supprime un utilisateur d’une Liste spécifique à partir de l’identifiant de la Liste et de l’identifiant de l’utilisateur.

<div id="parameters">
  #### Paramètres
</div>

| Nom                          | Type     | Description                                                   |
| :--------------------------- | :------- | :------------------------------------------------------------ |
| `id`                         | `string` | L'identifiant de la Liste dont un membre doit être supprimé.  |
| `userId`                     | `string` | L'identifiant de l'utilisateur qui sera supprimé de la Liste. |
| `options`                    | `Object` | -                                                             |
| `options.requestOptions`     | `Object` | -                                                             |
| `options.requestOptions.raw` | `true`   | -                                                             |

#### Renvoie

`Promise`\<`Response`>

Promise résolue avec la réponse de l’API, ou objet `Response` brut si `requestOptions.raw` est à `true`

#### Défini dans

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

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

<div id="parameters">
  #### Paramètres
</div>

| Nom      | Type     |
| :------- | :------- |
| `id`     | `string` |
| `userId` | `string` |

#### Renvoie

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

#### Défini dans

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

Obtenir une Liste par id\
Récupère les détails d’une Liste spécifique à partir de son id.

<div id="parameters">
  #### Paramètres
</div>

| Nom       | Type                                                           | Description                |
| :-------- | :------------------------------------------------------------- | :------------------------- |
| `id`      | `string`                                                       | L’identifiant de la Liste. |
| `options` | `GetByIdOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                          |

#### Renvoie

`Promise`\<`Response`>

Promise qui se résout avec la réponse de l’API, ou l’objet `Response` brut si `requestOptions.raw` vaut `true`

#### Défini dans

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

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

<div id="parameters">
  #### Paramètres
</div>

| Nom        | Type             |
| :--------- | :--------------- |
| `id`       | `string`         |
| `options?` | `GetByIdOptions` |

#### Renvoie

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

#### Défini dans

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

Mettre à jour une liste\
Met à jour les détails d’une liste spécifique appartenant à l’utilisateur authentifié, à partir de son identifiant (`id`).

<div id="parameters">
  #### Paramètres
</div>

| Nom       | Type                                                          | Description                           |
| :-------- | :------------------------------------------------------------ | :------------------------------------ |
| `id`      | `string`                                                      | L’identifiant de la Liste à modifier. |
| `options` | `UpdateOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                                     |

#### Renvoie

`Promise`\<`Response`>

Promise qui se résout avec la réponse de l’API, ou l’objet `Response` brut si `requestOptions.raw` vaut `true`

#### Défini dans

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

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

<div id="parameters">
  #### Paramètres
</div>

| Nom        | Type            |
| :--------- | :-------------- |
| `id`       | `string`        |
| `options?` | `UpdateOptions` |

#### Renvoie

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

#### Défini dans

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

Supprimer une Liste
Supprime une Liste spécifique appartenant à l’utilisateur authentifié via son id.

<div id="parameters">
  #### Paramètres
</div>

| Nom                          | Type     | Description                            |
| :--------------------------- | :------- | :------------------------------------- |
| `id`                         | `string` | L'identifiant de la Liste à supprimer. |
| `options`                    | `Object` | -                                      |
| `options.requestOptions`     | `Object` | -                                      |
| `options.requestOptions.raw` | `true`   | -                                      |

#### Renvoie

`Promise`\<`Response`>

Promise qui se résout avec la réponse de l’API, ou l’objet Response brut si `requestOptions.raw` est true

#### Défini dans

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

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

<div id="parameters">
  #### Paramètres
</div>

| Nom  | Type     |
| :--- | :------- |
| `id` | `string` |

#### Renvoie

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

#### Défini dans

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