WebhooksClient

webhooks ऑपरेशनों के लिए क्लाइंट

यह क्लाइंट X API के webhooks endpoints के साथ इंटरैक्ट करने के लिए मेथड उपलब्ध कराता है। यह सभी webhooks-संबंधित ऑपरेशनों के लिए authentication, request formatting और रिस्पॉन्स parsing को संभालता है।

कंस्ट्रक्टर्स

constructor

• new WebhooksClient(client): WebhooksClient

एक नया WebhooksClient इंस्टेंस बनाता है

पैरामीटर

नाम	type	विवरण
client	Client	मुख्य X API क्लाइंट इंस्टेंस

रिटर्न

WebhooksClient

यहाँ परिभाषित

webhooks/client.ts:162

मेथड्स

createStreamLink

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

स्ट्रीम लिंक बनाएँ यह दिए गए webhook पर FilteredStream इवेंट पहुँचाने के लिए एक लिंक बनाता है।

पैरामीटर

नाम	type	विवरण
webhookId	string	आपके FilteredStream ruleset से लिंक करने के लिए webhook की ID।
options	CreateStreamLinkOptions & { requestOptions: { raw: true } }	-

रिटर्न

Promise<Response>

वह Promise जो API रिस्पॉन्स पर resolve होता है, या यदि requestOptions.raw true है, तो raw Response

यहाँ परिभाषित है

webhooks/client.ts:207

▸ createStreamLink(webhookId, options?): Promise<WebhookLinksCreateResponse>

पैरामीटर

नाम	प्रकार
webhookId	string
options?	CreateStreamLinkOptions

रिटर्न

Promise<WebhookLinksCreateResponse>

यहाँ परिभाषित है

webhooks/client.ts:220

---

deleteStreamLink

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

स्ट्रीम लिंक हटाएँ यह दिए गए webhook के लिए FilteredStream इवेंट्स से लिंक हटाता है।

पैरामीटर

नाम	type	विवरण
webhookId	string	आपके FilteredStream ruleset से लिंक करने के लिए webhook ID
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

रिटर्न

Promise<Response>

API रिस्पॉन्स में resolve होने वाला Promise, या यदि requestOptions.raw true है, तो raw Response

यहाँ परिभाषित

webhooks/client.ts:433

▸ deleteStreamLink(webhookId): Promise<WebhookLinksDeleteResponse>

पैरामीटर

नाम	type
webhookId	string

रिटर्न

Promise<WebhookLinksDeleteResponse>

यहाँ परिभाषित है

webhooks/client.ts:446

---

getStreamLinks

▸ getStreamLinks(options): Promise<Response>

स्ट्रीम लिंक प्राप्त करें फ़िल्टर किए गए स्ट्रीम ruleset से जुड़े webhook लिंक की सूची प्राप्त करें।

पैरामीटर

नाम	type
options	Object
options.requestOptions	Object
options.requestOptions.raw	true

रिटर्न

Promise<Response>

API रिस्पॉन्स पर रिज़ॉल्व होने वाला Promise, या यदि requestOptions.raw true है तो raw Response

यहाँ परिभाषित है

webhooks/client.ts:527

▸ getStreamLinks(): Promise<WebhookLinksGetResponse>

रिटर्न

Promise<WebhookLinksGetResponse>

में निर्दिष्ट

webhooks/client.ts:536

---

createWebhookReplayJob

▸ createWebhookReplayJob(options): Promise<Response>

webhook के लिए replay job बनाएँ webhook को डिलीवर किए गए या डिलीवर करने का प्रयास किए गए सभी इवेंट्स के लिए पिछले 24 घंटों तक के इवेंट्स पुनर्प्राप्त करने हेतु एक replay job बनाता है।

पैरामीटर

नाम	type
options	CreateWebhookReplayJobOptions & { requestOptions: { raw: true } }

रिटर्न

Promise<Response>

ऐसा Promise जो API रिस्पॉन्स पर resolve होता है, या यदि requestOptions.raw true हो, तो raw Response

यहाँ परिभाषित है

webhooks/client.ts:605

▸ createWebhookReplayJob(options?): Promise<ReplayJobCreateResponse>

पैरामीटर

नाम	type
options?	CreateWebhookReplayJobOptions

रिटर्न

Promise<ReplayJobCreateResponse>

यहाँ परिभाषित

webhooks/client.ts:614

---

validate

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

webhook को मान्य करें यह दिए गए webhook के लिए CRC जाँच को ट्रिगर करता है।

पैरामीटर

नाम	प्रकार	विवरण
webhookId	string	जाँच करने के लिए webhook की ID।
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

रिटर्न

Promise<Response>

API रिस्पॉन्स पर रिज़ॉल्व होने वाला Promise, या यदि requestOptions.raw true है, तो raw Response

इसमें परिभाषित

webhooks/client.ts:704

▸ validate(webhookId): Promise<WebhookConfigPutResponse>

पैरामीटर

नाम	type
webhookId	string

रिटर्न

Promise<WebhookConfigPutResponse>

यहाँ परिभाषित है

webhooks/client.ts:717

---

delete

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

Webhook हटाएँ किसी मौजूदा webhook कॉन्फ़िगरेशन को हटाता है।

पैरामीटर

नाम	type	विवरण
webhookId	string	हटाए जाने वाले webhook का ID।
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

रिटर्न

Promise<Response>

वह Promise जो API रिस्पॉन्स पर resolve होता है, या अगर requestOptions.raw true है, तो raw Response

इसमें परिभाषित

webhooks/client.ts:808

▸ delete(webhookId): Promise<WebhookConfigDeleteResponse>

पैरामीटर

नाम	type
webhookId	string

रिटर्न

Promise<WebhookConfigDeleteResponse>

यहाँ परिभाषित है

webhooks/client.ts:821

---

get

▸ get(options): Promise<Response>

webhook प्राप्त करें क्लाइंट ऐप से जुड़ी webhook कॉन्फ़िगरेशन की सूची प्राप्त करें।

पैरामीटर

नाम	type
options	GetOptions & { requestOptions: { raw: true } }

रिटर्न

Promise<Response>

API रिस्पॉन्स पर resolve होने वाला Promise, या अगर requestOptions.raw true है, तो raw Response

इसमें परिभाषित है

webhooks/client.ts:908

▸ get(options?): Promise<Get2WebhooksResponse>

पैरामीटर

नाम	type
options?	GetOptions

रिटर्न

Promise<Get2WebhooksResponse>

यहाँ परिभाषित है

webhooks/client.ts:917

---

create

▸ create(options): Promise<Response>

webhook बनाएँ यह एक नया webhook कॉन्फ़िगरेशन बनाता है।

पैरामीटर

नाम	type
options	CreateOptions & { requestOptions: { raw: true } }

रिटर्न

Promise<Response>

वह Promise जो API रिस्पॉन्स पर resolve होता है, या यदि requestOptions.raw true है, तो raw Response

यहाँ परिभाषित

webhooks/client.ts:1023

▸ create(options?): Promise<WebhookConfigCreateResponse>

पैरामीटर

नाम	type
options?	CreateOptions

रिटर्न

Promise<WebhookConfigCreateResponse>

यहाँ परिभाषित है

webhooks/client.ts:1032