@standard-crypto/farcaster-js-neynar/dist/commonjs/v1/openapi/generated/apis/user-api.d.ts

A tool for interacting with Farcaster via Neynar APIs.

/**
 * 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 { CustodyAddressResponse } from '../models';
import { RecentUsersResponse } from '../models';
import { User200Response } from '../models';
import { UserCastLikeResponse } from '../models';
/**
 * UserApi - axios parameter creator
 * @export
 */
export declare const UserApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Returns the custody address for a given FID
     * @summary Get the custody address for a given FID
     * @param {number} fid fid of a user
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    custodyAddress: (fid: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Get a list of casts from the protocol in reverse chronological order based on timestamp
     * @summary Get Recent Users
     * @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 100, max 1000)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    recentUsers: (viewerFid?: number, cursor?: string, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Returns metadata about a specific user
     * @summary Get User Information by FID
     * @param {number} fid fid of a user
     * @param {number} [viewerFid] fid of the user viewing this information, needed for contextual information.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    user: (fid: number, viewerFid?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Returns metadata about a specific user
     * @summary Get User Information by username
     * @param {string} username Username of the user
     * @param {number} [viewerFid] fid of the user viewing this information, needed for contextual information.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    userByUsername: (username: string, viewerFid?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Fetch all the liked cast of a User
     * @summary Get User Cast Likes
     * @param {number} fid FID of the user
     * @param {number} [viewerFid] fid of the user viewing this information, needed for contextual information.
     * @param {number} [limit] Number of results to retrieve (default 25, max 150)
     * @param {string} [cursor] Pagination cursor
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    userCastLikes: (fid: number, viewerFid?: number, limit?: number, cursor?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * UserApi - functional programming interface
 * @export
 */
export declare const UserApiFp: (configuration?: Configuration) => {
    /**
     * Returns the custody address for a given FID
     * @summary Get the custody address for a given FID
     * @param {number} fid fid of a user
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    custodyAddress(fid: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustodyAddressResponse>>;
    /**
     * Get a list of casts from the protocol in reverse chronological order based on timestamp
     * @summary Get Recent Users
     * @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 100, max 1000)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    recentUsers(viewerFid?: number, cursor?: string, limit?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RecentUsersResponse>>;
    /**
     * Returns metadata about a specific user
     * @summary Get User Information by FID
     * @param {number} fid fid of a user
     * @param {number} [viewerFid] fid of the user viewing this information, needed for contextual information.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    user(fid: number, viewerFid?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User200Response>>;
    /**
     * Returns metadata about a specific user
     * @summary Get User Information by username
     * @param {string} username Username of the user
     * @param {number} [viewerFid] fid of the user viewing this information, needed for contextual information.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    userByUsername(username: string, viewerFid?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User200Response>>;
    /**
     * Fetch all the liked cast of a User
     * @summary Get User Cast Likes
     * @param {number} fid FID of the user
     * @param {number} [viewerFid] fid of the user viewing this information, needed for contextual information.
     * @param {number} [limit] Number of results to retrieve (default 25, max 150)
     * @param {string} [cursor] Pagination cursor
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    userCastLikes(fid: number, viewerFid?: number, limit?: number, cursor?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserCastLikeResponse>>;
};
/**
 * UserApi - factory interface
 * @export
 */
export declare const UserApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Returns the custody address for a given FID
     * @summary Get the custody address for a given FID
     * @param {UserApiCustodyAddressRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    custodyAddress(requestParameters: UserApiCustodyAddressRequest, options?: AxiosRequestConfig): AxiosPromise<CustodyAddressResponse>;
    /**
     * Get a list of casts from the protocol in reverse chronological order based on timestamp
     * @summary Get Recent Users
     * @param {UserApiRecentUsersRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    recentUsers(requestParameters?: UserApiRecentUsersRequest, options?: AxiosRequestConfig): AxiosPromise<RecentUsersResponse>;
    /**
     * Returns metadata about a specific user
     * @summary Get User Information by FID
     * @param {UserApiUserRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    user(requestParameters: UserApiUserRequest, options?: AxiosRequestConfig): AxiosPromise<User200Response>;
    /**
     * Returns metadata about a specific user
     * @summary Get User Information by username
     * @param {UserApiUserByUsernameRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    userByUsername(requestParameters: UserApiUserByUsernameRequest, options?: AxiosRequestConfig): AxiosPromise<User200Response>;
    /**
     * Fetch all the liked cast of a User
     * @summary Get User Cast Likes
     * @param {UserApiUserCastLikesRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    userCastLikes(requestParameters: UserApiUserCastLikesRequest, options?: AxiosRequestConfig): AxiosPromise<UserCastLikeResponse>;
};
/**
 * Request parameters for custodyAddress operation in UserApi.
 * @export
 * @interface UserApiCustodyAddressRequest
 */
export interface UserApiCustodyAddressRequest {
    /**
     * fid of a user
     * @type {number}
     * @memberof UserApiCustodyAddress
     */
    readonly fid: number;
}
/**
 * Request parameters for recentUsers operation in UserApi.
 * @export
 * @interface UserApiRecentUsersRequest
 */
export interface UserApiRecentUsersRequest {
    /**
     * fid of the user viewing this information, needed for contextual information.
     * @type {number}
     * @memberof UserApiRecentUsers
     */
    readonly viewerFid?: number;
    /**
     * Pagination cursor.
     * @type {string}
     * @memberof UserApiRecentUsers
     */
    readonly cursor?: string;
    /**
     * Number of results to retrieve (default 100, max 1000)
     * @type {number}
     * @memberof UserApiRecentUsers
     */
    readonly limit?: number;
}
/**
 * Request parameters for user operation in UserApi.
 * @export
 * @interface UserApiUserRequest
 */
export interface UserApiUserRequest {
    /**
     * fid of a user
     * @type {number}
     * @memberof UserApiUser
     */
    readonly fid: number;
    /**
     * fid of the user viewing this information, needed for contextual information.
     * @type {number}
     * @memberof UserApiUser
     */
    readonly viewerFid?: number;
}
/**
 * Request parameters for userByUsername operation in UserApi.
 * @export
 * @interface UserApiUserByUsernameRequest
 */
export interface UserApiUserByUsernameRequest {
    /**
     * Username of the user
     * @type {string}
     * @memberof UserApiUserByUsername
     */
    readonly username: string;
    /**
     * fid of the user viewing this information, needed for contextual information.
     * @type {number}
     * @memberof UserApiUserByUsername
     */
    readonly viewerFid?: number;
}
/**
 * Request parameters for userCastLikes operation in UserApi.
 * @export
 * @interface UserApiUserCastLikesRequest
 */
export interface UserApiUserCastLikesRequest {
    /**
     * FID of the user
     * @type {number}
     * @memberof UserApiUserCastLikes
     */
    readonly fid: number;
    /**
     * fid of the user viewing this information, needed for contextual information.
     * @type {number}
     * @memberof UserApiUserCastLikes
     */
    readonly viewerFid?: number;
    /**
     * Number of results to retrieve (default 25, max 150)
     * @type {number}
     * @memberof UserApiUserCastLikes
     */
    readonly limit?: number;
    /**
     * Pagination cursor
     * @type {string}
     * @memberof UserApiUserCastLikes
     */
    readonly cursor?: string;
}
/**
 * UserApi - object-oriented interface
 * @export
 * @class UserApi
 * @extends {BaseAPI}
 */
export declare class UserApi extends BaseAPI {
    /**
     * Returns the custody address for a given FID
     * @summary Get the custody address for a given FID
     * @param {UserApiCustodyAddressRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof UserApi
     */
    custodyAddress(requestParameters: UserApiCustodyAddressRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<CustodyAddressResponse, any>>;
    /**
     * Get a list of casts from the protocol in reverse chronological order based on timestamp
     * @summary Get Recent Users
     * @param {UserApiRecentUsersRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof UserApi
     */
    recentUsers(requestParameters?: UserApiRecentUsersRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<RecentUsersResponse, any>>;
    /**
     * Returns metadata about a specific user
     * @summary Get User Information by FID
     * @param {UserApiUserRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof UserApi
     */
    user(requestParameters: UserApiUserRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<User200Response, any>>;
    /**
     * Returns metadata about a specific user
     * @summary Get User Information by username
     * @param {UserApiUserByUsernameRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof UserApi
     */
    userByUsername(requestParameters: UserApiUserByUsernameRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<User200Response, any>>;
    /**
     * Fetch all the liked cast of a User
     * @summary Get User Cast Likes
     * @param {UserApiUserCastLikesRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof UserApi
     */
    userCastLikes(requestParameters: UserApiUserCastLikesRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<UserCastLikeResponse, any>>;
}