ComplianceClient

Client para operações de compliance Este client fornece métodos para interagir com os endpoints compliance da X API. Ele cuida da autenticação, formatação de requisição e análise de resposta para todas as operações relacionadas a compliance.

​

Construtores

​

constructor

• new ComplianceClient(client): ComplianceClient Cria uma nova instância do client compliance

​

Parâmetros

​

Retorna

ComplianceClient

​

Definido em

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

​

Retorna

Promise<Response> Promise que resolve para a resposta da API, ou Response bruto se requestOptions.raw for true

​

Definido em

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

​

Parâmetros

​

Retorna

Promise<Get2ComplianceJobsIdResponse>

​

Definido em

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

​

Retorna

Promise<Response> Promise que resolve para a resposta da API, ou Response bruto se requestOptions.raw for true

​

Definido em

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

​

Parâmetros

​

Retorna

Promise<Get2ComplianceJobsResponse>

​

Definido em

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

​

Retorna

Promise<Response> Promise que resolve para a resposta da API, ou Response bruto se requestOptions.raw for true

​

Definido em

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

​

Parâmetros

​

Retorna

Promise<CreateComplianceJobResponse>

​

Definido em

compliance/client.ts:441