meta-cloud-api 1.6.1 → 1.7.1

package/dist/types/index.d.ts

@@ -1243,7 +1243,7 @@ interface MediaClass {
   downloadMedia(mediaUrl: string): Promise<Blob>;
 }
 //#endregion
-//#region src/core/webhook/types.d.ts
+//#region src/core/webhook/types/common.d.ts
 /**
  * WhatsApp contact information
  */
@@ -1316,6 +1316,8 @@ interface ReplyContext {
   from: string;
   id: string;
 }
+//#endregion
+//#region src/core/webhook/types/message.d.ts
 /**
  * Base message properties common to all message types
  */
@@ -1523,6 +1525,8 @@ type GroupMessage = {
   group_id: string;
 } & (TextMessage | ImageMessage | VideoMessage | AudioMessage | DocumentMessage | LocationMessage | ContactsMessage);
 type WhatsAppMessage = TextMessage | ImageMessage | VideoMessage | AudioMessage | DocumentMessage | StickerMessage | InteractiveMessage | ButtonMessage | LocationMessage | ContactsMessage | ReactionMessage | OrderMessage | SystemMessage | UnsupportedMessage | GroupMessage;
+//#endregion
+//#region src/core/webhook/types/status.d.ts
 interface StatusWebhook {
   id: string;
   status: 'sent' | 'delivered' | 'read' | 'failed';
@@ -1547,6 +1551,450 @@ interface StatusWebhook {
   };
   errors?: Array<WebhookError>;
 }
