@openzeppelin/relayer-sdk
Version:
OpenZeppelin Relayer SDK
80 lines (79 loc) • 2.99 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';
import type { ApiResponsePluginCallResponse } from '../models';
import type { PluginCallRequest } from '../models';
/**
* PluginsApi - axios parameter creator
* @export
*/
export declare const PluginsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @summary Calls a plugin method.
* @param {string} pluginId The unique identifier of the plugin
* @param {PluginCallRequest} pluginCallRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
callPlugin: (pluginId: string, pluginCallRequest: PluginCallRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* PluginsApi - functional programming interface
* @export
*/
export declare const PluginsApiFp: (configuration?: Configuration) => {
/**
*
* @summary Calls a plugin method.
* @param {string} pluginId The unique identifier of the plugin
* @param {PluginCallRequest} pluginCallRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
callPlugin(pluginId: string, pluginCallRequest: PluginCallRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiResponsePluginCallResponse>>;
};
/**
* PluginsApi - factory interface
* @export
*/
export declare const PluginsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary Calls a plugin method.
* @param {string} pluginId The unique identifier of the plugin
* @param {PluginCallRequest} pluginCallRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
callPlugin(pluginId: string, pluginCallRequest: PluginCallRequest, options?: RawAxiosRequestConfig): AxiosPromise<ApiResponsePluginCallResponse>;
};
/**
* PluginsApi - object-oriented interface
* @export
* @class PluginsApi
* @extends {BaseAPI}
*/
export declare class PluginsApi extends BaseAPI {
/**
*
* @summary Calls a plugin method.
* @param {string} pluginId The unique identifier of the plugin
* @param {PluginCallRequest} pluginCallRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof PluginsApi
*/
callPlugin(pluginId: string, pluginCallRequest: PluginCallRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiResponsePluginCallResponse, any>>;
}