meta-cloud-api 1.1.5 → 1.1.6

package/dist/api/flow/types/common.d.ts

@@ -0,0 +1,406 @@
+import { ResponseSuccess } from "../../../types/request.js";
+import { IncomingHttpHeaders, IncomingMessage } from "http";
+
+//#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",
+}
+/**
+ * Enum for Flow Categories
+ */
+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",
+}
+/**
+ * Enum for Flow Types in webhook handlers
+ * Used to register handlers for specific flow events
+ */
+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];
+/**
+ * Flow Validation Error Pointer
+ */
+interface FlowValidationErrorPointer {
+  line_start: number;
+  line_end: number;
+  column_start: number;
+  column_end: number;
+  path: string;
+}
+/**
+ * Flow Validation Error
+ */
+interface FlowValidationError {
+  error: string;
+  error_type: string;
+  message: string;
+  line_start: number;
+  line_end: number;
+  column_start: number;
+  column_end: number;
+  pointers: FlowValidationErrorPointer[];
+}
+/**
+ * Flow Item
+ */
+interface Flow {
+  id: string;
+  name: string;
+  status: FlowStatusEnum;
+  categories: FlowCategoryEnum[];
+  validation_errors: FlowValidationError[];
+}
+/**
+ * Pagination Cursors
+ */
+interface PaginationCursors {
+  before: string;
+  after: 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
+export { CreateFlowResponse, Flow, FlowActionEnum, FlowAsset, FlowAssetsResponse, FlowCategoryEnum, FlowClass, FlowDataExchangeRequest, FlowDataExchangeResponse, FlowDecryptedRequestResponse, FlowEncryptedRequestPayload, FlowEndpointRequest, FlowEndpointResponse, FlowErrorNotificationRequest, FlowErrorNotificationResponse, FlowHealthCheckRequest, FlowHealthCheckResponse, FlowHttpRequest, FlowMigrationFailure, FlowMigrationResponse, FlowMigrationResult, FlowPreview, FlowPreviewResponse, FlowStatusEnum, FlowSuccessScreenResponse, FlowType, FlowTypeEnum, FlowValidationError, FlowValidationErrorPointer, FlowsListResponse, Pagination, PaginationCursors, UpdateFlowResponse, ValidateFlowJsonResponse };
+//# sourceMappingURL=common.d.ts.map

package/dist/api/flow/types/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","names":[],"sources":["../../../../src/api/flow/types/common.ts"],"sourcesContent":[],"mappings":";;;;;;;AAMA;AAWY,aAXA,cAAA;EAsBA,KAAA,GAAA,OAAA;EAUA,SAAA,GAAA,WAAY;EAWZ,SAAA,GAAQ,WAAA;EAAA,OAAA,GAAA,SAAA;YAAW,GAAA,YAAA;;;AAK/B;AAWA;AAciB,aA9DL,gBAAA;EA8DS,MAAA,GAAA,SAAA;QAGT,GAAA,SAAA;oBACI,GAAA,qBAAA;gBACO,GAAA,iBAAA;EAAmB,SAAA,GAAA,YAAA;EAMzB,eAAA,GAAA,kBAAiB;EAQjB,MAAA,GAAA,QAAU;EAOV,KAAA,GAAA,OAAA;;AACP,aA9EE,cAAA;MA+EA,GAAA,MAAA;EAAU,IAAA,GAAA,MAAA;EAML,aAAS,GAAA,eAAA;AAS1B;;;;;AAQiB,aA5FL,YAAA;EAoGK;EAQA,IAAA,GAAA,MAAA;EASA;EASA,MAAA,GAAA,eAAkB;EASlB;EAQA,KAAA,GAAA,OAAA;EAAqB;KAClB,GAAA,GAAA;;AACkB,KAtI1B,QAAA,GAsI0B,CAAA,OAtIP,YAsIO,CAAA,CAAA,MAAA,OAtIoB,YAsIpB,CAAA;AAMtC;AAUA;AAUA;AAA6C,UA3J5B,0BAAA,CA2J4B;YAE3B,EAAA,MAAA;UACO,EAAA,MAAA;EAAM,YAAA,EAAA,MAAA;EAOd,UAAA,EAAA,MAAgB;EAAA,IAAA,EAAA,MAAA;;;;;AAShB,UAnKA,mBAAA,CAmKsB;EAStB,KAAA,EAAA,MAAA;EAUA,UAAA,EAAA,MAAA;EAAuB,OAAA,EAAA,MAAA;YAE5B,EAAA,MAAA;UAGD,EAAA,MAAA;EAAM,YAAA,EAAA,MAAA;EAOA,UAAA,EAAA,MAAA;EASA,QAAA,EAnMH,0BAmM4B,EAAA;AAgB1C;;;;AAEY,UA/MK,IAAA,CA+ML;EAAO,EAAA,EAAA,MAAA;EAaF,IAAA,EAAA,MAAA;EASA,MAAA,EAlOL,cAkOwB;EAAA,UAAA,EAjOpB,gBAiOoB,EAAA;mBAGd,EAnOC,mBAmOD,EAAA;;;AAetB;;AACM,UA7OW,iBAAA,CA6OX;QACA,EAAA,MAAA;OACA,EAAA,MAAA;;;AAGN;;AAOuC,UAjPtB,UAAA,CAiPsB;SAAR,EAhPlB,iBAgPkB;;;;;AA6BmD,UAvQjE,iBAAA,CAuQiE;MAAf,EAtQzD,IAsQyD,EAAA;QAa1C,EAlRb,UAkRa;;;;;AAoBe,UAhSvB,SAAA,CAgSuB;MAAR,EAAA,MAAA;YAYd,EAAA,MAAA;cAAO,EAAA,MAAA;;;;;AAa2D,UAhTnE,kBAAA,CAgTmE;MAAR,EA/SlE,SA+SkE,EAAA;QAQnC,EAtT7B,UAsT6B;;;;;AAuBlC,UAvUU,WAAA,CAuUV;EAAO,WAAA,EAAA,MAAA;;;;;;UA/TG,mBAAA;WACJ;;;;;;UAOI,mBAAA;;;;;;;;UASA,oBAAA;;;;;;;;UASA,kBAAA;;;sBAGO;;;;;UAMP,kBAAA;;sBAEO;;;;;UAMP,qBAAA;kBACG;gBACF;;;;;UAMD,wBAAA;;;sBAGO;;;;;;UAOP,2BAAA;;;;;;;;;UAUA,4BAAA;;gBAEC;uBACO;;;;;;UAOR,eAAA,SAAwB;QAC/B;WACG;;;;;;UAOI,sBAAA;;;;;;;;UASA,uBAAA;;;;;;;;;UAUA,uBAAA;;UAEL;;;SAGD;;;;;;;;UAOM,wBAAA;;SAEN;;;;;;;;UAOM,yBAAA;;;;;;;;;;;;;;;UAgBA,4BAAA;;UAEL,QAAQ,gBAAgB,cAAA,CAAe;;;;;;;;;;;;UAalC,6BAAA;;;;;;;;UASA,mBAAA;;oBAGK;;;SAKX;;;;;;;;;KAUC,oBAAA,GACN,0BACA,2BACA,gCACA;UAEW,SAAA;;;;;;;6BAOc,QAAQ;;;;;;;;;;iBAad;;;;;MAMlB,QAAQ;;;;;;;;;iEAUoD,QAAQ,OAAO;;;;;;;;;;iBAazD;;;MAIlB,QAAQ;;;;;;;8BAQiB,QAAQ;;;;;;;8BAQR,QAAQ;;;;;;;;;UAYtB,OAAO;;MAGlB,QAAQ;;;;;;;;;iDAUoC,OAAO,kBAAkB,QAAQ;;;;;;;+BAQnD,QAAQ;;;;;;;iCAQN,QAAQ;;;;;;;;;;;MAepC,QAAQ"}

package/dist/api/flow/types/common.js

@@ -0,0 +1,51 @@
+//#region src/api/flow/types/common.ts
+/**
+* Enum for Flow Status
+*/
+let FlowStatusEnum = /* @__PURE__ */ function(FlowStatusEnum$1) {
+	FlowStatusEnum$1["Draft"] = "DRAFT";
+	FlowStatusEnum$1["Published"] = "PUBLISHED";
+	FlowStatusEnum$1["Throttled"] = "THROTTLED";
+	FlowStatusEnum$1["Blocked"] = "BLOCKED";
+	FlowStatusEnum$1["Deprecated"] = "DEPRECATED";
+	return FlowStatusEnum$1;
+}({});
+/**
+* Enum for Flow Categories
+*/
+let FlowCategoryEnum = /* @__PURE__ */ function(FlowCategoryEnum$1) {
+	FlowCategoryEnum$1["SignUp"] = "SIGN_UP";
+	FlowCategoryEnum$1["SignIn"] = "SIGN_IN";
+	FlowCategoryEnum$1["AppointmentBooking"] = "APPOINTMENT_BOOKING";
+	FlowCategoryEnum$1["LeadGeneration"] = "LEAD_GENERATION";
+	FlowCategoryEnum$1["ContactUs"] = "CONTACT_US";
+	FlowCategoryEnum$1["CustomerSupport"] = "CUSTOMER_SUPPORT";
+	FlowCategoryEnum$1["Survey"] = "SURVEY";
+	FlowCategoryEnum$1["Other"] = "OTHER";
+	return FlowCategoryEnum$1;
+}({});
+let FlowActionEnum = /* @__PURE__ */ function(FlowActionEnum$1) {
+	FlowActionEnum$1["INIT"] = "INIT";
+	FlowActionEnum$1["BACK"] = "BACK";
+	FlowActionEnum$1["DATA_EXCHANGE"] = "data_exchange";
+	return FlowActionEnum$1;
+}({});
+/**
+* Enum for Flow Types in webhook handlers
+* Used to register handlers for specific flow events
+*/
+let FlowTypeEnum = /* @__PURE__ */ function(FlowTypeEnum$1) {
+	/** Health check/ping requests */
+	FlowTypeEnum$1["Ping"] = "ping";
+	/** Data exchange requests */
+	FlowTypeEnum$1["Change"] = "data_exchange";
+	/** Error notification requests */
+	FlowTypeEnum$1["Error"] = "error";
+	/** Match all flow action types */
+	FlowTypeEnum$1["All"] = "*";
+	return FlowTypeEnum$1;
+}({});
+
+//#endregion
+export { FlowActionEnum, FlowCategoryEnum, FlowStatusEnum, FlowTypeEnum };
+//# sourceMappingURL=common.js.map

package/dist/api/flow/types/common.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.js","names":[],"sources":["../../../../src/api/flow/types/common.ts"],"sourcesContent":["import { ResponseSuccess } from '../../../types';\nimport { IncomingHttpHeaders, IncomingMessage } from 'http';\n\n/**\n * Enum for Flow Status\n */\nexport enum FlowStatusEnum {\n    Draft = 'DRAFT',\n    Published = 'PUBLISHED',\n    Throttled = 'THROTTLED',\n    Blocked = 'BLOCKED',\n    Deprecated = 'DEPRECATED',\n}\n\n/**\n * Enum for Flow Categories\n */\nexport enum FlowCategoryEnum {\n    SignUp = 'SIGN_UP',\n    SignIn = 'SIGN_IN',\n    AppointmentBooking = 'APPOINTMENT_BOOKING',\n    LeadGeneration = 'LEAD_GENERATION',\n    ContactUs = 'CONTACT_US',\n    CustomerSupport = 'CUSTOMER_SUPPORT',\n    Survey = 'SURVEY',\n    Other = 'OTHER',\n}\n\nexport enum FlowActionEnum {\n    INIT = 'INIT',\n    BACK = 'BACK',\n    DATA_EXCHANGE = 'data_exchange',\n}\n\n/**\n * Enum for Flow Types in webhook handlers\n * Used to register handlers for specific flow events\n */\nexport enum FlowTypeEnum {\n    /** Health check/ping requests */\n    Ping = 'ping',\n    /** Data exchange requests */\n    Change = 'data_exchange',\n    /** Error notification requests */\n    Error = 'error',\n    /** Match all flow action types */\n    All = '*',\n}\n\nexport type FlowType = (typeof FlowTypeEnum)[keyof typeof FlowTypeEnum];\n\n/**\n * Flow Validation Error Pointer\n */\nexport interface FlowValidationErrorPointer {\n    line_start: number;\n    line_end: number;\n    column_start: number;\n    column_end: number;\n    path: string;\n}\n\n/**\n * Flow Validation Error\n */\nexport interface FlowValidationError {\n    error: string;\n    error_type: string;\n    message: string;\n    line_start: number;\n    line_end: number;\n    column_start: number;\n    column_end: number;\n    pointers: FlowValidationErrorPointer[];\n}\n\n/**\n * Flow Item\n */\nexport interface Flow {\n    id: string;\n    name: string;\n    status: FlowStatusEnum;\n    categories: FlowCategoryEnum[];\n    validation_errors: FlowValidationError[];\n}\n\n/**\n * Pagination Cursors\n */\nexport interface PaginationCursors {\n    before: string;\n    after: string;\n}\n\n/**\n * Pagination Object\n */\nexport interface Pagination {\n    cursors: PaginationCursors;\n}\n\n/**\n * Flows List Response\n */\nexport interface FlowsListResponse {\n    data: Flow[];\n    paging: Pagination;\n}\n\n/**\n * Flow Asset\n */\nexport interface FlowAsset {\n    name: string;\n    asset_type: string;\n    download_url: string;\n}\n\n/**\n * Flow Assets Response\n */\nexport interface FlowAssetsResponse {\n    data: FlowAsset[];\n    paging: Pagination;\n}\n\n/**\n * Flow Preview\n */\nexport interface FlowPreview {\n    preview_url: string;\n    expires_at: string;\n}\n\n/**\n * Flow Preview Response\n */\nexport interface FlowPreviewResponse {\n    preview: FlowPreview;\n    id: string;\n}\n\n/**\n * Flow Migration Result\n */\nexport interface FlowMigrationResult {\n    source_name: string;\n    source_id: string;\n    migrated_id: string;\n}\n\n/**\n * Flow Migration Failure\n */\nexport interface FlowMigrationFailure {\n    source_name: string;\n    error_code: string;\n    error_message: string;\n}\n\n/**\n * Create Flow Response\n */\nexport interface CreateFlowResponse {\n    id: string;\n    success: boolean;\n    validation_errors?: FlowValidationError[];\n}\n\n/**\n * Update Flow Response\n */\nexport interface UpdateFlowResponse {\n    success: boolean;\n    validation_errors?: FlowValidationError[];\n}\n\n/**\n * Flow Migration Response\n */\nexport interface FlowMigrationResponse {\n    migrated_flows: FlowMigrationResult[];\n    failed_flows: FlowMigrationFailure[];\n}\n\n/**\n * Validate Flow JSON Response\n */\nexport interface ValidateFlowJsonResponse {\n    valid: boolean;\n    success: boolean;\n    validation_errors?: FlowValidationError[];\n}\n\n/**\n * WhatsApp Flow Endpoint - Encrypted Request Payload\n * Represents the raw encrypted data received from WhatsApp\n */\nexport interface FlowEncryptedRequestPayload {\n    encrypted_aes_key: string;\n    encrypted_flow_data: string;\n    initial_vector: string;\n}\n\n/**\n * WhatsApp Flow Endpoint - Decrypted Request Response\n * Represents the successfully decrypted data and encryption keys\n */\nexport interface FlowDecryptedRequestResponse {\n    decryptedBody: any;\n    aesKeyBuffer: Buffer;\n    initialVectorBuffer: Buffer;\n}\n\n/**\n * WhatsApp Flow Endpoint - HTTP Request with Body\n * Represents an HTTP request with the encrypted payload\n */\nexport interface FlowHttpRequest extends IncomingMessage {\n    body: FlowEncryptedRequestPayload;\n    headers: IncomingHttpHeaders;\n}\n\n/**\n * WhatsApp Flow Endpoint - Health Check Request\n * Represents the structure of a health check request\n */\nexport interface FlowHealthCheckRequest {\n    action: 'ping';\n    version: '3.0';\n}\n\n/**\n * WhatsApp Flow Endpoint - Health Check Response\n * The expected response structure for health check requests\n */\nexport interface FlowHealthCheckResponse {\n    data: {\n        status: 'active';\n    };\n}\n\n/**\n * WhatsApp Flow Endpoint - Data Exchange Request\n * Represents the structure of a data exchange request\n */\nexport interface FlowDataExchangeRequest {\n    version: '3.0';\n    action: FlowActionEnum;\n    screen: string;\n    flow_token: string;\n    data?: Record<string, any> & { error_message?: string };\n}\n\n/**\n * WhatsApp Flow Endpoint - Data Exchange Response\n * The expected response structure for data exchange requests\n */\nexport interface FlowDataExchangeResponse {\n    screen?: string;\n    data?: Record<string, any | { error_message?: string }>;\n}\n\n/**\n * WhatsApp Flow Endpoint - Success Screen Response\n * The expected response structure for success screen requests\n */\nexport interface FlowSuccessScreenResponse {\n    screen: 'SUCCESS';\n    data: {\n        extension_message_response?: {\n            params?: {\n                flow_token: string;\n                [key: string]: string;\n            };\n        };\n    };\n}\n\n/**\n * WhatsApp Flow Endpoint - Error Notification Request\n * Represents the structure of an error notification request\n */\nexport interface FlowErrorNotificationRequest {\n    version: '3.0';\n    action: Exclude<FlowActionEnum, FlowActionEnum.BACK>;\n    screen: string;\n    flow_token: string;\n    data: {\n        error: string;\n        error_message: string;\n    };\n}\n\n/**\n * WhatsApp Flow Endpoint - Error Notification Response\n * The expected response structure for error notification requests\n */\nexport interface FlowErrorNotificationResponse {\n    acknowledged: boolean;\n}\n\n/**\n * WhatsApp Flow Endpoint - Comprehensive Request Object\n * A combined type that includes all possible fields from different request types\n * with all fields being optional for flexibility\n */\nexport interface FlowEndpointRequest {\n    // Common fields\n    version?: '3.0';\n    action?: 'ping' | FlowActionEnum;\n\n    screen?: string;\n    flow_token?: string;\n\n    data?: Record<string, any> & {\n        error_key?: string;\n        error_message?: string;\n    };\n}\n\n/**\n * WhatsApp Flow Endpoint - Response\n * Union type for all possible response types from a Flow endpoint\n */\nexport type FlowEndpointResponse =\n    | FlowHealthCheckResponse\n    | FlowDataExchangeResponse\n    | FlowErrorNotificationResponse\n    | FlowSuccessScreenResponse;\n\nexport interface FlowClass {\n    /**\n     * List Flows\n     *\n     * @param wabaId - The WABA ID\n     * @returns Promise with the list of flows\n     */\n    listFlows(wabaId: string): Promise<FlowsListResponse>;\n\n    /**\n     * Create Flow\n     *\n     * @param wabaId - The WABA ID\n     * @param data - The flow data including name, categories, endpoint_uri, and optional clone_flow_id\n     * @returns Promise with the created flow ID\n     */\n    createFlow(\n        wabaId: string,\n        data: {\n            name: string;\n            categories?: FlowCategoryEnum[];\n            endpoint_uri?: string;\n            clone_flow_id?: string;\n            flow_json?: string;\n            publish?: boolean;\n        },\n    ): Promise<CreateFlowResponse>;\n\n    /**\n     * Get Flow\n     *\n     * @param flowId - The flow ID\n     * @param fields - Optional fields to return\n     * @param dateFormat - Optional date format\n     * @returns Promise with the flow details\n     */\n    getFlow(flowId: string, fields?: string, dateFormat?: string): Promise<Flow | FlowPreviewResponse>;\n\n    /**\n     * Update Flow Metadata\n     *\n     * @param flowId - The flow ID\n     * @param data - The flow metadata to update\n     * @returns Promise with the success status\n     */\n    updateFlowMetadata(\n        flowId: string,\n        data: {\n            name?: string;\n            categories?: FlowCategoryEnum[];\n            endpoint_uri?: string;\n            application_id?: string;\n        },\n    ): Promise<ResponseSuccess>;\n\n    /**\n     * Delete Flow\n     *\n     * @param flowId - The flow ID\n     * @returns Promise with the success status\n     */\n    deleteFlow(flowId: string): Promise<ResponseSuccess>;\n\n    /**\n     * List Assets (Get Flow JSON URL)\n     *\n     * @param flowId - The flow ID\n     * @returns Promise with the list of assets\n     */\n    listAssets(flowId: string): Promise<FlowAssetsResponse>;\n\n    /**\n     * Update Flow JSON\n     *\n     * @param flowId - The flow ID\n     * @param data - The asset data including asset_type, file, and name\n     * @returns Promise with the success status and validation errors\n     */\n    updateFlowJson(\n        flowId: string,\n        data: {\n            file: Blob | Buffer | object;\n            name?: string;\n        },\n    ): Promise<UpdateFlowResponse>;\n\n    /**\n     * Validate Flow JSON by attempting an update without publishing.\n     * This is a convenience method; the API doesn't have a dedicated validation endpoint.\n     *\n     * @param flowId - The ID of the Flow (must exist, can be in DRAFT status).\n     * @param flowJsonData - The Flow JSON content as a Buffer, JSON object, or Blob.\n     * @returns Promise indicating if the JSON is valid and includes validation errors if any.\n     */\n    validateFlowJson(flowId: string, flowJsonData: Blob | Buffer | object): Promise<ValidateFlowJsonResponse>;\n\n    /**\n     * Publish Flow\n     *\n     * @param flowId - The flow ID\n     * @returns Promise with the success status\n     */\n    publishFlow(flowId: string): Promise<ResponseSuccess>;\n\n    /**\n     * Deprecate Flow\n     *\n     * @param flowId - The flow ID\n     * @returns Promise with the success status\n     */\n    deprecateFlow(flowId: string): Promise<ResponseSuccess>;\n\n    /**\n     * Migrate Flows\n     *\n     * @param wabaId - The destination WABA ID\n     * @param data - The migration data including source_waba_id and optional source_flow_names\n     * @returns Promise with migration results\n     */\n    migrateFlows(\n        wabaId: string,\n        data: {\n            source_waba_id: string;\n            source_flow_names?: string[];\n        },\n    ): Promise<FlowMigrationResponse>;\n}\n"],"mappings":";;;;AAMA,IAAY,4DAAL;AACH;AACA;AACA;AACA;AACA;;;;;;AAMJ,IAAY,gEAAL;AACH;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;AAGJ,IAAY,4DAAL;AACH;AACA;AACA;;;;;;;AAOJ,IAAY,wDAAL;;AAEH;;AAEA;;AAEA;;AAEA"}

package/dist/api/flow/types/index.d.ts

@@ -0,0 +1 @@
+import { CreateFlowResponse, Flow, FlowActionEnum, FlowAsset, FlowAssetsResponse, FlowCategoryEnum, FlowClass, FlowDataExchangeRequest, FlowDataExchangeResponse, FlowDecryptedRequestResponse, FlowEncryptedRequestPayload, FlowEndpointRequest, FlowEndpointResponse, FlowErrorNotificationRequest, FlowErrorNotificationResponse, FlowHealthCheckRequest, FlowHealthCheckResponse, FlowHttpRequest, FlowMigrationFailure, FlowMigrationResponse, FlowMigrationResult, FlowPreview, FlowPreviewResponse, FlowStatusEnum, FlowSuccessScreenResponse, FlowType, FlowTypeEnum, FlowValidationError, FlowValidationErrorPointer, FlowsListResponse, Pagination, PaginationCursors, UpdateFlowResponse, ValidateFlowJsonResponse } from "./common.js";

package/dist/api/flow/types/index.js

@@ -0,0 +1 @@
+import { FlowActionEnum, FlowCategoryEnum, FlowStatusEnum, FlowTypeEnum } from "./common.js";

package/dist/api/media/types/common.d.ts

@@ -0,0 +1,32 @@
+import { ResponseSuccess } from "../../../types/request.js";
+
+//#region src/api/media/types/common.d.ts
+type MediaResponse = {
+  id: string;
+  url: string;
+  mime_type: string;
+  sha256: string;
+  file_size: number;
+  messaging_product: 'whatsapp';
+};
+type MediasResponse = {
+  data: MediaResponse[];
+  paging: {
+    cursors: {
+      before: string;
+      after: string;
+    };
+  };
+};
+type UploadMediaResponse = {
+  id: string;
+};
+interface MediaClass {
+  getMediaById(mediaId: string, phone_number_id?: string): Promise<MediaResponse>;
+  uploadMedia(file: File, messagingProduct?: string): Promise<UploadMediaResponse>;
+  deleteMedia(mediaId: string, phone_number_id?: string): Promise<ResponseSuccess>;
+  downloadMedia(mediaUrl: string): Promise<Blob>;
+}
+//#endregion
+export { MediaClass, MediaResponse, MediasResponse, UploadMediaResponse };
+//# sourceMappingURL=common.d.ts.map

package/dist/api/media/types/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","names":[],"sources":["../../../../src/api/media/types/common.ts"],"sourcesContent":[],"mappings":";;;KAEY,aAAA;;EAAA,GAAA,EAAA,MAAA;EASA,SAAA,EAAA,MAAc;EAUd,MAAA,EAAA,MAAA;EAIK,SAAA,EAAA,MAAU;EAAA,iBAAA,EAAA,UAAA;;AACkC,KAfjD,cAAA,GAeiD;MACvC,EAfZ,aAeY,EAAA;QAA0C,EAAA;IAAR,OAAA,EAAA;MACY,MAAA,EAAA,MAAA;MAAR,KAAA,EAAA,MAAA;IACf,CAAA;;CAAD;KARhC,mBAAA;;;UAIK,UAAA;2DAC4C,QAAQ;oBAC/C,kCAAkC,QAAQ;0DACJ,QAAQ;mCAC/B,QAAQ"}

package/dist/api/media/types/index.d.ts

@@ -0,0 +1 @@
+import { MediaClass, MediaResponse, MediasResponse, UploadMediaResponse } from "./common.js";

package/dist/api/messages/types/common.d.ts

@@ -0,0 +1,99 @@
+import { ComponentTypesEnum, InteractiveTypesEnum, MessageTypesEnum } from "../../../types/enums.js";
+import { GeneralRequestBody } from "../../../types/request.js";
+import { BaseClass } from "../../../types/base.js";
+import { TextMessageParams } from "./text.js";
+import { MessageTemplateObject } from "./template.js";
+import { AudioMediaObject, DocumentMediaObject, ImageMediaObject, StickerMediaObject, VideoMediaObject } from "./media.js";
+import { ContactObject } from "./contact.js";
+import { LocationObject } from "./location.js";
+import { InteractiveObject } from "./interactive.js";
+import { ReactionParams } from "./reaction.js";
+
+//#region src/api/messages/types/common.d.ts
+type GeneralMessageBody = GeneralRequestBody & {
+  /**
+   * The Meta messaging product name.
+   * @default 'whatsapp'
+   */
+  messaging_product: 'whatsapp';
+};
+type StatusObject = {
+  status: 'read';
+  message_id: string;
+  typing_indicator?: TypingIndicatorObject;
+};
+type TypingIndicatorObject = {
+  type: 'text';
+};
+type StatusRequestBody = GeneralMessageBody & StatusObject;
+type ConTextObject = {
+  message_id: string;
+};
+type MessageRequestBody<T extends MessageTypesEnum> = GeneralMessageBody & {
+  recipient_type?: string;
+  to: string;
+  context?: ConTextObject;
+  type?: T;
+};
+interface MessageRequestParams<T> {
+  body: T;
+  to: string;
+  replyMessageId?: string;
+}
+interface StatusParams {
+  status: string;
+  messageId: string;
+  typingIndicator?: {
+    type: string;
+  };
+}
+type MessagesResponse = GeneralMessageBody & {
+  contacts: [{
+    input: string;
+    wa_id: string;
+  }];
+  messages: [{
+    id: string;
+  }];
+};
+declare class MessagesClass extends BaseClass {
+  text(params: TextMessageParams): Promise<MessagesResponse>;
+  template(params: MessageRequestParams<MessageTemplateObject<ComponentTypesEnum>>): Promise<MessagesResponse>;
+  audio(params: MessageRequestParams<AudioMediaObject>): Promise<MessagesResponse>;
+  document(params: MessageRequestParams<DocumentMediaObject>): Promise<MessagesResponse>;
+  image(params: MessageRequestParams<ImageMediaObject>): Promise<MessagesResponse>;
+  video(params: MessageRequestParams<VideoMediaObject>): Promise<MessagesResponse>;
+  sticker(params: MessageRequestParams<StickerMediaObject>): Promise<MessagesResponse>;
+  contacts(params: MessageRequestParams<[ContactObject]>): Promise<MessagesResponse>;
+  location(params: MessageRequestParams<LocationObject>): Promise<MessagesResponse>;
+  interactive(params: MessageRequestParams<InteractiveObject>): Promise<MessagesResponse>;
+  interactiveList(params: MessageRequestParams<InteractiveObject & {
+    type: InteractiveTypesEnum.List;
+  }>): Promise<MessagesResponse>;
+  interactiveCtaUrl(params: MessageRequestParams<InteractiveObject & {
+    type: InteractiveTypesEnum.CtaUrl;
+  }>): Promise<MessagesResponse>;
+  interactiveLocationRequest(params: MessageRequestParams<InteractiveObject & {
+    type: InteractiveTypesEnum.LocationRequest;
+  }>): Promise<MessagesResponse>;
+  interactiveAddressMessage(params: MessageRequestParams<InteractiveObject & {
+    type: InteractiveTypesEnum.AddressMessage;
+  }>): Promise<MessagesResponse>;
+  interactiveReplyButtons(params: MessageRequestParams<InteractiveObject & {
+    type: InteractiveTypesEnum.Button;
+  }>): Promise<MessagesResponse>;
+  interactiveFlow(params: MessageRequestParams<InteractiveObject & {
+    type: InteractiveTypesEnum.Flow;
+  }>): Promise<MessagesResponse>;
+  reaction(params: ReactionParams): Promise<MessagesResponse>;
+  markAsRead(params: {
+    messageId: string;
+  }): Promise<MessagesResponse>;
+  showTypingIndicator(params: {
+    messageId: string;
+  }): Promise<MessagesResponse>;
+  status(params: StatusParams): Promise<MessagesResponse>;
+}
+//#endregion
+export { GeneralMessageBody, MessageRequestBody, MessageRequestParams, MessagesClass, MessagesResponse, StatusParams };
+//# sourceMappingURL=common.d.ts.map

package/dist/api/messages/types/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","names":[],"sources":["../../../../src/api/messages/types/common.ts"],"sourcesContent":[],"mappings":";;;;;;;;;;;;KAIY,kBAAA,GAAqB;;;;;;;KAQrB,YAAA;;EARA,UAAA,EAAA,MAAA;EAQA,gBAAY,CAAA,EAGD,qBAAA;AAGvB,CAAA;AAIY,KAJA,qBAAA,GAIiB;EAAA,IAAA,EAAA,MAAA;;AAAwB,KAAzC,iBAAA,GAAoB,kBAAqB,GAAA,YAAA;KAEhD,aAAA,GAF4D;EAE5D,UAAA,EAAA,MAAa;AAIlB,CAAA;AAA8B,KAAlB,kBAAkB,CAAA,UAAW,gBAAX,CAAA,GAA+B,kBAA/B,GAAA;gBAAW,CAAA,EAAA,MAAA;MAAoB,MAAA;SAG/C,CAAA,EAAA,aAAA;MACH,CAAA,EAAA,CAAA;CAAC;AAIK,UAAA,oBAAoB,CAAA,CAC3B,CAAA,CAAC;EAKM,IAAA,EALP,CAKO;EASL,EAAA,EAAA,MAAA;EAeS,cAAA,CAAA,EAAc,MAAA;;AAAA,UAxBlB,YAAA,CAwBkB;QAE2B,EAAA,MAAA;WAAR,EAAA,MAAA;iBAI0B,CAAA,EAAA;IAAkB,IAAA,EAAA,MAAA;;;AAC3F,KAtBK,gBAAA,GAAmB,kBAsBxB,GAAA;UAAO,EAAA,CAGI;IAAmE,KAAA,EAAA,MAAA;IAAR,KAAA,EAAA,MAAA;EAAO,CAAA;UACO,EAAA,CAAR;IAAO,EAAA,EAAA,MAAA;EACxE,CAAA;;AAAkE,cAZ/D,aAAA,SAAsB,SAAA,CAYyC;MAClE,CAAA,MAAA,EAbiB,iBAajB,CAAA,EAXoC,OAWpC,CAX4C,gBAW5C,CAAA;UAAmE,CAAA,MAAA,EAPrE,oBAOqE,CAPa,qBAOb,CAPL,kBAOK,CAAA,CAAA,CAAA,EAN9E,OAM8E,CANtE,gBAMsE,CAAA;OAAR,CAAA,MAAA,EAH3D,oBAG2D,CAN/D,gBAAA,CAM+D,CAAA,EAHA,OAGA,CAHQ,gBAGR,CAAA;UAAO,CAAA,MAAA,EAF/D,oBAE+D,CAHA,mBAAA,CAGA,CAAA,EAFD,OAEC,CAFO,gBAEP,CAAA;OAChE,CAAA,MAAA,EAFF,oBAEE,CAHsE,gBAAA,CAGtE,CAAA,EAFyD,OAEzD,CAFiE,gBAEjE,CAAA;OAAqE,CAAA,MAAA,EADvE,oBACuE,CAFL,gBAAA,CAEK,CAAA,EADZ,OACY,CADJ,gBACI,CAAA;SAAR,CAAA,MAAA,EAA7D,oBAA6D,CADG,kBAAA,CACH,CAAA,EAAA,OAAA,CAAQ,gBAAR,CAAA;UAAO,CAAA,MAAA,EAGnE,oBAHmE,CAAA,CAAA,aAAA,CAAA,CAAA,CAAA,EAGP,OAHO,CAGC,gBAHD,CAAA;UAGnE,CAAA,MAAA,EAGA,oBAHA,CAAmE,cAAA,CAAnE,CAAA,EAG4D,OAH5D,CAGoE,gBAHpE,CAAA;aAAoE,CAAA,MAAA,EAMjE,oBANiE,CAGD,iBAAA,CAHC,CAAA,EAMC,OAND,CAMS,gBANT,CAAA;iBAAR,CAAA,MAAA,EAQjE,oBARiE,CAMgB,iBAAA,GANhB;IAAO,IAAA,EAQC,oBAAA,CAAqB,IARtB;KAGnE,EAMd,OANc,CAMN,gBANM,CAAA;mBAAoE,CAAA,MAAA,EAQzE,oBARyE,CAM3E,iBAAA,GAN2E;IAAR,IAAA,EAU3D,oBAAA,CAAqB,MAVsC;KAAO,EAajF,OAbiF,CAazE,gBAbyE,CAAA;4BAGhE,CAAA,MAAA,EAYR,oBAZQ,CAUV,iBAAA,GAVU;IAA0E,IAAA,EAc5E,oBAAA,CAAqB,eAduD;KAAR,EAiBnF,OAjBmF,CAiB3E,gBAjB2E,CAAA;2BAAO,CAAA,MAAA,EAmBjF,oBAnBiF,CAiBnF,iBAAA,GAjBmF;IAER,IAAA,EAmBnE,oBAAA,CAAqB,cAnBmE;KAA9F,EAsBT,OAtBS,CAsBD,gBAtBC,CAAA;yBACD,CAAA,MAAA,EAuBC,oBAvBD,CAqBD,iBAAA,GArBC;IAAR,IAAA,EAyBe,oBAAA,CAAqB,MAzBpC;KAAO,EA4BP,OA5BO,CA4BC,gBA5BD,CAAA;iBAIQ,CAAA,MAAA,EA0BN,oBA1B2B,CAwB7B,iBAAA,GAxB6B;IAF3B,IAAA,EA8BM,oBAAA,CAAqB,IA9B3B;KAKD,EA4BR,OA5BQ,CA4BA,gBA5BA,CAAA;UAAR,CAAA,MAAA,EA4BO,cA5BP,CAAA,EA+BoD,OA/BpD,CA+B4D,gBA/B5D,CAAA;YAAO,CAAA,MAAA,EAAA;IAIQ,SAAA,EAAA,MAAA;MA4ByB,OA9B/B,CA8BuC,gBA9BvC,CAAA;qBAKD,CAAA,MAAA,EAAA;IAAR,SAAA,EAAA,MAAA;MA0BiD,OA1B1C,CA0BkD,gBA1BlD,CAAA;QAIQ,CAAA,MAAA,EAuBH,YAvBwB,CAAA,EAuBT,OAvBS,CAuBD,gBAvBC,CAAA"}