Saltar al contenido principal
Cliente para operaciones generales Este cliente proporciona métodos para interactuar con los endpoints generales de la X API. Se encarga de la autenticación, el formato de las solicitudes y el análisis de las respuestas para todas las operaciones generales.

Constructores

constructor

new GeneralClient(client): GeneralClient Crea una nueva instancia de GeneralClient

Parámetros

NombreTypeDescripción
clientClientLa instancia principal de Client para la X API

Devuelve

GeneralClient

Definido en

general/client.ts:42

Métodos

getOpenApiSpec

getOpenApiSpec(options): Promise<Response> Obtiene la especificación OpenAPI. Devuelve la especificación completa de OpenAPI en formato JSON. (Consulta https://github.com/OAI/OpenAPI-Specification/blob/master/README.md)

Parámetros

NombreTipo
optionsObject
options.requestOptionsObject
options.requestOptions.rawtrue

Devuelve

Promise<Response> Promesa que se resuelve con la respuesta de la API o con el objeto Response sin procesar si requestOptions.raw es true

Definido en

general/client.ts:83 getOpenApiSpec(): Promise<GetOpenApiSpecResponse>

Devuelve

Promise<GetOpenApiSpecResponse>

Definido en

general/client.ts:92