@openzeppelin/relayer-sdk/dist/apis/metrics-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';
/**
 * MetricsApi - axios parameter creator
 * @export
 */
export declare const MetricsApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Note: OpenAPI documentation for these endpoints can be found in the `openapi.rs` file Returns a list of all available metric names in JSON format.  # Returns  An `HttpResponse` containing a JSON array of metric names.
     * @summary Metrics routes implementation
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listMetrics: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * # Parameters  - `path`: The name of the metric to retrieve details for.  # Returns  An `HttpResponse` containing the metric details in plain text, or a 404 error if the metric is not found.
     * @summary Returns the details of a specific metric in plain text format.
     * @param {string} metricName Name of the metric to retrieve, e.g. utopia_transactions_total
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    metricDetail: (metricName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * # Returns  An `HttpResponse` containing the updated metrics in plain text, or an error message if the update fails.
     * @summary Triggers an update of system metrics and returns the result in plain text format.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    scrapeMetrics: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * MetricsApi - functional programming interface
 * @export
 */
export declare const MetricsApiFp: (configuration?: Configuration) => {
    /**
     * Note: OpenAPI documentation for these endpoints can be found in the `openapi.rs` file Returns a list of all available metric names in JSON format.  # Returns  An `HttpResponse` containing a JSON array of metric names.
     * @summary Metrics routes implementation
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listMetrics(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
    /**
     * # Parameters  - `path`: The name of the metric to retrieve details for.  # Returns  An `HttpResponse` containing the metric details in plain text, or a 404 error if the metric is not found.
     * @summary Returns the details of a specific metric in plain text format.
     * @param {string} metricName Name of the metric to retrieve, e.g. utopia_transactions_total
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    metricDetail(metricName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
    /**
     * # Returns  An `HttpResponse` containing the updated metrics in plain text, or an error message if the update fails.
     * @summary Triggers an update of system metrics and returns the result in plain text format.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    scrapeMetrics(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
};
/**
 * MetricsApi - factory interface
 * @export
 */
export declare const MetricsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Note: OpenAPI documentation for these endpoints can be found in the `openapi.rs` file Returns a list of all available metric names in JSON format.  # Returns  An `HttpResponse` containing a JSON array of metric names.
     * @summary Metrics routes implementation
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listMetrics(options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
    /**
     * # Parameters  - `path`: The name of the metric to retrieve details for.  # Returns  An `HttpResponse` containing the metric details in plain text, or a 404 error if the metric is not found.
     * @summary Returns the details of a specific metric in plain text format.
     * @param {string} metricName Name of the metric to retrieve, e.g. utopia_transactions_total
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    metricDetail(metricName: string, options?: RawAxiosRequestConfig): AxiosPromise<string>;
    /**
     * # Returns  An `HttpResponse` containing the updated metrics in plain text, or an error message if the update fails.
     * @summary Triggers an update of system metrics and returns the result in plain text format.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    scrapeMetrics(options?: RawAxiosRequestConfig): AxiosPromise<string>;
};
/**
 * MetricsApi - object-oriented interface
 * @export
 * @class MetricsApi
 * @extends {BaseAPI}
 */
export declare class MetricsApi extends BaseAPI {
    /**
     * Note: OpenAPI documentation for these endpoints can be found in the `openapi.rs` file Returns a list of all available metric names in JSON format.  # Returns  An `HttpResponse` containing a JSON array of metric names.
     * @summary Metrics routes implementation
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof MetricsApi
     */
    listMetrics(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
    /**
     * # Parameters  - `path`: The name of the metric to retrieve details for.  # Returns  An `HttpResponse` containing the metric details in plain text, or a 404 error if the metric is not found.
     * @summary Returns the details of a specific metric in plain text format.
     * @param {string} metricName Name of the metric to retrieve, e.g. utopia_transactions_total
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof MetricsApi
     */
    metricDetail(metricName: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
    /**
     * # Returns  An `HttpResponse` containing the updated metrics in plain text, or an error message if the update fails.
     * @summary Triggers an update of system metrics and returns the result in plain text format.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof MetricsApi
     */
    scrapeMetrics(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
}