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 के compliance endpoints के साथ इंटरैक्ट करने के लिए मेथड्स प्रदान करता है। यह सभी compliance-संबंधित ऑपरेशनों के लिए authentication, request formatting और रिस्पॉन्स parsing को संभालता है।
• new ComplianceClient(client): ComplianceClient
एक नया compliance client इंस्टेंस बनाता है
| नाम | type | विवरण |
|---|
client | Client | मुख्य X API Client इंस्टेंस |
ComplianceClient
यहाँ परिभाषित किया गया है
id, options): Promise<Response>
ID के आधार पर Compliance Job प्राप्त करें
किसी विशिष्ट Compliance Job का विवरण उसकी ID के आधार पर प्राप्त करता है।
| नाम | type | विवरण |
|---|
id | string | प्राप्त किए जाने वाले Compliance Job की ID। |
options | GetJobsByIdOptions & { requestOptions: { raw: true } } | - |
Promise<Response>
वह Promise जो API रिस्पॉन्स पर resolve होता है, या यदि requestOptions.raw true है, तो raw Response
यहाँ परिभाषित है
compliance/client.ts:138
▸ getJobsById(id, options?): Promise<Get2ComplianceJobsIdResponse>
| नाम | type |
|---|
id | string |
options? | GetJobsByIdOptions |
Promise<Get2ComplianceJobsIdResponse>
यहाँ परिभाषित है
compliance/client.ts:151
▸ getJobs(type, options): Promise<Response>
Compliance Jobs प्राप्त करें
जॉब type और वैकल्पिक status के आधार पर फ़िल्टर की गई Compliance Jobs की सूची प्राप्त करता है।
| Name | Type | विवरण |
|---|
type | string | सूचीबद्ध किए जाने वाले Compliance Job का प्रकार। |
options | GetJobsOptions & { requestOptions: { raw: true } } | - |
Promise<Response>
API रिस्पॉन्स पर रिज़ॉल्व होने वाला Promise, या यदि requestOptions.raw true है, तो raw Response
यहाँ परिभाषित
compliance/client.ts:273
▸ getJobs(type, options?): Promise<Get2ComplianceJobsResponse>
| Name | Type |
|---|
type | string |
options? | GetJobsOptions |
Promise<Get2ComplianceJobsResponse>
यहाँ परिभाषित
compliance/client.ts:286
▸ createJobs(body, options): Promise<Response>
Compliance Job बनाएँ
यह निर्दिष्ट job type के लिए एक नया Compliance Job बनाता है।
| Name | Type | Description |
|---|
body | CreateComplianceJobRequest | नया बैच compliance जॉब बनाने का अनुरोध। |
options | Object | - |
options.requestOptions | Object | - |
options.requestOptions.raw | true | - |
Promise<Response>
API रिस्पॉन्स पर resolve होने वाला Promise, या यदि requestOptions.raw true है, तो raw Response
यहाँ परिभाषित है
compliance/client.ts:430
▸ createJobs(body): Promise<CreateComplianceJobResponse>
Promise<CreateComplianceJobResponse>
यहाँ परिभाषित है
compliance/client.ts:441
