@neynar/nodejs-sdk/build/api/models/user.d.ts

SDK to interact with Neynar APIs (https://docs.neynar.com/reference/quickstart)

/**
 * 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.34.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 { UserAuthAddressesInner } from './user-auth-addresses-inner';
import type { UserExperimental } from './user-experimental';
import type { UserPro } from './user-pro';
import type { UserProfile } from './user-profile';
import type { UserVerifiedAccountsInner } from './user-verified-accounts-inner';
import type { UserVerifiedAddresses } from './user-verified-addresses';
import type { UserViewerContext } from './user-viewer-context';
/**
 *
 * @export
 * @interface User
 */
export interface User {
    /**
     *
     * @type {string}
     * @memberof User
     */
    'object': UserObjectEnum;
    /**
     * The unique identifier of a farcaster user or app (unsigned integer)
     * @type {number}
     * @memberof User
     */
    'fid': number;
    /**
     *
     * @type {string}
     * @memberof User
     */
    'username': string;
    /**
     *
     * @type {string}
     * @memberof User
     */
    'display_name'?: string;
    /**
     * Ethereum address
     * @type {string}
     * @memberof User
     */
    'custody_address': string;
    /**
     *
     * @type {UserPro}
     * @memberof User
     */
    'pro'?: UserPro;
    /**
     * The URL of the user\'s profile picture
     * @type {string}
     * @memberof User
     */
    'pfp_url'?: string;
    /**
     *
     * @type {UserProfile}
     * @memberof User
     */
    'profile': UserProfile;
    /**
     * The number of followers the user has.
     * @type {number}
     * @memberof User
     */
    'follower_count': number;
    /**
     * The number of users the user is following.
     * @type {number}
     * @memberof User
     */
    'following_count': number;
    /**
     *
     * @type {Array<string>}
     * @memberof User
     */
    'verifications': Array<string>;
    /**
     *
     * @type {Array<UserAuthAddressesInner>}
     * @memberof User
     */
    'auth_addresses': Array<UserAuthAddressesInner>;
    /**
     *
     * @type {UserVerifiedAddresses}
     * @memberof User
     */
    'verified_addresses': UserVerifiedAddresses;
    /**
     *
     * @type {Array<UserVerifiedAccountsInner>}
     * @memberof User
     */
    'verified_accounts': Array<UserVerifiedAccountsInner>;
    /**
     *
     * @type {boolean}
     * @memberof User
     */
    'power_badge': boolean;
    /**
     *
     * @type {UserExperimental}
     * @memberof User
     */
    'experimental'?: UserExperimental;
    /**
     *
     * @type {UserViewerContext}
     * @memberof User
     */
    'viewer_context'?: UserViewerContext;
    /**
     * Score that represents the probability that the account is not spam.
     * @type {number}
     * @memberof User
     */
    'score'?: number;
}
export declare const UserObjectEnum: {
    readonly User: "user";
};
export type UserObjectEnum = typeof UserObjectEnum[keyof typeof UserObjectEnum];