UNPKG

lambdaorm-client-node

Version:
130 lines (129 loc) 4.19 kB
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; import { RequestArgs, BaseAPI } from './base'; import { Configuration, Health, Ping } from '../../domain'; /** * GeneralApi - axios parameter creator * @export */ export declare const GeneralApiAxiosParamCreator: (configuration: Configuration) => { /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ version: (options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ health: (options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ metrics: (options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ ping: (options?: AxiosRequestConfig) => Promise<RequestArgs>; }; /** * GeneralApi - functional programming interface * @export */ export declare const GeneralApiFp: (configuration: Configuration) => { /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ version(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Health>>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ health(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Health>>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ metrics(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ ping(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Ping>>; }; /** * GeneralApi - factory interface * @export */ export declare const GeneralApiFactory: (configuration: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ version(options?: any): AxiosPromise<Health>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ health(options?: any): AxiosPromise<Health>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ metrics(options?: any): AxiosPromise<any>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ ping(options?: any): AxiosPromise<Ping>; }; /** * GeneralApi - object-oriented interface * @export * @class GeneralApi * @extends {BaseAPI} */ export declare class GeneralApi extends BaseAPI { /** * * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GeneralApi */ version(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Health, any>>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GeneralApi */ health(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Health, any>>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GeneralApi */ metrics(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GeneralApi */ ping(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Ping, any>>; }