Construtores
constructor
• new AccountActivityClient(client): AccountActivityClient
Cria uma nova instância do client account activity
Parâmetros
Retorna
AccountActivityClient
Definido em
account_activity/client.ts:70Métodos
getSubscriptions
▸ getSubscriptions(webhookId, options): Promise<Response>
Get subscriptions
Retrieves a list of all active subscriptions for a given webhook.
Parâmetros
Retorna
Promise<Response>
Promise que resolve para a resposta da API, ou Response bruto se requestOptions.raw for true
Definido em
account_activity/client.ts:115 ▸ getSubscriptions(webhookId): Promise<SubscriptionsListGetResponse>
Parâmetros
Retorna
Promise<SubscriptionsListGetResponse>
Definido em
account_activity/client.ts:128deleteSubscription
▸ deleteSubscription(webhookId, userId, options): Promise<Response>
Delete subscription
Deletes an Account Activity subscription for the given webhook and user ID.
Parâmetros
Retorna
Promise<Response>
Promise que resolve para a resposta da API, ou Response bruto se requestOptions.raw for true
Definido em
account_activity/client.ts:217 ▸ deleteSubscription(webhookId, userId): Promise<SubscriptionsDeleteResponse>
Parâmetros
Retorna
Promise<SubscriptionsDeleteResponse>
Definido em
account_activity/client.ts:234validateSubscription
▸ validateSubscription(webhookId, options): Promise<Response>
Validate subscription
Checks a user’s Account Activity subscription for a given webhook.
Parâmetros
Retorna
Promise<Response>
Promise que resolve para a resposta da API, ou Response bruto se requestOptions.raw for true
Definido em
account_activity/client.ts:331 ▸ validateSubscription(webhookId): Promise<SubscriptionsGetResponse>
Parâmetros
Retorna
Promise<SubscriptionsGetResponse>
Definido em
account_activity/client.ts:344createSubscription
▸ createSubscription(webhookId, options): Promise<Response>
Create subscription
Creates an Account Activity subscription for the user and the given webhook.
Parâmetros
Retorna
Promise<Response>
Promise que resolve para a resposta da API, ou Response bruto se requestOptions.raw for true
Definido em
account_activity/client.ts:435 ▸ createSubscription(webhookId, options?): Promise<SubscriptionsCreateResponse>
Parâmetros
Retorna
Promise<SubscriptionsCreateResponse>
Definido em
account_activity/client.ts:448createReplayJob
▸ createReplayJob(webhookId, fromDate, toDate, options): Promise<Response>
Create replay job
Creates a replay job to retrieve activities from up to the past 5 days for all subscriptions associated with a given webhook.
Parâmetros
Retorna
Promise<Response>
Promise que resolve para a resposta da API, ou Response bruto se requestOptions.raw for true
Definido em
account_activity/client.ts:564 ▸ createReplayJob(webhookId, fromDate, toDate): Promise<ReplayJobCreateResponse>
Parâmetros
Retorna
Promise<ReplayJobCreateResponse>
Definido em
account_activity/client.ts:585getSubscriptionCount
▸ getSubscriptionCount(options): Promise<Response>
Get subscription count
Retrieves a count of currently active Account Activity subscriptions.
Parâmetros
Retorna
Promise<Response>
Promise que resolve para a resposta da API, ou Response bruto se requestOptions.raw for true
Definido em
account_activity/client.ts:704 ▸ getSubscriptionCount():Promise<SubscriptionsCountGetResponse>
Retorna
Promise<SubscriptionsCountGetResponse>