GeneralClient

Client pour les opérations générales

Ce client fournit des méthodes pour interagir avec les endpoints généraux de X API. Il gère l’authentification, le formatage des requêtes et l’analyse des réponses pour toutes les opérations générales associées.

​

Constructeurs

​

constructor

• new GeneralClient(client): GeneralClient

Crée une nouvelle instance de GeneralClient

​

Paramètres

Nom	Type	Description
client	Client	L’instance principale du Client X API

​

Renvoie

GeneralClient

​

Défini dans

general/client.ts:42

​

Méthodes

​

getOpenApiSpec

▸ getOpenApiSpec(options): Promise<Response>

Obtient la spécification OpenAPI. Renvoie la spécification OpenAPI complète au format JSON. (Voir https://github.com/OAI/OpenAPI-Specification/blob/master/README.md)

​

Paramètres

Nom	Type
options	Object
options.requestOptions	Object
options.requestOptions.raw	true

​

Renvoie

Promise<Response>

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

​

Défini dans

general/client.ts:83

▸ getOpenApiSpec(): Promise<GetOpenApiSpecResponse>

​

Retourne

Promise<GetOpenApiSpecResponse>

​

Défini dans

general/client.ts:92