ComplianceClient

Cliente para operaciones de compliance This client provides methods for interacting with the compliance endpoints of the X API. It handles authentication, request formatting, and response parsing for all compliance related operations.

​

Constructores

​

constructor

• new ComplianceClient(client): ComplianceClient Creates a new compliance client instance

​

Parámetros

​

Devuelve

ComplianceClient

​

Definido en

compliance/client.ts:93

​

Métodos

​

getJobsById

▸ getJobsById(id, options): Promise<Response> Get Compliance Job by ID Retrieves details of a specific Compliance Job by its ID.

​

Parámetros

​

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

​

Definido en

compliance/client.ts:138 ▸ getJobsById(id, options?): Promise<Get2ComplianceJobsIdResponse>

​

Parámetros

​

Devuelve

Promise<Get2ComplianceJobsIdResponse>

​

Definido en

compliance/client.ts:151

---

​

getJobs

▸ getJobs(type, options): Promise<Response> Get Compliance Jobs Retrieves a list of Compliance Jobs filtered by job type and optional status.

​

Parámetros

​

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

​

Definido en

compliance/client.ts:273 ▸ getJobs(type, options?): Promise<Get2ComplianceJobsResponse>

​

Parámetros

​

Devuelve

Promise<Get2ComplianceJobsResponse>

​

Definido en

compliance/client.ts:286

---

​

createJobs

▸ createJobs(body, options): Promise<Response> Create Compliance Job Creates a new Compliance Job for the specified job type.

​

Parámetros

​

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

​

Definido en

compliance/client.ts:430 ▸ createJobs(body): Promise<CreateComplianceJobResponse>

​

Parámetros

​

Devuelve

Promise<CreateComplianceJobResponse>

​

Definido en

compliance/client.ts:441