+//#endregion
+//#region src/core/webhook/types/account.d.ts
+/**
+ * Account update event types
+ * @see https://developers.facebook.com/docs/whatsapp/business-management-api/webhooks/components#value--event
+ */
+type AccountUpdateEvent = 'VERIFIED_ACCOUNT' | 'DISABLED_UPDATE' | 'ACCOUNT_VIOLATION' | 'ACCOUNT_RESTRICTION' | 'ACCOUNT_DELETED' | 'PARTNER_REMOVED' | 'PARTNER_APP_UNINSTALLED';
+/**
+ * WABA ban state
+ * @see https://developers.facebook.com/docs/whatsapp/business-management-api/webhooks/components#value--ban_info
+ */
+type WabaBanState = 'SCHEDULE_FOR_DISABLE' | 'DISABLE' | 'REINSTATE';
+/**
+ * Restriction types imposed on WABA
+ * @see https://developers.facebook.com/docs/whatsapp/business-management-api/webhooks/components#value--restriction_info
+ */
+type RestrictionType = 'RESTRICTION_ADD_PHONE_NUMBER_ACTION' | 'RESTRICTED_BIZ_INITIATED_MESSAGING' | 'RESTRICTED_CUSTOMER_INITIATED_MESSAGING';
+interface AccountUpdateBanInfo {
+  waba_ban_state: WabaBanState;
+  waba_ban_date?: number;
+}
+interface AccountUpdateViolationInfo {
+  violation_type: string;
+}
+interface AccountUpdateRestrictionInfo {
+  restriction_type: RestrictionType;
+  expiration?: number;
+}
+interface AccountUpdateWabaInfo {
+  waba_id: string;
+  owner_business_id: string;
+  partner_app_id?: string;
+}
+interface AccountUpdateValue {
+  phone_number?: string;
+  event: AccountUpdateEvent;
+  ban_info?: AccountUpdateBanInfo;
+  violation_info?: AccountUpdateViolationInfo;
+  restriction_info?: AccountUpdateRestrictionInfo[];
+  waba_info?: AccountUpdateWabaInfo;
+}
+interface AccountUpdateWebhookValue {
+  field: 'account_update';
+  value: AccountUpdateValue;
+}
+/**
+ * Account review decision
+ * @see https://developers.facebook.com/docs/whatsapp/business-management-api/webhooks/components#value--decision
+ */
+type ReviewDecision = 'APPROVED' | 'REJECTED' | 'DEFERRED';
+interface AccountReviewUpdateValue {
+  decision: ReviewDecision;
+}
+interface AccountReviewUpdateWebhookValue {
+  field: 'account_review_update';
+  value: AccountReviewUpdateValue;
+}
+/**
+ * Entity type for alert
+ * @see https://developers.facebook.com/docs/whatsapp/business-management-api/webhooks/components#account-alerts
+ */
+type AlertEntityType = 'BUSINESS' | 'PHONE_NUMBER' | 'WABA';
+/**
+ * Alert severity level
+ * @see https://developers.facebook.com/docs/whatsapp/business-management-api/webhooks/components#account-alerts
+ */
+type AlertSeverity = 'CRITICAL' | 'WARNING' | 'INFO';
+/**
+ * Alert status
+ * @see https://developers.facebook.com/docs/whatsapp/business-management-api/webhooks/components#account-alerts
+ */
+type AlertStatus = 'ACTIVE' | 'RESOLVED';
+/**
+ * Alert types for messaging limit increases
+ * @see https://developers.facebook.com/docs/whatsapp/business-management-api/webhooks/components#account-alerts
+ */
+type AlertType = 'INCREASED_CAPABILITIES_ELIGIBILITY_FAILED' | 'INCREASED_CAPABILITIES_ELIGIBILITY_DEFERRED' | 'INCREASED_CAPABILITIES_ELIGIBILITY_NEED_MORE_INFO';
+interface AccountAlertsValue {
+  entity_type: AlertEntityType;
+  entity_id: string;
+  alert_severity: AlertSeverity;
+  alert_status: AlertStatus;
+  alert_type: AlertType;
+  alert_description: string;
+}
+interface AccountAlertsWebhookValue {
+  field: 'account_alerts';
+  value: AccountAlertsValue;
+}
+//#endregion
+//#region src/core/webhook/types/business.d.ts
+/**
+ * Business capability limits
+ * @see https://developers.facebook.com/docs/whatsapp/business-management-api/webhooks/components#business-capability-updates
+ */
+interface BusinessCapabilityUpdateValue {
+  max_daily_conversation_per_phone?: number;
+  max_phone_numbers_per_business?: number;
+  max_phone_numbers_per_waba?: number;
+}
+interface BusinessCapabilityUpdateWebhookValue {
+  field: 'business_capability_update';
+  value: BusinessCapabilityUpdateValue;
+}
+//#endregion
+//#region src/core/webhook/types/phoneNumber.d.ts
+/**
+ * Phone number name update decision
+ * @see https://developers.facebook.com/docs/whatsapp/business-management-api/webhooks/components#phone-number-updates
+ */
+type PhoneNumberDecision = 'APPROVED' | 'REJECTED' | 'DEFERRED';
+interface PhoneNumberNameUpdateValue {
+  display_phone_number: string;
+  decision: PhoneNumberDecision;
+  requested_verified_name: string;
+  rejection_reason: string | null;
+}
+interface PhoneNumberNameUpdateWebhookValue {
+  field: 'phone_number_name_update';
+  value: PhoneNumberNameUpdateValue;
+}
+/**
+ * Phone number quality events
+ * @see https://developers.facebook.com/docs/whatsapp/business-management-api/webhooks/components#value--event
+ */
+type PhoneNumberQualityEvent = 'FLAGGED' | 'UNFLAGGED' | 'UPGRADE' | 'DOWNGRADE' | 'ONBOARDING';
+/**
+ * Messaging tier limits
+ * @see https://developers.facebook.com/docs/whatsapp/business-management-api/webhooks/components#value--current_limit
+ */
+type CurrentLimit = 'TIER_50' | 'TIER_250' | 'TIER_1K' | 'TIER_10K' | 'TIER_100K' | 'TIER_UNLIMITED';
+interface PhoneNumberQualityUpdateValue {
+  display_phone_number: string;
+  event: PhoneNumberQualityEvent;
+  current_limit: CurrentLimit;
+}
+interface PhoneNumberQualityUpdateWebhookValue {
+  field: 'phone_number_quality_update';
+  value: PhoneNumberQualityUpdateValue;
+}
+//#endregion
+//#region src/core/webhook/types/template.d.ts
+/**
+ * Message template status events
+ * @see https://developers.facebook.com/docs/whatsapp/business-management-api/webhooks/components#value--event
+ */
+type TemplateStatusEvent = 'APPROVED' | 'REJECTED' | 'PENDING' | 'DISABLED' | 'REINSTATED' | 'IN_APPEAL' | 'FLAGGED' | 'PAUSED' | 'PENDING_DELETION';
+/**
+ * Template rejection reasons
+ * @see https://developers.facebook.com/docs/whatsapp/business-management-api/webhooks/components#value--reason
+ */
+type TemplateRejectionReason = 'NONE' | 'ABUSIVE_CONTENT' | 'INCORRECT_CATEGORY' | 'INVALID_FORMAT' | 'SCAM';
+interface TemplateDisableInfo {
+  disable_date: string;
+}
+interface TemplatePauseInfo {
+  title: string;
+  description: string;
+}
+interface MessageTemplateStatusUpdateValue {
+  event: TemplateStatusEvent;
+  message_template_id: number;
+  message_template_name: string;
+  message_template_language: string;
+  reason: TemplateRejectionReason | null;
+  disable_info?: TemplateDisableInfo;
+  other_info?: TemplatePauseInfo;
+}
+interface MessageTemplateStatusUpdateWebhookValue {
+  field: 'message_template_status_update';
+  value: MessageTemplateStatusUpdateValue;
+}
+/**
+ * Template categories
+ * @see https://developers.facebook.com/docs/whatsapp/business-management-api/webhooks/components#value--event
+ */
+type TemplateCategory = 'MARKETING' | 'OTP' | 'TRANSACTIONAL' | 'AUTHENTICATION' | 'UTILITY';
+interface TemplateCategoryUpdateValue {
+  message_template_id: number;
+  message_template_name: string;
+  message_template_language: string;
+  previous_category: TemplateCategory;
+  new_category: TemplateCategory;
+}
+interface TemplateCategoryUpdateWebhookValue {
+  field: 'template_category_update';
+  value: TemplateCategoryUpdateValue;
+}
+/**
+ * Template quality scores
+ * @see https://developers.facebook.com/docs/whatsapp/business-management-api/webhooks/components#value--event
+ */
+type TemplateQualityScore = 'GREEN' | 'YELLOW' | 'RED' | 'UNKNOWN';
+interface MessageTemplateQualityUpdateValue {
+  previous_quality_score: TemplateQualityScore;
+  new_quality_score: TemplateQualityScore;
+  message_template_id: number;
+  message_template_name: string;
+  message_template_language: string;
+}
+interface MessageTemplateQualityUpdateWebhookValue {
+  field: 'message_template_quality_update';
+  value: MessageTemplateQualityUpdateValue;
+}
+//#endregion
+//#region src/core/webhook/types/flows.d.ts
+/**
+ * Flow event types
+ * @see https://developers.facebook.com/docs/whatsapp/business-management-api/webhooks/components#value--event
+ */
+type FlowEvent = 'FLOW_STATUS_CHANGE' | 'FLOW_HEALTH_UPDATE' | 'FLOW_THROTTLED';
+/**
+ * Flow status values
+ * @see https://developers.facebook.com/docs/whatsapp/flows/reference/flowsapi#statuses
+ */
+type FlowStatus = 'DRAFT' | 'PUBLISHED' | 'DEPRECATED' | 'BLOCKED' | 'THROTTLED';
+/**
+ * Flow alert state
+ * @see https://developers.facebook.com/docs/whatsapp/business-management-api/webhooks/components#value--alert_state
+ */
+type FlowAlertState = 'ACTIVE' | 'RESOLVED';
+/**
+ * Flow endpoint request error
+ */
+interface FlowEndpointRequestError {
+  error_code: string;
+  error_message: string;
+  error_count: number;
+}
+/**
+ * Flow webhook value
+ */
+interface FlowsValue {
+  event: FlowEvent;
+  message?: string;
+  flow_id: string;
+  old_status?: FlowStatus;
+  new_status?: FlowStatus;
+  warning?: string;
+  p90_latency?: number;
+  p50_latency?: number;
+  error_rate?: number;
+  errors?: FlowEndpointRequestError[];
+  requests_count?: number;
+  availability?: number;
+  threshold?: number;
+  alert_state?: FlowAlertState;
+}
+interface FlowsWebhookValue {
+  field: 'flows';
+  value: FlowsValue;
+}
+//#endregion
+//#region src/core/webhook/types/security.d.ts
+/**
+ * Two-step verification security events
+ * @see https://developers.facebook.com/docs/whatsapp/business-management-api/webhooks/components#value--event
+ */
+type SecurityEvent = 'PIN_CHANGED' | 'PIN_RESET_REQUEST' | 'PIN_RESET_SUCCESS';
+interface SecurityValue {
+  event: SecurityEvent;
+  requester?: string;
+}
+interface SecurityWebhookValue {
+  field: 'security';
+  value: SecurityValue;
+}
+//#endregion
+//#region src/core/webhook/types/history.d.ts
+/**
+ * History sync metadata
+ */
+interface HistorySyncMetadata {
+  phase: number;
+  chunk_order: number;
+  progress: number;
+}
+/**
+ * Reaction object in history
+ */
+interface HistoryReaction {
+  message_id: string;
+  emoji: string;
+}
+/**
+ * Message echo data (sent messages)
+ */
+interface HistoryMessageEcho {
+  from: string;
+  to: string;
+  id: string;
+  timestamp: string;
+  text?: {
+    body: string;
+  };
+  interactive?: any;
+  location?: any;
+  image?: any;
+  document?: any;
+  voice?: any;
+  audio?: any;
+  video?: any;
+  sticker?: any;
+  button?: any;
+  contacts?: any;
+  reaction?: HistoryReaction;
+  order?: any;
+  biz_opaque_callback_data?: string;
+  template?: any;
+}
+/**
+ * History sync thread data
+ */
+interface HistorySyncThread {
+  id: string;
+  messages: WhatsAppMessage[];
+}
+/**
+ * History sync error data
+ */
+interface HistorySyncError {
+  message: string;
+  error_data?: {
+    details: string;
+  };
+}
+/**
+ * History sync data
+ */
+interface HistorySyncData {
+  metadata: HistorySyncMetadata;
+  threads?: HistorySyncThread[];
+  errors?: HistorySyncError[];
+}
+/**
+ * History webhook value
+ */
+interface HistoryValue {
+  messaging_product: string;
+  metadata: HistorySyncMetadata;
+  history?: HistorySyncData[];
+  messages?: WhatsAppMessage[];
+  message_echoes?: HistoryMessageEcho[];
+}
+interface HistoryWebhookValue {
+  field: 'history';
+  value: HistoryValue;
+}
+//#endregion
+//#region src/core/webhook/types/messageEchoes.d.ts
+/**
+ * Message echo error
+ */
+interface MessageEchoError {
+  message: string;
+  error_data?: {
+    details: string;
+  };
+}
+/**
+ * Message echo data (sent messages from business)
+ */
+interface MessageEcho {
+  from: string;
+  to: string;
+  id: string;
+  timestamp: string;
+  text?: {
+    body: string;
+  };
+  interactive?: any;
+  location?: any;
+  image?: any;
+  document?: any;
+  voice?: any;
+  audio?: any;
+  video?: any;
+  sticker?: any;
+  button?: any;
+  contacts?: any;
+  reaction?: {
+    message_id: string;
+    emoji: string;
+  };
+  order?: any;
+  biz_opaque_callback_data?: string;
+  template?: any;
+  system?: {
+    type: string;
+  };
+  user_actions?: any[];
+}
+/**
+ * SMB Message Echoes value
+ */
+interface SmbMessageEchoesValue {
+  metadata: WebhookMetadata;
+  errors?: MessageEchoError[];
+  message_echoes: MessageEcho[];
+}
+interface SmbMessageEchoesWebhookValue {
+  field: 'smb_message_echoes';
+  value: SmbMessageEchoesValue;
+}
+//#endregion
+//#region src/core/webhook/types/appStateSync.d.ts
+/**
+ * Contact data in state sync
+ */
+interface StateSyncContact {
+  full_name: string;
+  first_name: string;
+  phone_number: string;
+}
+/**
+ * State sync metadata
+ */
+interface StateSyncMetadata {
+  timestamp: string;
+  version: number;
+}
+/**
+ * State sync data
+ */
+interface StateSyncData {
+  type: string;
+  contact: StateSyncContact;
+  action: string;
+  metadata: StateSyncMetadata;
+}
+/**
+ * SMB App State Sync value
+ */
+interface SmbAppStateSyncValue {
+  messaging_product: string;
+  metadata: WebhookMetadata;
+  state_sync: StateSyncData[];
+}
+interface SmbAppStateSyncWebhookValue {
+  field: 'smb_app_state_sync';
+  value: SmbAppStateSyncValue;
+}
+//#endregion
+//#region src/core/webhook/types/index.d.ts
 /**
  * Webhook value for incoming messages
  */
