@neynar/nodejs-sdk/build/hub-api/apis/info-api.d.ts

SDK to interact with Neynar APIs (https://docs.neynar.com/reference/quickstart)

/**
 * Farcaster Hub API
 * Perform basic queries of Farcaster state via the REST API of a Farcaster hub. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
 *
 * The version of the OpenAPI document: 2.35.0
 * Contact: team@neynar.com
 *
 * 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 { HubInfoResponse } from '../models';
/**
 * InfoApi - axios parameter creator
 * @export
 */
export declare const InfoApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Retrieve hub information.
     * @summary Sync Methods
     * @param {boolean} dbstats Controls whether the response includes database statistics. When true, the response includes information about the hub\'s database state, storage usage, and performance metrics.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<HubInfoResponse>} A promise that resolves to a `HubInfoResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-hub-info)
     *
     */
    lookupHubInfo: (dbstats: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * InfoApi - functional programming interface
 * @export
 */
export declare const InfoApiFp: (configuration?: Configuration) => {
    /**
     * Retrieve hub information.
     * @summary Sync Methods
     * @param {boolean} dbstats Controls whether the response includes database statistics. When true, the response includes information about the hub\&#39;s database state, storage usage, and performance metrics.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<HubInfoResponse>} A promise that resolves to a `HubInfoResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-hub-info)
     *
     */
    lookupHubInfo(dbstats: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HubInfoResponse>>;
};
/**
 * InfoApi - factory interface
 * @export
 */
export declare const InfoApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Retrieve hub information.
     * @summary Sync Methods
     * @param {InfoApiLookupHubInfoRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<HubInfoResponse>} A promise that resolves to a `HubInfoResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-hub-info)
     *
     */
    lookupHubInfo(requestParameters: InfoApiLookupHubInfoRequest, options?: RawAxiosRequestConfig): AxiosPromise<HubInfoResponse>;
};
/**
 * InfoApi - interface
 * @export
 * @interface InfoApi
 */
export interface InfoApiInterface {
    /**
     * Retrieve hub information.
     * @summary Sync Methods
     * @param {InfoApiLookupHubInfoRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof InfoApiInterface
     * @returns {Promise<HubInfoResponse>} A promise that resolves to a `HubInfoResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-hub-info)
     *
     */
    lookupHubInfo(requestParameters: InfoApiLookupHubInfoRequest, options?: RawAxiosRequestConfig): AxiosPromise<HubInfoResponse>;
}
/**
 * Request parameters for lookupHubInfo operation in InfoApi.
 * @export
 * @interface InfoApiLookupHubInfoRequest
 */
export interface InfoApiLookupHubInfoRequest {
    /**
     * Controls whether the response includes database statistics. When true, the response includes information about the hub\&#39;s database state, storage usage, and performance metrics.
     *
     *
     *
     * @type {boolean}
     * @memberof InfoApiLookupHubInfo
     */
    readonly dbstats: boolean;
}
/**
 * InfoApi - object-oriented interface
 * @export
 * @class InfoApi
 * @extends {BaseAPI}
 */
export declare class InfoApi extends BaseAPI implements InfoApiInterface {
    /**
     * Retrieve hub information.
     * @summary Sync Methods
     * @param {InfoApiLookupHubInfoRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof InfoApi
     * @returns {Promise<HubInfoResponse>} A promise that resolves to a `HubInfoResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-hub-info)
     *
     */
    lookupHubInfo(requestParameters: InfoApiLookupHubInfoRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HubInfoResponse, any, {}>>;
}