ComplianceClient

Cliente para operaciones de cumplimiento

Este cliente proporciona métodos para interactuar con los endpoints de cumplimiento de la X API. Se encarga de la autenticación, el formateo de las solicitudes y el análisis de las respuestas para todas las operaciones de cumplimiento.

​

Constructores

​

constructor

• new ComplianceClient(client): ComplianceClient

Crea una nueva instancia del cliente de cumplimiento

​

Parámetros

Nombre	Tipo	Descripción
client	Client	La instancia principal de Client de la X API

​

Devuelve

ComplianceClient

​

Definido en

compliance/client.ts:93

​

Métodos

​

getJobsById

▸ getJobsById(id, options): Promise<Response>

Obtener un Compliance Job por ID
Recupera los detalles de un Compliance Job específico mediante su ID.

​

Parámetros

Nombre	Tipo	Descripción
id	string	El ID del Compliance Job que se va a obtener.
options	GetJobsByIdOptions & { requestOptions: { raw: true } }	-

​

Returns

Promise<Response>

Promesa que se resuelve en la respuesta de la API, o en el objeto Response sin procesar si requestOptions.raw es true

​

Definido en

compliance/client.ts:138

▸ getJobsById(id, options?): Promise<Get2ComplianceJobsIdResponse>

​

Parámetros

Nombre	Tipo
id	string
options?	GetJobsByIdOptions

​

Devuelve

Promise<Get2ComplianceJobsIdResponse>

​

Definido en

compliance/client.ts:151

---

​

getJobs

▸ getJobs(type, options): Promise<Response>

Obtener Compliance Jobs
Recupera una lista de Compliance Jobs filtrados por tipo de job y, opcionalmente, por estado.

​

Parámetros

Nombre	Type	Descripción
type	string	Tipo de Compliance Job que se va a listar.
options	GetJobsOptions & { requestOptions: { raw: true } }	-

​

Returns

Promise<Response>

Promise que se resuelve con la respuesta de la API, o con el objeto Response sin procesar si requestOptions.raw es true

​

Definido en

compliance/client.ts:273

▸ getJobs(type, options?): Promise<Get2ComplianceJobsResponse>

​

Parámetros

Nombre	Tipo
type	string
options?	GetJobsOptions

​

Devuelve

Promise<Get2ComplianceJobsResponse>

​

Definido en

compliance/client.ts:286

---

​

createJobs

▸ createJobs(body, options): Promise<Response>

Create Compliance Job Crea un nuevo trabajo de cumplimiento para el type de trabajo especificado.

​

Parámetros

Nombre	Tipo	Descripción
body	CreateComplianceJobRequest	Una solicitud para crear un nuevo trabajo de cumplimiento por lotes.
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

Devuelve

Promise<Response>

Promesa que se resuelve en la respuesta de la API, o en el objeto Response sin procesar si requestOptions.raw es true

​

Definido en

compliance/client.ts:430

▸ createJobs(body): Promise<CreateComplianceJobResponse>

​

Parámetros

Nombre	Tipo
body	CreateComplianceJobRequest

​

Devuelve

Promise<CreateComplianceJobResponse>

​

Definido en

compliance/client.ts:441