@@ -1576,6 +2024,10 @@ interface ErrorWebhookValue {
  * Union type for all webhook value types
  */
 type WebhookValue = MessageWebhookValue | StatusWebhookValue | ErrorWebhookValue;
+/**
+ * Union type for all webhook field values
+ */
+type WebhookFieldValue = AccountUpdateWebhookValue | AccountReviewUpdateWebhookValue | AccountAlertsWebhookValue | BusinessCapabilityUpdateWebhookValue | PhoneNumberNameUpdateWebhookValue | PhoneNumberQualityUpdateWebhookValue | MessageTemplateStatusUpdateWebhookValue | TemplateCategoryUpdateWebhookValue | MessageTemplateQualityUpdateWebhookValue | FlowsWebhookValue | SecurityWebhookValue | HistoryWebhookValue | SmbMessageEchoesWebhookValue | SmbAppStateSyncWebhookValue;
 interface WebhookPayload {
   object: 'whatsapp_business_account';
   entry: Array<{
@@ -1583,7 +2035,7 @@ interface WebhookPayload {
     changes: Array<{
       value: WebhookValue;
       field: 'messages';
-    }>;
+    } | WebhookFieldValue>;
   }>;
 }
 /**
@@ -1595,23 +2047,23 @@ interface WebhookMessage {
   id: string;
   from: string;
   timestamp: string;
-  type: MessageTypesEnum;
+  type: any;
   phoneNumberId: string;
   displayPhoneNumber: string;
   profileName: string;
-  text?: TextMessage['text'];
-  image?: ImageMessage['image'];
-  video?: VideoMessage['video'];
-  audio?: AudioMessage['audio'];
-  document?: DocumentMessage['document'];
-  sticker?: StickerMessage['sticker'];
-  location?: LocationMessage['location'];
-  contacts?: ContactsMessage['contacts'];
-  interactive?: InteractiveMessage['interactive'];
-  button?: ButtonMessage['button'];
-  order?: OrderMessage['order'];
-  system?: SystemMessage['system'];
-  reaction?: ReactionMessage['reaction'];
+  text?: any;
+  image?: any;
+  video?: any;
+  audio?: any;
+  document?: any;
+  sticker?: any;
+  location?: any;
+  contacts?: any;
+  interactive?: any;
+  button?: any;
+  order?: any;
+  system?: any;
+  reaction?: any;
   statuses?: StatusWebhook;
   originalData: any;
 }