Constructors
constructor
• new GeneralClient(client): GeneralClient
Creates a new general client instance
Parameters
| Name | Type | Description |
|---|---|---|
client | Client | The main X API client instance |
Returns
GeneralClient
Defined in
general/client.ts:42Methods
getOpenApiSpec
▸ getOpenApiSpec(options): Promise<Response>
Get OpenAPI Spec.
Retrieves the full OpenAPI Specification in JSON format. (See https://github.com/OAI/OpenAPI-Specification/blob/master/README.md)
Parameters
| Name | Type |
|---|---|
options | Object |
options.requestOptions | Object |
options.requestOptions.raw | true |
Returns
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
Defined in
general/client.ts:83 ▸ getOpenApiSpec():Promise<GetOpenApiSpecResponse>
Returns
Promise<GetOpenApiSpecResponse>