AccountActivityClient

account activity 操作向けのクライアント このクライアントは X API の account activity エンドポイントと対話するためのメソッドを提供します。認証、リクエストの整形、account activity に関連するすべての操作のレスポンス解析を扱います。

​

コンストラクター

​

コンストラクター

• new AccountActivityClient(client): AccountActivityClient 新しい account activity クライアントインスタンスを作成します

​

パラメーター

​

戻り値

AccountActivityClient

​

定義場所

account_activity/client.ts:70

​

メソッド

​

getSubscriptions

▸ getSubscriptions(webhookId, options): Promise<Response> Get subscriptions 次の一覧を取得します: all active subscriptions for a given webhook.

​

パラメーター

​

戻り値

Promise<Response> API レスポンスに解決される Promise。requestOptions.raw が true の場合は生の Response を返します

​

定義場所

account_activity/client.ts:115 ▸ getSubscriptions(webhookId): Promise<SubscriptionsListGetResponse>

​

パラメーター

​

戻り値

Promise<SubscriptionsListGetResponse>

​

定義場所

account_activity/client.ts:128

---

​

deleteSubscription

▸ deleteSubscription(webhookId, userId, options): Promise<Response> Delete subscription Deletes an Account Activity subscription for the given webhook and user ID.

​

パラメーター

​

戻り値

Promise<Response> API レスポンスに解決される Promise。requestOptions.raw が true の場合は生の Response を返します

​

定義場所

account_activity/client.ts:217 ▸ deleteSubscription(webhookId, userId): Promise<SubscriptionsDeleteResponse>

​

パラメーター

​

戻り値

Promise<SubscriptionsDeleteResponse>

​

定義場所

account_activity/client.ts:234

---

​

validateSubscription

▸ validateSubscription(webhookId, options): Promise<Response> Validate subscription Checks a user’s Account Activity subscription for a given webhook.

​

パラメーター

​

戻り値

Promise<Response> API レスポンスに解決される Promise。requestOptions.raw が true の場合は生の Response を返します

​

定義場所

account_activity/client.ts:331 ▸ validateSubscription(webhookId): Promise<SubscriptionsGetResponse>

​

パラメーター

​

戻り値

Promise<SubscriptionsGetResponse>

​

定義場所

account_activity/client.ts:344

---

​

createSubscription

▸ createSubscription(webhookId, options): Promise<Response> Create subscription Creates an Account Activity subscription for the user and the given webhook.

​

パラメーター

​

戻り値

Promise<Response> API レスポンスに解決される Promise。requestOptions.raw が true の場合は生の Response を返します

​

定義場所

account_activity/client.ts:435 ▸ createSubscription(webhookId, options?): Promise<SubscriptionsCreateResponse>

​

パラメーター

​

戻り値

Promise<SubscriptionsCreateResponse>

​

定義場所

account_activity/client.ts:448

---

​

createReplayJob

▸ 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.

​

パラメーター

​

戻り値

Promise<Response> API レスポンスに解決される Promise。requestOptions.raw が true の場合は生の Response を返します

​

定義場所

account_activity/client.ts:564 ▸ createReplayJob(webhookId, fromDate, toDate): Promise<ReplayJobCreateResponse>

​

パラメーター

​

戻り値

Promise<ReplayJobCreateResponse>

​

定義場所

account_activity/client.ts:585

---

​

getSubscriptionCount

▸ getSubscriptionCount(options): Promise<Response> Get subscription count Retrieves a count of currently active Account Activity subscriptions.

​

パラメーター

​

戻り値

Promise<Response> API レスポンスに解決される Promise。requestOptions.raw が true の場合は生の Response を返します

​

定義場所

account_activity/client.ts:704 ▸ getSubscriptionCount(): Promise<SubscriptionsCountGetResponse>

​

戻り値

Promise<SubscriptionsCountGetResponse>

​

定義場所

account_activity/client.ts:713