@openzeppelin/relayer-sdk/dist/apis/signers-api.d.ts

OpenZeppelin Relayer SDK

/**
 * 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 { ApiResponseSignerResponse } from '../models';
import type { ApiResponseString } from '../models';
import type { ApiResponseVecSignerResponse } from '../models';
import type { SignerCreateRequest } from '../models';
/**
 * SignersApi - axios parameter creator
 * @export
 */
export declare const SignersApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Creates a new signer.
     * @param {SignerCreateRequest} signerCreateRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createSigner: (signerCreateRequest: SignerCreateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Deletes a signer by ID.
     * @param {string} signerId Signer ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteSigner: (signerId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Retrieves details of a specific signer by ID.
     * @param {string} signerId Signer ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getSigner: (signerId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Note: OpenAPI documentation for these endpoints can be found in the `openapi.rs` file  Lists all signers with pagination support.
     * @summary Signer routes implementation
     * @param {number} [page] Page number for pagination (starts at 1)
     * @param {number} [perPage] Number of items per page (default: 10)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listSigners: (page?: number, perPage?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Updates an existing signer.
     * @param {string} signerId Signer ID
     * @param {object} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateSigner: (signerId: string, body: object, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * SignersApi - functional programming interface
 * @export
 */
export declare const SignersApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Creates a new signer.
     * @param {SignerCreateRequest} signerCreateRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createSigner(signerCreateRequest: SignerCreateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiResponseSignerResponse>>;
    /**
     *
     * @summary Deletes a signer by ID.
     * @param {string} signerId Signer ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteSigner(signerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiResponseString>>;
    /**
     *
     * @summary Retrieves details of a specific signer by ID.
     * @param {string} signerId Signer ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getSigner(signerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiResponseSignerResponse>>;
    /**
     * Note: OpenAPI documentation for these endpoints can be found in the `openapi.rs` file  Lists all signers with pagination support.
     * @summary Signer routes implementation
     * @param {number} [page] Page number for pagination (starts at 1)
     * @param {number} [perPage] Number of items per page (default: 10)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listSigners(page?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiResponseVecSignerResponse>>;
    /**
     *
     * @summary Updates an existing signer.
     * @param {string} signerId Signer ID
     * @param {object} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateSigner(signerId: string, body: object, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiResponseSignerResponse>>;
};
/**
 * SignersApi - factory interface
 * @export
 */
export declare const SignersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Creates a new signer.
     * @param {SignerCreateRequest} signerCreateRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createSigner(signerCreateRequest: SignerCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise<ApiResponseSignerResponse>;
    /**
     *
     * @summary Deletes a signer by ID.
     * @param {string} signerId Signer ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteSigner(signerId: string, options?: RawAxiosRequestConfig): AxiosPromise<ApiResponseString>;
    /**
     *
     * @summary Retrieves details of a specific signer by ID.
     * @param {string} signerId Signer ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getSigner(signerId: string, options?: RawAxiosRequestConfig): AxiosPromise<ApiResponseSignerResponse>;
    /**
     * Note: OpenAPI documentation for these endpoints can be found in the `openapi.rs` file  Lists all signers with pagination support.
     * @summary Signer routes implementation
     * @param {number} [page] Page number for pagination (starts at 1)
     * @param {number} [perPage] Number of items per page (default: 10)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listSigners(page?: number, perPage?: number, options?: RawAxiosRequestConfig): AxiosPromise<ApiResponseVecSignerResponse>;
    /**
     *
     * @summary Updates an existing signer.
     * @param {string} signerId Signer ID
     * @param {object} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateSigner(signerId: string, body: object, options?: RawAxiosRequestConfig): AxiosPromise<ApiResponseSignerResponse>;
};
/**
 * SignersApi - object-oriented interface
 * @export
 * @class SignersApi
 * @extends {BaseAPI}
 */
export declare class SignersApi extends BaseAPI {
    /**
     *
     * @summary Creates a new signer.
     * @param {SignerCreateRequest} signerCreateRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SignersApi
     */
    createSigner(signerCreateRequest: SignerCreateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiResponseSignerResponse, any>>;
    /**
     *
     * @summary Deletes a signer by ID.
     * @param {string} signerId Signer ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SignersApi
     */
    deleteSigner(signerId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiResponseString, any>>;
    /**
     *
     * @summary Retrieves details of a specific signer by ID.
     * @param {string} signerId Signer ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SignersApi
     */
    getSigner(signerId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiResponseSignerResponse, any>>;
    /**
     * Note: OpenAPI documentation for these endpoints can be found in the `openapi.rs` file  Lists all signers with pagination support.
     * @summary Signer routes implementation
     * @param {number} [page] Page number for pagination (starts at 1)
     * @param {number} [perPage] Number of items per page (default: 10)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SignersApi
     */
    listSigners(page?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiResponseVecSignerResponse, any>>;
    /**
     *
     * @summary Updates an existing signer.
     * @param {string} signerId Signer ID
     * @param {object} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SignersApi
     */
    updateSigner(signerId: string, body: object, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiResponseSignerResponse, any>>;
}