WebhooksClient

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

​

コンストラクター

​

コンストラクター

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

​

パラメーター

​

戻り値

WebhooksClient

​

定義場所

webhooks/client.ts:162

​

メソッド

​

createStreamLink

▸ createStreamLink(webhookId, options): Promise<Response> Create stream link Creates a link to deliver FilteredStream events to the given webhook.

​

パラメーター

​

戻り値

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

​

定義場所

webhooks/client.ts:207 ▸ createStreamLink(webhookId, options?): Promise<WebhookLinksCreateResponse>

​

パラメーター

​

戻り値

Promise<WebhookLinksCreateResponse>

​

定義場所

webhooks/client.ts:220

---

​

deleteStreamLink

▸ deleteStreamLink(webhookId, options): Promise<Response> Delete stream link Deletes a link from FilteredStream events to the given webhook.

​

パラメーター

​

戻り値

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

​

定義場所

webhooks/client.ts:433 ▸ deleteStreamLink(webhookId): Promise<WebhookLinksDeleteResponse>

​

パラメーター

​

戻り値

Promise<WebhookLinksDeleteResponse>

​

定義場所

webhooks/client.ts:446

---

​

getStreamLinks

▸ getStreamLinks(options): Promise<Response> Get stream links Get a list of webhook links associated with a filtered stream ruleset.

​

パラメーター

​

戻り値

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

​

定義場所

webhooks/client.ts:527 ▸ getStreamLinks(): Promise<WebhookLinksGetResponse>

​

戻り値

Promise<WebhookLinksGetResponse>

​

定義場所

webhooks/client.ts:536

---

​

createWebhookReplayJob

▸ createWebhookReplayJob(options): Promise<Response> Create replay job for webhook Creates a replay job to retrieve events from up to the past 24 hours for all events delivered or attempted to be delivered to the webhook.

​

パラメーター

​

戻り値

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

​

定義場所

webhooks/client.ts:605 ▸ createWebhookReplayJob(options?): Promise<ReplayJobCreateResponse>

​

パラメーター

​

戻り値

Promise<ReplayJobCreateResponse>

​

定義場所

webhooks/client.ts:614

---

​

validate

▸ validate(webhookId, options): Promise<Response> Validate webhook Triggers a CRC check for a given webhook.

​

パラメーター

​

戻り値

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

​

定義場所

webhooks/client.ts:704 ▸ validate(webhookId): Promise<WebhookConfigPutResponse>

​

パラメーター

​

戻り値

Promise<WebhookConfigPutResponse>

​

定義場所

webhooks/client.ts:717

---

​

delete

▸ delete(webhookId, options): Promise<Response> Delete webhook Deletes an existing webhook configuration.

​

パラメーター

​

戻り値

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

​

定義場所

webhooks/client.ts:808 ▸ delete(webhookId): Promise<WebhookConfigDeleteResponse>

​

パラメーター

​

戻り値

Promise<WebhookConfigDeleteResponse>

​

定義場所

webhooks/client.ts:821

---

​

get

▸ get(options): Promise<Response> Get webhook Get a list of webhook configs associated with a client app.

​

パラメーター

​

戻り値

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

​

定義場所

webhooks/client.ts:908 ▸ get(options?): Promise<Get2WebhooksResponse>

​

パラメーター

​

戻り値

Promise<Get2WebhooksResponse>

​

定義場所

webhooks/client.ts:917

---

​

create

▸ create(options): Promise<Response> Create webhook Creates a new webhook configuration.

​

パラメーター

​

戻り値

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

​

定義場所

webhooks/client.ts:1023 ▸ create(options?): Promise<WebhookConfigCreateResponse>

​

パラメーター

​

戻り値

Promise<WebhookConfigCreateResponse>

​

定義場所

webhooks/client.ts:1032