meta-cloud-api 0.2.15 → 0.2.17

package/dist/index.d.ts

@@ -1,12 +1,524 @@
+import { M as MessageTypesEnum, H as HttpMethodsEnum, S as SDKEnums } from './enums-Z1f7QuVx.js';
+export { a as StatusEnum, W as WebhookTypesEnum } from './enums-Z1f7QuVx.js';
+import { WhatsAppConfig, WabaConfigType } from './shared/types/config.js';
 import { IncomingMessage } from 'http';
-import { H as HttpMethodsEnum, c as RequesterClass, d as WabaConfigType, S as SDKEnums, e as MessageTypesEnum, f as FlowEndpointRequest, g as FlowTypeEnum } from './waba-RRlZTQUG.js';
-export { a$ as AccountMode, aA as AudioMediaObject, G as AudioMediaTypesEnum, aB as AudioMessageRequestBody, h as BaseClass, B as BusinessProfileClass, k as BusinessProfileData, i as BusinessProfileField, j as BusinessProfileFieldsParam, l as BusinessProfileResponse, Z as BusinessVerticalEnum, u as ButtonPositionEnum, t as ButtonTypesEnum, C as CategoryEnum, b0 as CodeVerificationStatus, bE as ComponentTypes, v as ComponentTypesEnum, aC as ContactObject, aD as ContactsMessageRequestBody, x as ConversationTypesEnum, bu as CopyCodeButton, ad as CreateFlowResponse, bg as CreateQrCodeRequest, X as CurrencyCodesEnum, b9 as Cursors, Y as DataLocalizationRegionEnum, aE as DocumentMediaObject, D as DocumentMediaTypesEnum, aF as DocumentMessageRequestBody, E as EncryptionClass, q as EncryptionPublicKeyResponse, a3 as Flow, a0 as FlowActionEnum, a7 as FlowAsset, a8 as FlowAssetsResponse, bv as FlowButton, $ as FlowCategoryEnum, F as FlowClass, am as FlowDataExchangeRequest, an as FlowDataExchangeResponse, ai as FlowDecryptedRequestResponse, ah as FlowEncryptedRequestPayload, ar as FlowEndpointResponse, ap as FlowErrorNotificationRequest, aq as FlowErrorNotificationResponse, ak as FlowHealthCheckRequest, al as FlowHealthCheckResponse, aj as FlowHttpRequest, ac as FlowMigrationFailure, af as FlowMigrationResponse, ab as FlowMigrationResult, a9 as FlowPreview, aa as FlowPreviewResponse, _ as FlowStatusEnum, ao as FlowSuccessScreenResponse, a2 as FlowValidationError, a1 as FlowValidationErrorPointer, a6 as FlowsListResponse, bk as GeneralHeaderInterface, av as GeneralMessageBody, bj as GeneralRequestBody, b5 as HealthStatus, b4 as HealthStatusEntity, aG as ImageMediaObject, A as ImageMediaTypesEnum, aH as ImageMessageRequestBody, aJ as InteractiveMessageRequestBody, aI as InteractiveObject, I as InteractiveTypesEnum, O as LanguagesEnum, aU as LocationMessageRequestBody, aT as LocationObject, bw as MPMButton, b as MediaClass, as as MediaResponse, at as MediasResponse, az as MessageRequestBody, aW as MessageRequestParams, aR as MessageTemplateObject, aS as MessageTemplateRequestBody, M as MessagesClass, aV as MessagesResponse, b1 as MessagingLimitTier, bx as OTPButton, a5 as Pagination, a4 as PaginationCursors, bp as Paging, s as ParametersTypesEnum, br as PhoneNumberButton, P as PhoneNumberClass, b8 as PhoneNumberResponse, ba as PhoneNumbersResponse, b2 as PlatformType, Q as QrCodeClass, be as QrCodeResponse, bf as QrCodesResponse, a_ as QualityRating, b6 as QualityScore, bt as QuickReplyButton, aM as ReactionMessageRequestBody, aY as ReactionParams, L as ReferralSourceTypesEnum, R as RegistrationClass, bi as RegistrationRequest, N as RequestCodeMethodsEnum, bb as RequestVerificationCodeRequest, bl as RequesterResponseInterface, bn as ResponseData, bo as ResponsePagination, bm as ResponseSuccess, by as SPMButton, y as StatusEnum, aw as StatusObject, aZ as StatusParams, ay as StatusRequestBody, aK as StickerMediaObject, z as StickerMediaTypesEnum, aL as StickerMessageRequestBody, K as SystemChangeTypesEnum, bC as TemplateBody, bz as TemplateButton, T as TemplateClass, bI as TemplateDeleteParams, bD as TemplateFooter, bq as TemplateFormat, bH as TemplateGetParams, bB as TemplateHeader, bA as TemplateHeaderExample, bF as TemplateRequestBody, bG as TemplateResponse, r as TemplateStatusEnum, aX as TextMessageParams, aO as TextMessageRequestBody, aN as TextObject, b7 as Throughput, b3 as ThroughputLevel, a as TwoStepVerificationClass, bd as TwoStepVerificationParams, bJ as TwoStepVerificationRequest, ax as TypingIndicatorObject, bs as URLButton, U as UpdateBusinessProfileRequest, ae as UpdateFlowResponse, bh as UpdateQrCodeRequest, bL as UpdateWabaSubscription, o as UploadBusinessProfileResponse, p as UploadHandle, au as UploadMediaResponse, m as UploadSession, n as UploadSessionResponse, ag as ValidateFlowJsonResponse, bc as VerifyCodeRequest, aP as VideoMediaObject, V as VideoMediaTypesEnum, aQ as VideoMessageRequestBody, W as WABAClass, bU as WabaAccount, bV as WabaAccountFields, bW as WabaAccountFieldsParam, bN as WabaAccountReviewStatus, bP as WabaAccountStatus, bQ as WabaBusinessVerificationStatus, w as WabaConfigEnum, bT as WabaHealthStatus, bO as WabaHealthStatusCanSendMessage, bS as WabaHealthStatusEntity, bR as WabaHealthStatusError, bK as WabaSubscription, bM as WabaSubscriptions, J as WebhookTypesEnum } from './waba-RRlZTQUG.js';
-import { HttpsClientClass, HttpsClientResponseClass, WebhookMessage, WebhookEvent } from './types/index.js';
-export { EventField, EventHandler, LoggerInterface, MessageHandler, MessageStatus, ResponseHeaderValue, ResponseHeaders, ResponseJSONBody, WebhookContact } from './types/index.js';
-import { W as WhatsAppClass, a as WhatsAppConfig } from './whatsapp-DmeO83A8.js';
-import { MessagesAPI as MessagesApi, TemplateAPI as TemplateApi, PhoneNumberAPI as PhoneNumberApi, QrCodeAPI, EncryptionAPI, TwoStepVerificationAPI, RegistrationAPI, MediaAPI, WabaAPI, FlowAPI, BusinessProfileAPI } from './api/index.js';
+import { F as FlowApi, a as FlowEndpointRequest, b as FlowTypeEnum } from './FlowApi-BIBrWYEv.js';
+export { c as Flow, d as FlowClass, e as FlowEndpointResponse } from './FlowApi-BIBrWYEv.js';
+import { E as EncryptionApi } from './EncryptionApi-CwxQlC-2.js';
+import { M as MediaApi } from './MediaApi-VqxndaBJ.js';
+export { a as MediaClass, b as MediaResponse, c as MediasResponse, U as UploadMediaResponse } from './MediaApi-VqxndaBJ.js';
+import { M as MessagesApi } from './MessageApi-CHc6bn3g.js';
+export { A as AudioMediaObject, C as ContactObject, D as DocumentMediaObject, I as ImageMediaObject, a as InteractiveObject, L as LocationObject, b as MessageRequestParams, d as MessageTemplateObject, c as MessagesResponse, R as ReactionParams, S as StatusParams, e as StickerMediaObject, T as TextMessageParams, f as TextObject, V as VideoMediaObject } from './MessageApi-CHc6bn3g.js';
+import { P as PhoneNumberApi } from './PhoneNumberApi-C-bs6YAe.js';
+export { a as PhoneNumberClass, b as PhoneNumberResponse } from './PhoneNumberApi-C-bs6YAe.js';
+import { B as BusinessProfileApi } from './BusinessProfileApi-DDkv2WQK.js';
+export { a as BusinessProfileClass, b as BusinessProfileResponse } from './BusinessProfileApi-DDkv2WQK.js';
+import { Q as QrCodeApi } from './QrCodeApi-BjlyPUXV.js';
+export { a as QrCodeClass, b as QrCodeResponse } from './QrCodeApi-BjlyPUXV.js';
+import { R as RegistrationApi } from './RegistrationApi-D7Bg8BUz.js';
+export { a as RegistrationClass } from './RegistrationApi-D7Bg8BUz.js';
+import { T as TemplateApi } from './TemplateApi-dmZbvMkO.js';
+export { a as TemplateClass, b as TemplateResponse } from './TemplateApi-dmZbvMkO.js';
+import { T as TwoStepVerificationApi } from './TwoStepVerificationApi-DaYWPjY_.js';
+import { W as WabaApi } from './WabaApi-CMoTCWiH.js';
+export { b as WABAClass, a as WabaAccount } from './WabaApi-CMoTCWiH.js';
 import { Agent } from 'https';
