trysoftwacloudapi/dist/messages.types.d.ts

TrySoft Whatsapp Cloud Api Wrapper

import type { RequireAtLeastOne } from 'type-fest';
interface Message {
    messaging_product: 'whatsapp';
    recipient_type: 'individual';
    to: string;
    context?: {
        message_id?: string;
    };
}
export interface MarkRead {
    messaging_product: 'whatsapp';
    status: 'read';
    message_id: string;
    typing_indicator: {
        "type": "text";
    };
}
interface ContactName {
    first_name?: string;
    last_name?: string;
    middle_name?: string;
    suffix?: string;
    prefix?: string;
}
export interface Contact {
    addresses?: {
        street?: string;
        city?: string;
        state?: string;
        zip?: string;
        country?: string;
        country_code?: string;
        type?: 'HOME' | 'WORK';
    }[];
    birthday?: string;
    emails?: {
        email?: string;
        type: 'HOME' | 'WORK';
    }[];
    name: {
        formatted_name: string;
    } & RequireAtLeastOne<ContactName, 'first_name' | 'last_name' | 'middle_name' | 'prefix' | 'suffix'>;
    org?: {
        company?: string;
        department?: string;
        title?: string;
    };
    phones?: {
        phone?: string;
        type?: 'CELL' | 'MAIN' | 'IPHONE' | 'HOME' | 'WORK';
        wa_id?: string;
    }[];
    urls?: {
        url?: string;
        type?: 'HOME' | 'WORK';
    }[];
}
interface InteractiveHeaderText {
    type: 'text';
    text: string;
}
interface InteractiveHeaderVideo {
    type: 'video';
    video: Media;
}
interface InteractiveHeaderImage {
    type: 'image';
    image: Media;
}
interface InteractiveHeaderDocument {
    type: 'document';
    document: Media;
}
interface InteractiveHeaderLocation {
    type: 'location';
    document: Location;
}
export type InteractiveHeader = InteractiveHeaderText | InteractiveHeaderVideo | InteractiveHeaderImage | InteractiveHeaderDocument | InteractiveHeaderLocation;
export interface InteractiveBase {
    body: {
        text: string;
    };
    footer?: {
        text: string;
    };
    header?: InteractiveHeader;
}
export interface InteractiveReplyButton {
    type: 'button';
    action: {
        buttons: {
            type: 'reply';
            reply: {
                title: string | number;
                id: string;
            };
        }[];
    };
}
export interface InteractiveFlowMessage {
    type: 'flow';
    action: {
        name: "flow";
        parameters: {
            flow_message_version: "3";
            flow_token: string;
            flow_id: string;
            flow_cta: string;
            flow_action: "navigate";
            flow_action_payload: {
                screen?: string;
                data?: object;
            };
        };
    };
}
export interface InteractiveLocationRequestMessage {
    type: 'location_request_message';
    action: {
        name: "send_location";
    };
}
export interface InteractiveListMessage {
    type: 'list';
    action: {
        button: string;
        sections: {
            title: string;
            rows: {
                id: string | number;
                title: string | number;
                description?: string;
            }[];
        }[];
    };
}
type Interactive = InteractiveBase & (InteractiveReplyButton | InteractiveFlowMessage | InteractiveLocationRequestMessage | InteractiveListMessage);
export interface Location {
    longitude: number;
    latitude: number;
    name?: string;
    address?: string;
}
export interface MediaWithId {
    id: string;
}
export interface MediaWithLink {
    link: string;
}
export interface MediaBase {
    caption?: string;
    filename?: string;
}
export type Media = MediaBase & (MediaWithId | MediaWithLink);
interface ParameterText {
    type: 'text';
    text: string;
}
interface ParameterCurrency {
    type: 'currency';
    fallback_value: string;
    code: string;
    amount_1000: number;
}
interface ParameterDateTime {
    type: 'date_time';
    fallback_value: string;
}
interface ParameterImage {
    type: 'image';
    image: Media;
}
interface ParameterDocument {
    type: 'document';
    document: Media;
}
interface ParameterVideo {
    type: 'video';
    video: Media;
}
interface TemplateComponentTypeHeader {
    type: 'header';
}
interface TemplateComponentTypeBody {
    type: 'body';
    parameters: (ParameterText | ParameterCurrency | ParameterDateTime | ParameterImage | ParameterDocument | ParameterVideo)[];
}
interface TemplateComponentTypeButtonQuickReply {
    sub_type: 'quick_reply';
    parameters: {
        type: 'payload' | 'text';
        payload: any;
        text: string;
    }[];
}
interface TemplateComponentTypeButtonUrl {
    sub_type: 'url';
    parameters: {
        type?: 'payload' | 'text';
        payload?: any;
        text: string;
    }[];
}
interface TemplateComponentTypeButtonBase {
    type: 'button';
    index: 0 | 1 | 2;
}
type TemplateComponentTypeButton = TemplateComponentTypeButtonBase & (TemplateComponentTypeButtonQuickReply | TemplateComponentTypeButtonUrl);
export type TemplateComponent = TemplateComponentTypeHeader | TemplateComponentTypeBody | TemplateComponentTypeButton;
export interface Template {
    name: string;
    language: {
        policy?: 'deterministic';
        code: string;
    };
    components?: TemplateComponent[];
}
export interface Text {
    body: string;
    preview_url?: boolean;
}
export interface AudioMessage extends Message {
    type: 'audio';
    audio: Media;
}
export interface ContactMessage extends Message {
    type: 'contacts';
    contacts: Contact[];
}
export interface DocumentMessage extends Message {
    type: 'document';
    document: Media;
}
export interface ImageMessage extends Message {
    type: 'image';
    image: Media;
}
export interface InteractiveMessage extends Message {
    type: 'interactive';
    interactive: Interactive;
}
export interface LocationMessage extends Message {
    type: 'location';
    location: Location;
}
export interface StickerMessage extends Message {
    type: 'sticker';
    sticker: Media;
}
export interface TemplateMessage extends Message {
    type: 'template';
    template: Template;
}
export interface TextMessage extends Message {
    type: 'text';
    text: Text;
}
export interface VideoMessage extends Message {
    type: 'video';
    video: Media;
}
export type MediaMessage = AudioMessage | DocumentMessage | ImageMessage | StickerMessage | VideoMessage;
export {};