@circle-fin/circle-sdk
Version:
Node.js SDK for Circle API
65 lines (64 loc) • 2.01 kB
TypeScript
/**
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from "axios";
import { Configuration } from "../configuration";
import { RequestArgs, BaseAPI } from "../base";
import { Ping } from "../models";
/**
* HealthApi - axios parameter creator
* @export
*/
export declare const HealthApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Checks that the service is running.
* @summary Ping
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
ping: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* HealthApi - functional programming interface
* @export
*/
export declare const HealthApiFp: (configuration?: Configuration) => {
/**
* Checks that the service is running.
* @summary Ping
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
ping(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Ping>>;
};
/**
* HealthApi - factory interface
* @export
*/
export declare const HealthApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Checks that the service is running.
* @summary Ping
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
ping(options?: any): AxiosPromise<Ping>;
};
/**
* HealthApi - object-oriented interface
* @export
* @class HealthApi
* @extends {BaseAPI}
*/
export declare class HealthApi extends BaseAPI {
/**
* Checks that the service is running.
* @summary Ping
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof HealthApi
*/
ping(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Ping, any>>;
}