> ## Documentation Index
> Fetch the complete documentation index at: https://generaltranslation.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.

<div id="constructors">
  ## Constructores
</div>

<div id="constructor">
  ### constructor
</div>

• **new ComplianceClient**(`client`): [`ComplianceClient`](/es/xdks/typescript/reference/classes/ComplianceClient)

Crea una nueva instancia del cliente de cumplimiento

<div id="parameters">
  #### Parámetros
</div>

| Nombre   | Tipo                                                     | Descripción                                    |
| :------- | :------------------------------------------------------- | :--------------------------------------------- |
| `client` | [`Client`](/es/xdks/typescript/reference/classes/Client) | La instancia principal de `Client` de la X API |

<div id="returns">
  #### Devuelve
</div>

[`ComplianceClient`](/es/xdks/typescript/reference/classes/ComplianceClient)

<div id="defined-in">
  #### Definido en
</div>

[compliance/client.ts:93](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/compliance/client.ts#L93)

<div id="methods">
  ## Métodos
</div>

<div id="getjobsbyid">
  ### getJobsById
</div>

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

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

<div id="parameters">
  #### Parámetros
</div>

| 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

<div id="defined-in">
  #### Definido en
</div>

[compliance/client.ts:138](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/compliance/client.ts#L138)

▸ **getJobsById**(`id`, `options?`): `Promise`\<[`Get2ComplianceJobsIdResponse`](/es/xdks/typescript/reference/interfaces/Schemas.Get2ComplianceJobsIdResponse)>

<div id="parameters">
  #### Parámetros
</div>

| Nombre     | Tipo                 |
| :--------- | :------------------- |
| `id`       | `string`             |
| `options?` | `GetJobsByIdOptions` |

<div id="returns">
  #### Devuelve
</div>

`Promise`\<[`Get2ComplianceJobsIdResponse`](/es/xdks/typescript/reference/interfaces/Schemas.Get2ComplianceJobsIdResponse)>

<div id="defined-in">
  #### Definido en
</div>

[compliance/client.ts:151](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/compliance/client.ts#L151)

***

<div id="getjobs">
  ### getJobs
</div>

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

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

<div id="parameters">
  #### Parámetros
</div>

| 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

<div id="defined-in">
  #### Definido en
</div>

[compliance/client.ts:273](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/compliance/client.ts#L273)

▸ **getJobs**(`type`, `options?`): `Promise`\<[`Get2ComplianceJobsResponse`](/es/xdks/typescript/reference/interfaces/Schemas.Get2ComplianceJobsResponse)>

<div id="parameters">
  #### Parámetros
</div>

| Nombre     | Tipo             |
| :--------- | :--------------- |
| `type`     | `string`         |
| `options?` | `GetJobsOptions` |

<div id="returns">
  #### Devuelve
</div>

`Promise`\<[`Get2ComplianceJobsResponse`](/es/xdks/typescript/reference/interfaces/Schemas.Get2ComplianceJobsResponse)>

<div id="defined-in">
  #### Definido en
</div>

[compliance/client.ts:286](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/compliance/client.ts#L286)

***

<div id="createjobs">
  ### createJobs
</div>

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

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

<div id="parameters">
  #### Parámetros
</div>

| Nombre                       | Tipo                                                                                                        | Descripción                                                          |
| :--------------------------- | :---------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------- |
| `body`                       | [`CreateComplianceJobRequest`](/es/xdks/typescript/reference/interfaces/Schemas.CreateComplianceJobRequest) | Una solicitud para crear un nuevo trabajo de cumplimiento por lotes. |
| `options`                    | `Object`                                                                                                    | -                                                                    |
| `options.requestOptions`     | `Object`                                                                                                    | -                                                                    |
| `options.requestOptions.raw` | `true`                                                                                                      | -                                                                    |

<div id="returns">
  #### Devuelve
</div>

`Promise`\<`Response`>

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

<div id="defined-in">
  #### Definido en
</div>

[compliance/client.ts:430](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/compliance/client.ts#L430)

▸ **createJobs**(`body`): `Promise`\<[`CreateComplianceJobResponse`](/es/xdks/typescript/reference/interfaces/Schemas.CreateComplianceJobResponse)>

<div id="parameters">
  #### Parámetros
</div>

| Nombre | Tipo                                                                                                        |
| :----- | :---------------------------------------------------------------------------------------------------------- |
| `body` | [`CreateComplianceJobRequest`](/es/xdks/typescript/reference/interfaces/Schemas.CreateComplianceJobRequest) |

<div id="returns">
  #### Devuelve
</div>

`Promise`\<[`CreateComplianceJobResponse`](/es/xdks/typescript/reference/interfaces/Schemas.CreateComplianceJobResponse)>

<div id="defined-in">
  #### Definido en
</div>

[compliance/client.ts:441](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/compliance/client.ts#L441)