Class MiscApi

Hierarchy (View Summary)

BaseAPI
- MiscApi

Index

Constructors

Properties

Methods

health healthRaw isJsonMime request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

new MiscApi(configuration?: Configuration): MiscApi
Parameters
- configuration: Configuration = DefaultConfig
Returns MiscApi
Inherited from BaseAPI.constructor
- Defined in sdk/runtime.ts:104

Properties

`Protected`configuration

configuration: Configuration = DefaultConfig

Methods

health

health(initOverrides?: any): Promise<string>
Check if the API server is healthy and responding. This endpoint does not require authentication. Health
Parameters
- OptionalinitOverrides: any
Returns Promise<string>
- Defined in sdk/apis/MiscApi.ts:60

healthRaw

healthRaw(initOverrides?: any): Promise<ApiResponse<string>>
Check if the API server is healthy and responding. This endpoint does not require authentication. Health
Parameters
- OptionalinitOverrides: any
Returns Promise<ApiResponse<string>>
- Defined in sdk/apis/MiscApi.ts:34

`Protected`isJsonMime

isJsonMime(mime: string | null | undefined): boolean
Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 APPLICATION/JSON application/vnd.company+json
Parameters
- mime: string | null | undefined
  MIME (Multipurpose Internet Mail Extensions)
Returns boolean
True if the given MIME is JSON, false otherwise.
Inherited from BaseAPI.isJsonMime
- Defined in sdk/runtime.ts:134

`Protected`request

request(context: RequestOpts, initOverrides?: any): Promise<any>
Parameters
- context: RequestOpts
- OptionalinitOverrides: any
Returns Promise<any>
Inherited from BaseAPI.request
- Defined in sdk/runtime.ts:141

withMiddleware

withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- ...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in sdk/runtime.ts:108

withPostMiddleware

withPostMiddleware<T extends BaseAPI>(
    this: T,
    ...postMiddlewares: (
        ((context: ResponseContext) => Promise<any>)
        | undefined
    )[],
): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- ...postMiddlewares: (((context: ResponseContext) => Promise<any>) | undefined)[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in sdk/runtime.ts:119

withPreMiddleware

withPreMiddleware<T extends BaseAPI>(
    this: T,
    ...preMiddlewares: (
        ((context: RequestContext) => Promise<void | FetchParams>)
        | undefined
    )[],
): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- ...preMiddlewares: (((context: RequestContext) => Promise<void | FetchParams>) | undefined)[]
Returns T
Inherited from BaseAPI.withPreMiddleware
- Defined in sdk/runtime.ts:114