@standard-crypto/farcaster-js-neynar
Version:
A tool for interacting with Farcaster via Neynar APIs.
184 lines (183 loc) • 8.1 kB
TypeScript
/**
* v1 Farcaster
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
*
* The version of the OpenAPI document: 1.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 globalAxios from 'axios';
import { RequestArgs, BaseAPI } from '../base.js';
import { MentionsAndRepliesResponse } from '../models';
import { ReactionsAndRecastsResponse } from '../models';
/**
* NotificationsApi - axios parameter creator
* @export
*/
export declare const NotificationsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Gets a list of mentions and replies to the user’s casts in reverse chronological order
* @summary Get mentions and replies
* @param {number} fid fid of a user
* @param {number} [viewerFid] fid of the user viewing this information, needed for contextual information.
* @param {string} [cursor] Pagination cursor.
* @param {number} [limit] Number of results to retrieve (default 25, max 150)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
mentionsAndReplies: (fid: number, viewerFid?: number, cursor?: string, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
* Get a list of reactions and recasts to the users’s casts in reverse chronological order
* @summary Get reactions and recasts
* @param {number} fid fid of a user
* @param {number} [viewerFid] fid of the user viewing this information, needed for contextual information.
* @param {string} [cursor] Pagination cursor.
* @param {number} [limit] Number of results to retrieve (default 25, max 150)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
reactionsAndRecasts: (fid: number, viewerFid?: number, cursor?: string, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* NotificationsApi - functional programming interface
* @export
*/
export declare const NotificationsApiFp: (configuration?: Configuration) => {
/**
* Gets a list of mentions and replies to the user’s casts in reverse chronological order
* @summary Get mentions and replies
* @param {number} fid fid of a user
* @param {number} [viewerFid] fid of the user viewing this information, needed for contextual information.
* @param {string} [cursor] Pagination cursor.
* @param {number} [limit] Number of results to retrieve (default 25, max 150)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
mentionsAndReplies(fid: number, viewerFid?: number, cursor?: string, limit?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MentionsAndRepliesResponse>>;
/**
* Get a list of reactions and recasts to the users’s casts in reverse chronological order
* @summary Get reactions and recasts
* @param {number} fid fid of a user
* @param {number} [viewerFid] fid of the user viewing this information, needed for contextual information.
* @param {string} [cursor] Pagination cursor.
* @param {number} [limit] Number of results to retrieve (default 25, max 150)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
reactionsAndRecasts(fid: number, viewerFid?: number, cursor?: string, limit?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReactionsAndRecastsResponse>>;
};
/**
* NotificationsApi - factory interface
* @export
*/
export declare const NotificationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Gets a list of mentions and replies to the user’s casts in reverse chronological order
* @summary Get mentions and replies
* @param {NotificationsApiMentionsAndRepliesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
mentionsAndReplies(requestParameters: NotificationsApiMentionsAndRepliesRequest, options?: AxiosRequestConfig): AxiosPromise<MentionsAndRepliesResponse>;
/**
* Get a list of reactions and recasts to the users’s casts in reverse chronological order
* @summary Get reactions and recasts
* @param {NotificationsApiReactionsAndRecastsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
reactionsAndRecasts(requestParameters: NotificationsApiReactionsAndRecastsRequest, options?: AxiosRequestConfig): AxiosPromise<ReactionsAndRecastsResponse>;
};
/**
* Request parameters for mentionsAndReplies operation in NotificationsApi.
* @export
* @interface NotificationsApiMentionsAndRepliesRequest
*/
export interface NotificationsApiMentionsAndRepliesRequest {
/**
* fid of a user
* @type {number}
* @memberof NotificationsApiMentionsAndReplies
*/
readonly fid: number;
/**
* fid of the user viewing this information, needed for contextual information.
* @type {number}
* @memberof NotificationsApiMentionsAndReplies
*/
readonly viewerFid?: number;
/**
* Pagination cursor.
* @type {string}
* @memberof NotificationsApiMentionsAndReplies
*/
readonly cursor?: string;
/**
* Number of results to retrieve (default 25, max 150)
* @type {number}
* @memberof NotificationsApiMentionsAndReplies
*/
readonly limit?: number;
}
/**
* Request parameters for reactionsAndRecasts operation in NotificationsApi.
* @export
* @interface NotificationsApiReactionsAndRecastsRequest
*/
export interface NotificationsApiReactionsAndRecastsRequest {
/**
* fid of a user
* @type {number}
* @memberof NotificationsApiReactionsAndRecasts
*/
readonly fid: number;
/**
* fid of the user viewing this information, needed for contextual information.
* @type {number}
* @memberof NotificationsApiReactionsAndRecasts
*/
readonly viewerFid?: number;
/**
* Pagination cursor.
* @type {string}
* @memberof NotificationsApiReactionsAndRecasts
*/
readonly cursor?: string;
/**
* Number of results to retrieve (default 25, max 150)
* @type {number}
* @memberof NotificationsApiReactionsAndRecasts
*/
readonly limit?: number;
}
/**
* NotificationsApi - object-oriented interface
* @export
* @class NotificationsApi
* @extends {BaseAPI}
*/
export declare class NotificationsApi extends BaseAPI {
/**
* Gets a list of mentions and replies to the user’s casts in reverse chronological order
* @summary Get mentions and replies
* @param {NotificationsApiMentionsAndRepliesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof NotificationsApi
*/
mentionsAndReplies(requestParameters: NotificationsApiMentionsAndRepliesRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<MentionsAndRepliesResponse, any>>;
/**
* Get a list of reactions and recasts to the users’s casts in reverse chronological order
* @summary Get reactions and recasts
* @param {NotificationsApiReactionsAndRecastsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof NotificationsApi
*/
reactionsAndRecasts(requestParameters: NotificationsApiReactionsAndRecastsRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<ReactionsAndRecastsResponse, any>>;
}