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

OpenZeppelin Relayer SDK

/**
 * OpenZeppelin Relayer API
 * OpenZeppelin Relayer API
 *
 * The version of the OpenAPI document: 1.3.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 { ApiResponseNetworkResponse } from '../models';
import type { ApiResponseVecNetworkResponse } from '../models';
import type { UpdateNetworkRequest } from '../models';
/**
 * NetworksApi - axios parameter creator
 * @export
 */
export declare const NetworksApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Retrieves details of a specific network by ID.
     * @param {string} networkId Network ID (e.g., evm:sepolia, solana:mainnet)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getNetwork: (networkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Note: OpenAPI documentation for these endpoints can be found in the `openapi.rs` file  Lists all networks with pagination support.
     * @summary Network 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}
     */
    listNetworks: (page?: number, perPage?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Updates a network\'s configuration. Currently supports updating RPC URLs only. Can be extended to support other fields.
     * @param {string} networkId Network ID (e.g., evm:sepolia, solana:mainnet)
     * @param {UpdateNetworkRequest} updateNetworkRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateNetwork: (networkId: string, updateNetworkRequest: UpdateNetworkRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * NetworksApi - functional programming interface
 * @export
 */
export declare const NetworksApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Retrieves details of a specific network by ID.
     * @param {string} networkId Network ID (e.g., evm:sepolia, solana:mainnet)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getNetwork(networkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiResponseNetworkResponse>>;
    /**
     * Note: OpenAPI documentation for these endpoints can be found in the `openapi.rs` file  Lists all networks with pagination support.
     * @summary Network 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}
     */
    listNetworks(page?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiResponseVecNetworkResponse>>;
    /**
     *
     * @summary Updates a network\'s configuration. Currently supports updating RPC URLs only. Can be extended to support other fields.
     * @param {string} networkId Network ID (e.g., evm:sepolia, solana:mainnet)
     * @param {UpdateNetworkRequest} updateNetworkRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateNetwork(networkId: string, updateNetworkRequest: UpdateNetworkRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiResponseNetworkResponse>>;
};
/**
 * NetworksApi - factory interface
 * @export
 */
export declare const NetworksApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Retrieves details of a specific network by ID.
     * @param {string} networkId Network ID (e.g., evm:sepolia, solana:mainnet)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getNetwork(networkId: string, options?: RawAxiosRequestConfig): AxiosPromise<ApiResponseNetworkResponse>;
    /**
     * Note: OpenAPI documentation for these endpoints can be found in the `openapi.rs` file  Lists all networks with pagination support.
     * @summary Network 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}
     */
    listNetworks(page?: number, perPage?: number, options?: RawAxiosRequestConfig): AxiosPromise<ApiResponseVecNetworkResponse>;
    /**
     *
     * @summary Updates a network\'s configuration. Currently supports updating RPC URLs only. Can be extended to support other fields.
     * @param {string} networkId Network ID (e.g., evm:sepolia, solana:mainnet)
     * @param {UpdateNetworkRequest} updateNetworkRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateNetwork(networkId: string, updateNetworkRequest: UpdateNetworkRequest, options?: RawAxiosRequestConfig): AxiosPromise<ApiResponseNetworkResponse>;
};
/**
 * NetworksApi - object-oriented interface
 * @export
 * @class NetworksApi
 * @extends {BaseAPI}
 */
export declare class NetworksApi extends BaseAPI {
    /**
     *
     * @summary Retrieves details of a specific network by ID.
     * @param {string} networkId Network ID (e.g., evm:sepolia, solana:mainnet)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof NetworksApi
     */
    getNetwork(networkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiResponseNetworkResponse, any, {}>>;
    /**
     * Note: OpenAPI documentation for these endpoints can be found in the `openapi.rs` file  Lists all networks with pagination support.
     * @summary Network 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 NetworksApi
     */
    listNetworks(page?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiResponseVecNetworkResponse, any, {}>>;
    /**
     *
     * @summary Updates a network\'s configuration. Currently supports updating RPC URLs only. Can be extended to support other fields.
     * @param {string} networkId Network ID (e.g., evm:sepolia, solana:mainnet)
     * @param {UpdateNetworkRequest} updateNetworkRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof NetworksApi
     */
    updateNetwork(networkId: string, updateNetworkRequest: UpdateNetworkRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiResponseNetworkResponse, any, {}>>;
}