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

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

/**
 * Neynar API
 * The Neynar API allows you to interact with the Farcaster protocol among other things. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
 *
 * The version of the OpenAPI document: 3.115.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 { TrendingTopicsResponse } from '../models';
/**
 * TopicApi - axios parameter creator
 * @export
 */
export declare const TopicApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Returns a list of trending topics for casts.
     * @summary Fetch trending topics
     * @param {number} [limit] Number of topics to fetch.  (Default: 10, Maximum: 25)
     * @param {string} [cursor] Pagination cursor.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<TrendingTopicsResponse>} A promise that resolves to a `TrendingTopicsResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-trending-topics)
     *
     */
    listTrendingTopics: (limit?: number, cursor?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * TopicApi - functional programming interface
 * @export
 */
export declare const TopicApiFp: (configuration?: Configuration) => {
    /**
     * Returns a list of trending topics for casts.
     * @summary Fetch trending topics
     * @param {number} [limit] Number of topics to fetch.  (Default: 10, Maximum: 25)
     * @param {string} [cursor] Pagination cursor.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<TrendingTopicsResponse>} A promise that resolves to a `TrendingTopicsResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-trending-topics)
     *
     */
    listTrendingTopics(limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TrendingTopicsResponse>>;
};
/**
 * TopicApi - factory interface
 * @export
 */
export declare const TopicApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Returns a list of trending topics for casts.
     * @summary Fetch trending topics
     * @param {TopicApiListTrendingTopicsRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<TrendingTopicsResponse>} A promise that resolves to a `TrendingTopicsResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-trending-topics)
     *
     */
    listTrendingTopics(requestParameters?: TopicApiListTrendingTopicsRequest, options?: RawAxiosRequestConfig): AxiosPromise<TrendingTopicsResponse>;
};
/**
 * TopicApi - interface
 * @export
 * @interface TopicApi
 */
export interface TopicApiInterface {
    /**
     * Returns a list of trending topics for casts.
     * @summary Fetch trending topics
     * @param {TopicApiListTrendingTopicsRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof TopicApiInterface
     * @returns {Promise<TrendingTopicsResponse>} A promise that resolves to a `TrendingTopicsResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-trending-topics)
     *
     */
    listTrendingTopics(requestParameters?: TopicApiListTrendingTopicsRequest, options?: RawAxiosRequestConfig): AxiosPromise<TrendingTopicsResponse>;
}
/**
 * Request parameters for listTrendingTopics operation in TopicApi.
 * @export
 * @interface TopicApiListTrendingTopicsRequest
 */
export interface TopicApiListTrendingTopicsRequest {
    /**
     * Number of topics to fetch. (Default: 10, Maximum: 25)
     *
     *
     *
     * @type {number}
     * @memberof TopicApiListTrendingTopics
     */
    readonly limit?: number;
    /**
     * Pagination cursor.
     *
     *
     *
     * @type {string}
     * @memberof TopicApiListTrendingTopics
     */
    readonly cursor?: string;
}
/**
 * TopicApi - object-oriented interface
 * @export
 * @class TopicApi
 * @extends {BaseAPI}
 */
export declare class TopicApi extends BaseAPI implements TopicApiInterface {
    /**
     * Returns a list of trending topics for casts.
     * @summary Fetch trending topics
     * @param {TopicApiListTrendingTopicsRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof TopicApi
     * @returns {Promise<TrendingTopicsResponse>} A promise that resolves to a `TrendingTopicsResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-trending-topics)
     *
     */
    listTrendingTopics(requestParameters?: TopicApiListTrendingTopicsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TrendingTopicsResponse, any, {}>>;
}