@neynar/nodejs-sdk
Version:
SDK to interact with Neynar APIs (https://docs.neynar.com/reference/quickstart)
124 lines (123 loc) • 2.99 kB
TypeScript
/**
* Farcaster API V2
* The Farcaster API allows you to interact with the Farcaster protocol. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
*
* The version of the OpenAPI document: 2.46.0
* Contact: team@neynar.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import type { UserExperimental } from './user-experimental';
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;
/**
* 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 {UserVerifiedAddresses}
* @memberof User
*/
'verified_addresses': UserVerifiedAddresses;
/**
* Verified accounts of the user on other platforms, currently only X is supported.
* @type {Array<UserVerifiedAccountsInner>}
* @memberof User
*/
'verified_accounts': Array<UserVerifiedAccountsInner>;
/**
*
* @type {boolean}
* @memberof User
*/
'power_badge': boolean;
/**
*
* @type {UserExperimental}
* @memberof User
*/
'experimental'?: UserExperimental;
/**
* Score that represents the probability that the account is not spam.
* @type {number}
* @memberof User
*/
'score': number;
/**
*
* @type {UserViewerContext}
* @memberof User
*/
'viewer_context'?: UserViewerContext;
}
export declare const UserObjectEnum: {
readonly User: "user";
};
export type UserObjectEnum = typeof UserObjectEnum[keyof typeof UserObjectEnum];