/** * 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.137.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 { AddVerificationReqBody } from '../models'; import type { BestFriendsResponse } from '../models'; import type { BulkFollowResponse } from '../models'; import type { BulkUsersByAddressResponse } from '../models'; import type { BulkUsersResponse } from '../models'; import type { FetchVerifications200Response } from '../models'; import type { FollowReqBody } from '../models'; import type { OperationResponse } from '../models'; import type { RegisterUserReqBody } from '../models'; import type { RegisterUserResponse } from '../models'; import type { RemoveVerificationReqBody } from '../models'; import type { UpdateUserReqBody } from '../models'; import type { UserFIDResponse } from '../models'; import type { UserResponse } from '../models'; import type { UserSearchResponse } from '../models'; import type { UsersResponse } from '../models'; /** * UserApi - axios parameter creator * @export */ export declare const UserApiAxiosParamCreator: (configuration?: Configuration) => { /** * Removes verification for an eth address for the user (In order to delete verification `signer_uuid` must be approved) * @summary Delete verification * @param {RemoveVerificationReqBody} removeVerificationReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `OperationResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/delete-verification) * */ deleteVerification: (removeVerificationReqBody: RemoveVerificationReqBody, options?: RawAxiosRequestConfig) => Promise; /** * Fetches information about multiple users based on FIDs * @summary By FIDs * @param {string} fids Comma separated list of FIDs, up to 100 at a time * @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 {number} [viewerFid] * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `BulkUsersResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-bulk-users) * */ fetchBulkUsers: (fids: string, xNeynarExperimental?: boolean, viewerFid?: number, options?: RawAxiosRequestConfig) => Promise; /** * Fetches all users based on multiple Ethereum or Solana addresses. Each farcaster user has a custody Ethereum address and optionally verified Ethereum or Solana addresses. This endpoint returns all users that have any of the given addresses as their custody or verified Ethereum or Solana addresses. A custody address can be associated with only 1 farcaster user at a time but a verified address can be associated with multiple users. You can pass in Ethereum and Solana addresses, comma separated, in the same request. The response will contain users associated with the given addresses. * @summary By Eth or Sol addresses * @param {string} addresses Comma separated list of Ethereum or Solana addresses, up to 350 at a time * @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 {Array} [addressTypes] Customize which address types the request should search for. This is a comma-separated string that can include the following values: \'custody_address\' and \'verified_address\'. By default api returns both. To select multiple types, use a comma-separated list of these values. * @param {number} [viewerFid] * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `BulkUsersByAddressResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-bulk-users-by-eth-or-sol-address) * */ fetchBulkUsersByEthOrSolAddress: (addresses: string, xNeynarExperimental?: boolean, addressTypes?: Array, viewerFid?: number, options?: RawAxiosRequestConfig) => Promise; /** * Fetches a list of users given a location * @summary By location * @param {number | null} latitude Latitude of the location * @param {number | null} longitude Longitude of the location * @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 {number} [viewerFid] FID of the user viewing the feed. 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 {string} [cursor] Pagination cursor * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `UsersResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-users-by-location) * */ fetchUsersByLocation: (latitude: number | null, longitude: number | null, xNeynarExperimental?: boolean, viewerFid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) => Promise; /** * Fetch all Ethereum and Solana verified addresses for a Farcaster user. Use this endpoint to identify which wallets are associated with which Farcaster applications for the specified user. * @summary Fetch verifications * @param {number | null} fid FID of the user whose verifications to fetch * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `FetchVerifications200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-verifications) * */ fetchVerifications: (fid: number | null, options?: RawAxiosRequestConfig) => Promise; /** * Follow a user (In order to follow a user `signer_uuid` must be approved) * @summary Follow user * @param {FollowReqBody} followReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `BulkFollowResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/follow-user) * */ followUser: (followReqBody: FollowReqBody, options?: RawAxiosRequestConfig) => Promise; /** * Fetches FID to [assign it to new user](https://docs.neynar.com/reference/register-account). * @summary Fetch fresh FID * @param {string} xWalletId Wallet ID to use for transactions * @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} A promise that resolves to a `UserFIDResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-fresh-account-fid) * */ getFreshAccountFID: (xWalletId: string, xNeynarExperimental?: boolean, options?: RawAxiosRequestConfig) => Promise; /** * Returns the best friends of a user ranked by mutual affinity score based on interactions with each other. * @summary Best friends * @param {number} fid The FID of the user * @param {number} [limit] Number of results to fetch (Default: 3, Maximum: 100) * @param {string} [cursor] Pagination cursor * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `BestFriendsResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-user-best-friends) * */ getUserBestFriends: (fid: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) => Promise; /** * Lookup a user by custody-address * @summary By custody-address * @param {string} custodyAddress Custody Address associated with mnemonic * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `UserResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-user-by-custody-address) * */ lookupUserByCustodyAddress: (custodyAddress: string, options?: RawAxiosRequestConfig) => Promise; /** * Fetches a single hydrated user object given a username * @summary By username * @param {string} username Username of the user to fetch * @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 {number} [viewerFid] * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `UserResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-user-by-username) * */ lookupUserByUsername: (username: string, xNeynarExperimental?: boolean, viewerFid?: number, options?: RawAxiosRequestConfig) => Promise; /** * Fetches the users who have verified the specified X (Twitter) username * @summary By X username * @param {string} xUsername X (Twitter) username to search for, without the @ symbol * @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 {number} [viewerFid] FID of the viewer for contextual information like follows and blocks * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `BulkUsersResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-users-by-x-username) * */ lookupUsersByXUsername: (xUsername: string, xNeynarExperimental?: boolean, viewerFid?: number, options?: RawAxiosRequestConfig) => Promise; /** * Adds verification for an eth address or contract for the user (In order to add verification `signer_uuid` must be approved) * @summary Add verification * @param {AddVerificationReqBody} addVerificationReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `OperationResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/publish-verification) * */ publishVerification: (addVerificationReqBody: AddVerificationReqBody, options?: RawAxiosRequestConfig) => Promise; /** * Register account on farcaster. Optionally provide x-wallet-id header to use your own wallet. **Note:** This API must be called within 10 minutes of the fetch FID API call (i.e., /v2/farcaster/user/fid). Otherwise, Neynar will assign this FID to another available user. * @summary Register new account * @param {string} xWalletId Wallet ID to use for transactions * @param {RegisterUserReqBody} registerUserReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `RegisterUserResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/register-account) * */ registerAccount: (xWalletId: string, registerUserReqBody: RegisterUserReqBody, options?: RawAxiosRequestConfig) => Promise; /** * Search for Usernames * @summary Search for Usernames * @param {string} q * @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 {number} [viewerFid] Providing this will return search results that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {number} [limit] Number of users to fetch (Default: 5, Maximum: 10) * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `UserSearchResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/search-user) * */ searchUser: (q: string, xNeynarExperimental?: boolean, viewerFid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) => Promise; /** * Unfollow a user (In order to unfollow a user `signer_uuid` must be approved) * @summary Unfollow user * @param {FollowReqBody} followReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `BulkFollowResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/unfollow-user) * */ unfollowUser: (followReqBody: FollowReqBody, options?: RawAxiosRequestConfig) => Promise; /** * Update user profile (In order to update user\'s profile `signer_uuid` must be approved) * @summary Update user profile * @param {UpdateUserReqBody} updateUserReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `OperationResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/update-user) * */ updateUser: (updateUserReqBody: UpdateUserReqBody, options?: RawAxiosRequestConfig) => Promise; }; /** * UserApi - functional programming interface * @export */ export declare const UserApiFp: (configuration?: Configuration) => { /** * Removes verification for an eth address for the user (In order to delete verification `signer_uuid` must be approved) * @summary Delete verification * @param {RemoveVerificationReqBody} removeVerificationReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `OperationResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/delete-verification) * */ deleteVerification(removeVerificationReqBody: RemoveVerificationReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetches information about multiple users based on FIDs * @summary By FIDs * @param {string} fids Comma separated list of FIDs, up to 100 at a time * @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 {number} [viewerFid] * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `BulkUsersResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-bulk-users) * */ fetchBulkUsers(fids: string, xNeynarExperimental?: boolean, viewerFid?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetches all users based on multiple Ethereum or Solana addresses. Each farcaster user has a custody Ethereum address and optionally verified Ethereum or Solana addresses. This endpoint returns all users that have any of the given addresses as their custody or verified Ethereum or Solana addresses. A custody address can be associated with only 1 farcaster user at a time but a verified address can be associated with multiple users. You can pass in Ethereum and Solana addresses, comma separated, in the same request. The response will contain users associated with the given addresses. * @summary By Eth or Sol addresses * @param {string} addresses Comma separated list of Ethereum or Solana addresses, up to 350 at a time * @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 {Array} [addressTypes] Customize which address types the request should search for. This is a comma-separated string that can include the following values: \'custody_address\' and \'verified_address\'. By default api returns both. To select multiple types, use a comma-separated list of these values. * @param {number} [viewerFid] * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `BulkUsersByAddressResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-bulk-users-by-eth-or-sol-address) * */ fetchBulkUsersByEthOrSolAddress(addresses: string, xNeynarExperimental?: boolean, addressTypes?: Array, viewerFid?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetches a list of users given a location * @summary By location * @param {number | null} latitude Latitude of the location * @param {number | null} longitude Longitude of the location * @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 {number} [viewerFid] FID of the user viewing the feed. 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 {string} [cursor] Pagination cursor * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `UsersResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-users-by-location) * */ fetchUsersByLocation(latitude: number | null, longitude: number | null, xNeynarExperimental?: boolean, viewerFid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetch all Ethereum and Solana verified addresses for a Farcaster user. Use this endpoint to identify which wallets are associated with which Farcaster applications for the specified user. * @summary Fetch verifications * @param {number | null} fid FID of the user whose verifications to fetch * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `FetchVerifications200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-verifications) * */ fetchVerifications(fid: number | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Follow a user (In order to follow a user `signer_uuid` must be approved) * @summary Follow user * @param {FollowReqBody} followReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `BulkFollowResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/follow-user) * */ followUser(followReqBody: FollowReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetches FID to [assign it to new user](https://docs.neynar.com/reference/register-account). * @summary Fetch fresh FID * @param {string} xWalletId Wallet ID to use for transactions * @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} A promise that resolves to a `UserFIDResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-fresh-account-fid) * */ getFreshAccountFID(xWalletId: string, xNeynarExperimental?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the best friends of a user ranked by mutual affinity score based on interactions with each other. * @summary Best friends * @param {number} fid The FID of the user * @param {number} [limit] Number of results to fetch (Default: 3, Maximum: 100) * @param {string} [cursor] Pagination cursor * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `BestFriendsResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-user-best-friends) * */ getUserBestFriends(fid: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Lookup a user by custody-address * @summary By custody-address * @param {string} custodyAddress Custody Address associated with mnemonic * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `UserResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-user-by-custody-address) * */ lookupUserByCustodyAddress(custodyAddress: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetches a single hydrated user object given a username * @summary By username * @param {string} username Username of the user to fetch * @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 {number} [viewerFid] * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `UserResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-user-by-username) * */ lookupUserByUsername(username: string, xNeynarExperimental?: boolean, viewerFid?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetches the users who have verified the specified X (Twitter) username * @summary By X username * @param {string} xUsername X (Twitter) username to search for, without the @ symbol * @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 {number} [viewerFid] FID of the viewer for contextual information like follows and blocks * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `BulkUsersResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-users-by-x-username) * */ lookupUsersByXUsername(xUsername: string, xNeynarExperimental?: boolean, viewerFid?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Adds verification for an eth address or contract for the user (In order to add verification `signer_uuid` must be approved) * @summary Add verification * @param {AddVerificationReqBody} addVerificationReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `OperationResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/publish-verification) * */ publishVerification(addVerificationReqBody: AddVerificationReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Register account on farcaster. Optionally provide x-wallet-id header to use your own wallet. **Note:** This API must be called within 10 minutes of the fetch FID API call (i.e., /v2/farcaster/user/fid). Otherwise, Neynar will assign this FID to another available user. * @summary Register new account * @param {string} xWalletId Wallet ID to use for transactions * @param {RegisterUserReqBody} registerUserReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `RegisterUserResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/register-account) * */ registerAccount(xWalletId: string, registerUserReqBody: RegisterUserReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Search for Usernames * @summary Search for Usernames * @param {string} q * @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 {number} [viewerFid] Providing this will return search results that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {number} [limit] Number of users to fetch (Default: 5, Maximum: 10) * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `UserSearchResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/search-user) * */ searchUser(q: string, xNeynarExperimental?: boolean, viewerFid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Unfollow a user (In order to unfollow a user `signer_uuid` must be approved) * @summary Unfollow user * @param {FollowReqBody} followReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `BulkFollowResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/unfollow-user) * */ unfollowUser(followReqBody: FollowReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update user profile (In order to update user\'s profile `signer_uuid` must be approved) * @summary Update user profile * @param {UpdateUserReqBody} updateUserReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `OperationResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/update-user) * */ updateUser(updateUserReqBody: UpdateUserReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * UserApi - factory interface * @export */ export declare const UserApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Removes verification for an eth address for the user (In order to delete verification `signer_uuid` must be approved) * @summary Delete verification * @param {UserApiDeleteVerificationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `OperationResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/delete-verification) * */ deleteVerification(requestParameters: UserApiDeleteVerificationRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Fetches information about multiple users based on FIDs * @summary By FIDs * @param {UserApiFetchBulkUsersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `BulkUsersResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-bulk-users) * */ fetchBulkUsers(requestParameters: UserApiFetchBulkUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Fetches all users based on multiple Ethereum or Solana addresses. Each farcaster user has a custody Ethereum address and optionally verified Ethereum or Solana addresses. This endpoint returns all users that have any of the given addresses as their custody or verified Ethereum or Solana addresses. A custody address can be associated with only 1 farcaster user at a time but a verified address can be associated with multiple users. You can pass in Ethereum and Solana addresses, comma separated, in the same request. The response will contain users associated with the given addresses. * @summary By Eth or Sol addresses * @param {UserApiFetchBulkUsersByEthOrSolAddressRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `BulkUsersByAddressResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-bulk-users-by-eth-or-sol-address) * */ fetchBulkUsersByEthOrSolAddress(requestParameters: UserApiFetchBulkUsersByEthOrSolAddressRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Fetches a list of users given a location * @summary By location * @param {UserApiFetchUsersByLocationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `UsersResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-users-by-location) * */ fetchUsersByLocation(requestParameters: UserApiFetchUsersByLocationRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Fetch all Ethereum and Solana verified addresses for a Farcaster user. Use this endpoint to identify which wallets are associated with which Farcaster applications for the specified user. * @summary Fetch verifications * @param {UserApiFetchVerificationsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `FetchVerifications200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-verifications) * */ fetchVerifications(requestParameters: UserApiFetchVerificationsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Follow a user (In order to follow a user `signer_uuid` must be approved) * @summary Follow user * @param {UserApiFollowUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `BulkFollowResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/follow-user) * */ followUser(requestParameters: UserApiFollowUserRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Fetches FID to [assign it to new user](https://docs.neynar.com/reference/register-account). * @summary Fetch fresh FID * @param {UserApiGetFreshAccountFIDRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `UserFIDResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-fresh-account-fid) * */ getFreshAccountFID(requestParameters: UserApiGetFreshAccountFIDRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the best friends of a user ranked by mutual affinity score based on interactions with each other. * @summary Best friends * @param {UserApiGetUserBestFriendsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `BestFriendsResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-user-best-friends) * */ getUserBestFriends(requestParameters: UserApiGetUserBestFriendsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Lookup a user by custody-address * @summary By custody-address * @param {UserApiLookupUserByCustodyAddressRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `UserResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-user-by-custody-address) * */ lookupUserByCustodyAddress(requestParameters: UserApiLookupUserByCustodyAddressRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Fetches a single hydrated user object given a username * @summary By username * @param {UserApiLookupUserByUsernameRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `UserResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-user-by-username) * */ lookupUserByUsername(requestParameters: UserApiLookupUserByUsernameRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Fetches the users who have verified the specified X (Twitter) username * @summary By X username * @param {UserApiLookupUsersByXUsernameRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `BulkUsersResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-users-by-x-username) * */ lookupUsersByXUsername(requestParameters: UserApiLookupUsersByXUsernameRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Adds verification for an eth address or contract for the user (In order to add verification `signer_uuid` must be approved) * @summary Add verification * @param {UserApiPublishVerificationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `OperationResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/publish-verification) * */ publishVerification(requestParameters: UserApiPublishVerificationRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Register account on farcaster. Optionally provide x-wallet-id header to use your own wallet. **Note:** This API must be called within 10 minutes of the fetch FID API call (i.e., /v2/farcaster/user/fid). Otherwise, Neynar will assign this FID to another available user. * @summary Register new account * @param {UserApiRegisterAccountRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `RegisterUserResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/register-account) * */ registerAccount(requestParameters: UserApiRegisterAccountRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Search for Usernames * @summary Search for Usernames * @param {UserApiSearchUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `UserSearchResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/search-user) * */ searchUser(requestParameters: UserApiSearchUserRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Unfollow a user (In order to unfollow a user `signer_uuid` must be approved) * @summary Unfollow user * @param {UserApiUnfollowUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `BulkFollowResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/unfollow-user) * */ unfollowUser(requestParameters: UserApiUnfollowUserRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Update user profile (In order to update user\'s profile `signer_uuid` must be approved) * @summary Update user profile * @param {UserApiUpdateUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `OperationResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/update-user) * */ updateUser(requestParameters: UserApiUpdateUserRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * UserApi - interface * @export * @interface UserApi */ export interface UserApiInterface { /** * Removes verification for an eth address for the user (In order to delete verification `signer_uuid` must be approved) * @summary Delete verification * @param {UserApiDeleteVerificationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApiInterface * @returns {Promise} A promise that resolves to a `OperationResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/delete-verification) * */ deleteVerification(requestParameters: UserApiDeleteVerificationRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Fetches information about multiple users based on FIDs * @summary By FIDs * @param {UserApiFetchBulkUsersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApiInterface * @returns {Promise} A promise that resolves to a `BulkUsersResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-bulk-users) * */ fetchBulkUsers(requestParameters: UserApiFetchBulkUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Fetches all users based on multiple Ethereum or Solana addresses. Each farcaster user has a custody Ethereum address and optionally verified Ethereum or Solana addresses. This endpoint returns all users that have any of the given addresses as their custody or verified Ethereum or Solana addresses. A custody address can be associated with only 1 farcaster user at a time but a verified address can be associated with multiple users. You can pass in Ethereum and Solana addresses, comma separated, in the same request. The response will contain users associated with the given addresses. * @summary By Eth or Sol addresses * @param {UserApiFetchBulkUsersByEthOrSolAddressRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApiInterface * @returns {Promise} A promise that resolves to a `BulkUsersByAddressResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-bulk-users-by-eth-or-sol-address) * */ fetchBulkUsersByEthOrSolAddress(requestParameters: UserApiFetchBulkUsersByEthOrSolAddressRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Fetches a list of users given a location * @summary By location * @param {UserApiFetchUsersByLocationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApiInterface * @returns {Promise} A promise that resolves to a `UsersResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-users-by-location) * */ fetchUsersByLocation(requestParameters: UserApiFetchUsersByLocationRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Fetch all Ethereum and Solana verified addresses for a Farcaster user. Use this endpoint to identify which wallets are associated with which Farcaster applications for the specified user. * @summary Fetch verifications * @param {UserApiFetchVerificationsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApiInterface * @returns {Promise} A promise that resolves to a `FetchVerifications200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-verifications) * */ fetchVerifications(requestParameters: UserApiFetchVerificationsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Follow a user (In order to follow a user `signer_uuid` must be approved) * @summary Follow user * @param {UserApiFollowUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApiInterface * @returns {Promise} A promise that resolves to a `BulkFollowResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/follow-user) * */ followUser(requestParameters: UserApiFollowUserRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Fetches FID to [assign it to new user](https://docs.neynar.com/reference/register-account). * @summary Fetch fresh FID * @param {UserApiGetFreshAccountFIDRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApiInterface * @returns {Promise} A promise that resolves to a `UserFIDResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-fresh-account-fid) * */ getFreshAccountFID(requestParameters: UserApiGetFreshAccountFIDRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the best friends of a user ranked by mutual affinity score based on interactions with each other. * @summary Best friends * @param {UserApiGetUserBestFriendsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApiInterface * @returns {Promise} A promise that resolves to a `BestFriendsResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-user-best-friends) * */ getUserBestFriends(requestParameters: UserApiGetUserBestFriendsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Lookup a user by custody-address * @summary By custody-address * @param {UserApiLookupUserByCustodyAddressRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApiInterface * @returns {Promise} A promise that resolves to a `UserResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-user-by-custody-address) * */ lookupUserByCustodyAddress(requestParameters: UserApiLookupUserByCustodyAddressRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Fetches a single hydrated user object given a username * @summary By username * @param {UserApiLookupUserByUsernameRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApiInterface * @returns {Promise} A promise that resolves to a `UserResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-user-by-username) * */ lookupUserByUsername(requestParameters: UserApiLookupUserByUsernameRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Fetches the users who have verified the specified X (Twitter) username * @summary By X username * @param {UserApiLookupUsersByXUsernameRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApiInterface * @returns {Promise} A promise that resolves to a `BulkUsersResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-users-by-x-username) * */ lookupUsersByXUsername(requestParameters: UserApiLookupUsersByXUsernameRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Adds verification for an eth address or contract for the user (In order to add verification `signer_uuid` must be approved) * @summary Add verification * @param {UserApiPublishVerificationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApiInterface * @returns {Promise} A promise that resolves to a `OperationResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/publish-verification) * */ publishVerification(requestParameters: UserApiPublishVerificationRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Register account on farcaster. Optionally provide x-wallet-id header to use your own wallet. **Note:** This API must be called within 10 minutes of the fetch FID API call (i.e., /v2/farcaster/user/fid). Otherwise, Neynar will assign this FID to another available user. * @summary Register new account * @param {UserApiRegisterAccountRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApiInterface * @returns {Promise} A promise that resolves to a `RegisterUserResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/register-account) * */ registerAccount(requestParameters: UserApiRegisterAccountRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Search for Usernames * @summary Search for Usernames * @param {UserApiSearchUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApiInterface * @returns {Promise} A promise that resolves to a `UserSearchResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/search-user) * */ searchUser(requestParameters: UserApiSearchUserRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Unfollow a user (In order to unfollow a user `signer_uuid` must be approved) * @summary Unfollow user * @param {UserApiUnfollowUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApiInterface * @returns {Promise} A promise that resolves to a `BulkFollowResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/unfollow-user) * */ unfollowUser(requestParameters: UserApiUnfollowUserRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Update user profile (In order to update user\'s profile `signer_uuid` must be approved) * @summary Update user profile * @param {UserApiUpdateUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApiInterface * @returns {Promise} A promise that resolves to a `OperationResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/update-user) * */ updateUser(requestParameters: UserApiUpdateUserRequest, options?: RawAxiosRequestConfig): AxiosPromise; } /** * Request parameters for deleteVerification operation in UserApi. * @export * @interface UserApiDeleteVerificationRequest */ export interface UserApiDeleteVerificationRequest { /** * * * * * @type {RemoveVerificationReqBody} * @memberof UserApiDeleteVerification */ readonly removeVerificationReqBody: RemoveVerificationReqBody; } /** * Request parameters for fetchBulkUsers operation in UserApi. * @export * @interface UserApiFetchBulkUsersRequest */ export interface UserApiFetchBulkUsersRequest { /** * Comma separated list of FIDs, up to 100 at a time * @acceptAs integer * @commaSeparated * * @type {string} * @memberof UserApiFetchBulkUsers */ readonly fids: 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 UserApiFetchBulkUsers */ readonly xNeynarExperimental?: boolean; /** * * * * * @type {number} * @memberof UserApiFetchBulkUsers */ readonly viewerFid?: number; } /** * Request parameters for fetchBulkUsersByEthOrSolAddress operation in UserApi. * @export * @interface UserApiFetchBulkUsersByEthOrSolAddressRequest */ export interface UserApiFetchBulkUsersByEthOrSolAddressRequest { /** * Comma separated list of Ethereum or Solana addresses, up to 350 at a time * * @commaSeparated * * @type {string} * @memberof UserApiFetchBulkUsersByEthOrSolAddress */ readonly addresses: 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 UserApiFetchBulkUsersByEthOrSolAddress */ readonly xNeynarExperimental?: boolean; /** * Customize which address types the request should search for. This is a comma-separated string that can include the following values: \'custody_address\' and \'verified_address\'. By default api returns both. To select multiple types, use a comma-separated list of these values. * * * * @type {Array<'custody_address' | 'verified_address'>} * @memberof UserApiFetchBulkUsersByEthOrSolAddress */ readonly addressTypes?: Array; /** * * * * * @type {number} * @memberof UserApiFetchBulkUsersByEthOrSolAddress */ readonly viewerFid?: number; } /** * Request parameters for fetchUsersByLocation operation in UserApi. * @export * @interface UserApiFetchUsersByLocationRequest */ export interface UserApiFetchUsersByLocationRequest { /** * Latitude of the location * * * * @type {number} * @memberof UserApiFetchUsersByLocation */ readonly latitude: number | null; /** * Longitude of the location * * * * @type {number} * @memberof UserApiFetchUsersByLocation */ readonly longitude: number | null; /** * 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 UserApiFetchUsersByLocation */ readonly xNeynarExperimental?: boolean; /** * FID of the user viewing the feed. Providing this will return a list of users that respects this user\'s mutes and blocks and includes `viewer_context`. * * * * @type {number} * @memberof UserApiFetchUsersByLocation */ readonly viewerFid?: number; /** * Number of results to fetch (Default: 25, Maximum: 100) * * * * @type {number} * @memberof UserApiFetchUsersByLocation */ readonly limit?: number; /** * Pagination cursor * * * * @type {string} * @memberof UserApiFetchUsersByLocation */ readonly cursor?: string; } /** * Request parameters for fetchVerifications operation in UserApi. * @export * @interface UserApiFetchVerificationsRequest */ export interface UserApiFetchVerificationsRequest { /** * FID of the user whose verifications to fetch * * * * @type {number} * @memberof UserApiFetchVerifications */ readonly fid: number | null; } /** * Request parameters for followUser operation in UserApi. * @export * @interface UserApiFollowUserRequest */ export interface UserApiFollowUserRequest { /** * * * * * @type {FollowReqBody} * @memberof UserApiFollowUser */ readonly followReqBody: FollowReqBody; } /** * Request parameters for getFreshAccountFID operation in UserApi. * @export * @interface UserApiGetFreshAccountFIDRequest */ export interface UserApiGetFreshAccountFIDRequest { /** * Wallet ID to use for transactions * * * @globalHeader * @type {string} * @memberof UserApiGetFreshAccountFID */ readonly xWalletId: 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 UserApiGetFreshAccountFID */ readonly xNeynarExperimental?: boolean; } /** * Request parameters for getUserBestFriends operation in UserApi. * @export * @interface UserApiGetUserBestFriendsRequest */ export interface UserApiGetUserBestFriendsRequest { /** * The FID of the user * * * * @type {number} * @memberof UserApiGetUserBestFriends */ readonly fid: number; /** * Number of results to fetch (Default: 3, Maximum: 100) * * * * @type {number} * @memberof UserApiGetUserBestFriends */ readonly limit?: number; /** * Pagination cursor * * * * @type {string} * @memberof UserApiGetUserBestFriends */ readonly cursor?: string; } /** * Request parameters for lookupUserByCustodyAddress operation in UserApi. * @export * @interface UserApiLookupUserByCustodyAddressRequest */ export interface UserApiLookupUserByCustodyAddressRequest { /** * Custody Address associated with mnemonic * * * * @type {string} * @memberof UserApiLookupUserByCustodyAddress */ readonly custodyAddress: string; } /** * Request parameters for lookupUserByUsername operation in UserApi. * @export * @interface UserApiLookupUserByUsernameRequest */ export interface UserApiLookupUserByUsernameRequest { /** * Username of the user to fetch * * * * @type {string} * @memberof UserApiLookupUserByUsername */ readonly username: 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 UserApiLookupUserByUsername */ readonly xNeynarExperimental?: boolean; /** * * * * * @type {number} * @memberof UserApiLookupUserByUsername */ readonly viewerFid?: number; } /** * Request parameters for lookupUsersByXUsername operation in UserApi. * @export * @interface UserApiLookupUsersByXUsernameRequest */ export interface UserApiLookupUsersByXUsernameRequest { /** * X (Twitter) username to search for, without the @ symbol * * * * @type {string} * @memberof UserApiLookupUsersByXUsername */ readonly xUsername: 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 UserApiLookupUsersByXUsername */ readonly xNeynarExperimental?: boolean; /** * FID of the viewer for contextual information like follows and blocks * * * * @type {number} * @memberof UserApiLookupUsersByXUsername */ readonly viewerFid?: number; } /** * Request parameters for publishVerification operation in UserApi. * @export * @interface UserApiPublishVerificationRequest */ export interface UserApiPublishVerificationRequest { /** * * * * * @type {AddVerificationReqBody} * @memberof UserApiPublishVerification */ readonly addVerificationReqBody: AddVerificationReqBody; } /** * Request parameters for registerAccount operation in UserApi. * @export * @interface UserApiRegisterAccountRequest */ export interface UserApiRegisterAccountRequest { /** * Wallet ID to use for transactions * * * @globalHeader * @type {string} * @memberof UserApiRegisterAccount */ readonly xWalletId: string; /** * * * * * @type {RegisterUserReqBody} * @memberof UserApiRegisterAccount */ readonly registerUserReqBody: RegisterUserReqBody; } /** * Request parameters for searchUser operation in UserApi. * @export * @interface UserApiSearchUserRequest */ export interface UserApiSearchUserRequest { /** * * * * * @type {string} * @memberof UserApiSearchUser */ readonly q: 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 UserApiSearchUser */ readonly xNeynarExperimental?: boolean; /** * Providing this will return search results that respects this user\'s mutes and blocks and includes `viewer_context`. * * * * @type {number} * @memberof UserApiSearchUser */ readonly viewerFid?: number; /** * Number of users to fetch (Default: 5, Maximum: 10) * * * * @type {number} * @memberof UserApiSearchUser */ readonly limit?: number; /** * Pagination cursor. * * * * @type {string} * @memberof UserApiSearchUser */ readonly cursor?: string; } /** * Request parameters for unfollowUser operation in UserApi. * @export * @interface UserApiUnfollowUserRequest */ export interface UserApiUnfollowUserRequest { /** * * * * * @type {FollowReqBody} * @memberof UserApiUnfollowUser */ readonly followReqBody: FollowReqBody; } /** * Request parameters for updateUser operation in UserApi. * @export * @interface UserApiUpdateUserRequest */ export interface UserApiUpdateUserRequest { /** * * * * * @type {UpdateUserReqBody} * @memberof UserApiUpdateUser */ readonly updateUserReqBody: UpdateUserReqBody; } /** * UserApi - object-oriented interface * @export * @class UserApi * @extends {BaseAPI} */ export declare class UserApi extends BaseAPI implements UserApiInterface { /** * Removes verification for an eth address for the user (In order to delete verification `signer_uuid` must be approved) * @summary Delete verification * @param {UserApiDeleteVerificationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi * @returns {Promise} A promise that resolves to a `OperationResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/delete-verification) * */ deleteVerification(requestParameters: UserApiDeleteVerificationRequest, options?: RawAxiosRequestConfig): Promise>; /** * Fetches information about multiple users based on FIDs * @summary By FIDs * @param {UserApiFetchBulkUsersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi * @returns {Promise} A promise that resolves to a `BulkUsersResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-bulk-users) * */ fetchBulkUsers(requestParameters: UserApiFetchBulkUsersRequest, options?: RawAxiosRequestConfig): Promise>; /** * Fetches all users based on multiple Ethereum or Solana addresses. Each farcaster user has a custody Ethereum address and optionally verified Ethereum or Solana addresses. This endpoint returns all users that have any of the given addresses as their custody or verified Ethereum or Solana addresses. A custody address can be associated with only 1 farcaster user at a time but a verified address can be associated with multiple users. You can pass in Ethereum and Solana addresses, comma separated, in the same request. The response will contain users associated with the given addresses. * @summary By Eth or Sol addresses * @param {UserApiFetchBulkUsersByEthOrSolAddressRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi * @returns {Promise} A promise that resolves to a `BulkUsersByAddressResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-bulk-users-by-eth-or-sol-address) * */ fetchBulkUsersByEthOrSolAddress(requestParameters: UserApiFetchBulkUsersByEthOrSolAddressRequest, options?: RawAxiosRequestConfig): Promise>; /** * Fetches a list of users given a location * @summary By location * @param {UserApiFetchUsersByLocationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi * @returns {Promise} A promise that resolves to a `UsersResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-users-by-location) * */ fetchUsersByLocation(requestParameters: UserApiFetchUsersByLocationRequest, options?: RawAxiosRequestConfig): Promise>; /** * Fetch all Ethereum and Solana verified addresses for a Farcaster user. Use this endpoint to identify which wallets are associated with which Farcaster applications for the specified user. * @summary Fetch verifications * @param {UserApiFetchVerificationsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi * @returns {Promise} A promise that resolves to a `FetchVerifications200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-verifications) * */ fetchVerifications(requestParameters: UserApiFetchVerificationsRequest, options?: RawAxiosRequestConfig): Promise>; /** * Follow a user (In order to follow a user `signer_uuid` must be approved) * @summary Follow user * @param {UserApiFollowUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi * @returns {Promise} A promise that resolves to a `BulkFollowResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/follow-user) * */ followUser(requestParameters: UserApiFollowUserRequest, options?: RawAxiosRequestConfig): Promise>; /** * Fetches FID to [assign it to new user](https://docs.neynar.com/reference/register-account). * @summary Fetch fresh FID * @param {UserApiGetFreshAccountFIDRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi * @returns {Promise} A promise that resolves to a `UserFIDResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-fresh-account-fid) * */ getFreshAccountFID(requestParameters: UserApiGetFreshAccountFIDRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns the best friends of a user ranked by mutual affinity score based on interactions with each other. * @summary Best friends * @param {UserApiGetUserBestFriendsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi * @returns {Promise} A promise that resolves to a `BestFriendsResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-user-best-friends) * */ getUserBestFriends(requestParameters: UserApiGetUserBestFriendsRequest, options?: RawAxiosRequestConfig): Promise>; /** * Lookup a user by custody-address * @summary By custody-address * @param {UserApiLookupUserByCustodyAddressRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi * @returns {Promise} A promise that resolves to a `UserResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-user-by-custody-address) * */ lookupUserByCustodyAddress(requestParameters: UserApiLookupUserByCustodyAddressRequest, options?: RawAxiosRequestConfig): Promise>; /** * Fetches a single hydrated user object given a username * @summary By username * @param {UserApiLookupUserByUsernameRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi * @returns {Promise} A promise that resolves to a `UserResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-user-by-username) * */ lookupUserByUsername(requestParameters: UserApiLookupUserByUsernameRequest, options?: RawAxiosRequestConfig): Promise>; /** * Fetches the users who have verified the specified X (Twitter) username * @summary By X username * @param {UserApiLookupUsersByXUsernameRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi * @returns {Promise} A promise that resolves to a `BulkUsersResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-users-by-x-username) * */ lookupUsersByXUsername(requestParameters: UserApiLookupUsersByXUsernameRequest, options?: RawAxiosRequestConfig): Promise>; /** * Adds verification for an eth address or contract for the user (In order to add verification `signer_uuid` must be approved) * @summary Add verification * @param {UserApiPublishVerificationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi * @returns {Promise} A promise that resolves to a `OperationResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/publish-verification) * */ publishVerification(requestParameters: UserApiPublishVerificationRequest, options?: RawAxiosRequestConfig): Promise>; /** * Register account on farcaster. Optionally provide x-wallet-id header to use your own wallet. **Note:** This API must be called within 10 minutes of the fetch FID API call (i.e., /v2/farcaster/user/fid). Otherwise, Neynar will assign this FID to another available user. * @summary Register new account * @param {UserApiRegisterAccountRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi * @returns {Promise} A promise that resolves to a `RegisterUserResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/register-account) * */ registerAccount(requestParameters: UserApiRegisterAccountRequest, options?: RawAxiosRequestConfig): Promise>; /** * Search for Usernames * @summary Search for Usernames * @param {UserApiSearchUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi * @returns {Promise} A promise that resolves to a `UserSearchResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/search-user) * */ searchUser(requestParameters: UserApiSearchUserRequest, options?: RawAxiosRequestConfig): Promise>; /** * Unfollow a user (In order to unfollow a user `signer_uuid` must be approved) * @summary Unfollow user * @param {UserApiUnfollowUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi * @returns {Promise} A promise that resolves to a `BulkFollowResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/unfollow-user) * */ unfollowUser(requestParameters: UserApiUnfollowUserRequest, options?: RawAxiosRequestConfig): Promise>; /** * Update user profile (In order to update user\'s profile `signer_uuid` must be approved) * @summary Update user profile * @param {UserApiUpdateUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi * @returns {Promise} A promise that resolves to a `OperationResponse` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/update-user) * */ updateUser(requestParameters: UserApiUpdateUserRequest, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const FetchBulkUsersByEthOrSolAddressAddressTypesEnum: { readonly CustodyAddress: "custody_address"; readonly VerifiedAddress: "verified_address"; }; export type FetchBulkUsersByEthOrSolAddressAddressTypesEnum = typeof FetchBulkUsersByEthOrSolAddressAddressTypesEnum[keyof typeof FetchBulkUsersByEthOrSolAddressAddressTypesEnum];