Documentation Index
Fetch the complete documentation index at: https://generaltranslation.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
अकाउंट गतिविधि संचालन के लिए Client
यह Client, X API के account activity endpoints के साथ इंटरैक्ट करने के लिए methods प्रदान करता है।
यह authentication, request formatting, और account activity से संबंधित सभी operations के लिए रिस्पॉन्स
parsing को संभालता है।
• new AccountActivityClient(client): AccountActivityClient
एक नया AccountActivityClient instance बनाता है
| Name | Type | Description |
|---|
client | Client | मुख्य X API Client इंस्टेंस |
रिटर्न
AccountActivityClient
यहाँ परिभाषित
account_activity/client.ts:70
▸ getSubscriptions(webhookId, options): Promise<Response>
सदस्यताएँ प्राप्त करें
किसी दिए गए webhook के लिए सभी सक्रिय सदस्यताओं की सूची प्राप्त करता है।
| नाम | Type | विवरण |
|---|
webhookId | string | वह webhook ID जिसके लिए सदस्यताएँ प्राप्त करनी हैं। |
options | Object | - |
options.requestOptions | Object | - |
options.requestOptions.raw | true | - |
रिटर्न
Promise<Response>
API रिस्पॉन्स पर resolve होने वाला Promise, या यदि requestOptions.raw true है, तो raw Response
यहाँ परिभाषित
account_activity/client.ts:115
▸ getSubscriptions(webhookId): Promise<SubscriptionsListGetResponse>
रिटर्न
Promise<SubscriptionsListGetResponse>
account_activity/client.ts:128
▸ deleteSubscription(webhookId, userId, options): Promise<Response>
सदस्यता हटाएं
दिए गए webhook और user ID के लिए Account Activity सदस्यता हटाता है।
| नाम | type | विवरण |
|---|
webhookId | string | वह webhook ID जिसके लिए सदस्यता की जाँच करनी है। |
userId | string | जिस उपयोगकर्ता की सदस्यता समाप्त करनी है, उसका user ID। |
options | Object | - |
options.requestOptions | Object | - |
options.requestOptions.raw | true | - |
Promise<Response>
API रिस्पॉन्स पर resolve होने वाला Promise, या अगर requestOptions.raw true हो, तो raw Response
यहाँ परिभाषित
account_activity/client.ts:217
▸ deleteSubscription(webhookId, userId): Promise<SubscriptionsDeleteResponse>
| नाम | type |
|---|
webhookId | string |
userId | string |
Promise<SubscriptionsDeleteResponse>
यहाँ परिभाषित
account_activity/client.ts:234
▸ validateSubscription(webhookId, options): Promise<Response>
सदस्यता को वैध करें
दिए गए webhook के लिए उपयोगकर्ता के Account Activity सदस्यता की जाँच करता है।
| नाम | type | विवरण |
|---|
webhookId | string | वह webhook ID जिसके लिए सदस्यता की जाँच करनी है। |
options | Object | - |
options.requestOptions | Object | - |
options.requestOptions.raw | true | - |
रिटर्न
Promise<Response>
ऐसा Promise जो API रिस्पॉन्स पर resolve होता है, या अगर requestOptions.raw true है तो raw Response
account_activity/client.ts:331
▸ validateSubscription(webhookId): Promise<SubscriptionsGetResponse>
रिटर्न
Promise<SubscriptionsGetResponse>
account_activity/client.ts:344
▸ createSubscription(webhookId, options): Promise<Response>
सदस्यता बनाएँ
उपयोगकर्ता और दिए गए webhook के लिए एक Account Activity सदस्यता बनाता है।
| Name | Type | Description |
|---|
webhookId | string | वह webhook ID जिसके लिए सदस्यता की जाँच करनी है। |
options | CreateSubscriptionOptions & { requestOptions: { raw: true } } | - |
रिटर्न
Promise<Response>
ऐसा Promise जो API रिस्पॉन्स पर resolve होता है, या यदि requestOptions.raw true है तो raw Response
यहाँ परिभाषित
account_activity/client.ts:435
▸ createSubscription(webhookId, options?): Promise<SubscriptionsCreateResponse>
| नाम | type |
|---|
webhookId | string |
options? | CreateSubscriptionOptions |
रिटर्न
Promise<SubscriptionsCreateResponse>
account_activity/client.ts:448
▸ createReplayJob(webhookId, fromDate, toDate, options): Promise<Response>
रीप्ले जॉब बनाएँ
दिए गए webhook से संबद्ध सभी सदस्यताओं के लिए पिछले अधिकतम 5 दिनों की activities प्राप्त करने हेतु एक रीप्ले जॉब बनाता है।
| Name | Type | Description |
|---|
webhookId | string | webhook कॉन्फ़िगरेशन का अद्वितीय पहचानकर्ता। |
fromDate | string | वह सबसे पुराना (प्रारंभिक) UTC टाइमस्टैम्प (समावेशी) जिससे yyyymmddhhmm फ़ॉर्मैट में इवेंट प्रदान किए जाएंगे। |
toDate | string | वह नवीनतम (अंतिम) UTC टाइमस्टैम्प (बहिष्कृत) जिस तक yyyymmddhhmm फ़ॉर्मैट in इवेंट प्रदान किए जाएंगे। |
options | Object | - |
options.requestOptions | Object | - |
options.requestOptions.raw | true | - |
रिटर्न
Promise<Response>
API रिस्पॉन्स पर resolve होने वाला Promise, या यदि requestOptions.raw true है, तो raw Response
यहाँ परिभाषित
account_activity/client.ts:564
▸ createReplayJob(webhookId, fromDate, toDate): Promise<ReplayJobCreateResponse>
| नाम | Type |
|---|
webhookId | string |
fromDate | string |
toDate | string |
Promise<ReplayJobCreateResponse>
यहाँ परिभाषित
account_activity/client.ts:585
▸ getSubscriptionCount(options): Promise<Response>
सदस्यताओं की संख्या प्राप्त करें
वर्तमान में सक्रिय Account Activity सदस्यताओं की कुल संख्या प्राप्त करता है।
| नाम | type |
|---|
options | Object |
options.requestOptions | Object |
options.requestOptions.raw | true |
Promise<Response>
API रिस्पॉन्स पर रिज़ॉल्व होने वाला Promise, या अगर requestOptions.raw true है, तो raw Response
यहाँ परिभाषित
account_activity/client.ts:704
▸ getSubscriptionCount(): Promise<SubscriptionsCountGetResponse>
रिटर्न
Promise<SubscriptionsCountGetResponse>
यहाँ परिभाषित
account_activity/client.ts:713