@openzeppelin/relayer-sdk
Version:
OpenZeppelin Relayer SDK
70 lines (69 loc) • 2.88 kB
TypeScript
/**
* OpenZeppelin Relayer API
* OpenZeppelin Relayer API
*
* The version of the OpenAPI document: 1.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import type { Configuration } from '../configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import { type RequestArgs, BaseAPI } from '../base';
/**
* HealthApi - axios parameter creator
* @export
*/
export declare const HealthApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Note: OpenAPI documentation for these endpoints can be found in the `openapi.rs` file Handles the `/health` endpoint. Returns an `HttpResponse` with a status of `200 OK` and a body of `\"OK\"`.
* @summary Health routes implementation
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
health: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* HealthApi - functional programming interface
* @export
*/
export declare const HealthApiFp: (configuration?: Configuration) => {
/**
* Note: OpenAPI documentation for these endpoints can be found in the `openapi.rs` file Handles the `/health` endpoint. Returns an `HttpResponse` with a status of `200 OK` and a body of `\"OK\"`.
* @summary Health routes implementation
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
health(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
};
/**
* HealthApi - factory interface
* @export
*/
export declare const HealthApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Note: OpenAPI documentation for these endpoints can be found in the `openapi.rs` file Handles the `/health` endpoint. Returns an `HttpResponse` with a status of `200 OK` and a body of `\"OK\"`.
* @summary Health routes implementation
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
health(options?: RawAxiosRequestConfig): AxiosPromise<string>;
};
/**
* HealthApi - object-oriented interface
* @export
* @class HealthApi
* @extends {BaseAPI}
*/
export declare class HealthApi extends BaseAPI {
/**
* Note: OpenAPI documentation for these endpoints can be found in the `openapi.rs` file Handles the `/health` endpoint. Returns an `HttpResponse` with a status of `200 OK` and a body of `\"OK\"`.
* @summary Health routes implementation
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof HealthApi
*/
health(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
}