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

​

Constructeurs

​

constructor

• new ComplianceClient(client): ComplianceClient

Crée une nouvelle instance de ComplianceClient

​

Paramètres

Nom	Type	Description
client	Client	Instance principale de la classe Client pour l’X API

​

Renvoie

ComplianceClient

​

Défini dans

compliance/client.ts:93

​

Méthodes

​

getJobsById

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

​

Paramètres

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

​

Valeur de retour

Promise<Response>

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

​

Défini dans

compliance/client.ts:138

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

​

Paramètres

Nom	Type
id	string
options?	GetJobsByIdOptions

​

Renvoie

Promise<Get2ComplianceJobsIdResponse>

​

Défini dans

compliance/client.ts:151

---

​

getJobs

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

​

Paramètres

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

​

Défini dans

compliance/client.ts:273

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

​

Paramètres

Nom	Type
type	string
options?	GetJobsOptions

​

Renvoie

Promise<Get2ComplianceJobsResponse>

​

Défini dans

compliance/client.ts:286

---

​

createJobs

▸ 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é.

​

Paramètres

Nom	Type	Description
body	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

​

Défini dans

compliance/client.ts:430

▸ createJobs(body): Promise<CreateComplianceJobResponse>

​

Paramètres

Nom	Type
body	CreateComplianceJobRequest

​

Renvoie

Promise<CreateComplianceJobResponse>

​

Défini dans

compliance/client.ts:441