@neynar/nodejs-sdk/build/api/models/cast.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 { CastEmbeddedParentAuthor } from './cast-embedded-parent-author';
import type { CastNotificationType } from './cast-notification-type';
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 { Frame } from './frame';
import type { TextRange } from './text-range';
import type { User } from './user';
import type { UserDehydrated } from './user-dehydrated';
/**
 *
 * @export
 * @interface Cast
 */
export interface Cast {
    /**
     *
     * @type {string}
     * @memberof Cast
     */
    'object': CastObjectEnum;
    /**
     *
     * @type {string}
     * @memberof Cast
     */
    'hash': string;
    /**
     *
     * @type {string}
     * @memberof Cast
     */
    'parent_hash': string | null;
    /**
     *
     * @type {string}
     * @memberof Cast
     */
    'parent_url': string | null;
    /**
     *
     * @type {string}
     * @memberof Cast
     */
    'root_parent_url': string | null;
    /**
     *
     * @type {CastEmbeddedParentAuthor}
     * @memberof Cast
     */
    'parent_author': CastEmbeddedParentAuthor;
    /**
     *
     * @type {User}
     * @memberof Cast
     */
    'author': User;
    /**
     *
     * @type {UserDehydrated}
     * @memberof Cast
     */
    'app'?: UserDehydrated | null;
    /**
     *
     * @type {string}
     * @memberof Cast
     */
    'text': string;
    /**
     *
     * @type {string}
     * @memberof Cast
     */
    'timestamp': string;
    /**
     *
     * @type {Array<Embed>}
     * @memberof Cast
     */
    'embeds': Array<Embed>;
    /**
     *
     * @type {CastNotificationType}
     * @memberof Cast
     */
    'type'?: CastNotificationType;
    /**
     *
     * @type {Array<Frame>}
     * @memberof Cast
     */
    'frames'?: Array<Frame>;
    /**
     *
     * @type {CastReactions}
     * @memberof Cast
     */
    'reactions': CastReactions;
    /**
     *
     * @type {CastReplies}
     * @memberof Cast
     */
    'replies': CastReplies;
    /**
     *
     * @type {string}
     * @memberof Cast
     */
    'thread_hash': string | null;
    /**
     *
     * @type {Array<User>}
     * @memberof Cast
     */
    '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.
     * @type {Array<TextRange>}
     * @memberof Cast
     */
    'mentioned_profiles_ranges': Array<TextRange>;
    /**
     *
     * @type {Array<ChannelDehydrated>}
     * @memberof Cast
     */
    '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.
     * @type {Array<TextRange>}
     * @memberof Cast
     */
    'mentioned_channels_ranges': Array<TextRange>;
    /**
     *
     * @type {ChannelOrChannelDehydrated}
     * @memberof Cast
     */
    'channel': ChannelOrChannelDehydrated | null;
    /**
     *
     * @type {CastViewerContext}
     * @memberof Cast
     */
    'viewer_context'?: CastViewerContext;
    /**
     *
     * @type {ChannelUserContext}
     * @memberof Cast
     */
    'author_channel_context'?: ChannelUserContext;
}
export declare const CastObjectEnum: {
    readonly Cast: "cast";
};
export type CastObjectEnum = typeof CastObjectEnum[keyof typeof CastObjectEnum];