@neynar/nodejs-sdk
Version:
SDK to interact with Neynar APIs (https://docs.neynar.com/reference/quickstart)
65 lines (64 loc) • 2.86 kB
TypeScript
/**
* 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.175.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 { CastNotificationType } from './cast-notification-type';
import type { CastParentAuthor } from './cast-parent-author';
import type { CastReactions } from './cast-reactions';
import type { CastReplies } from './cast-replies';
import type { CastViewerContext } from './cast-viewer-context';
import type { ChannelDehydrated } from './channel-dehydrated';
import type { ChannelOrChannelDehydrated } from './channel-or-channel-dehydrated';
import type { ChannelUserContext } from './channel-user-context';
import type { Embed } from './embed';
import type { TextRange } from './text-range';
import type { User } from './user';
import type { UserDehydrated } from './user-dehydrated';
/**
* Reference to CastAndConversations to avoid circular reference
*/
export interface CastAndConversationsRef {
'app'?: UserDehydrated | null;
'author': User;
'author_channel_context'?: ChannelUserContext;
'channel': ChannelOrChannelDehydrated | null;
/**
* note: This is recursive. It contains the direct replies to the cast and their direct replies up to n reply_depth.
*/
'direct_replies': Array<object>;
'embeds': Array<Embed>;
'hash': string;
'mentioned_channels': Array<ChannelDehydrated>;
/**
* Positions within the text (inclusive start, exclusive end) where each mention occurs. Each index within this list corresponds to the same-numbered index in the mentioned_channels list.
*/
'mentioned_channels_ranges': Array<TextRange>;
'mentioned_profiles': Array<User>;
/**
* Positions within the text (inclusive start, exclusive end) where each mention occurs. Each index within this list corresponds to the same-numbered index in the mentioned_profiles list.
*/
'mentioned_profiles_ranges': Array<TextRange>;
'object': CastAndConversationsRefObjectEnum;
'parent_author': CastParentAuthor;
'parent_hash': string | null;
'parent_url': string | null;
'reactions': CastReactions;
'replies': CastReplies;
'root_parent_url': string | null;
'text': string;
'thread_hash': string | null;
'timestamp': string;
'type'?: CastNotificationType;
'viewer_context'?: CastViewerContext;
}
export declare const CastAndConversationsRefObjectEnum: {
readonly Cast: "cast";
};
export type CastAndConversationsRefObjectEnum = typeof CastAndConversationsRefObjectEnum[keyof typeof CastAndConversationsRefObjectEnum];