@neynar/nodejs-sdk
Version:
SDK to interact with Neynar APIs (https://docs.neynar.com/reference/quickstart)
529 lines (528 loc) • 26.7 kB
TypeScript
/**
* Farcaster API V2
* The Farcaster API allows you to interact with the Farcaster protocol. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
*
* The version of the OpenAPI document: 2.46.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 { FollowSortType } from '../models';
import type { FollowersResponse } from '../models';
import type { RelevantFollowersResponse } from '../models';
import type { UsersResponse } from '../models';
/**
* FollowsApi - axios parameter creator
* @export
*/
export declare const FollowsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Fetch a list of suggested users to follow. Used to help users discover new users to follow
* @summary Suggest Follows
* @param {number} fid FID of the user whose following you want to fetch.
* @param {number} [viewerFid] Providing this will return a list of users that respects this user\'s mutes and blocks and includes `viewer_context`.
* @param {number} [limit] Number of results to fetch (Default: 25, Maximum: 100)
* @param {boolean} [xNeynarExperimental] Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<UsersResponse>} A promise that resolves to a `UsersResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-follow-suggestions)
*
*/
fetchFollowSuggestions: (fid: number, viewerFid?: number, limit?: number, xNeynarExperimental?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Returns a list of relevant followers for a specific FID. This usually shows on a profile as \"X, Y and Z follow this user\".
* @summary Relevant followers
* @param {number} targetFid User who\'s profile you are looking at
* @param {number} viewerFid The FID of the user to customize this response for. Providing this will also return a list of followers that respects this user\'s mutes and blocks and includes `viewer_context`.
* @param {boolean} [xNeynarExperimental] Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<RelevantFollowersResponse>} A promise that resolves to a `RelevantFollowersResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-relevant-followers)
*
*/
fetchRelevantFollowers: (targetFid: number, viewerFid: number, xNeynarExperimental?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Returns a list of followers for a specific FID.
* @summary Followers
* @param {number} fid User who\'s profile you are looking at
* @param {number} [viewerFid] Providing this will return a list of followers that respects this user\'s mutes and blocks and includes `viewer_context`.
* @param {FollowSortType} [sortType] Sort type for fetch followers. Default is `desc_chron`
* @param {number} [limit] Number of results to fetch (Default: 20, Maximum: 100)
* @param {string} [cursor] Pagination cursor.
* @param {boolean} [xNeynarExperimental] Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<FollowersResponse>} A promise that resolves to a `FollowersResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-user-followers)
*
*/
fetchUserFollowers: (fid: number, viewerFid?: number, sortType?: FollowSortType, limit?: number, cursor?: string, xNeynarExperimental?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Fetch a list of users who a given user is following. Can optionally include a viewer_fid and sort_type.
* @summary Following
* @param {number} fid FID of the user whose following you want to fetch.
* @param {number} [viewerFid] Providing this will return a list of users that respects this user\'s mutes and blocks and includes `viewer_context`.
* @param {FollowSortType} [sortType] Optional parameter to sort the users based on different criteria.
* @param {number} [limit] Number of results to fetch (Default: 25, Maximum: 100)
* @param {string} [cursor] Pagination cursor.
* @param {boolean} [xNeynarExperimental] Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<FollowersResponse>} A promise that resolves to a `FollowersResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-user-following)
*
*/
fetchUserFollowing: (fid: number, viewerFid?: number, sortType?: FollowSortType, limit?: number, cursor?: string, xNeynarExperimental?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* FollowsApi - functional programming interface
* @export
*/
export declare const FollowsApiFp: (configuration?: Configuration) => {
/**
* Fetch a list of suggested users to follow. Used to help users discover new users to follow
* @summary Suggest Follows
* @param {number} fid FID of the user whose following you want to fetch.
* @param {number} [viewerFid] Providing this will return a list of users that respects this user\'s mutes and blocks and includes `viewer_context`.
* @param {number} [limit] Number of results to fetch (Default: 25, Maximum: 100)
* @param {boolean} [xNeynarExperimental] Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<UsersResponse>} A promise that resolves to a `UsersResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-follow-suggestions)
*
*/
fetchFollowSuggestions(fid: number, viewerFid?: number, limit?: number, xNeynarExperimental?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UsersResponse>>;
/**
* Returns a list of relevant followers for a specific FID. This usually shows on a profile as \"X, Y and Z follow this user\".
* @summary Relevant followers
* @param {number} targetFid User who\'s profile you are looking at
* @param {number} viewerFid The FID of the user to customize this response for. Providing this will also return a list of followers that respects this user\'s mutes and blocks and includes `viewer_context`.
* @param {boolean} [xNeynarExperimental] Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<RelevantFollowersResponse>} A promise that resolves to a `RelevantFollowersResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-relevant-followers)
*
*/
fetchRelevantFollowers(targetFid: number, viewerFid: number, xNeynarExperimental?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RelevantFollowersResponse>>;
/**
* Returns a list of followers for a specific FID.
* @summary Followers
* @param {number} fid User who\'s profile you are looking at
* @param {number} [viewerFid] Providing this will return a list of followers that respects this user\'s mutes and blocks and includes `viewer_context`.
* @param {FollowSortType} [sortType] Sort type for fetch followers. Default is `desc_chron`
* @param {number} [limit] Number of results to fetch (Default: 20, Maximum: 100)
* @param {string} [cursor] Pagination cursor.
* @param {boolean} [xNeynarExperimental] Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<FollowersResponse>} A promise that resolves to a `FollowersResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-user-followers)
*
*/
fetchUserFollowers(fid: number, viewerFid?: number, sortType?: FollowSortType, limit?: number, cursor?: string, xNeynarExperimental?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FollowersResponse>>;
/**
* Fetch a list of users who a given user is following. Can optionally include a viewer_fid and sort_type.
* @summary Following
* @param {number} fid FID of the user whose following you want to fetch.
* @param {number} [viewerFid] Providing this will return a list of users that respects this user\'s mutes and blocks and includes `viewer_context`.
* @param {FollowSortType} [sortType] Optional parameter to sort the users based on different criteria.
* @param {number} [limit] Number of results to fetch (Default: 25, Maximum: 100)
* @param {string} [cursor] Pagination cursor.
* @param {boolean} [xNeynarExperimental] Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<FollowersResponse>} A promise that resolves to a `FollowersResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-user-following)
*
*/
fetchUserFollowing(fid: number, viewerFid?: number, sortType?: FollowSortType, limit?: number, cursor?: string, xNeynarExperimental?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FollowersResponse>>;
};
/**
* FollowsApi - factory interface
* @export
*/
export declare const FollowsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Fetch a list of suggested users to follow. Used to help users discover new users to follow
* @summary Suggest Follows
* @param {FollowsApiFetchFollowSuggestionsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<UsersResponse>} A promise that resolves to a `UsersResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-follow-suggestions)
*
*/
fetchFollowSuggestions(requestParameters: FollowsApiFetchFollowSuggestionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<UsersResponse>;
/**
* Returns a list of relevant followers for a specific FID. This usually shows on a profile as \"X, Y and Z follow this user\".
* @summary Relevant followers
* @param {FollowsApiFetchRelevantFollowersRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<RelevantFollowersResponse>} A promise that resolves to a `RelevantFollowersResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-relevant-followers)
*
*/
fetchRelevantFollowers(requestParameters: FollowsApiFetchRelevantFollowersRequest, options?: RawAxiosRequestConfig): AxiosPromise<RelevantFollowersResponse>;
/**
* Returns a list of followers for a specific FID.
* @summary Followers
* @param {FollowsApiFetchUserFollowersRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<FollowersResponse>} A promise that resolves to a `FollowersResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-user-followers)
*
*/
fetchUserFollowers(requestParameters: FollowsApiFetchUserFollowersRequest, options?: RawAxiosRequestConfig): AxiosPromise<FollowersResponse>;
/**
* Fetch a list of users who a given user is following. Can optionally include a viewer_fid and sort_type.
* @summary Following
* @param {FollowsApiFetchUserFollowingRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<FollowersResponse>} A promise that resolves to a `FollowersResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-user-following)
*
*/
fetchUserFollowing(requestParameters: FollowsApiFetchUserFollowingRequest, options?: RawAxiosRequestConfig): AxiosPromise<FollowersResponse>;
};
/**
* FollowsApi - interface
* @export
* @interface FollowsApi
*/
export interface FollowsApiInterface {
/**
* Fetch a list of suggested users to follow. Used to help users discover new users to follow
* @summary Suggest Follows
* @param {FollowsApiFetchFollowSuggestionsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FollowsApiInterface
* @returns {Promise<UsersResponse>} A promise that resolves to a `UsersResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-follow-suggestions)
*
*/
fetchFollowSuggestions(requestParameters: FollowsApiFetchFollowSuggestionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<UsersResponse>;
/**
* Returns a list of relevant followers for a specific FID. This usually shows on a profile as \"X, Y and Z follow this user\".
* @summary Relevant followers
* @param {FollowsApiFetchRelevantFollowersRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FollowsApiInterface
* @returns {Promise<RelevantFollowersResponse>} A promise that resolves to a `RelevantFollowersResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-relevant-followers)
*
*/
fetchRelevantFollowers(requestParameters: FollowsApiFetchRelevantFollowersRequest, options?: RawAxiosRequestConfig): AxiosPromise<RelevantFollowersResponse>;
/**
* Returns a list of followers for a specific FID.
* @summary Followers
* @param {FollowsApiFetchUserFollowersRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FollowsApiInterface
* @returns {Promise<FollowersResponse>} A promise that resolves to a `FollowersResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-user-followers)
*
*/
fetchUserFollowers(requestParameters: FollowsApiFetchUserFollowersRequest, options?: RawAxiosRequestConfig): AxiosPromise<FollowersResponse>;
/**
* Fetch a list of users who a given user is following. Can optionally include a viewer_fid and sort_type.
* @summary Following
* @param {FollowsApiFetchUserFollowingRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FollowsApiInterface
* @returns {Promise<FollowersResponse>} A promise that resolves to a `FollowersResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-user-following)
*
*/
fetchUserFollowing(requestParameters: FollowsApiFetchUserFollowingRequest, options?: RawAxiosRequestConfig): AxiosPromise<FollowersResponse>;
}
/**
* Request parameters for fetchFollowSuggestions operation in FollowsApi.
* @export
* @interface FollowsApiFetchFollowSuggestionsRequest
*/
export interface FollowsApiFetchFollowSuggestionsRequest {
/**
* FID of the user whose following you want to fetch.
*
*
*
* @type {number}
* @memberof FollowsApiFetchFollowSuggestions
*/
readonly fid: number;
/**
* Providing this will return a list of users that respects this user\'s mutes and blocks and includes `viewer_context`.
*
*
*
* @type {number}
* @memberof FollowsApiFetchFollowSuggestions
*/
readonly viewerFid?: number;
/**
* Number of results to fetch (Default: 25, Maximum: 100)
*
*
*
* @type {number}
* @memberof FollowsApiFetchFollowSuggestions
*/
readonly limit?: number;
/**
* Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
*
*
* @globalHeader
* @type {boolean}
* @memberof FollowsApiFetchFollowSuggestions
*/
readonly xNeynarExperimental?: boolean;
}
/**
* Request parameters for fetchRelevantFollowers operation in FollowsApi.
* @export
* @interface FollowsApiFetchRelevantFollowersRequest
*/
export interface FollowsApiFetchRelevantFollowersRequest {
/**
* User who\'s profile you are looking at
*
*
*
* @type {number}
* @memberof FollowsApiFetchRelevantFollowers
*/
readonly targetFid: number;
/**
* The FID of the user to customize this response for. Providing this will also return a list of followers that respects this user\'s mutes and blocks and includes `viewer_context`.
*
*
*
* @type {number}
* @memberof FollowsApiFetchRelevantFollowers
*/
readonly viewerFid: number;
/**
* Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
*
*
* @globalHeader
* @type {boolean}
* @memberof FollowsApiFetchRelevantFollowers
*/
readonly xNeynarExperimental?: boolean;
}
/**
* Request parameters for fetchUserFollowers operation in FollowsApi.
* @export
* @interface FollowsApiFetchUserFollowersRequest
*/
export interface FollowsApiFetchUserFollowersRequest {
/**
* User who\'s profile you are looking at
*
*
*
* @type {number}
* @memberof FollowsApiFetchUserFollowers
*/
readonly fid: number;
/**
* Providing this will return a list of followers that respects this user\'s mutes and blocks and includes `viewer_context`.
*
*
*
* @type {number}
* @memberof FollowsApiFetchUserFollowers
*/
readonly viewerFid?: number;
/**
* Sort type for fetch followers. Default is `desc_chron`
*
*
*
* @type {FollowSortType}
* @memberof FollowsApiFetchUserFollowers
*/
readonly sortType?: FollowSortType;
/**
* Number of results to fetch (Default: 20, Maximum: 100)
*
*
*
* @type {number}
* @memberof FollowsApiFetchUserFollowers
*/
readonly limit?: number;
/**
* Pagination cursor.
*
*
*
* @type {string}
* @memberof FollowsApiFetchUserFollowers
*/
readonly cursor?: string;
/**
* Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
*
*
* @globalHeader
* @type {boolean}
* @memberof FollowsApiFetchUserFollowers
*/
readonly xNeynarExperimental?: boolean;
}
/**
* Request parameters for fetchUserFollowing operation in FollowsApi.
* @export
* @interface FollowsApiFetchUserFollowingRequest
*/
export interface FollowsApiFetchUserFollowingRequest {
/**
* FID of the user whose following you want to fetch.
*
*
*
* @type {number}
* @memberof FollowsApiFetchUserFollowing
*/
readonly fid: number;
/**
* Providing this will return a list of users that respects this user\'s mutes and blocks and includes `viewer_context`.
*
*
*
* @type {number}
* @memberof FollowsApiFetchUserFollowing
*/
readonly viewerFid?: number;
/**
* Optional parameter to sort the users based on different criteria.
*
*
*
* @type {FollowSortType}
* @memberof FollowsApiFetchUserFollowing
*/
readonly sortType?: FollowSortType;
/**
* Number of results to fetch (Default: 25, Maximum: 100)
*
*
*
* @type {number}
* @memberof FollowsApiFetchUserFollowing
*/
readonly limit?: number;
/**
* Pagination cursor.
*
*
*
* @type {string}
* @memberof FollowsApiFetchUserFollowing
*/
readonly cursor?: string;
/**
* Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
*
*
* @globalHeader
* @type {boolean}
* @memberof FollowsApiFetchUserFollowing
*/
readonly xNeynarExperimental?: boolean;
}
/**
* FollowsApi - object-oriented interface
* @export
* @class FollowsApi
* @extends {BaseAPI}
*/
export declare class FollowsApi extends BaseAPI implements FollowsApiInterface {
/**
* Fetch a list of suggested users to follow. Used to help users discover new users to follow
* @summary Suggest Follows
* @param {FollowsApiFetchFollowSuggestionsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FollowsApi
* @returns {Promise<UsersResponse>} A promise that resolves to a `UsersResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-follow-suggestions)
*
*/
fetchFollowSuggestions(requestParameters: FollowsApiFetchFollowSuggestionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UsersResponse, any>>;
/**
* Returns a list of relevant followers for a specific FID. This usually shows on a profile as \"X, Y and Z follow this user\".
* @summary Relevant followers
* @param {FollowsApiFetchRelevantFollowersRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FollowsApi
* @returns {Promise<RelevantFollowersResponse>} A promise that resolves to a `RelevantFollowersResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-relevant-followers)
*
*/
fetchRelevantFollowers(requestParameters: FollowsApiFetchRelevantFollowersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RelevantFollowersResponse, any>>;
/**
* Returns a list of followers for a specific FID.
* @summary Followers
* @param {FollowsApiFetchUserFollowersRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FollowsApi
* @returns {Promise<FollowersResponse>} A promise that resolves to a `FollowersResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-user-followers)
*
*/
fetchUserFollowers(requestParameters: FollowsApiFetchUserFollowersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FollowersResponse, any>>;
/**
* Fetch a list of users who a given user is following. Can optionally include a viewer_fid and sort_type.
* @summary Following
* @param {FollowsApiFetchUserFollowingRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FollowsApi
* @returns {Promise<FollowersResponse>} A promise that resolves to a `FollowersResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-user-following)
*
*/
fetchUserFollowing(requestParameters: FollowsApiFetchUserFollowingRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FollowersResponse, any>>;
}