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 relacionadas con el 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 del cliente de la X API

​

Devuelve

ComplianceClient

​

Definido en

compliance/client.ts:67

​

Métodos

​

getJobsById

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

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

​

Parámetros

Nombre	Tipo	Descripción
id	string	El id del trabajo de cumplimiento que se desea obtener.
options	GetJobsByIdOptions	-

​

Devuelve

Promise<Get2ComplianceJobsIdResponse>

Promesa que se resuelve con la respuesta de la API

​

Definido en

compliance/client.ts:84

---

​

getJobs

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

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

​

Parámetros

Nombre	Tipo	Descripción
type	string	Tipo de trabajo de Compliance que se va a listar.
options	GetJobsOptions	-

​

Devuelve

Promise<Get2ComplianceJobsResponse>

Promesa que se resuelve con la respuesta de la API

​

Definido en

compliance/client.ts:134

---

​

createJobs

▸ createJobs(body): Promise<CreateComplianceJobResponse>

Crear Job de cumplimiento Crea un nuevo Job de cumplimiento para el tipo de Job especificado.

​

Parámetros

Nombre	Tipo	Descripción
body	CreateComplianceJobRequest	Cuerpo de la solicitud

​

Devuelve

Promise<CreateComplianceJobResponse>

Promesa que se resuelve con la respuesta de la API

​

Definido en

compliance/client.ts:190