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

Cliente para operaciones con mensajes directos

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

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

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

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

Crea una nueva instancia del cliente de mensajes directos

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

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

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

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

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

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

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

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

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

Crear un mensaje directo por ID de conversación\
Envía un nuevo mensaje directo a una conversación específica mediante su ID.

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

| Nombre             | Tipo                                                                          | Descripción                     |
| :----------------- | :---------------------------------------------------------------------------- | :------------------------------ |
| `dmConversationId` | `string`                                                                      | El id de la conversación de MD. |
| `options`          | `CreateByConversationIdOptions` & \{ `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>

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

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

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

| Nombre             | Tipo                            |
| :----------------- | :------------------------------ |
| `dmConversationId` | `string`                        |
| `options?`         | `CreateByConversationIdOptions` |

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

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

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

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

Obtiene los eventos de MD de una conversación de mensajes directos\
Recupera los eventos de mensajes directos de una conversación específica.

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

| Nombre    | Tipo                                                                             | Descripción                                         |
| :-------- | :------------------------------------------------------------------------------- | :-------------------------------------------------- |
| `id`      | `string`                                                                         | El id de la conversación de Mensajes Directos (DM). |
| `options` | `GetEventsByConversationIdOptions` & \{ `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>

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

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

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

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

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

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

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

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

Crear una conversación de MD
Inicia una nueva conversación de mensaje directo con los participantes especificados.

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

| Nombre    | type                                                                      |
| :-------- | :------------------------------------------------------------------------ |
| `options` | `CreateConversationOptions` & \{ `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>

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

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

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

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

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

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

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

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

Obtener eventos de mensajes directos de una conversación
Recupera los eventos de mensajes directos para una conversación específica.

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

| Nombre          | Tipo                                                                            | Descripción                                                                   |
| :-------------- | :------------------------------------------------------------------------------ | :---------------------------------------------------------------------------- |
| `participantId` | `string`                                                                        | El identificador del usuario participante en la conversación de MD uno a uno. |
| `options`       | `GetEventsByParticipantIdOptions` & \{ `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>

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

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

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

| Nombre          | Tipo                              |
| :-------------- | :-------------------------------- |
| `participantId` | `string`                          |
| `options?`      | `GetEventsByParticipantIdOptions` |

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

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

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

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

Obtener eventos de MD
Obtiene una lista de eventos recientes de mensajes directos de todas las conversaciones.

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

| Nombre    | type                                                             |
| :-------- | :--------------------------------------------------------------- |
| `options` | `GetEventsOptions` & \{ `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>

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

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

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

| Nombre     | Tipo               |
| :--------- | :----------------- |
| `options?` | `GetEventsOptions` |

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

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

<div id="defined-in">
  #### Definido en
</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`>

Obtener evento de MD por ID\
Obtiene los detalles de un evento de mensaje directo específico por su ID.

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

| Nombre    | Tipo                                                                 | Descripción          |
| :-------- | :------------------------------------------------------------------- | :------------------- |
| `eventId` | `string`                                                             | id del evento de DM. |
| `options` | `GetEventsByIdOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                    |

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

`Promise`\<`Response`>

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

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

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

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

| Nombre     | Tipo                   |
| :--------- | :--------------------- |
| `eventId`  | `string`               |
| `options?` | `GetEventsByIdOptions` |

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

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

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

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

Eliminar evento de MD\
Elimina un evento de mensaje directo específico por su id, si pertenece al usuario autenticado.

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

| Nombre                       | Tipo     | Descripción                                               |
| :--------------------------- | :------- | :-------------------------------------------------------- |
| `eventId`                    | `string` | La ID del evento de mensaje directo 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 con el objeto `Response` sin procesar si `requestOptions.raw` es true

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

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

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

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

| Nombre    | Tipo     |
| :-------- | :------- |
| `eventId` | `string` |

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

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

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

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

Crear un mensaje directo por identificador de participante
Envía un nuevo mensaje directo a un participante específico mediante su identificador.

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

| Name            | Type                                                                         | Description                                        |
| :-------------- | :--------------------------------------------------------------------------- | :------------------------------------------------- |
| `participantId` | `string`                                                                     | El id del usuario destinatario que recibirá el DM. |
| `options`       | `CreateByParticipantIdOptions` & \{ `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>

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

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

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

| Nombre          | Tipo                           |
| :-------------- | :----------------------------- |
| `participantId` | `string`                       |
| `options?`      | `CreateByParticipantIdOptions` |

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

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

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

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