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

Client pour les opérations de conformité

Ce client fournit des méthodes pour interagir avec les points de terminaison de conformité
de la X API. Il gère l'authentification, le formatage des requêtes et l'interprétation des
réponses pour toutes les opérations liées à la conformité.

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

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

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

Crée une nouvelle instance de `ComplianceClient`

<div id="parameters">
  #### Paramètres
</div>

| Nom      | Type                                                     | Description                                            |
| :------- | :------------------------------------------------------- | :----------------------------------------------------- |
| `client` | [`Client`](/fr/xdks/typescript/reference/classes/Client) | Instance principale de la classe `Client` pour l’X API |

#### Renvoie

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

<div id="defined-in">
  #### Défini dans
</div>

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

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

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

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

Récupérer un Compliance Job par id\
Récupère les détails d’un Compliance Job spécifique à partir de son id.

<div id="parameters">
  #### Paramètres
</div>

| Nom       | Type                                                               | Description                                          |
| :-------- | :----------------------------------------------------------------- | :--------------------------------------------------- |
| `id`      | `string`                                                           | L'identifiant de la tâche de conformité à récupérer. |
| `options` | `GetJobsByIdOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                                                    |

<div id="returns">
  #### Valeur de retour
</div>

`Promise`\<`Response`>

Promise qui se résout avec la réponse de l’API, ou `Response` brut si `requestOptions.raw` vaut `true`

<div id="defined-in">
  #### Défini dans
</div>

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

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

<div id="parameters">
  #### Paramètres
</div>

| Nom        | Type                 |
| :--------- | :------------------- |
| `id`       | `string`             |
| `options?` | `GetJobsByIdOptions` |

#### Renvoie

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

<div id="defined-in">
  #### Défini dans
</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`>

Récupérer les jobs de conformité
Récupère une liste de jobs de conformité filtrés par type de job et, éventuellement, par statut.

<div id="parameters">
  #### Paramètres
</div>

| Nom       | Type                                                           | Description                      |
| :-------- | :------------------------------------------------------------- | :------------------------------- |
| `type`    | `string`                                                       | Type de Compliance Job à lister. |
| `options` | `GetJobsOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                                |

#### Renvoie

`Promise`\<`Response`>

Promise résolue avec la réponse de l'API, ou `Response` brut si `requestOptions.raw` vaut `true`

<div id="defined-in">
  #### Défini dans
</div>

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

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

<div id="parameters">
  #### Paramètres
</div>

| Nom        | Type             |
| :--------- | :--------------- |
| `type`     | `string`         |
| `options?` | `GetJobsOptions` |

#### Renvoie

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

<div id="defined-in">
  #### Défini dans
</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`>

Créer un job de conformité
Crée un nouveau job de conformité pour le type de job spécifié.

<div id="parameters">
  #### Paramètres
</div>

| Nom                          | Type                                                                                                        | Description                                                       |
| :--------------------------- | :---------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------- |
| `body`                       | [`CreateComplianceJobRequest`](/fr/xdks/typescript/reference/interfaces/Schemas.CreateComplianceJobRequest) | Requête visant à créer une nouvelle tâche de conformité par lots. |
| `options`                    | `Object`                                                                                                    | -                                                                 |
| `options.requestOptions`     | `Object`                                                                                                    | -                                                                 |
| `options.requestOptions.raw` | `true`                                                                                                      | -                                                                 |

#### Renvoie

`Promise`\<`Response`>

Promise se résolvant avec la réponse de l’API, ou un objet `Response` brut si `requestOptions.raw` est défini sur `true`

<div id="defined-in">
  #### Défini dans
</div>

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

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

<div id="parameters">
  #### Paramètres
</div>

| Nom    | Type                                                                                                        |
| :----- | :---------------------------------------------------------------------------------------------------------- |
| `body` | [`CreateComplianceJobRequest`](/fr/xdks/typescript/reference/interfaces/Schemas.CreateComplianceJobRequest) |

#### Renvoie

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

<div id="defined-in">
  #### Défini dans
</div>

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