-export { MetaError, generateXHub256Sig, importConfig, isFlowDataExchangeRequest, isFlowErrorRequest, isFlowPingRequest, isMetaError, objectToQueryString } from './utils/index.js';
+import { R as RequesterClass } from './base-BG2gtoDs.js';
+export { MetaError, isMetaError } from './shared/utils/isMetaError.js';
+
+/**
+ * Represents a message received through the webhook
+ * Based on Meta's documentation: https://developers.facebook.com/docs/whatsapp/cloud-api/webhooks/components#messages-object
+ */
+interface WebhookMessage {
+    /**
+     * The message ID
+     */
+    id: string;
+    /**
+     * The sender's phone number
+     */
+    from: string;
+    /**
+     * The timestamp of the message
+     */
+    timestamp: string;
+    /**
+     * The type of message (text, image, etc.)
+     */
+    type: MessageTypesEnum;
+    /**
+     * The phone number ID that received the message
+     */
+    phoneNumberId: string;
+    /**
+     * The display phone number that received the message
+     */
+    displayPhoneNumber: string;
+    /**
+     * The profile name of the sender
+     */
+    profileName: string;
+    /**
+     * Text object for text messages
+     */
+    text?: {
+        /**
+         * The text content of the message
+         */
+        body: string;
+    };
+    /**
+     * Image object for image messages
+     */
+    image?: {
+        /**
+         * The image caption (if provided)
+         */
+        caption?: string;
+        /**
+         * The SHA256 hash of the image
+         */
+        sha256?: string;
+        /**
+         * The ID for the image
+         */
+        id: string;
+        /**
+         * The MIME type of the image
+         */
+        mime_type: string;
+    };
+    /**
+     * Video object for video messages
+     */
+    video?: {
+        /**
+         * The video caption (if provided)
+         */
+        caption?: string;
+        /**
+         * The SHA256 hash of the video
+         */
+        sha256?: string;
+        /**
+         * The ID for the video
+         */
+        id: string;
+        /**
+         * The MIME type of the video
+         */
+        mime_type: string;
+    };
+    /**
+     * Audio object for audio messages
+     */
+    audio?: {
+        /**
+         * The ID for the audio file
+         */
+        id: string;
+        /**
+         * The MIME type of the audio file
+         */
+        mime_type: string;
+        /**
+         * Whether the audio is a voice message
+         */
+        voice?: boolean;
+    };
+    /**
+     * Document object for document messages
+     */
+    document?: {
+        /**
+         * The document caption (if provided)
+         */
+        caption?: string;
+        /**
+         * The document filename
+         */
+        filename: string;
+        /**
+         * The SHA256 hash of the document
+         */
+        sha256?: string;
+        /**
+         * The ID for the document
+         */
+        id: string;
+        /**
+         * The MIME type of the document
+         */
+        mime_type: string;
+    };
+    /**
+     * Sticker object for sticker messages
+     */
+    sticker?: {
+        /**
+         * The ID for the sticker
+         */
+        id: string;
+        /**
+         * Whether this is an animated sticker
+         */
+        animated: boolean;
+        /**
+         * The MIME type of the sticker
+         */
+        mime_type: string;
+    };
+    /**
+     * Reaction object for reaction messages
+     */
+    reaction?: {
+        /**
+         * The ID of the message being reacted to
+         */
+        message_id: string;
+        /**
+         * Emoji used for the reaction
+         */
+        emoji: string;
+    };
+    /**
+     * Contacts object for contact messages
+     */
+    contacts?: Array<{
+        /**
+         * The contact's name
+         */
+        name: {
+            /**
+             * The formatted name
+             */
+            formatted_name: string;
+            /**
+             * The first name
+             */
+            first_name?: string;
+            /**
+             * The last name
+             */
+            last_name?: string;
+            /**
+             * The middle name
+             */
+            middle_name?: string;
+            /**
+             * The suffix
+             */
+            suffix?: string;
+            /**
+             * The prefix
+             */
+            prefix?: string;
+        };
+        /**
+         * The contact's phone numbers
+         */
+        phones?: Array<{
+            phone: string;
+            type?: string;
+            wa_id?: string;
+        }>;
+        /**
+         * The contact's emails
+         */
+        emails?: Array<{
+            email: string;
+            type?: string;
+        }>;
+        /**
+         * The contact's addresses
+         */
+        addresses?: Array<{
+            street?: string;
+            city?: string;
+            state?: string;
+            zip?: string;
+            country?: string;
+            country_code?: string;
+            type?: string;
+        }>;
+        /**
+         * The contact's organizations
+         */
+        org?: {
+            company?: string;
+            department?: string;
+            title?: string;
+        };
+        /**
+         * The contact's URLs
+         */
+        urls?: Array<{
+            url: string;
+            type?: string;
+        }>;
+        /**
+         * The contact's birthday (YYYY-MM-DD format)
+         */
+        birthday?: string;
+    }>;
+    /**
+     * Location object for location messages
+     */
+    location?: {
+        /**
+         * Latitude of the location
+         */
+        latitude: number;
+        /**
+         * Longitude of the location
+         */
+        longitude: number;
+        /**
+         * Name of the location
+         */
+        name?: string;
+        /**
+         * Address of the location
+         */
+        address?: string;
+    };
+    /**
+     * Interactive object for interactive messages
+     */
+    interactive?: {
+        /**
+         * Type of the interactive message
+         * Can be: button_reply, list_reply, flow, nfm_reply, etc.
+         */
+        type: string;
+        /**
+         * ID for the button that was clicked
+         */
+        button_reply?: {
+            id: string;
+            title: string;
+        };
+        /**
+         * ID for the list item that was selected
+         */
+        list_reply?: {
+            id: string;
+            title: string;
+            description?: string;
+        };
+        /**
+         * NFM (No-Code Flow Message) reply data
+         */
+        nfm_reply?: {
+            /**
+             * Response data in JSON format
+             */
+            response_json: string;
+            /**
+             * Body text of the reply
+             */
+            body: string;
+            /**
+             * Name of the flow
+             */
+            name: string;
+        };
+    };
+    /**
+     * System object for system messages (like user phone number changes)
+     */
+    system?: {
+        /**
+         * The type of system update
+         */
+        type: string;
+        /**
+         * User's identity if the update is a customer identity change
+         */
+        identity?: string;
+        /**
+         * Old and new phone numbers if the update is a phone number change
+         */
+        customer?: {
+            /**
+             * The previous phone number
+             */
+            previous_wa_id: string;
+            /**
+             * The new phone number
+             */
+            wa_id: string;
+        };
+    };
+    /**
+     * Order object for order messages
+     */
+    order?: {
+        /**
+         * Catalog ID
+         */
+        catalog_id: string;
+        /**
+         * Product items in the order
+         */
+        product_items: Array<{
+            /**
+             * Product ID
+             */
+            product_retailer_id: string;
+            /**
+             * Quantity of the product
+             */
+            quantity: number;
+            /**
+             * Item price
+             */
+            item_price: number;
+            /**
+             * Currency code
+             */
+            currency: string;
+        }>;
+        /**
+         * Text message included with the order
+         */
+        text?: string;
+    };
+    /**
+     * Context object, included when a user replies or interacts
+     */
+    context?: {
+        /**
+         * ID of the message
+         */
+        id?: string;
+        /**
+         * ID of the sender
+         */
+        from?: string;
+        /**
+         * ID of the message being replied to or interacted with
+         */
+        message_id: string;
+        /**
+         * ID of the forwarded message, if applicable
+         */
+        forwarded?: boolean;
+        /**
+         * Frequently forwarded status
+         */
+        frequently_forwarded?: boolean;
+        /**
+         * Original message information if the message was referred
+         */
+        referred_product?: {
+            /**
+             * Catalog ID
+             */
+            catalog_id: string;
+            /**
+             * Product ID
+             */
+            product_retailer_id: string;
+        };
+    };
+    /**
+     * Errors array, if the message had errors
+     */
+    errors?: Array<{
+        /**
+         * Error code
+         */
+        code: number;
+        /**
+         * Error title
+         */
+        title: string;
+        /**
+         * Error message
+         */
+        message: string;
+        /**
+         * Error details object
+         */
+        error_data?: {
+            /**
+             * Describes the error details
+             */
+            details: string;
+        };
+    }>;
+    /**
+     * Button object for button messages
+     */
+    button?: {
+        /**
+         * The payload for the button
+         */
+        payload: string;
+        /**
+         * Button text
+         */
+        text: string;
+    };
+    /**
+     * The original message data as received from the webhook
+     */
+    originalData: any;
+}
+/**
+ * Webhook event received from WhatsApp
+ */
+interface WebhookEvent {
+    /**
+     * The field type of the event
+     */
+    field: string;
+    /**
+     * The event data
+     */
+    value: any;
+    /**
+     * The timestamp when the event was received
+     */
+    timestamp: number;
+}
+
+type ResponseHeaderValue = string | string[] | undefined;
+type ResponseHeaders = Record<string, ResponseHeaderValue>;
+type ResponseJSONBody = Record<string, unknown>;
+declare class HttpsClientResponseClass {
+    constructor(resp: Response);
+    statusCode: () => number;
+    headers: () => ResponseHeaders;
+    rawResponse: () => Response;
+    json: () => Promise<ResponseJSONBody>;
+}
+declare class HttpsClientClass {
+    constructor();
+    clearSockets: () => boolean;
+    sendRequest: (host: string, path: string, method: HttpMethodsEnum, headers: HeadersInit, timeout: number, body?: BodyInit | null) => Promise<HttpsClientResponseClass>;
+}
+
+declare class WhatsAppClass {
+    constructor(config?: WhatsAppConfig);
+    readonly messages: MessagesApi;
+    readonly templates: TemplateApi;
+    readonly phoneNumber: PhoneNumberApi;
+    readonly qrCode: QrCodeApi;
+    readonly encryption: EncryptionApi;
+    readonly twoStepVerification: TwoStepVerificationApi;
+    readonly registration: RegistrationApi;
+    readonly media: MediaApi;
+    readonly waba: WabaApi;
+    readonly flow: FlowApi;
+    readonly businessProfile: BusinessProfileApi;
+    updateTimeout(ms: number): boolean;
+    updatePhoneNumberId(phoneNumberId: number): boolean;
+    updateAccessToken(accessToken: string): boolean;
+    updateWabaId(wabaId: string): boolean;
+}
 
 declare class HttpsClient implements HttpsClientClass {
     agent: Agent;
@@ -15,6 +527,8 @@ declare class HttpsClient implements HttpsClientClass {
     sendRequest(hostname: string, path: string, method: HttpMethodsEnum, headers: HeadersInit, timeout: number, body?: BodyInit | null): Promise<HttpsClientResponseClass>;
 }
 
+declare const importConfig: (inputConfig?: WhatsAppConfig) => WabaConfigType;
+
 declare class Requester implements RequesterClass {
     client: Readonly<HttpsClient>;
     accessToken: Readonly<string>;
@@ -39,14 +553,14 @@ declare class WhatsApp implements WhatsAppClass {
     readonly messages: MessagesApi;
     readonly templates: TemplateApi;
     readonly phoneNumber: PhoneNumberApi;
-    readonly qrCode: QrCodeAPI;
-    readonly encryption: EncryptionAPI;
-    readonly twoStepVerification: TwoStepVerificationAPI;
-    readonly registration: RegistrationAPI;
-    readonly media: MediaAPI;
-    readonly waba: WabaAPI;
-    readonly flow: FlowAPI;
-    readonly businessProfile: BusinessProfileAPI;
+    readonly qrCode: QrCodeApi;
+    readonly encryption: EncryptionApi;
+    readonly twoStepVerification: TwoStepVerificationApi;
+    readonly registration: RegistrationApi;
+    readonly media: MediaApi;
+    readonly waba: WabaApi;
+    readonly flow: FlowApi;
+    readonly businessProfile: BusinessProfileApi;
     static readonly Enums: typeof SDKEnums;
     constructor(config?: WhatsAppConfig);
     private userAgent;
@@ -99,47 +613,51 @@ declare class WebhookHandler {
      * Process incoming messages
      */
     private processMessages;
+    /**
+     * Process other webhook events
+     */
     private processEvent;
     /**
      * Register a message handler for a specific message type
-     * @param type Message type to handle, or '*' for all types
-     * @param handler The handler function
      */
     onMessage(type: MessageTypesEnum, handler: (whatsapp: WhatsApp, message: WebhookMessage) => void | Promise<void>): void;
     /**
-     * Register a general event handler
-     * @param field Event field to handle, or '*' for all fields
-     * @param handler The handler function
+     * Register an event handler for a specific field
      */
     onEvent(field: string, handler: (event: WebhookEvent) => void | Promise<void>): void;
     /**
-     * Register a pre-processing handler for all messages
-     * @param handler The handler function
+     * Register a pre-process handler that runs before all message handlers
      */
     onMessagePreProcess(handler: (whatsapp: WhatsApp, message: WebhookMessage) => void | Promise<void>): void;
     /**
-     * Register a post-processing handler for all messages
-     * @param handler The handler function
+     * Register a post-process handler that runs after all message handlers
      */
     onMessagePostProcess(handler: (whatsapp: WhatsApp, message: WebhookMessage) => void | Promise<void>): void;
     handleFlowRequest<Req extends IRequest & {
         rawBody: string;
     }, Res extends IResponse>(req: Req, res: Res): Promise<void>;
+    /**
+     * Validate the request signature
+     */
     isRequestSignatureValid(req: IRequest & {
         rawBody: string;
     }): boolean;
+    /**
+     * Decrypt a flow request
+     */
     decryptRequest(body: any): {
         decryptedBody: FlowEndpointRequest;
         aesKeyBuffer: Buffer;
         initialVectorBuffer: Buffer;
     };
+    /**
+     * Encrypt a flow response
+     */
     private encryptResponse;
     /**
-     * Register a Flow action handler for a specific flow type
-     * @param type The flow type to handle (ping, change, error), or '*' for all types
-     * @param handler The handler function that receives the WhatsApp client and the Flow request
+     * Register a flow handler for a specific flow type
      */
     onFlow(type: FlowTypeEnum, handler: (whatsapp: WhatsApp, request: FlowEndpointRequest) => any | Promise<any>): void;
 }
 
-export { FlowEndpointRequest, FlowTypeEnum, HttpMethodsEnum, HttpsClientClass, HttpsClientResponseClass, type IRequest, type IResponse, MessageTypesEnum, RequesterClass, WabaConfigType, WebhookEvent, WebhookHandler, WebhookMessage, WhatsAppClass, WhatsAppConfig, WhatsApp as default };
+export { BusinessProfileApi, EncryptionApi, FlowApi, FlowEndpointRequest, HttpMethodsEnum, type IRequest, type IResponse, MessageTypesEnum, MessagesApi, PhoneNumberApi, QrCodeApi, RegistrationApi, TemplateApi, TwoStepVerificationApi, WabaApi, WabaConfigType, WebhookHandler, WhatsApp as default, importConfig };