Constructors
constructor
• new ComplianceClient(client): ComplianceClient
Creates a new compliance client instance
Parameters
| Name | Type | Description |
|---|---|---|
client | Client | The main X API client instance |
Returns
ComplianceClient
Defined in
compliance/client.ts:67Methods
getJobsById
▸ getJobsById(id, options?): Promise<Get2ComplianceJobsIdResponse>
Get Compliance Job by ID
Retrieves details of a specific Compliance Job by its ID.
Parameters
| Name | Type | Description |
|---|---|---|
id | string | The ID of the Compliance Job to retrieve. |
options | GetJobsByIdOptions | - |
Returns
Promise<Get2ComplianceJobsIdResponse>
Promise resolving to the API response
Defined in
compliance/client.ts:84getJobs
▸ getJobs(type, options?): Promise<Get2ComplianceJobsResponse>
Get Compliance Jobs
Retrieves a list of Compliance Jobs filtered by job type and optional status.
Parameters
| Name | Type | Description |
|---|---|---|
type | string | Type of Compliance Job to list. |
options | GetJobsOptions | - |
Returns
Promise<Get2ComplianceJobsResponse>
Promise resolving to the API response
Defined in
compliance/client.ts:134createJobs
▸ createJobs(body): Promise<CreateComplianceJobResponse>
Create Compliance Job
Creates a new Compliance Job for the specified job type.
Parameters
| Name | Type | Description |
|---|---|---|
body | CreateComplianceJobRequest | Request body |
Returns
Promise<CreateComplianceJobResponse>
Promise resolving to the API response