AccountActivityClient

Client pour les opérations d’activité de compte

Ce client fournit des méthodes pour interagir avec les endpoints d’activité de compte de 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 à l’activité de compte.

​

Constructeurs

​

constructor

• new AccountActivityClient(client): AccountActivityClient

Crée une nouvelle instance d’AccountActivityClient

​

Paramètres

Name	Type	Description
client	Client	L’instance principale du Client X API

​

Retourne

AccountActivityClient

​

Défini dans

account_activity/client.ts:70

​

Méthodes

​

getSubscriptions

▸ getSubscriptions(webhookId, options): Promise<Response>

Obtenir les abonnements
Renvoie la liste de tous les abonnements actifs associés à un webhook donné.

​

Paramètres

Nom	Type	Description
webhookId	string	L’identifiant du webhook pour lequel récupérer les abonnements.
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 vaut true

​

Défini dans

account_activity/client.ts:115

▸ getSubscriptions(webhookId): Promise<SubscriptionsListGetResponse>

​

Paramètres

Nom	Type
webhookId	string

​

Renvoie

Promise<SubscriptionsListGetResponse>

​

Défini dans

account_activity/client.ts:128

---

​

deleteSubscription

▸ deleteSubscription(webhookId, userId, options): Promise<Response>

Supprimer un abonnement Supprime un abonnement Account Activity pour le webhook et l’identifiant utilisateur spécifiés.

​

Paramètres

Nom	Type	Description
webhookId	string	L’identifiant du webhook pour lequel vérifier l’abonnement.
userId	string	Identifiant de l’utilisateur à désabonner.
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 avec l’objet Response brut si requestOptions.raw vaut true

​

Défini dans

account_activity/client.ts:217

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

​

Paramètres

Nom	Type
webhookId	string
userId	string

​

Renvoie

Promise<SubscriptionsDeleteResponse>

​

Défini dans

account_activity/client.ts:234

---

​

validateSubscription

▸ validateSubscription(webhookId, options): Promise<Response>

Valide l’abonnement Vérifie l’abonnement Account Activity d’un utilisateur pour un webhook donné.

​

Paramètres

Nom	Type	Description
webhookId	string	L’identifiant du webhook à utiliser pour vérifier l’abonnement.
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 Response brute si requestOptions.raw vaut true

​

Défini dans

account_activity/client.ts:331

▸ validateSubscription(webhookId): Promise<SubscriptionsGetResponse>

​

Paramètres

Nom	Type
webhookId	string

​

Renvoie

Promise<SubscriptionsGetResponse>

​

Défini dans

account_activity/client.ts:344

---

​

createSubscription

▸ createSubscription(webhookId, options): Promise<Response>

Créer un abonnement Crée un abonnement Account Activity pour l’utilisateur et le webhook fournis.

​

Paramètres

Nom	Type	Description
webhookId	string	L’identifiant du webhook à utiliser pour vérifier l’abonnement.
options	CreateSubscriptionOptions & { requestOptions: { raw: true } }	-

​

Renvoie

Promise<Response>

Promesse se résolvant en la réponse de l’API, ou en l’objet Response brut si requestOptions.raw est défini à true

​

Défini dans

account_activity/client.ts:435

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

​

Paramètres

Nom	Type
webhookId	string
options?	CreateSubscriptionOptions

​

Renvoie

Promise<SubscriptionsCreateResponse>

​

Défini dans

account_activity/client.ts:448

---

​

createReplayJob

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

Créer une tâche de relecture (replay) Crée une tâche de relecture (replay) pour récupérer les activités des 5 derniers jours au maximum pour tous les abonnements associés à un webhook donné.

​

Paramètres

Nom	Type	Description
webhookId	string	L’identifiant unique de la configuration du webhook.
fromDate	string	L’horodatage UTC le plus ancien (de début, inclus) à partir duquel les événements seront fournis, au format yyyymmddhhmm.
toDate	string	L’horodatage UTC le plus récent (de fin, exclus) jusqu’auquel les événements seront fournis, au format yyyymmddhhmm.
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 vaut true

​

Défini dans

account_activity/client.ts:564

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

​

Paramètres

Nom	Type
webhookId	string
fromDate	string
toDate	string

​

Retourne

Promise<ReplayJobCreateResponse>

​

Défini dans

account_activity/client.ts:585

---

​

getSubscriptionCount

▸ getSubscriptionCount(options): Promise<Response>

Obtenir le nombre d’abonnements
Renvoie le nombre d’abonnements Account Activity actuellement actifs.

​

Paramètres

Nom	Type
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 avec l’objet Response brut si requestOptions.raw est à true

​

Défini dans

account_activity/client.ts:704

▸ getSubscriptionCount(): Promise<SubscriptionsCountGetResponse>

​

Renvoie

Promise<SubscriptionsCountGetResponse>

​

Défini dans

account_activity/client.ts:713