@neynar/nodejs-sdk/build/hub-api/apis/fids-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 { FidsResponse } from '../models';
/**
 * FidsApi - axios parameter creator
 * @export
 */
export declare const FidsApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Fetch a list of all the FIDs.
     * @summary Fetch a list of all the FIDs
     * @param {number} shardId The shard ID to filter by
     * @param {number} [pageSize] Maximum number of messages to return in a single response
     * @param {boolean} [reverse] Reverse the sort order, returning latest messages first
     * @param {string} [pageToken] The page token returned by the previous query, to fetch the next page. If this parameter is empty, fetch the first page
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<FidsResponse>} A promise that resolves to a `FidsResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-fids)
     *
     */
    fetchFids: (shardId: number, pageSize?: number, reverse?: boolean, pageToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * FidsApi - functional programming interface
 * @export
 */
export declare const FidsApiFp: (configuration?: Configuration) => {
    /**
     * Fetch a list of all the FIDs.
     * @summary Fetch a list of all the FIDs
     * @param {number} shardId The shard ID to filter by
     * @param {number} [pageSize] Maximum number of messages to return in a single response
     * @param {boolean} [reverse] Reverse the sort order, returning latest messages first
     * @param {string} [pageToken] The page token returned by the previous query, to fetch the next page. If this parameter is empty, fetch the first page
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<FidsResponse>} A promise that resolves to a `FidsResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-fids)
     *
     */
    fetchFids(shardId: number, pageSize?: number, reverse?: boolean, pageToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FidsResponse>>;
};
/**
 * FidsApi - factory interface
 * @export
 */
export declare const FidsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Fetch a list of all the FIDs.
     * @summary Fetch a list of all the FIDs
     * @param {FidsApiFetchFidsRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<FidsResponse>} A promise that resolves to a `FidsResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-fids)
     *
     */
    fetchFids(requestParameters: FidsApiFetchFidsRequest, options?: RawAxiosRequestConfig): AxiosPromise<FidsResponse>;
};
/**
 * FidsApi - interface
 * @export
 * @interface FidsApi
 */
export interface FidsApiInterface {
    /**
     * Fetch a list of all the FIDs.
     * @summary Fetch a list of all the FIDs
     * @param {FidsApiFetchFidsRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FidsApiInterface
     * @returns {Promise<FidsResponse>} A promise that resolves to a `FidsResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-fids)
     *
     */
    fetchFids(requestParameters: FidsApiFetchFidsRequest, options?: RawAxiosRequestConfig): AxiosPromise<FidsResponse>;
}
/**
 * Request parameters for fetchFids operation in FidsApi.
 * @export
 * @interface FidsApiFetchFidsRequest
 */
export interface FidsApiFetchFidsRequest {
    /**
     * The shard ID to filter by
     *
     *
     *
     * @type {number}
     * @memberof FidsApiFetchFids
     */
    readonly shardId: number;
    /**
     * Maximum number of messages to return in a single response
     *
     *
     *
     * @type {number}
     * @memberof FidsApiFetchFids
     */
    readonly pageSize?: number;
    /**
     * Reverse the sort order, returning latest messages first
     *
     *
     *
     * @type {boolean}
     * @memberof FidsApiFetchFids
     */
    readonly reverse?: boolean;
    /**
     * The page token returned by the previous query, to fetch the next page. If this parameter is empty, fetch the first page
     *
     *
     *
     * @type {string}
     * @memberof FidsApiFetchFids
     */
    readonly pageToken?: string;
}
/**
 * FidsApi - object-oriented interface
 * @export
 * @class FidsApi
 * @extends {BaseAPI}
 */
export declare class FidsApi extends BaseAPI implements FidsApiInterface {
    /**
     * Fetch a list of all the FIDs.
     * @summary Fetch a list of all the FIDs
     * @param {FidsApiFetchFidsRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FidsApi
     * @returns {Promise<FidsResponse>} A promise that resolves to a `FidsResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-fids)
     *
     */
    fetchFids(requestParameters: FidsApiFetchFidsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FidsResponse, any>>;
}