AccountActivityClient

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. Gestiona la autenticación, el formateo de solicitudes y el procesamiento de respuestas para todas las operaciones relacionadas con la actividad de la cuenta.

​

Constructores

​

constructor

• new AccountActivityClient(client): AccountActivityClient

Crea una nueva instancia del cliente de actividad de cuentas

​

Parámetros

Nombre	Tipo	Descripción
client	Client	La instancia principal del cliente de la X API

​

Devuelve

AccountActivityClient

​

Definido en

account_activity/client.ts:54

​

Métodos

​

getSubscriptions

▸ getSubscriptions(webhookId): Promise<SubscriptionsListGetResponse>

Obtener suscripciones Recupera una lista de todas las suscripciones activas para un webhook determinado.

​

Parámetros

Nombre	Tipo	Descripción
webhookId	string	El id del webhook para obtener suscripciones.

​

Devuelve

Promise<SubscriptionsListGetResponse>

Promesa que se resuelve con la respuesta de la API

​

Definido en

account_activity/client.ts:71

---

​

createReplayJob

▸ createReplayJob(webhookId, fromDate, toDate): Promise<ReplayJobCreateResponse>

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 con un webhook determinado.

​

Parámetros

Nombre	Tipo	Descripción
webhookId	string	El identificador único de la configuración del webhook.
fromDate	string	La marca de tiempo UTC más antigua (inicio), inclusiva, a partir de la cual se proporcionarán eventos, en formato yyyymmddhhmm.
toDate	string	La marca de tiempo UTC más reciente (fin), exclusiva, hasta la cual se proporcionarán eventos, en formato yyyymmddhhmm.

​

Devuelve

Promise<ReplayJobCreateResponse>

Promesa que se resuelve con la respuesta de la API

​

Definido en

account_activity/client.ts:118

---

​

validateSubscription

▸ validateSubscription(webhookId): Promise<SubscriptionsGetResponse>

Validar la suscripción Comprueba la suscripción de Account Activity de un usuario para un webhook determinado.

​

Parámetros

Nombre	Tipo	Descripción
webhookId	string	El id del webhook con el que verificar la suscripción.

​

Devuelve

Promise<SubscriptionsGetResponse>

Promesa que se resuelve con la respuesta de la API

​

Definido en

account_activity/client.ts:169

---

​

createSubscription

▸ createSubscription(webhookId, options?): Promise<SubscriptionsCreateResponse>

Crear suscripción Crea una suscripción de Account Activity para el usuario y el webhook indicado.

​

Parámetros

Nombre	Tipo	Descripción
webhookId	string	El id del webhook para verificar la suscripción correspondiente.
options	CreateSubscriptionOptions	-

​

Devuelve

Promise<SubscriptionsCreateResponse>

Promesa que se resuelve con la respuesta de la API

​

Definido en

account_activity/client.ts:209

---

​

deleteSubscription

▸ deleteSubscription(webhookId, userId): Promise<SubscriptionsDeleteResponse>

Eliminar suscripción Elimina una suscripción de Account Activity para el webhook y el userId indicados.

​

Parámetros

Nombre	Tipo	Descripción
webhookId	string	El id del webhook para comprobar la suscripción.
userId	string	id de usuario del que darse de baja.

​

Devuelve

Promise<SubscriptionsDeleteResponse>

Promesa que se resuelve con la respuesta de la API

​

Definido en

account_activity/client.ts:261

---

​

getSubscriptionCount

▸ getSubscriptionCount(): Promise<SubscriptionsCountGetResponse>

Obtener el conteo de suscripciones Recupera el conteo de las suscripciones de Account Activity que están activas actualmente.

​

Devuelve

Promise<SubscriptionsCountGetResponse>

Promesa que se resuelve con la respuesta de la API

​

Definido en

account_activity/client.ts:301