twitter-api-client/dist/interfaces/params/WelcomeMessagesParams.d.ts

Node.js / JavaScript client for Twitter API

export interface WelcomeMessagesRulesShowParams {
    /**
    * The id of the Welcome Message Rule that should be returned.
    */
    'id': string;
}
export interface WelcomeMessagesShowParams {
    /**
    * The id of the Welcome Message that should be returned.
    */
    'id': string;
}
export interface WelcomeMessagesNewParams {
    /**
    * The Message Data Object defining the content of the message template.
  See POST direct_messages/events/new (message_create) for Message Data object
  details.
  
    */
    'welcome_message': {
        message_data: {
            text: string;
            quick_reply?: {
                type: string[];
            };
            attachment?: {
                type: string;
                media: {
                    id: string;
                };
            };
        };
        name?: string;
    };
    /**
    * A human readable name for the Welcome Message. This is not displayed
  to the user. Max length of 100 alpha numeric characters including hyphens,
  underscores, spaces, hashes and at signs.
  
    */
    'name'?: string;
}
export interface WelcomeMessagesRulesNewParams {
    /**
    * The rule to be triggered
    */
    'welcome_message_rule': {
        welcome_message_id: string;
    };
}
export interface WelcomeMessagesListParams {
    /**
    * Number of welcome messages to be returned. Max of 50. Default is 20.
    */
    'count'?: string | number;
    /**
    * For paging through result sets greater than 1 page, use the “next_cursor” property from the previous request.
    */
    'cursor'?: string;
}
export interface WelcomeMessagesDestroyParams {
    /**
    * The id of the Welcome Message that should be deleted.
    */
    'id': string;
}
export interface WelcomeMessagesRulesDestroyParams {
    /**
    * The id of the Welcome Message Rule that should be deleted.
    */
    'id': string;
}