meta-cloud-api 1.1.9 → 1.1.10

package/dist/types/index.d.ts

@@ -180,9 +180,6 @@ interface UploadHandle {
     name: string;
   };
 }
-/**
- * Request parameters for creating upload session.
- */
 //#endregion
 //#region src/api/profile/types/common.d.ts
 /**
@@ -1197,610 +1194,210 @@ interface MediaClass {
   downloadMedia(mediaUrl: string): Promise<Blob>;
 }
 //#endregion
-//#region src/api/flow/types/common.d.ts
-/**
- * Enum for Flow Status
- */
-declare enum FlowStatusEnum {
-  Draft = "DRAFT",
-  Published = "PUBLISHED",
-  Throttled = "THROTTLED",
-  Blocked = "BLOCKED",
-  Deprecated = "DEPRECATED",
+//#region src/core/webhook/types.d.ts
+interface WebhookContact {
+  /**
+   * WhatsApp ID of the contact. Business can respond to this contact using this ID.
+   */
+  wa_id: string;
+  /**
+   *  Additional unique, alphanumeric identifier for a WhatsApp user
+   */
+  user_id?: string;
+  /**
+   * Profile of Whatsapp user
+   */
+  profile: {
+    /**
+     * The display name of the contact
+     */
+    name: string;
+  };
 }
 /**
- * Enum for Flow Categories
+ * Base message interface with common properties
  */
-declare enum FlowCategoryEnum {
-  SignUp = "SIGN_UP",
-  SignIn = "SIGN_IN",
-  AppointmentBooking = "APPOINTMENT_BOOKING",
-  LeadGeneration = "LEAD_GENERATION",
-  ContactUs = "CONTACT_US",
-  CustomerSupport = "CUSTOMER_SUPPORT",
-  Survey = "SURVEY",
-  Other = "OTHER",
-}
-declare enum FlowActionEnum {
-  INIT = "INIT",
-  BACK = "BACK",
-  DATA_EXCHANGE = "data_exchange",
+interface BaseMessage {
+  id: string;
+  from: string;
+  timestamp: string;
+  type: MessageTypesEnum;
+  /**
+   * 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;
+    };
+  }>;
 }
 /**
- * Enum for Flow Types in webhook handlers
- * Used to register handlers for specific flow events
+ * Text message interface
  */
-declare enum FlowTypeEnum {
-  /** Health check/ping requests */
-  Ping = "ping",
-  /** Data exchange requests */
-  Change = "data_exchange",
-  /** Error notification requests */
-  Error = "error",
-  /** Match all flow action types */
-  All = "*",
+interface TextMessage extends BaseMessage {
+  type: MessageTypesEnum.Text;
+  text: {
+    /**
+     * The text content of the message
+     */
+    body: string;
+    preview_url?: boolean;
+  };
 }
-type FlowType = (typeof FlowTypeEnum)[keyof typeof FlowTypeEnum];
 /**
- * Flow Validation Error Pointer
+ * Image message interface
  */
-interface FlowValidationErrorPointer {
-  line_start: number;
-  line_end: number;
-  column_start: number;
-  column_end: number;
-  path: string;
+interface ImageMessage extends BaseMessage {
+  type: MessageTypesEnum.Image;
+  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;
+  };
 }
 /**
- * Flow Validation Error
+ * Video message interface
  */
-interface FlowValidationError {
-  error: string;
-  error_type: string;
-  message: string;
-  line_start: number;
-  line_end: number;
-  column_start: number;
-  column_end: number;
-  pointers: FlowValidationErrorPointer[];
+interface VideoMessage extends BaseMessage {
+  type: MessageTypesEnum.Video;
+  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;
+  };
 }
 /**
- * Flow Item
+ * Audio message interface
  */
-interface Flow {
-  id: string;
-  name: string;
-  status: FlowStatusEnum;
-  categories: FlowCategoryEnum[];
-  validation_errors: FlowValidationError[];
+interface AudioMessage extends BaseMessage {
+  type: MessageTypesEnum.Audio;
+  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;
+  };
 }
 /**
- * Pagination Cursors
+ * Document message interface
  */
-interface PaginationCursors {
-  before: string;
-  after: string;
+interface DocumentMessage extends BaseMessage {
+  type: MessageTypesEnum.Document;
+  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;
+  };
 }
 /**
- * Pagination Object
- */
-interface Pagination {
-  cursors: PaginationCursors;
-}
-/**
- * Flows List Response
- */
-interface FlowsListResponse {
-  data: Flow[];
-  paging: Pagination;
-}
-/**
- * Flow Asset
- */
-interface FlowAsset {
-  name: string;
-  asset_type: string;
-  download_url: string;
-}
-/**
- * Flow Assets Response
- */
-interface FlowAssetsResponse {
-  data: FlowAsset[];
-  paging: Pagination;
-}
-/**
- * Flow Preview
- */
-interface FlowPreview {
-  preview_url: string;
-  expires_at: string;
-}
-/**
- * Flow Preview Response
- */
-interface FlowPreviewResponse {
-  preview: FlowPreview;
-  id: string;
-}
-/**
- * Flow Migration Result
- */
-interface FlowMigrationResult {
-  source_name: string;
-  source_id: string;
-  migrated_id: string;
-}
-/**
- * Flow Migration Failure
- */
-interface FlowMigrationFailure {
-  source_name: string;
-  error_code: string;
-  error_message: string;
-}
-/**
- * Create Flow Response
- */
-interface CreateFlowResponse {
-  id: string;
-  success: boolean;
-  validation_errors?: FlowValidationError[];
-}
-/**
- * Update Flow Response
- */
-interface UpdateFlowResponse {
-  success: boolean;
-  validation_errors?: FlowValidationError[];
-}
-/**
- * Flow Migration Response
- */
-interface FlowMigrationResponse {
-  migrated_flows: FlowMigrationResult[];
-  failed_flows: FlowMigrationFailure[];
-}
-/**
- * Validate Flow JSON Response
- */
-interface ValidateFlowJsonResponse {
-  valid: boolean;
-  success: boolean;
-  validation_errors?: FlowValidationError[];
-}
-/**
- * WhatsApp Flow Endpoint - Encrypted Request Payload
- * Represents the raw encrypted data received from WhatsApp
- */
-interface FlowEncryptedRequestPayload {
-  encrypted_aes_key: string;
-  encrypted_flow_data: string;
-  initial_vector: string;
-}
-/**
- * WhatsApp Flow Endpoint - Decrypted Request Response
- * Represents the successfully decrypted data and encryption keys
- */
-interface FlowDecryptedRequestResponse {
-  decryptedBody: any;
-  aesKeyBuffer: Buffer;
-  initialVectorBuffer: Buffer;
-}
-/**
- * WhatsApp Flow Endpoint - HTTP Request with Body
- * Represents an HTTP request with the encrypted payload
- */
-interface FlowHttpRequest extends IncomingMessage {
-  body: FlowEncryptedRequestPayload;
-  headers: IncomingHttpHeaders;
-}
-/**
- * WhatsApp Flow Endpoint - Health Check Request
- * Represents the structure of a health check request
- */
-interface FlowHealthCheckRequest {
-  action: 'ping';
-  version: '3.0';
-}
-/**
- * WhatsApp Flow Endpoint - Health Check Response
- * The expected response structure for health check requests
- */
-interface FlowHealthCheckResponse {
-  data: {
-    status: 'active';
-  };
-}
-/**
- * WhatsApp Flow Endpoint - Data Exchange Request
- * Represents the structure of a data exchange request
- */
-interface FlowDataExchangeRequest {
-  version: '3.0';
-  action: FlowActionEnum;
-  screen: string;
-  flow_token: string;
-  data?: Record<string, any> & {
-    error_message?: string;
-  };
-}
-/**
- * WhatsApp Flow Endpoint - Data Exchange Response
- * The expected response structure for data exchange requests
- */
-interface FlowDataExchangeResponse {
-  screen?: string;
-  data?: Record<string, any | {
-    error_message?: string;
-  }>;
-}
-/**
- * WhatsApp Flow Endpoint - Success Screen Response
- * The expected response structure for success screen requests
- */
-interface FlowSuccessScreenResponse {
-  screen: 'SUCCESS';
-  data: {
-    extension_message_response?: {
-      params?: {
-        flow_token: string;
-        [key: string]: string;
-      };
-    };
-  };
-}
-/**
- * WhatsApp Flow Endpoint - Error Notification Request
- * Represents the structure of an error notification request
- */
-interface FlowErrorNotificationRequest {
-  version: '3.0';
-  action: Exclude<FlowActionEnum, FlowActionEnum.BACK>;
-  screen: string;
-  flow_token: string;
-  data: {
-    error: string;
-    error_message: string;
-  };
-}
-/**
- * WhatsApp Flow Endpoint - Error Notification Response
- * The expected response structure for error notification requests
- */
-interface FlowErrorNotificationResponse {
-  acknowledged: boolean;
-}
-/**
- * WhatsApp Flow Endpoint - Comprehensive Request Object
- * A combined type that includes all possible fields from different request types
- * with all fields being optional for flexibility
- */
-interface FlowEndpointRequest {
-  version?: '3.0';
-  action?: 'ping' | FlowActionEnum;
-  screen?: string;
-  flow_token?: string;
-  data?: Record<string, any> & {
-    error_key?: string;
-    error_message?: string;
-  };
-}
-/**
- * WhatsApp Flow Endpoint - Response
- * Union type for all possible response types from a Flow endpoint
- */
-type FlowEndpointResponse = FlowHealthCheckResponse | FlowDataExchangeResponse | FlowErrorNotificationResponse | FlowSuccessScreenResponse;
-interface FlowClass {
-  /**
-   * List Flows
-   *
-   * @param wabaId - The WABA ID
-   * @returns Promise with the list of flows
-   */
-  listFlows(wabaId: string): Promise<FlowsListResponse>;
-  /**
-   * Create Flow
-   *
-   * @param wabaId - The WABA ID
-   * @param data - The flow data including name, categories, endpoint_uri, and optional clone_flow_id
-   * @returns Promise with the created flow ID
-   */
-  createFlow(wabaId: string, data: {
-    name: string;
-    categories?: FlowCategoryEnum[];
-    endpoint_uri?: string;
-    clone_flow_id?: string;
-    flow_json?: string;
-    publish?: boolean;
-  }): Promise<CreateFlowResponse>;
-  /**
-   * Get Flow
-   *
-   * @param flowId - The flow ID
-   * @param fields - Optional fields to return
-   * @param dateFormat - Optional date format
-   * @returns Promise with the flow details
-   */
-  getFlow(flowId: string, fields?: string, dateFormat?: string): Promise<Flow | FlowPreviewResponse>;
-  /**
-   * Update Flow Metadata
-   *
-   * @param flowId - The flow ID
-   * @param data - The flow metadata to update
-   * @returns Promise with the success status
-   */
-  updateFlowMetadata(flowId: string, data: {
-    name?: string;
-    categories?: FlowCategoryEnum[];
-    endpoint_uri?: string;
-    application_id?: string;
-  }): Promise<ResponseSuccess>;
-  /**
-   * Delete Flow
-   *
-   * @param flowId - The flow ID
-   * @returns Promise with the success status
-   */
-  deleteFlow(flowId: string): Promise<ResponseSuccess>;
-  /**
-   * List Assets (Get Flow JSON URL)
-   *
-   * @param flowId - The flow ID
-   * @returns Promise with the list of assets
-   */
-  listAssets(flowId: string): Promise<FlowAssetsResponse>;
-  /**
-   * Update Flow JSON
-   *
-   * @param flowId - The flow ID
-   * @param data - The asset data including asset_type, file, and name
-   * @returns Promise with the success status and validation errors
-   */
-  updateFlowJson(flowId: string, data: {
-    file: Blob | Buffer | object;
-    name?: string;
-  }): Promise<UpdateFlowResponse>;
-  /**
-   * Validate Flow JSON by attempting an update without publishing.
-   * This is a convenience method; the API doesn't have a dedicated validation endpoint.
-   *
-   * @param flowId - The ID of the Flow (must exist, can be in DRAFT status).
-   * @param flowJsonData - The Flow JSON content as a Buffer, JSON object, or Blob.
-   * @returns Promise indicating if the JSON is valid and includes validation errors if any.
-   */
-  validateFlowJson(flowId: string, flowJsonData: Blob | Buffer | object): Promise<ValidateFlowJsonResponse>;
-  /**
-   * Publish Flow
-   *
-   * @param flowId - The flow ID
-   * @returns Promise with the success status
-   */
-  publishFlow(flowId: string): Promise<ResponseSuccess>;
-  /**
-   * Deprecate Flow
-   *
-   * @param flowId - The flow ID
-   * @returns Promise with the success status
-   */
-  deprecateFlow(flowId: string): Promise<ResponseSuccess>;
-  /**
-   * Migrate Flows
-   *
-   * @param wabaId - The destination WABA ID
-   * @param data - The migration data including source_waba_id and optional source_flow_names
-   * @returns Promise with migration results
-   */
-  migrateFlows(wabaId: string, data: {
-    source_waba_id: string;
-    source_flow_names?: string[];
-  }): Promise<FlowMigrationResponse>;
-}
-//#endregion
-//#region src/core/webhook/types.d.ts
-interface WebhookContact {
-  /**
-   * WhatsApp ID of the contact. Business can respond to this contact using this ID.
-   */
-  wa_id: string;
-  /**
-   *  Additional unique, alphanumeric identifier for a WhatsApp user
-   */
-  user_id?: string;
-  /**
-   * Profile of Whatsapp user
-   */
-  profile: {
-    /**
-     * The display name of the contact
-     */
-    name: string;
-  };
-}
-/**
- * Base message interface with common properties
- */
-interface BaseMessage {
-  id: string;
-  from: string;
-  timestamp: string;
-  type: MessageTypesEnum;
-  /**
-   * 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;
-    };
-  }>;
-}
-/**
- * Text message interface
- */
-interface TextMessage extends BaseMessage {
-  type: MessageTypesEnum.Text;
-  text: {
-    /**
-     * The text content of the message
-     */
-    body: string;
-    preview_url?: boolean;
-  };
-}
-/**
- * Image message interface
- */
-interface ImageMessage extends BaseMessage {
-  type: MessageTypesEnum.Image;
-  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 message interface
- */
-interface VideoMessage extends BaseMessage {
-  type: MessageTypesEnum.Video;
-  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 message interface
- */
-interface AudioMessage extends BaseMessage {
-  type: MessageTypesEnum.Audio;
-  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 message interface
- */
-interface DocumentMessage extends BaseMessage {
-  type: MessageTypesEnum.Document;
-  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 message interface
+ * Sticker message interface
  */
 interface StickerMessage extends BaseMessage {
   type: MessageTypesEnum.Sticker;
@@ -2069,10 +1666,6 @@ interface ButtonMessage extends BaseMessage {
     text: string;
   };
 }
-/**
- * Union type for all message types
- */
-
 /**
  * Represents a message received through the webhook
  * Based on Meta's documentation: https://developers.facebook.com/docs/whatsapp/cloud-api/webhooks/components#messages-object
@@ -2226,218 +1819,609 @@ interface WebhookMessage {
      */
     timestamp: string;
   };
-  /**
-   * The original message data as received from the webhook
-   */
-  originalData: any;
+  /**
+   * 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;
+}
+//#endregion
+//#region src/api/qrCode/types/common.d.ts
+type QrCodeResponse = {
+  code: string;
+  prefilled_message: string;
+  deep_link_url: string;
+  qr_image_url?: string;
+};
+type QrCodesResponse = ResponseData<QrCodeResponse[]>;
+type CreateQrCodeRequest = {
+  prefilled_message: string;
+  generate_qr_image?: 'SVG' | 'PNG';
+};
+type UpdateQrCodeRequest = {
+  code: string;
+  prefilled_message: string;
+};
+interface QrCodeClass {
+  createQrCode(request: CreateQrCodeRequest): Promise<QrCodeResponse>;
+  getQrCodes(): Promise<QrCodesResponse>;
+  getQrCode(qrCodeId: string): Promise<QrCodeResponse>;
+  updateQrCode(request: UpdateQrCodeRequest): Promise<QrCodeResponse>;
+  deleteQrCode(qrCodeId: string): Promise<ResponseSuccess>;
+}
+//#endregion
+//#region src/api/waba/types/common.d.ts
+/**
+ * WhatsApp Business Account subscription configuration
+ */
+type WabaSubscription = {
+  whatsapp_business_api_data: {
+    id: string;
+    link: string;
+    name: string;
+    category: string;
+  };
+  override_callback_uri?: string;
+};
+/**
+ * Parameters for updating WABA subscription
+ */
+interface UpdateWabaSubscription {
+  override_callback_uri: string;
+  verify_token: string;
+}
+/**
+ * Response containing all WABA subscriptions
+ */
+interface WabaSubscriptions {
+  data: Array<WabaSubscription>;
+}
+/**
+ * WABA account review status enumeration
+ */
+declare enum WabaAccountReviewStatus {
+  Approved = "APPROVED",
+  Active = "ACTIVE",
+  Inactive = "INACTIVE",
+  Disabled = "DISABLED",
+}
+/**
+ * WABA health status for message sending capability
+ */
+declare enum WabaHealthStatusCanSendMessage {
+  Blocked = "BLOCKED",
+  Limited = "LIMITED",
+  Available = "AVAILABLE",
+}
+/**
+ * WABA account status enumeration
+ */
+declare enum WabaAccountStatus {
+  Approved = "APPROVED",
+  Active = "ACTIVE",
+  Inactive = "INACTIVE",
+  Disabled = "DISABLED",
+}
+/**
+ * Business verification status enumeration
+ */
+declare enum WabaBusinessVerificationStatus {
+  Verified = "verified",
+  PendingSubmission = "pending_submission",
+  Unverified = "unverified",
+  Rejected = "rejected",
+}
+/**
+ * WABA health status error details
+ */
+interface WabaHealthStatusError {
+  error_code?: number;
+  error_description?: string;
+  possible_solution?: string;
+}
+/**
+ * WABA health status entity information
+ */
+interface WabaHealthStatusEntity {
+  entity_type?: string;
+  id?: string;
+  can_send_message?: string;
+  errors?: WabaHealthStatusError[];
+}
+/**
+ * Overall WABA health status
+ */
+interface WabaHealthStatus {
+  can_send_message?: WabaHealthStatusCanSendMessage;
+  entities?: WabaHealthStatusEntity[];
+}
+/**
+ * WhatsApp Business Account information
+ */
+interface WabaAccount {
+  account_review_status?: WabaAccountReviewStatus;
+  id?: string;
+  health_status?: WabaHealthStatus;
+  status?: WabaAccountStatus;
+  business_verification_status?: WabaBusinessVerificationStatus;
+  message_template_namespace?: string;
+  name?: string;
+  ownership_type?: string;
+  currency?: string;
+}
+/**
+ * Available fields for WABA account queries
+ */
+type WabaAccountFields = 'id' | 'name' | 'account_review_status' | 'auth_international_rate_eligibility' | 'business_verification_status' | 'country' | 'currency' | 'health_status' | 'status' | 'ownership_type' | 'message_template_namespace';
+/**
+ * Parameter type for specifying which WABA account fields to retrieve
+ */
+type WabaAccountFieldsParam = WabaAccountFields[];
+/**
+ * Interface defining all WABA API methods
+ */
+interface WABAClass {
+  getWabaAccount(fields?: WabaAccountFieldsParam): Promise<WabaAccount>;
+  getAllWabaSubscriptions(): Promise<WabaSubscriptions>;
+  updateWabaSubscription(params: UpdateWabaSubscription): Promise<ResponseSuccess>;
+  unsubscribeFromWaba(): Promise<ResponseSuccess>;
+}
+//#endregion
+//#region src/api/registration/types/common.d.ts
+type RegistrationRequest = {
+  messaging_product: 'whatsapp';
+  pin: string;
+  data_localization_region?: DataLocalizationRegionEnum;
+};
+interface RegistrationClass {
+  register(pin: string, dataLocalizationRegion?: DataLocalizationRegionEnum): Promise<ResponseSuccess>;
+  deregister(): Promise<ResponseSuccess>;
+}
+//#endregion
+//#region src/api/twoStepVerification/types/common.d.ts
+type TwoStepVerificationRequest = {
+  pin: string;
+};
+interface TwoStepVerificationClass {
+  setTwoStepVerificationCode(pin: string): Promise<ResponseSuccess>;
+}
+//#endregion
+//#region src/api/encryption/types/publicKey.d.ts
+type EncryptionPublicKeyResponse = ResponseData<{
+  business_public_key: string;
+  business_public_key_signature_status: 'VALID' | 'MISMATCH';
+}>;
+//#endregion
+//#region src/utils/isMetaError.d.ts
+interface MetaError extends Error {
+  error: {
+    message: string;
+    type: string;
+    code: number;
+    error_data?: {
+      messaging_product: 'whatsapp';
+      details: string;
+    };
+    error_subcode?: number;
+    fbtrace_id: string;
+  };
 }
+//#endregion
+//#region src/api/flow/types/common.d.ts
 /**
- * Webhook event received from WhatsApp
+ * Enum for Flow Status
  */
-interface WebhookEvent {
-  /**
-   * The field type of the event
-   */
-  field: string;
-  /**
-   * The event data
-   */
-  value: any;
-  /**
-   * The timestamp when the event was received
-   */
-  timestamp: number;
+declare enum FlowStatusEnum {
+  Draft = "DRAFT",
+  Published = "PUBLISHED",
+  Throttled = "THROTTLED",
+  Blocked = "BLOCKED",
+  Deprecated = "DEPRECATED",
 }
 /**
- * Message status enum
+ * Enum for Flow Categories
  */
-//#endregion
-//#region src/api/qrCode/types/common.d.ts
-type QrCodeResponse = {
-  code: string;
-  prefilled_message: string;
-  deep_link_url: string;
-  qr_image_url?: string;
-};
-type QrCodesResponse = ResponseData<QrCodeResponse[]>;
-type CreateQrCodeRequest = {
-  prefilled_message: string;
-  generate_qr_image?: 'SVG' | 'PNG';
-};
-type UpdateQrCodeRequest = {
-  code: string;
-  prefilled_message: string;
-};
-interface QrCodeClass {
-  createQrCode(request: CreateQrCodeRequest): Promise<QrCodeResponse>;
-  getQrCodes(): Promise<QrCodesResponse>;
-  getQrCode(qrCodeId: string): Promise<QrCodeResponse>;
-  updateQrCode(request: UpdateQrCodeRequest): Promise<QrCodeResponse>;
-  deleteQrCode(qrCodeId: string): Promise<ResponseSuccess>;
+declare enum FlowCategoryEnum {
+  SignUp = "SIGN_UP",
+  SignIn = "SIGN_IN",
+  AppointmentBooking = "APPOINTMENT_BOOKING",
+  LeadGeneration = "LEAD_GENERATION",
+  ContactUs = "CONTACT_US",
+  CustomerSupport = "CUSTOMER_SUPPORT",
+  Survey = "SURVEY",
+  Other = "OTHER",
+}
+declare enum FlowActionEnum {
+  INIT = "INIT",
+  BACK = "BACK",
+  DATA_EXCHANGE = "data_exchange",
 }
-//#endregion
-//#region src/api/waba/types/common.d.ts
 /**
- * WhatsApp Business Account subscription configuration
+ * Enum for Flow Types in webhook handlers
+ * Used to register handlers for specific flow events
  */
-type WabaSubscription = {
-  whatsapp_business_api_data: {
-    id: string;
-    link: string;
-    name: string;
-    category: string;
-  };
-  override_callback_uri?: string;
-};
+declare enum FlowTypeEnum {
+  /** Health check/ping requests */
+  Ping = "ping",
+  /** Data exchange requests */
+  Change = "data_exchange",
+  /** Error notification requests */
+  Error = "error",
+  /** Match all flow action types */
+  All = "*",
+}
+type FlowType = (typeof FlowTypeEnum)[keyof typeof FlowTypeEnum];
 /**
- * Parameters for updating WABA subscription
+ * Flow Validation Error Pointer
  */
-interface UpdateWabaSubscription {
-  override_callback_uri: string;
-  verify_token: string;
+interface FlowValidationErrorPointer {
+  line_start: number;
+  line_end: number;
+  column_start: number;
+  column_end: number;
+  path: string;
 }
 /**
- * Response containing all WABA subscriptions
+ * Flow Validation Error
  */
-interface WabaSubscriptions {
-  data: Array<WabaSubscription>;
+interface FlowValidationError {
+  error: string;
+  error_type: string;
+  message: string;
+  line_start: number;
+  line_end: number;
+  column_start: number;
+  column_end: number;
+  pointers: FlowValidationErrorPointer[];
 }
 /**
- * WABA account review status enumeration
+ * Flow Item
  */
-declare enum WabaAccountReviewStatus {
-  Approved = "APPROVED",
-  Active = "ACTIVE",
-  Inactive = "INACTIVE",
-  Disabled = "DISABLED",
+interface Flow {
+  id: string;
+  name: string;
+  status: FlowStatusEnum;
+  categories: FlowCategoryEnum[];
+  validation_errors: FlowValidationError[];
 }
 /**
- * WABA health status for message sending capability
+ * Pagination Cursors
  */
-declare enum WabaHealthStatusCanSendMessage {
-  Blocked = "BLOCKED",
-  Limited = "LIMITED",
-  Available = "AVAILABLE",
+interface PaginationCursors {
+  before: string;
+  after: string;
 }
 /**
- * WABA account status enumeration
+ * Pagination Object
  */
-declare enum WabaAccountStatus {
-  Approved = "APPROVED",
-  Active = "ACTIVE",
-  Inactive = "INACTIVE",
-  Disabled = "DISABLED",
+interface Pagination {
+  cursors: PaginationCursors;
 }
 /**
- * Business verification status enumeration
+ * Flows List Response
  */
-declare enum WabaBusinessVerificationStatus {
-  Verified = "verified",
-  PendingSubmission = "pending_submission",
-  Unverified = "unverified",
-  Rejected = "rejected",
+interface FlowsListResponse {
+  data: Flow[];
+  paging: Pagination;
+}
+/**
+ * Flow Asset
+ */
+interface FlowAsset {
+  name: string;
+  asset_type: string;
+  download_url: string;
+}
+/**
+ * Flow Assets Response
+ */
+interface FlowAssetsResponse {
+  data: FlowAsset[];
+  paging: Pagination;
+}
+/**
+ * Flow Preview
+ */
+interface FlowPreview {
+  preview_url: string;
+  expires_at: string;
+}
+/**
+ * Flow Preview Response
+ */
+interface FlowPreviewResponse {
+  preview: FlowPreview;
+  id: string;
+}
+/**
+ * Flow Migration Result
+ */
+interface FlowMigrationResult {
+  source_name: string;
+  source_id: string;
+  migrated_id: string;
+}
+/**
+ * Flow Migration Failure
+ */
+interface FlowMigrationFailure {
+  source_name: string;
+  error_code: string;
+  error_message: string;
+}
+/**
+ * Create Flow Response
+ */
+interface CreateFlowResponse {
+  id: string;
+  success: boolean;
+  validation_errors?: FlowValidationError[];
+}
+/**
+ * Update Flow Response
+ */
+interface UpdateFlowResponse {
+  success: boolean;
+  validation_errors?: FlowValidationError[];
+}
+/**
+ * Flow Migration Response
+ */
+interface FlowMigrationResponse {
+  migrated_flows: FlowMigrationResult[];
+  failed_flows: FlowMigrationFailure[];
+}
+/**
+ * Validate Flow JSON Response
+ */
+interface ValidateFlowJsonResponse {
+  valid: boolean;
+  success: boolean;
+  validation_errors?: FlowValidationError[];
+}
+/**
+ * WhatsApp Flow Endpoint - Encrypted Request Payload
+ * Represents the raw encrypted data received from WhatsApp
+ */
+interface FlowEncryptedRequestPayload {
+  encrypted_aes_key: string;
+  encrypted_flow_data: string;
+  initial_vector: string;
+}
+/**
+ * WhatsApp Flow Endpoint - Decrypted Request Response
+ * Represents the successfully decrypted data and encryption keys
+ */
+interface FlowDecryptedRequestResponse {
+  decryptedBody: any;
+  aesKeyBuffer: Buffer;
+  initialVectorBuffer: Buffer;
+}
+/**
+ * WhatsApp Flow Endpoint - HTTP Request with Body
+ * Represents an HTTP request with the encrypted payload
+ */
+interface FlowHttpRequest extends IncomingMessage {
+  body: FlowEncryptedRequestPayload;
+  headers: IncomingHttpHeaders;
 }
 /**
- * WABA health status error details
+ * WhatsApp Flow Endpoint - Health Check Request
+ * Represents the structure of a health check request
  */
-interface WabaHealthStatusError {
-  error_code?: number;
-  error_description?: string;
-  possible_solution?: string;
+interface FlowHealthCheckRequest {
+  action: 'ping';
+  version: '3.0';
 }
 /**
- * WABA health status entity information
+ * WhatsApp Flow Endpoint - Health Check Response
+ * The expected response structure for health check requests
  */
-interface WabaHealthStatusEntity {
-  entity_type?: string;
-  id?: string;
-  can_send_message?: string;
-  errors?: WabaHealthStatusError[];
+interface FlowHealthCheckResponse {
+  data: {
+    status: 'active';
+  };
 }
 /**
- * Overall WABA health status
+ * WhatsApp Flow Endpoint - Data Exchange Request
+ * Represents the structure of a data exchange request
  */
-interface WabaHealthStatus {
-  can_send_message?: WabaHealthStatusCanSendMessage;
-  entities?: WabaHealthStatusEntity[];
+interface FlowDataExchangeRequest {
+  version: '3.0';
+  action: FlowActionEnum;
+  screen: string;
+  flow_token: string;
+  data?: Record<string, any> & {
+    error_message?: string;
+  };
 }
 /**
- * WhatsApp Business Account information
+ * WhatsApp Flow Endpoint - Data Exchange Response
+ * The expected response structure for data exchange requests
  */
-interface WabaAccount {
-  account_review_status?: WabaAccountReviewStatus;
-  id?: string;
-  health_status?: WabaHealthStatus;
-  status?: WabaAccountStatus;
-  business_verification_status?: WabaBusinessVerificationStatus;
-  message_template_namespace?: string;
-  name?: string;
-  ownership_type?: string;
-  currency?: string;
+interface FlowDataExchangeResponse {
+  screen?: string;
+  data?: Record<string, any | {
+    error_message?: string;
+  }>;
 }
 /**
- * Available fields for WABA account queries
+ * WhatsApp Flow Endpoint - Success Screen Response
+ * The expected response structure for success screen requests
  */
-type WabaAccountFields = 'id' | 'name' | 'account_review_status' | 'auth_international_rate_eligibility' | 'business_verification_status' | 'country' | 'currency' | 'health_status' | 'status' | 'ownership_type' | 'message_template_namespace';
+interface FlowSuccessScreenResponse {
+  screen: 'SUCCESS';
+  data: {
+    extension_message_response?: {
+      params?: {
+        flow_token: string;
+        [key: string]: string;
+      };
+    };
+  };
+}
 /**
- * Parameter type for specifying which WABA account fields to retrieve
+ * WhatsApp Flow Endpoint - Error Notification Request
+ * Represents the structure of an error notification request
  */
-type WabaAccountFieldsParam = WabaAccountFields[];
+interface FlowErrorNotificationRequest {
+  version: '3.0';
+  action: Exclude<FlowActionEnum, FlowActionEnum.BACK>;
+  screen: string;
+  flow_token: string;
+  data: {
+    error: string;
+    error_message: string;
+  };
+}
 /**
- * Interface defining all WABA API methods
+ * WhatsApp Flow Endpoint - Error Notification Response
+ * The expected response structure for error notification requests
  */
-interface WABAClass {
-  getWabaAccount(fields?: WabaAccountFieldsParam): Promise<WabaAccount>;
-  getAllWabaSubscriptions(): Promise<WabaSubscriptions>;
-  updateWabaSubscription(params: UpdateWabaSubscription): Promise<ResponseSuccess>;
-  unsubscribeFromWaba(): Promise<ResponseSuccess>;
-}
-//#endregion
-//#region src/api/registration/types/common.d.ts
-type RegistrationRequest = {
-  messaging_product: 'whatsapp';
-  pin: string;
-  data_localization_region?: DataLocalizationRegionEnum;
-};
-interface RegistrationClass {
-  register(pin: string, dataLocalizationRegion?: DataLocalizationRegionEnum): Promise<ResponseSuccess>;
-  deregister(): Promise<ResponseSuccess>;
-}
-//#endregion
-//#region src/api/twoStepVerification/types/common.d.ts
-type TwoStepVerificationRequest = {
-  pin: string;
-};
-interface TwoStepVerificationClass {
-  setTwoStepVerificationCode(pin: string): Promise<ResponseSuccess>;
+interface FlowErrorNotificationResponse {
+  acknowledged: boolean;
 }
-//#endregion
-//#region src/api/encryption/types/publicKey.d.ts
-type EncryptionPublicKeyResponse = ResponseData<{
-  business_public_key: string;
-  business_public_key_signature_status: 'VALID' | 'MISMATCH';
-}>;
-//#endregion
-//#region src/utils/isMetaError.d.ts
-interface MetaError extends Error {
-  error: {
-    message: string;
-    type: string;
-    code: number;
-    error_data?: {
-      messaging_product: 'whatsapp';
-      details: string;
-    };
-    error_subcode?: number;
-    fbtrace_id: string;
+/**
+ * WhatsApp Flow Endpoint - Comprehensive Request Object
+ * A combined type that includes all possible fields from different request types
+ * with all fields being optional for flexibility
+ */
+interface FlowEndpointRequest {
+  version?: '3.0';
+  action?: 'ping' | FlowActionEnum;
+  screen?: string;
+  flow_token?: string;
+  data?: Record<string, any> & {
+    error_key?: string;
+    error_message?: string;
   };
 }
 /**
- * Determines if the error is a Meta API error response
- * @param error Any error object to check
- * @returns Type guard indicating if error is a Meta API error
+ * WhatsApp Flow Endpoint - Response
+ * Union type for all possible response types from a Flow endpoint
  */
-
+type FlowEndpointResponse = FlowHealthCheckResponse | FlowDataExchangeResponse | FlowErrorNotificationResponse | FlowSuccessScreenResponse;
+interface FlowClass {
+  /**
+   * List Flows
+   *
+   * @param wabaId - The WABA ID
+   * @returns Promise with the list of flows
+   */
+  listFlows(wabaId: string): Promise<FlowsListResponse>;
+  /**
+   * Create Flow
+   *
+   * @param wabaId - The WABA ID
+   * @param data - The flow data including name, categories, endpoint_uri, and optional clone_flow_id
+   * @returns Promise with the created flow ID
+   */
+  createFlow(wabaId: string, data: {
+    name: string;
+    categories?: FlowCategoryEnum[];
+    endpoint_uri?: string;
+    clone_flow_id?: string;
+    flow_json?: string;
+    publish?: boolean;
+  }): Promise<CreateFlowResponse>;
+  /**
+   * Get Flow
+   *
+   * @param flowId - The flow ID
+   * @param fields - Optional fields to return
+   * @param dateFormat - Optional date format
+   * @returns Promise with the flow details
+   */
+  getFlow(flowId: string, fields?: string, dateFormat?: string): Promise<Flow | FlowPreviewResponse>;
+  /**
+   * Update Flow Metadata
+   *
+   * @param flowId - The flow ID
+   * @param data - The flow metadata to update
+   * @returns Promise with the success status
+   */
+  updateFlowMetadata(flowId: string, data: {
+    name?: string;
+    categories?: FlowCategoryEnum[];
+    endpoint_uri?: string;
+    application_id?: string;
+  }): Promise<ResponseSuccess>;
+  /**
+   * Delete Flow
+   *
+   * @param flowId - The flow ID
+   * @returns Promise with the success status
+   */
+  deleteFlow(flowId: string): Promise<ResponseSuccess>;
+  /**
+   * List Assets (Get Flow JSON URL)
+   *
+   * @param flowId - The flow ID
+   * @returns Promise with the list of assets
+   */
+  listAssets(flowId: string): Promise<FlowAssetsResponse>;
+  /**
+   * Update Flow JSON
+   *
+   * @param flowId - The flow ID
+   * @param data - The asset data including asset_type, file, and name
+   * @returns Promise with the success status and validation errors
+   */
+  updateFlowJson(flowId: string, data: {
+    file: Blob | Buffer | object;
+    name?: string;
+  }): Promise<UpdateFlowResponse>;
+  /**
+   * Validate Flow JSON by attempting an update without publishing.
+   * This is a convenience method; the API doesn't have a dedicated validation endpoint.
+   *
+   * @param flowId - The ID of the Flow (must exist, can be in DRAFT status).
+   * @param flowJsonData - The Flow JSON content as a Buffer, JSON object, or Blob.
+   * @returns Promise indicating if the JSON is valid and includes validation errors if any.
+   */
+  validateFlowJson(flowId: string, flowJsonData: Blob | Buffer | object): Promise<ValidateFlowJsonResponse>;
+  /**
+   * Publish Flow
+   *
+   * @param flowId - The flow ID
+   * @returns Promise with the success status
+   */
+  publishFlow(flowId: string): Promise<ResponseSuccess>;
+  /**
+   * Deprecate Flow
+   *
+   * @param flowId - The flow ID
+   * @returns Promise with the success status
+   */
+  deprecateFlow(flowId: string): Promise<ResponseSuccess>;
+  /**
+   * Migrate Flows
+   *
+   * @param wabaId - The destination WABA ID
+   * @param data - The migration data including source_waba_id and optional source_flow_names
+   * @returns Promise with migration results
+   */
+  migrateFlows(wabaId: string, data: {
+    source_waba_id: string;
+    source_flow_names?: string[];
+  }): Promise<FlowMigrationResponse>;
+}
 //#endregion
 export { type AccountMode, type AudioMediaObject, type AuthenticationTemplateOptions, type BaseClass, type BodyOptions, type BusinessProfileClass, type BusinessProfileData, type BusinessProfileField, type BusinessProfileFieldsParam, type BusinessProfileResponse, type ButtonOptions, type CarouselCard, type CarouselOptions, type CatalogButton, type CatalogTemplateOptions, type CodeVerificationStatus, type ComponentTypes, type ContactObject, type CopyCodeButton, type CouponTemplateOptions, CreateFlowResponse, type CreateQrCodeRequest, type CurrencyParameter, type Cursors, type DateTimeParameter, type DocumentMediaObject, type EncryptionPublicKeyResponse, type Flow, FlowActionEnum, type FlowAsset, type FlowAssetsResponse, type FlowButton, FlowCategoryEnum, type FlowClass, type FlowDataExchangeRequest, type FlowDataExchangeResponse, type FlowDecryptedRequestResponse, type FlowEncryptedRequestPayload, type FlowEndpointRequest, type FlowEndpointResponse, type FlowErrorNotificationRequest, type FlowErrorNotificationResponse, type FlowHealthCheckRequest, type FlowHealthCheckResponse, type FlowHttpRequest, type FlowMigrationFailure, type FlowMigrationResponse, type FlowMigrationResult, type FlowPreview, type FlowPreviewResponse, FlowStatusEnum, type FlowSuccessScreenResponse, type FlowType, FlowTypeEnum, type FlowValidationError, type FlowValidationErrorPointer, type FlowsListResponse, type FooterOptions, type GeneralHeaderInterface, type GeneralMessageBody, type GeneralRequestBody, type HeaderOptions, type HealthStatus, type HealthStatusEntity, type HttpsClientClass, type HttpsClientResponseClass, type ImageMediaObject, type InteractiveObject, type LimitedTimeOfferOptions, type LimitedTimeOfferTemplateOptions, type LocationObject, type LocationParameter, type LoggerInterface, type MPMButton, type MPMTemplateOptions, type MediaCardCarouselTemplateOptions, type MediaCarouselCard, MediaClass, type MediaParameter, MediaResponse, MediasResponse, type MessageRequestBody, type MessageRequestParams, type MessageTemplateObject, type MessagesClass, type MessagesResponse, type MessagingLimitTier, type MetaError, type OTPButton, type OTPTemplateOptions, type Pagination, type PaginationCursors, type Paging, type PhoneNumberButton, type PhoneNumberClass, type PhoneNumberResponse, type PhoneNumbersResponse, type PlatformType, type ProductCardCarouselTemplateOptions, type ProductCarouselCard, type ProductParameter, type ProductSection, type QrCodeClass, type QrCodeResponse, type QrCodesResponse, type QualityRating, type QualityScore, type QuickReplyButton, type ReactionParams, type RegistrationClass, type RegistrationRequest, type RequestVerificationCodeRequest, type RequesterClass, type RequesterResponseInterface, type ResponseData, type ResponseHeaderValue, type ResponseHeaders, type ResponseJSONBody, type ResponsePagination, type ResponseSuccess, type SPMButton, type SPMTemplateOptions, type StatusParams, type StickerMediaObject, type TemplateBody, type TemplateButton, type TemplateButtons, type TemplateCarousel, type TemplateClass, type TemplateDeleteParams, type TemplateFooter, type TemplateFormat, type TemplateGetParams, type TemplateHeader, type TemplateHeaderExample, type TemplateLimitedTimeOffer, type TemplateOptions, type TemplateParameter, type TemplateRequestBody, type TemplateResponse, type TextMessageParams, type TextObject, type TextParameter, type Throughput, type ThroughputLevel, type TwoStepVerificationClass, type TwoStepVerificationParams, type TwoStepVerificationRequest, type URLButton, type UpdateBusinessProfileRequest, type UpdateFlowResponse, type UpdateQrCodeRequest, type UpdateWabaSubscription, UploadMediaResponse, type ValidateFlowJsonResponse, type VerifyCodeRequest, type VideoMediaObject, type WABAClass, type WabaAccount, type WabaAccountFields, type WabaAccountFieldsParam, WabaAccountReviewStatus, WabaAccountStatus, WabaBusinessVerificationStatus, type WabaConfigType, type WabaHealthStatus, WabaHealthStatusCanSendMessage, type WabaHealthStatusEntity, type WabaHealthStatusError, type WabaSubscription, type WabaSubscriptions, type WebhookContact, type WebhookEvent, type WebhookMessage, type WhatsAppConfig };
 //# sourceMappingURL=index.d.ts.map