Documentation Index
Fetch the complete documentation index at: https://generaltranslation.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
Cliente para operaciones de actividad de la cuenta
Este cliente proporciona métodos para interactuar con los endpoints de actividad de la cuenta
de la X API. Se encarga de la autenticación, el formateo de las solicitudes y el análisis de las
respuestas para todas las operaciones relacionadas con la actividad de la cuenta.
• new AccountActivityClient(client): AccountActivityClient
Crea una nueva instancia del cliente de actividad de cuenta
| Nombre | Tipo | Descripción |
|---|
client | Client | La instancia principal del Client de la X API |
AccountActivityClient
account_activity/client.ts:70
▸ getSubscriptions(webhookId, options): Promise<Response>
Obtener suscripciones
Obtiene una lista de todas las suscripciones activas para un webhook determinado.
| Nombre | Tipo | Descripción |
|---|
webhookId | string | El id del webhook del que se quieren obtener las suscripciones. |
options | Object | - |
options.requestOptions | Object | - |
options.requestOptions.raw | true | - |
Promise<Response>
Promesa que se resuelve con la respuesta de la API, o con el objeto Response sin procesar si requestOptions.raw es true
account_activity/client.ts:115
▸ getSubscriptions(webhookId): Promise<SubscriptionsListGetResponse>
| Nombre | Tipo |
|---|
webhookId | string |
Promise<SubscriptionsListGetResponse>
account_activity/client.ts:128
▸ deleteSubscription(webhookId, userId, options): Promise<Response>
Eliminar suscripción
Elimina una suscripción de Account Activity para el webhook y el ID de usuario indicados.
| Nombre | Tipo | Descripción |
|---|
webhookId | string | El ID del webhook con el que comprobar la suscripción. |
userId | string | ID de usuario del que darse de baja. |
options | Object | - |
options.requestOptions | Object | - |
options.requestOptions.raw | true | - |
Promise<Response>
Promesa que se resuelve con la respuesta de la API, o con el objeto Response sin procesar si requestOptions.raw es true
account_activity/client.ts:217
▸ deleteSubscription(webhookId, userId): Promise<SubscriptionsDeleteResponse>
| Nombre | Tipo |
|---|
webhookId | string |
userId | string |
Promise<SubscriptionsDeleteResponse>
account_activity/client.ts:234
▸ validateSubscription(webhookId, options): Promise<Response>
Validar la suscripción
Comprueba la suscripción a Account Activity de un usuario para un webhook determinado.
| Nombre | Tipo | Descripción |
|---|
webhookId | string | El id del webhook para comprobar la suscripción correspondiente. |
options | Object | - |
options.requestOptions | Object | - |
options.requestOptions.raw | true | - |
Promise<Response>
Promesa que se resuelve con la respuesta de la API, o con el objeto Response sin procesar si requestOptions.raw es true
account_activity/client.ts:331
▸ validateSubscription(webhookId): Promise<SubscriptionsGetResponse>
| Nombre | Tipo |
|---|
webhookId | string |
Promise<SubscriptionsGetResponse>
account_activity/client.ts:344
▸ createSubscription(webhookId, options): Promise<Response>
Crear suscripción
Crea una suscripción de Account Activity para el usuario y el webhook indicado.
| Nombre | Tipo | Descripción |
|---|
webhookId | string | El id del webhook cuya suscripción se va a comprobar. |
options | CreateSubscriptionOptions & { requestOptions: { raw: true } } | - |
Promise<Response>
Promesa que se resuelve con la respuesta de la API, o con el objeto Response sin procesar si requestOptions.raw es true
account_activity/client.ts:435
▸ createSubscription(webhookId, options?): Promise<SubscriptionsCreateResponse>
| Nombre | Tipo |
|---|
webhookId | string |
options? | CreateSubscriptionOptions |
Promise<SubscriptionsCreateResponse>
account_activity/client.ts:448
▸ createReplayJob(webhookId, fromDate, toDate, options): Promise<Response>
Crear trabajo de reproducción
Crea un trabajo de reproducción para recuperar actividades de hasta los últimos 5 días para todas las suscripciones asociadas al webhook indicado.
| Nombre | Tipo | Descripción |
|---|
webhookId | string | El identificador único de la configuración del webhook. |
fromDate | string | La marca de tiempo UTC inicial (inclusive) a partir de la cual se proporcionarán eventos, en formato yyyymmddhhmm. |
toDate | string | La marca de tiempo UTC final (exclusiva) hasta la cual se proporcionarán eventos, en formato yyyymmddhhmm. |
options | Object | - |
options.requestOptions | Object | - |
options.requestOptions.raw | true | - |
Promise<Response>
Promesa que se resuelve con la respuesta de la API, o con el objeto Response sin procesar si requestOptions.raw es true
account_activity/client.ts:564
▸ createReplayJob(webhookId, fromDate, toDate): Promise<ReplayJobCreateResponse>
| Nombre | Tipo |
|---|
webhookId | string |
fromDate | string |
toDate | string |
Promise<ReplayJobCreateResponse>
account_activity/client.ts:585
▸ getSubscriptionCount(options): Promise<Response>
Obtiene el número de suscripciones
Devuelve el número de suscripciones activas de Account Activity.
| Nombre | Type |
|---|
options | Object |
options.requestOptions | Object |
options.requestOptions.raw | true |
Promise<Response>
Promesa que se resuelve con la respuesta de la API, o con el objeto Response sin procesar si requestOptions.raw es true
account_activity/client.ts:704
▸ getSubscriptionCount(): Promise<SubscriptionsCountGetResponse>
Promise<SubscriptionsCountGetResponse>
account_activity/client.ts:713
