wh-wrapper/lib/types/whatsapp-types.d.ts

JavaScript wrapper for the WhatsApp Cloud API

import { Contact, ConversationCategory, LocationType, MediaBase, ReactionType } from "./shared";
export type MessageType = "text" | "image" | "video" | "sticker" | "document" | "location" | "audio" | "reaction" | "interactive" | "contacts" | "unsupported" | "order" | "system" | "request_welcome" | "errors";
type Text = {
    type: "text";
    text: {
        body: string;
    };
};
type Image = {
    type: "image";
    image: MediaBase;
};
type Video = {
    type: "video";
    video: MediaBase;
};
type Sticker = {
    type: "sticker";
    sticker: MediaBase & {
        animated?: boolean;
    };
};
type Document = {
    type: "document";
    document: MediaBase & {
        filename?: string;
    };
};
type Location = {
    type: "location";
    location: LocationType;
};
type Audio = {
    type: "audio";
    audio: MediaBase & {
        voice?: boolean;
    };
};
type Reaction = {
    type: "reaction";
    reaction: ReactionType;
};
type Interactive = {
    type: "interactive";
    interactive: {
        [K in "list_reply" | "button_reply"]: K extends "list_reply" ? {
            id: string;
            title: string;
            description?: string;
        } : {
            id: string;
            title: string;
        };
    } & {
        type: "list_reply" | "button_reply";
    };
};
type Contacts = {
    type: "contacts";
    contacts: Contact[];
};
type Unsupported = {
    type: "unsupported";
    errors: {
        code: number;
        title: string;
        message: string;
        error_data?: {
            details: string;
        };
    }[];
};
export type MesaageTypes = Text | Image | Video | Sticker | Document | Audio | Location | Reaction | Interactive | Contacts | Unsupported;
export type MessageValueType<T extends "messages" | "statuses"> = {
    messaging_product: "whatsapp";
    metadata: {
        display_phone_number: string;
        phone_number_id: string;
    };
} & (T extends "messages" ? {
    contacts: {
        profile: {
            name: string;
        };
        wa_id: string;
    }[];
    messages: Array<{
        from: string;
        id: string;
        timestamp: string;
    } & MesaageTypes & {
        context?: {
            forwarded?: boolean;
            frequently_forwarded?: boolean;
        } & ({
            from: string;
            id: string;
        } | ({
            from?: never;
            id?: never;
        } & {
            forwarded?: boolean;
            frequently_forwarded?: boolean;
        }));
    }>;
    statuses?: never;
} : {
    contacts?: never;
    statuses: Array<{
        id: string;
        status: "sent" | "delivered" | "read";
        timestamp: string;
        recipient_id: string;
        conversation?: {
            id: string;
            expiration_timestamp?: string;
            origin?: {
                type: Lowercase<ConversationCategory>;
            };
        };
        pricing?: {
            billable: boolean;
            pricing_model: "CBP";
            category: Lowercase<ConversationCategory>;
        };
    }>;
    messages?: never;
});
export interface RowWhatsappObject<T extends "messages" | "statuses"> {
    object: "whatsapp_business_account";
    entry: Array<{
        id: string;
        changes: Array<{
            value: MessageValueType<T>;
            field: "messages";
        }>;
    }>;
}
export interface GetAllSubscriptions {
    whatsapp_business_api_data: {
        category?: string;
        link: string;
        name: string;
        id: string;
    };
}
export {};