@standard-crypto/farcaster-js-neynar/dist/esm/v2/openapi/generated/apis/follows-api.d.ts

A tool for interacting with Farcaster via Neynar APIs.

/**
 * Farcaster API V2
 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 *
 * The version of the OpenAPI document: 2.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.js';
import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
import { RequestArgs, BaseAPI } from '../base.js';
import { RelevantFollowersResponse } from '../models';
/**
 * FollowsApi - axios parameter creator
 * @export
 */
export declare const FollowsApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Returns a list of relevant followers for a specific FID.
     * @summary Retrieve relevant followers for a given user
     * @param {number} targetFid User who\'s profile you are looking at
     * @param {number} viewerFid Viewer who\'s looking at the profile
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    relevantFollowers: (targetFid: number, viewerFid: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * FollowsApi - functional programming interface
 * @export
 */
export declare const FollowsApiFp: (configuration?: Configuration) => {
    /**
     * Returns a list of relevant followers for a specific FID.
     * @summary Retrieve relevant followers for a given user
     * @param {number} targetFid User who\&#39;s profile you are looking at
     * @param {number} viewerFid Viewer who\&#39;s looking at the profile
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    relevantFollowers(targetFid: number, viewerFid: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RelevantFollowersResponse>>;
};
/**
 * FollowsApi - factory interface
 * @export
 */
export declare const FollowsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Returns a list of relevant followers for a specific FID.
     * @summary Retrieve relevant followers for a given user
     * @param {FollowsApiRelevantFollowersRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    relevantFollowers(requestParameters: FollowsApiRelevantFollowersRequest, options?: AxiosRequestConfig): AxiosPromise<RelevantFollowersResponse>;
};
/**
 * Request parameters for relevantFollowers operation in FollowsApi.
 * @export
 * @interface FollowsApiRelevantFollowersRequest
 */
export interface FollowsApiRelevantFollowersRequest {
    /**
     * User who\&#39;s profile you are looking at
     * @type {number}
     * @memberof FollowsApiRelevantFollowers
     */
    readonly targetFid: number;
    /**
     * Viewer who\&#39;s looking at the profile
     * @type {number}
     * @memberof FollowsApiRelevantFollowers
     */
    readonly viewerFid: number;
}
/**
 * FollowsApi - object-oriented interface
 * @export
 * @class FollowsApi
 * @extends {BaseAPI}
 */
export declare class FollowsApi extends BaseAPI {
    /**
     * Returns a list of relevant followers for a specific FID.
     * @summary Retrieve relevant followers for a given user
     * @param {FollowsApiRelevantFollowersRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FollowsApi
     */
    relevantFollowers(requestParameters: FollowsApiRelevantFollowersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RelevantFollowersResponse, any>>;
}