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

# DirectMessagesClient

Client pour les opérations de messages privés

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

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

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

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

Crée une nouvelle instance de client de messages privés

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

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

#### Renvoie

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

#### Défini dans

[direct\_messages/client.ts:340](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/direct_messages/client.ts#L340)

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

<div id="createbyconversationid">
  ### createByConversationId
</div>

▸ **createByConversationId**(`dmConversationId`, `options`): `Promise`\<`Response`>

Créer un message privé par identifiant de conversation\
Envoie un nouveau message privé dans une conversation spécifique à l'aide de son identifiant.

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

| Nom                | Type                                                                          | Description                             |
| :----------------- | :---------------------------------------------------------------------------- | :-------------------------------------- |
| `dmConversationId` | `string`                                                                      | L’identifiant de la conversation de DM. |
| `options`          | `CreateByConversationIdOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                                       |

#### Renvoie

`Promise`\<`Response`>

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

#### Défini dans

[direct\_messages/client.ts:385](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/direct_messages/client.ts#L385)

▸ **createByConversationId**(`dmConversationId`, `options?`): `Promise`\<[`CreateDmEventResponse`](/fr/xdks/typescript/reference/interfaces/Schemas.CreateDmEventResponse)>

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

| Nom                | Type                            |
| :----------------- | :------------------------------ |
| `dmConversationId` | `string`                        |
| `options?`         | `CreateByConversationIdOptions` |

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

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

#### Défini dans

[direct\_messages/client.ts:398](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/direct_messages/client.ts#L398)

***

<div id="geteventsbyconversationid">
  ### getEventsByConversationId
</div>

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

Obtenir les événements de messages privés pour une conversation
Récupère les événements de messages privés pour une conversation donnée.

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

| Nom       | Type                                                                             | Description                                               |
| :-------- | :------------------------------------------------------------------------------- | :-------------------------------------------------------- |
| `id`      | `string`                                                                         | L'identifiant de la conversation de messages privés (DM). |
| `options` | `GetEventsByConversationIdOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                                                         |

#### Renvoie

`Promise`\<`Response`>

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

#### Défini dans

[direct\_messages/client.ts:506](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/direct_messages/client.ts#L506)

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

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

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

#### Renvoie

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

#### Défini dans

[direct\_messages/client.ts:519](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/direct_messages/client.ts#L519)

***

<div id="createconversation">
  ### createConversation
</div>

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

Créer une conversation de messages privés
Démarre une nouvelle conversation de messages privés avec les participants spécifiés.

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

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

#### Renvoie

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

#### Défini dans

[direct\_messages/client.ts:784](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/direct_messages/client.ts#L784)

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

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

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

#### Renvoie

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

#### Défini dans

[direct\_messages/client.ts:793](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/direct_messages/client.ts#L793)

***

<div id="geteventsbyparticipantid">
  ### getEventsByParticipantId
</div>

▸ **getEventsByParticipantId**(`participantId`, `options`): `Promise`\<`Response`>

Obtenir les événements de messages directs pour une conversation
Récupère les événements de messages directs pour une conversation spécifique.

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

| Nom             | Type                                                                            | Description                                                                        |
| :-------------- | :------------------------------------------------------------------------------ | :--------------------------------------------------------------------------------- |
| `participantId` | `string`                                                                        | L’identifiant de l’utilisateur participant à la conversation de DM en tête-à-tête. |
| `options`       | `GetEventsByParticipantIdOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                                                                                  |

#### Renvoie

`Promise`\<`Response`>

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

#### Défini dans

[direct\_messages/client.ts:889](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/direct_messages/client.ts#L889)

▸ **getEventsByParticipantId**(`participantId`, `options?`): `Promise`\<[`Get2DmConversationsWithParticipantIdDmEventsResponse`](/fr/xdks/typescript/reference/interfaces/Schemas.Get2DmConversationsWithParticipantIdDmEventsResponse)>

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

| Nom             | Type                              |
| :-------------- | :-------------------------------- |
| `participantId` | `string`                          |
| `options?`      | `GetEventsByParticipantIdOptions` |

#### Renvoie

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

#### Défini dans

[direct\_messages/client.ts:902](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/direct_messages/client.ts#L902)

***

<div id="getevents">
  ### getEvents
</div>

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

Obtenir les événements de DM
Récupère une liste des événements récents de messages privés (DM) sur l’ensemble des conversations.

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

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

#### Renvoie

`Promise`\<`Response`>

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

#### Défini dans

[direct\_messages/client.ts:1167](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/direct_messages/client.ts#L1167)

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

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

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

#### Renvoie

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

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

[direct\_messages/client.ts:1176](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/direct_messages/client.ts#L1176)

***

<div id="geteventsbyid">
  ### getEventsById
</div>

▸ **getEventsById**(`eventId`, `options`): `Promise`\<`Response`>

Obtenir un événement de message privé (DM) par identifiant
Récupère les détails d’un événement de message privé (DM) spécifique à partir de son identifiant.

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

| Nom       | Type                                                                 | Description                       |
| :-------- | :------------------------------------------------------------------- | :-------------------------------- |
| `eventId` | `string`                                                             | Identifiant de l’événement de DM. |
| `options` | `GetEventsByIdOptions` & \{ `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

[direct\_messages/client.ts:1433](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/direct_messages/client.ts#L1433)

▸ **getEventsById**(`eventId`, `options?`): `Promise`\<[`Get2DmEventsEventIdResponse`](/fr/xdks/typescript/reference/interfaces/Schemas.Get2DmEventsEventIdResponse)>

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

| Nom        | Type                   |
| :--------- | :--------------------- |
| `eventId`  | `string`               |
| `options?` | `GetEventsByIdOptions` |

#### Renvoie

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

#### Défini dans

[direct\_messages/client.ts:1446](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/direct_messages/client.ts#L1446)

***

<div id="deleteevents">
  ### deleteEvents
</div>

▸ **deleteEvents**(`eventId`, `options`): `Promise`\<`Response`>

Supprimer un événement de DM
Supprime un événement de message privé spécifique par son identifiant, s’il appartient à l’utilisateur authentifié.

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

| Nom                          | Type     | Description                                                |
| :--------------------------- | :------- | :--------------------------------------------------------- |
| `eventId`                    | `string` | L’identifiant de l’événement de message privé à supprimer. |
| `options`                    | `Object` | -                                                          |
| `options.requestOptions`     | `Object` | -                                                          |
| `options.requestOptions.raw` | `true`   | -                                                          |

#### Renvoie

`Promise`\<`Response`>

Promise se résolvant en la réponse de l’API, ou en `Response` brute si `requestOptions.raw` vaut `true`

#### Défini dans

[direct\_messages/client.ts:1656](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/direct_messages/client.ts#L1656)

▸ **deleteEvents**(`eventId`): `Promise`\<[`DeleteDmResponse`](/fr/xdks/typescript/reference/interfaces/Schemas.DeleteDmResponse)>

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

| Nom       | Type     |
| :-------- | :------- |
| `eventId` | `string` |

#### Renvoie

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

#### Défini dans

[direct\_messages/client.ts:1669](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/direct_messages/client.ts#L1669)

***

<div id="createbyparticipantid">
  ### createByParticipantId
</div>

▸ **createByParticipantId**(`participantId`, `options`): `Promise`\<`Response`>

Créer un message privé (DM) à partir de l’id du participant\
Envoie un nouveau message privé à un participant spécifique en utilisant son id.

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

| Nom             | Type                                                                         | Description                                                    |
| :-------------- | :--------------------------------------------------------------------------- | :------------------------------------------------------------- |
| `participantId` | `string`                                                                     | L'identifiant de l'utilisateur destinataire qui recevra le DM. |
| `options`       | `CreateByParticipantIdOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                                                              |

#### Renvoie

`Promise`\<`Response`>

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

#### Défini dans

[direct\_messages/client.ts:1760](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/direct_messages/client.ts#L1760)

▸ **createByParticipantId**(`participantId`, `options?`): `Promise`\<[`CreateDmEventResponse`](/fr/xdks/typescript/reference/interfaces/Schemas.CreateDmEventResponse)>

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

| Nom             | Type                           |
| :-------------- | :----------------------------- |
| `participantId` | `string`                       |
| `options?`      | `CreateByParticipantIdOptions` |

#### Renvoie

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

#### Défini dans

[direct\_messages/client.ts:1773](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/direct_messages/client.ts#L1773)