meta-cloud-api 2.7.0 → 3.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -3,6 +3,7 @@ import { IncomingHttpHeaders, IncomingMessage } from "node:http";
3
3
 
4
4
  //#region src/types/request.d.ts
5
5
  type GeneralRequestBody = Record<string, unknown>;
6
+ type UrlEncodedFormBody = Record<string, string | string[]>;
6
7
  interface GeneralHeaderInterface {
7
8
  /**
8
9
  * Authorization token. This is required for all HTTP requests made to the graph API.
@@ -57,7 +58,7 @@ declare class RequesterClass {
57
58
  sendRequest: (method: HttpMethodsEnum, path: string, timeout: number, body?: GeneralRequestBody, contentType?: string, additionalHeaders?: Record<string, string>) => Promise<RequesterResponseInterface<unknown>>;
58
59
  getJson<T>(method: HttpMethodsEnum, endpoint: string, timeout: number, body?: GeneralRequestBody, additionalHeaders?: Record<string, string>): Promise<T>;
59
60
  sendFormData<T>(method: HttpMethodsEnum, endpoint: string, timeout: number, formData: FormData, additionalHeaders?: Record<string, string>): Promise<T>;
60
- sendUrlEncodedForm<T>(method: HttpMethodsEnum, endpoint: string, timeout: number, formData: Record<string, string>, additionalHeaders?: Record<string, string>): Promise<T>;
61
+ sendUrlEncodedForm<T>(method: HttpMethodsEnum, endpoint: string, timeout: number, formData: UrlEncodedFormBody, additionalHeaders?: Record<string, string>): Promise<T>;
61
62
  updateTimeout(timeout: number): void;
62
63
  updateAccessToken(accessToken: string): void;
63
64
  }
@@ -390,10 +391,13 @@ interface GroupsClass {
390
391
  getGroupInfo(groupId: string, fields?: GroupInfoFieldsParam): Promise<GroupInfoResponse>;
391
392
  getActiveGroups(params?: GroupListParams): Promise<GroupListResponse>;
392
393
  getGroupInviteLink(groupId: string): Promise<GroupInviteLinkResponse>;
394
+ createGroupInviteLink(groupId: string): Promise<GroupInviteLinkResponse>;
393
395
  resetGroupInviteLink(groupId: string): Promise<GroupInviteLinkResponse>;
396
+ deleteGroupInviteLink(groupId: string): Promise<ResponseSuccess>;
394
397
  getJoinRequests(groupId: string): Promise<GroupJoinRequestsResponse>;
395
398
  approveJoinRequests(groupId: string, joinRequestIds: string[]): Promise<GroupJoinRequestsActionResponse>;
396
399
  rejectJoinRequests(groupId: string, joinRequestIds: string[]): Promise<GroupJoinRequestsActionResponse>;
400
+ addParticipants(groupId: string, participants: string[]): Promise<ResponseSuccess>;
397
401
  removeParticipants(groupId: string, participants: string[]): Promise<ResponseSuccess>;
398
402
  updateGroupSettings(groupId: string, params: UpdateGroupSettingsRequest): Promise<GroupSettingsResponse>;
399
403
  }
@@ -618,6 +622,7 @@ type ReplyButtonObject = {
618
622
  reply: ButtonObject;
619
623
  };
620
624
  type ActionObject = {
625
+ button?: string;
621
626
  buttons?: ReplyButtonObject[];
622
627
  catalog_id?: string;
623
628
  product_retailer_id?: string;
@@ -628,6 +633,7 @@ type HeaderObject = {
628
633
  document?: DocumentMediaObject$1;
629
634
  image?: ImageMediaObject$1;
630
635
  text?: string;
636
+ sub_text?: string;
631
637
  video?: VideoMediaObject$1;
632
638
  };
633
639
  type ButtonInteractiveObject = {
@@ -658,6 +664,30 @@ type ProductListInteractiveObject = {
658
664
  header: HeaderObject;
659
665
  action: ActionObject;
660
666
  };
667
+ type CatalogMessageParameters = {
668
+ thumbnail_product_retailer_id: string;
669
+ };
670
+ type CatalogMessageActionObject = {
671
+ name: 'catalog_message';
672
+ parameters?: CatalogMessageParameters;
673
+ };
674
+ type CatalogMessageInteractiveObject = {
675
+ type: InteractiveTypesEnum.CatalogMessage | 'catalog_message';
676
+ body?: SimpleTextObject;
677
+ footer?: SimpleTextObject;
678
+ header?: HeaderObject;
679
+ action: CatalogMessageActionObject;
680
+ };
681
+ type CallPermissionRequestActionObject = {
682
+ name: 'call_permission_request';
683
+ };
684
+ type CallPermissionRequestInteractiveObject = {
685
+ type: InteractiveTypesEnum.CallPermissionRequest | 'call_permission_request';
686
+ body?: SimpleTextObject;
687
+ footer?: SimpleTextObject;
688
+ header?: HeaderObject;
689
+ action: CallPermissionRequestActionObject;
690
+ };
661
691
  type CtaUrlParameters = {
662
692
  display_text: string;
663
693
  url: string;
@@ -786,13 +816,14 @@ type CarouselInteractiveObject = {
786
816
  body: SimpleTextObject;
787
817
  action: CarouselActionObject;
788
818
  };
789
- type InteractiveObject = ButtonInteractiveObject | ListInteractiveObject | ProductInteractiveObject | ProductListInteractiveObject | CtaUrlInteractiveObject | CarouselInteractiveObject | LocationRequestInteractiveObject | AddressMessageInteractiveObject | FlowInteractiveObject;
819
+ type InteractiveObject = ButtonInteractiveObject | ListInteractiveObject | ProductInteractiveObject | ProductListInteractiveObject | CatalogMessageInteractiveObject | CallPermissionRequestInteractiveObject | CtaUrlInteractiveObject | CarouselInteractiveObject | LocationRequestInteractiveObject | AddressMessageInteractiveObject | FlowInteractiveObject;
790
820
  //#endregion
791
821
  //#region src/api/messages/types/reaction.d.ts
792
822
  interface ReactionParams {
793
823
  messageId: string;
794
824
  emoji: string;
795
825
  to: string;
826
+ recipientType?: MessageRecipientType;
796
827
  }
797
828
  //#endregion
798
829
  //#region src/types/config.d.ts
@@ -924,11 +955,21 @@ type GeneralMessageBody = GeneralRequestBody & {
924
955
  */
925
956
  messaging_product: 'whatsapp';
926
957
  };
958
+ type StatusObject = {
959
+ status: 'read' | 'typing';
960
+ message_id: string;
961
+ typing_indicator?: TypingIndicatorObject;
962
+ };
963
+ type TypingIndicatorObject = {
964
+ type: 'text';
965
+ };
966
+ type StatusResponse = ResponseSuccess;
927
967
  type ConTextObject = {
928
968
  message_id: string;
929
969
  };
970
+ type MessageRecipientType = 'individual' | 'group';
930
971
  type MessageRequestBody<T extends MessageTypesEnum> = GeneralMessageBody & {
931
- recipient_type?: string;
972
+ recipient_type?: MessageRecipientType;
932
973
  to: string;
933
974
  context?: ConTextObject;
934
975
  type?: T;
@@ -936,24 +977,32 @@ type MessageRequestBody<T extends MessageTypesEnum> = GeneralMessageBody & {
936
977
  interface MessageRequestParams<T> {
937
978
  body: T;
938
979
  to: string;
980
+ recipientType?: MessageRecipientType;
939
981
  replyMessageId?: string;
940
982
  }
941
983
  interface StatusParams {
942
- status: string;
984
+ status: StatusObject['status'];
943
985
  messageId: string;
944
- typingIndicator?: {
945
- type: string;
946
- };
986
+ typingIndicator?: TypingIndicatorObject;
947
987
  }
948
988
  type MessagesResponse = GeneralMessageBody & {
949
- contacts: [{
989
+ contacts: Array<{
950
990
  input: string;
951
991
  wa_id: string;
952
- }];
953
- messages: [{
992
+ }>;
993
+ messages: Array<{
954
994
  id: string;
955
- }];
995
+ message_status?: 'accepted' | 'held_for_quality_assessment' | 'paused';
996
+ }>;
997
+ };
998
+ type EncryptedMessageRequest = GeneralMessageBody & {
999
+ to: string;
1000
+ type?: string;
1001
+ encrypted?: Record<string, unknown>;
1002
+ jwe?: string;
1003
+ [key: string]: unknown;
956
1004
  };
1005
+ type EncryptedMessagesResponse = MessagesResponse;
957
1006
  declare class MessagesClass extends BaseClass {
958
1007
  text(params: TextMessageParams): Promise<MessagesResponse>;
959
1008
  template(params: MessageRequestParams<MessageTemplateObject<ComponentTypesEnum>>): Promise<MessagesResponse>;
@@ -987,13 +1036,14 @@ declare class MessagesClass extends BaseClass {
987
1036
  type: InteractiveTypesEnum.Carousel;
988
1037
  }>): Promise<MessagesResponse>;
989
1038
  reaction(params: ReactionParams): Promise<MessagesResponse>;
1039
+ encrypted(params: EncryptedMessageRequest): Promise<EncryptedMessagesResponse>;
990
1040
  markAsRead(params: {
991
1041
  messageId: string;
992
- }): Promise<MessagesResponse>;
1042
+ }): Promise<StatusResponse>;
993
1043
  showTypingIndicator(params: {
994
1044
  messageId: string;
995
- }): Promise<MessagesResponse>;
996
- status(params: StatusParams): Promise<MessagesResponse>;
1045
+ }): Promise<StatusResponse>;
1046
+ status(params: StatusParams): Promise<StatusResponse>;
997
1047
  }
998
1048
  //#endregion
999
1049
  //#region src/api/marketingMessages/types/marketingMessages.d.ts
@@ -1005,6 +1055,7 @@ type MarketingMessageRequest = {
1005
1055
  to: string;
1006
1056
  template: MessageTemplateObject<ComponentTypesEnum>;
1007
1057
  message_activity_sharing?: boolean;
1058
+ product_policy?: 'CLOUD_API_FALLBACK' | 'STRICT';
1008
1059
  };
1009
1060
  interface MarketingMessagesClass {
1010
1061
  sendTemplateMessage(params: MarketingMessageRequest): Promise<MessagesResponse>;
@@ -1106,12 +1157,15 @@ interface PaymentsClass {
1106
1157
  }
1107
1158
  //#endregion
1108
1159
  //#region src/api/phone/types/common.d.ts
1109
- type QualityRating = 'GREEN' | 'YELLOW' | 'RED' | 'NA';
1160
+ type QualityRating = 'GREEN' | 'YELLOW' | 'RED' | 'NA' | 'UNKNOWN';
1110
1161
  type AccountMode = 'LIVE' | 'SANDBOX';
1111
1162
  type CodeVerificationStatus = 'NOT_VERIFIED' | 'VERIFIED' | 'EXPIRED' | 'PENDING' | 'DELETED' | 'MIGRATED' | 'BANNED' | 'RESTRICTED' | 'RATE_LIMITED' | 'FLAGGED' | 'CONNECTED' | 'DISCONNECTED' | 'UNKNOWN' | 'UNVERIFIED';
1112
- type MessagingLimitTier = 'TIER_50' | 'TIER_250' | 'TIER_1K' | 'TIER_10K' | 'TIER_100K' | 'TIER_UNLIMITED';
1163
+ type MessagingLimitTier = 'TIER_50' | 'TIER_250' | 'TIER_1K' | 'TIER_2K' | 'TIER_10K' | 'TIER_100K' | 'TIER_UNLIMITED' | (string & {});
1113
1164
  type PlatformType = 'CLOUD_API' | 'ON_PREMISE' | 'NOT_APPLICABLE';
1114
1165
  type ThroughputLevel = 'STANDARD' | 'HIGH' | 'NOT_APPLICABLE';
1166
+ type PhoneNumberStatus = 'PENDING' | 'LINKED' | 'UNLINKED' | 'DELETED' | 'MIGRATED' | 'BANNED' | 'RESTRICTED';
1167
+ type UnifiedCertStatus = 'APPROVED' | 'PENDING' | 'REJECTED' | 'EXPIRED' | 'NONE' | string;
1168
+ type HostPlatform = 'CLOUD_API' | 'ON_PREMISE' | 'NOT_APPLICABLE' | string;
1115
1169
  type HealthStatusEntity = {
1116
1170
  entity_type: string;
1117
1171
  id: string;
@@ -1133,8 +1187,73 @@ type QualityScore = {
1133
1187
  type Throughput = {
1134
1188
  level: ThroughputLevel;
1135
1189
  };
1136
- type PhoneNumberField = 'display_phone_number' | 'id' | 'quality_rating' | 'verified_name' | 'account_mode' | 'certificate' | 'code_verification_status' | 'conversational_automation' | 'eligibility_for_api_business_global_search' | 'health_status' | 'is_official_business_account' | 'is_on_biz_app' | 'is_pin_enabled' | 'is_preverified_number' | 'last_onboarded_time' | 'messaging_limit_tier' | 'name_status' | 'new_certificate' | 'new_name_status' | 'platform_type' | 'quality_score' | 'search_visibility' | 'status' | 'throughput';
1190
+ type PhoneNumberField = 'country_code' | 'country_dial_code' | 'display_phone_number' | 'id' | 'quality_rating' | 'verified_name' | 'account_mode' | 'certificate' | 'code_verification_status' | 'conversational_automation' | 'eligibility_for_api_business_global_search' | 'health_status' | 'host_platform' | 'is_official_business_account' | 'is_on_biz_app' | 'is_pin_enabled' | 'is_preverified_number' | 'last_onboarded_time' | 'messaging_limit_tier' | 'name_status' | 'new_certificate' | 'new_name_status' | 'platform_type' | 'quality_score' | 'search_visibility' | 'status' | 'throughput' | 'unified_cert_status' | 'username';
1137
1191
  type PhoneNumberFieldsParam = PhoneNumberField[] | string;
1192
+ type PhoneNumberSort = 'creation_time.asc' | 'creation_time.desc' | 'last_onboarded_time.asc' | 'last_onboarded_time.desc' | (string & {});
1193
+ type PhoneNumberFilter = Record<string, unknown>;
1194
+ type PhoneNumbersListParams = {
1195
+ fields?: PhoneNumberFieldsParam;
1196
+ filtering?: PhoneNumberFilter[] | string;
1197
+ sort?: PhoneNumberSort;
1198
+ limit?: number;
1199
+ after?: string;
1200
+ before?: string;
1201
+ };
1202
+ type GraphObject = Record<string, unknown>;
1203
+ type CreatePhoneNumberRequest = {
1204
+ cc?: string;
1205
+ phone_number?: string;
1206
+ verified_name?: string;
1207
+ preverified_id?: string;
1208
+ [key: string]: unknown;
1209
+ };
1210
+ type CreatePhoneNumberResponse = {
1211
+ id: string;
1212
+ [key: string]: unknown;
1213
+ };
1214
+ type UpdatePhoneNumberStatusRequest = {
1215
+ status?: string;
1216
+ account_mode?: AccountMode;
1217
+ [key: string]: unknown;
1218
+ };
1219
+ type PhoneNumberSettingsFieldsParam = string[] | string;
1220
+ type PhoneNumberSettingsParams = {
1221
+ fields?: PhoneNumberSettingsFieldsParam;
1222
+ include_sip_credentials?: boolean;
1223
+ };
1224
+ type PhoneNumberSettingsResponse = GraphObject;
1225
+ type UpdatePhoneNumberSettingsRequest = {
1226
+ calling?: GraphObject;
1227
+ [key: string]: unknown;
1228
+ };
1229
+ type OfficialBusinessAccountStatusResponse = GraphObject;
1230
+ type OfficialBusinessAccountAction = 'SUBMIT_APPLICATION' | 'WITHDRAW_APPLICATION' | 'RESUBMIT_APPLICATION';
1231
+ type OfficialBusinessAccountApplicationData = {
1232
+ business_name?: string;
1233
+ business_description?: string;
1234
+ /**
1235
+ * OBA examples use `website_url`, while the schema also exposes `business_website_url`.
1236
+ * Both are accepted to track Meta's published OpenAPI variants.
1237
+ */
1238
+ website_url?: string;
1239
+ business_website_url?: string;
1240
+ contact_email?: string;
1241
+ primary_country_of_operation?: string;
1242
+ primary_language?: string;
1243
+ parent_business_or_brand?: string;
1244
+ [key: string]: unknown;
1245
+ };
1246
+ type UpdateOfficialBusinessAccountStatusRequest = {
1247
+ action?: OfficialBusinessAccountAction | (string & {});
1248
+ application_data?: OfficialBusinessAccountApplicationData;
1249
+ business_website_url?: string;
1250
+ primary_country_of_operation?: string;
1251
+ [key: string]: unknown;
1252
+ };
1253
+ type BusinessComplianceInfoResponse = GraphObject;
1254
+ type UpdateBusinessComplianceInfoRequest = {
1255
+ [key: string]: unknown;
1256
+ };
1138
1257
  type PhoneNumberResponse = {
1139
1258
  display_phone_number: string;
1140
1259
  id: string;
@@ -1144,8 +1263,11 @@ type PhoneNumberResponse = {
1144
1263
  certificate?: string;
1145
1264
  code_verification_status?: CodeVerificationStatus;
1146
1265
  conversational_automation?: Record<string, unknown>;
1266
+ country_code?: string;
1267
+ country_dial_code?: string;
1147
1268
  eligibility_for_api_business_global_search?: string;
1148
1269
  health_status?: HealthStatus;
1270
+ host_platform?: HostPlatform;
1149
1271
  is_official_business_account?: boolean;
1150
1272
  is_on_biz_app?: boolean;
1151
1273
  is_pin_enabled?: boolean;
@@ -1158,8 +1280,10 @@ type PhoneNumberResponse = {
1158
1280
  platform_type?: PlatformType;
1159
1281
  quality_score?: QualityScore;
1160
1282
  search_visibility?: string;
1161
- status?: CodeVerificationStatus;
1283
+ status?: PhoneNumberStatus | CodeVerificationStatus;
1162
1284
  throughput?: Throughput;
1285
+ unified_cert_status?: UnifiedCertStatus;
1286
+ username?: string;
1163
1287
  };
1164
1288
  type Cursors = {
1165
1289
  before: string;
@@ -1216,12 +1340,20 @@ type ThroughputResponse = {
1216
1340
  };
1217
1341
  interface PhoneNumberClass {
1218
1342
  getPhoneNumberById(fields?: PhoneNumberFieldsParam): Promise<PhoneNumberResponse>;
1219
- getPhoneNumbers(): Promise<PhoneNumbersResponse>;
1343
+ getPhoneNumbers(params?: PhoneNumbersListParams): Promise<PhoneNumbersResponse>;
1344
+ createPhoneNumber(request: CreatePhoneNumberRequest, wabaId?: string): Promise<CreatePhoneNumberResponse>;
1345
+ updatePhoneNumberStatus(request: UpdatePhoneNumberStatusRequest): Promise<ResponseSuccess>;
1220
1346
  requestVerificationCode(params: RequestVerificationCodeRequest): Promise<ResponseSuccess>;
1221
1347
  verifyCode(params: VerifyCodeRequest): Promise<ResponseSuccess>;
1348
+ getPhoneNumberSettings(params?: PhoneNumberSettingsParams): Promise<PhoneNumberSettingsResponse>;
1349
+ updatePhoneNumberSettings(params: UpdatePhoneNumberSettingsRequest): Promise<ResponseSuccess>;
1222
1350
  setConversationalAutomation(params: ConversationalAutomationRequest): Promise<ResponseSuccess>;
1223
1351
  getConversationalAutomation(): Promise<ConversationalAutomationResponse>;
1224
1352
  getThroughput(): Promise<ThroughputResponse>;
1353
+ getOfficialBusinessAccountStatus(): Promise<OfficialBusinessAccountStatusResponse>;
1354
+ updateOfficialBusinessAccountStatus(params: UpdateOfficialBusinessAccountStatusRequest): Promise<ResponseSuccess>;
1355
+ getBusinessComplianceInfo(): Promise<BusinessComplianceInfoResponse>;
1356
+ updateBusinessComplianceInfo(params: UpdateBusinessComplianceInfoRequest): Promise<ResponseSuccess>;
1225
1357
  }
1226
1358
  //#endregion
1227
1359
  //#region src/api/profile/types/upload.d.ts
@@ -1895,14 +2027,72 @@ type WabaAccountFields = 'id' | 'name' | 'timezone_id' | 'account_review_status'
1895
2027
  * Parameter type for specifying which WABA account fields to retrieve
1896
2028
  */
1897
2029
  type WabaAccountFieldsParam = WabaAccountFields[];
2030
+ type WabaGraphObject = Record<string, unknown>;
2031
+ type WabaFieldsParam = string[] | string;
2032
+ type WabaListParams = {
2033
+ fields?: WabaFieldsParam;
2034
+ filtering?: WabaGraphObject[] | string;
2035
+ sort?: string;
2036
+ limit?: number;
2037
+ after?: string;
2038
+ before?: string;
2039
+ };
2040
+ type WabaListResponse<T = WabaGraphObject> = {
2041
+ data: T[];
2042
+ paging?: Paging;
2043
+ summary?: WabaGraphObject;
2044
+ };
2045
+ type UpdateWabaAccountRequest = {
2046
+ name?: string;
2047
+ timezone_id?: string;
2048
+ [key: string]: unknown;
2049
+ };
2050
+ type AssignedUserRequest = {
2051
+ user: string;
2052
+ tasks?: string[];
2053
+ [key: string]: unknown;
2054
+ };
2055
+ type RemoveAssignedUserRequest = {
2056
+ user: string;
2057
+ [key: string]: unknown;
2058
+ };
2059
+ type CreateOBOMobilityIntentRequest = {
2060
+ intent?: string;
2061
+ [key: string]: unknown;
2062
+ };
2063
+ type SetOBOMobilityIntentRequest = {
2064
+ [key: string]: unknown;
2065
+ };
2066
+ type CreateScheduleRequest = {
2067
+ name?: string;
2068
+ schedule_type?: string;
2069
+ [key: string]: unknown;
2070
+ };
2071
+ type UpdateWhatsAppBusinessProfileRequest = {
2072
+ [key: string]: unknown;
2073
+ };
1898
2074
  /**
1899
2075
  * Interface defining all WABA API methods
1900
2076
  */
1901
2077
  interface WABAClass {
1902
2078
  getWabaAccount(fields?: WabaAccountFieldsParam): Promise<WabaAccount>;
2079
+ updateWabaAccount(params: UpdateWabaAccountRequest): Promise<ResponseSuccess>;
2080
+ getWabaActivities(params?: WabaListParams): Promise<WabaListResponse>;
1903
2081
  getAllWabaSubscriptions(): Promise<WabaSubscriptions>;
1904
2082
  updateWabaSubscription(params: UpdateWabaSubscription): Promise<ResponseSuccess>;
1905
2083
  unsubscribeFromWaba(): Promise<ResponseSuccess>;
2084
+ getAssignedUsers(params?: WabaListParams, wabaId?: string): Promise<WabaListResponse>;
2085
+ addAssignedUser(params: AssignedUserRequest, wabaId?: string): Promise<ResponseSuccess>;
2086
+ removeAssignedUser(params: RemoveAssignedUserRequest, wabaId?: string): Promise<ResponseSuccess>;
2087
+ getInProgressOnBehalfRequests(params?: WabaListParams, wabaId?: string): Promise<WabaListResponse>;
2088
+ getOBOMobilityIntent(oboMobilityIntentId: string, fields?: WabaFieldsParam): Promise<WabaGraphObject>;
2089
+ createOBOMobilityIntent(params: CreateOBOMobilityIntentRequest, wabaId?: string): Promise<WabaGraphObject>;
2090
+ setOBOMobilityIntent(params: SetOBOMobilityIntentRequest, wabaId?: string): Promise<WabaGraphObject>;
2091
+ getWabaSchedules(params?: WabaListParams, wabaId?: string): Promise<WabaListResponse>;
2092
+ createWabaSchedule(params: CreateScheduleRequest, wabaId?: string): Promise<WabaGraphObject>;
2093
+ getWhatsAppBusinessBotDetails(botId: string, fields?: WabaFieldsParam): Promise<WabaGraphObject>;
2094
+ getWhatsAppBusinessProfileDetails(profileId: string, fields?: WabaFieldsParam): Promise<WabaGraphObject>;
2095
+ updateWhatsAppBusinessProfile(profileId: string, params: UpdateWhatsAppBusinessProfileRequest): Promise<ResponseSuccess>;
1906
2096
  }
1907
2097
  //#endregion
1908
2098
  //#region src/core/webhook/types/account.d.ts
@@ -2128,8 +2318,10 @@ interface AccountSettingsUpdateWebhookValue {
2128
2318
  */
2129
2319
  interface WebhookContact {
2130
2320
  wa_id: string;
2321
+ user_id?: string;
2131
2322
  profile: {
2132
2323
  name: string;
2324
+ username?: string;
2133
2325
  };
2134
2326
  identity_key_hash?: string;
2135
2327
  }
@@ -2342,10 +2534,13 @@ interface CallEntry {
2342
2534
  }
2343
2535
  interface CallContact {
2344
2536
  profile: {
2345
- /** Display name of the caller */name: string;
2537
+ /** Display name of the caller */name: string; /** Business-scoped username, when Meta includes it */
2538
+ username?: string;
2346
2539
  };
2347
2540
  /** WhatsApp ID of the caller */
2348
2541
  wa_id: string;
2542
+ /** Business-scoped user ID, when Meta includes it */
2543
+ user_id?: string;
2349
2544
  }
2350
2545
  interface CallsValue {
2351
2546
  messaging_product: 'whatsapp';
@@ -4129,5 +4324,5 @@ interface LoggerInterface {
4129
4324
  debug(...data: any[]): void;
4130
4325
  }
4131
4326
  //#endregion
4132
- export { type AcceptCallRequest, type AccountMode, type ApiPermissionErrorCode, type AudioMediaObject, AudioMediaTypes, AudioMediaTypesEnum, AudioMediaTypesType, type AudioMessage, type AuthenticationTemplateOptions, type BaseClass, type BlockUsersClass, type BlockUsersResponse, type BlockedUserInfo, type BodyOptions, type BusinessProfileClass, type BusinessProfileData, type BusinessProfileField, type BusinessProfileFieldsParam, type BusinessProfileResponse, BusinessVerticalEnum, type ButtonMessage, type ButtonOptions, ButtonPosition, ButtonPositionEnum, ButtonPositionType, type CallAction, type CallActionResponse, type CallHours, type CallHoursDay, type CallHoursStatus, type CallIconVisibility, type CallPermission, type CallPermissionAction, type CallPermissionLimit, type CallPermissionsResponse, type CallSdpType, type CallSession, type CallbackPermissionStatus, type CallingClass, type CallingSettings, type CallingSettingsResponse, type CallingStatus, type CarouselCard, type CarouselOptions, type CatalogButton, type CatalogTemplateOptions, Category, CategoryEnum, CategoryType, type CodeVerificationStatus, type CommerceClass, type CommerceSetting, type CommerceSettingsResponse, ComponentType, ComponentTypeType, type ComponentTypes, ComponentTypesEnum, type ContactObject, type ContactsMessage, ConversationTypes, ConversationTypesEnum, ConversationTypesType, type CopyCodeButton, type CouponTemplateOptions, CreateFlowResponse, type CreateQrCodeRequest, CurrencyCodesEnum, type CurrencyParameter, type Cursors, DataLocalizationRegion, DataLocalizationRegionEnum, DataLocalizationRegionType, type DateTimeParameter, type DocumentMediaObject, DocumentMediaTypes, DocumentMediaTypesEnum, DocumentMediaTypesType, type DocumentMessage, type EncryptionPublicKeyResponse, type ErrorWebhookValue, type FailedUserInfo, 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 GroupCreateRequest, type GroupCreateResponse, type GroupInfoField, type GroupInfoFieldsParam, type GroupInfoResponse, type GroupInviteLinkResponse, type GroupJoinApprovalMode, type GroupJoinRequest, type GroupJoinRequestError, type GroupJoinRequestFailure, type GroupJoinRequestsActionResponse, type GroupJoinRequestsResponse, type GroupListParams, type GroupListResponse, type GroupMessage, type GroupParticipant, type GroupSettingsResponse, type GroupsClass, type HeaderOptions, type HealthStatus, type HealthStatusEntity, type HolidaySchedule, HttpMethods, HttpMethodsEnum, HttpMethodsType, type HttpsClientClass, type HttpsClientResponseClass, type ImageMediaObject, ImageMediaTypes, ImageMediaTypesEnum, ImageMediaTypesType, type ImageMessage, type InitiateCallRequest, type InitiateCallResponse, type InteractiveButtonReplyMessage, type InteractiveListReplyMessage, type InteractiveMessage, type InteractiveObject, InteractiveTypes, InteractiveTypesEnum, InteractiveTypesType, Languages, LanguagesEnum, LanguagesType, type LimitedTimeOfferOptions, type LimitedTimeOfferTemplateOptions, type ListBlockedUsersParams, type ListBlockedUsersResponse, type LocationMessage, type LocationObject, type LocationParameter, type LoggerInterface, type MPMButton, type MPMTemplateOptions, type MarketingMessageRequest, type MarketingMessagesClass, type MediaCardCarouselTemplateOptions, type MediaCarouselCard, MediaClass, type MediaParameter, MediaResponse, MediasResponse, type MessageRequestBody, type MessageRequestParams, type MessageTemplateObject, MessageTypes, MessageTypesEnum, MessageTypesType, type MessageWebhookValue, type MessagesClass, type MessagesResponse, type MessagingLimitTier, type MetaError, type MetaErrorData, type MetaErrorDetail, type OTPButton, type OTPTemplateOptions, type OrderMessage, type Pagination, type PaginationCursors, type Paging, ParametersTypes, ParametersTypesEnum, ParametersTypesType, type PaymentConfiguration, type PaymentConfigurationCode, type PaymentConfigurationCreateRequest, type PaymentConfigurationCreateResponse, type PaymentConfigurationDeleteRequest, type PaymentConfigurationOauthLinkRequest, type PaymentConfigurationOauthLinkResponse, type PaymentConfigurationProvider, type PaymentConfigurationStatus, type PaymentConfigurationUpdateRequest, type PaymentConfigurationUpdateResponse, type PaymentConfigurationsResponse, type PaymentsClass, type PhoneNumberButton, type PhoneNumberClass, type PhoneNumberResponse, type PhoneNumbersResponse, type PlatformType, type PreAcceptCallRequest, type ProductCardCarouselTemplateOptions, type ProductCarouselCard, type ProductParameter, type ProductSection, type QrCodeClass, type QrCodeResponse, type QrCodesResponse, type QualityRating, type QualityScore, type QuickReplyButton, type ReactionMessage, type ReactionParams, ReferralSourceTypes, ReferralSourceTypesEnum, ReferralSourceTypesType, type RegistrationClass, type RegistrationRequest, type RejectCallRequest, RequestCodeMethods, RequestCodeMethodsEnum, RequestCodeMethodsType, type RequestVerificationCodeRequest, type RequesterClass, type RequesterResponseInterface, type ResponseData, type ResponseHeaderValue, type ResponseHeaders, type ResponseJSONBody, type ResponsePagination, type ResponseSuccess, type SPMButton, type SPMTemplateOptions, type SipServer, type SipSettings, type SipStatus, Status, StatusEnum, type StatusParams, StatusType, type StatusWebhook, type StatusWebhookValue, type StickerMediaObject, StickerMediaTypes, StickerMediaTypesEnum, StickerMediaTypesType, type StickerMessage, SubType, SubTypeEnum, SubTypeType, SystemChangeTypes, SystemChangeTypesEnum, SystemChangeTypesType, type SystemMessage, 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, TemplateStatus, TemplateStatusEnum, TemplateStatusType, type TerminateCallRequest, type TextMessage, type TextMessageParams, type TextObject, type TextParameter, type Throughput, type ThroughputLevel, type TwoStepVerificationClass, type TwoStepVerificationParams, type TwoStepVerificationRequest, type URLButton, type UnsupportedMessage, type UpdateBusinessProfileRequest, type UpdateCallingSettingsRequest, type UpdateCommerceSettingsRequest, type UpdateFlowResponse, type UpdateGroupSettingsRequest, type UpdateQrCodeRequest, type UpdateWabaSubscription, UploadMediaResponse, type ValidateFlowJsonResponse, type VerifyCodeRequest, type VideoMediaObject, VideoMediaTypes, VideoMediaTypesEnum, VideoMediaTypesType, type VideoMessage, type WABAClass, type WabaAccount, type WabaAccountFields, type WabaAccountFieldsParam, WabaAccountReviewStatus, WabaAccountStatus, WabaBusinessVerificationStatus, WabaConfigEnum, type WabaConfigType, type WabaHealthStatus, WabaHealthStatusCanSendMessage, type WabaHealthStatusEntity, type WabaHealthStatusError, type WabaSubscription, type WabaSubscriptions, type WebhookContact, type WebhookEvent, type WebhookMessage, type WebhookPayload, WebhookTypes, WebhookTypesEnum, WebhookTypesType, type WebhookValue, type WeeklyOperatingHours, type WhatsAppConfig, type WhatsAppErrorCode, type WhatsAppMessage };
4327
+ export { type AcceptCallRequest, type AccountMode, type ApiPermissionErrorCode, type AudioMediaObject, AudioMediaTypes, AudioMediaTypesEnum, AudioMediaTypesType, type AudioMessage, type AuthenticationTemplateOptions, type BaseClass, type BlockUsersClass, type BlockUsersResponse, type BlockedUserInfo, type BodyOptions, type BusinessProfileClass, type BusinessProfileData, type BusinessProfileField, type BusinessProfileFieldsParam, type BusinessProfileResponse, BusinessVerticalEnum, type ButtonMessage, type ButtonOptions, ButtonPosition, ButtonPositionEnum, ButtonPositionType, type CallAction, type CallActionResponse, type CallHours, type CallHoursDay, type CallHoursStatus, type CallIconVisibility, type CallPermission, type CallPermissionAction, type CallPermissionLimit, type CallPermissionsResponse, type CallSdpType, type CallSession, type CallbackPermissionStatus, type CallingClass, type CallingSettings, type CallingSettingsResponse, type CallingStatus, type CarouselCard, type CarouselOptions, type CatalogButton, type CatalogTemplateOptions, Category, CategoryEnum, CategoryType, type CodeVerificationStatus, type CommerceClass, type CommerceSetting, type CommerceSettingsResponse, ComponentType, ComponentTypeType, type ComponentTypes, ComponentTypesEnum, type ContactObject, type ContactsMessage, ConversationTypes, ConversationTypesEnum, ConversationTypesType, type CopyCodeButton, type CouponTemplateOptions, CreateFlowResponse, type CreateQrCodeRequest, CurrencyCodesEnum, type CurrencyParameter, type Cursors, DataLocalizationRegion, DataLocalizationRegionEnum, DataLocalizationRegionType, type DateTimeParameter, type DocumentMediaObject, DocumentMediaTypes, DocumentMediaTypesEnum, DocumentMediaTypesType, type DocumentMessage, type EncryptionPublicKeyResponse, type ErrorWebhookValue, type FailedUserInfo, 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 GroupCreateRequest, type GroupCreateResponse, type GroupInfoField, type GroupInfoFieldsParam, type GroupInfoResponse, type GroupInviteLinkResponse, type GroupJoinApprovalMode, type GroupJoinRequest, type GroupJoinRequestError, type GroupJoinRequestFailure, type GroupJoinRequestsActionResponse, type GroupJoinRequestsResponse, type GroupListParams, type GroupListResponse, type GroupMessage, type GroupParticipant, type GroupSettingsResponse, type GroupsClass, type HeaderOptions, type HealthStatus, type HealthStatusEntity, type HolidaySchedule, type HostPlatform, HttpMethods, HttpMethodsEnum, HttpMethodsType, type HttpsClientClass, type HttpsClientResponseClass, type ImageMediaObject, ImageMediaTypes, ImageMediaTypesEnum, ImageMediaTypesType, type ImageMessage, type InitiateCallRequest, type InitiateCallResponse, type InteractiveButtonReplyMessage, type InteractiveListReplyMessage, type InteractiveMessage, type InteractiveObject, InteractiveTypes, InteractiveTypesEnum, InteractiveTypesType, Languages, LanguagesEnum, LanguagesType, type LimitedTimeOfferOptions, type LimitedTimeOfferTemplateOptions, type ListBlockedUsersParams, type ListBlockedUsersResponse, type LocationMessage, type LocationObject, type LocationParameter, type LoggerInterface, type MPMButton, type MPMTemplateOptions, type MarketingMessageRequest, type MarketingMessagesClass, type MediaCardCarouselTemplateOptions, type MediaCarouselCard, MediaClass, type MediaParameter, MediaResponse, MediasResponse, type MessageRecipientType, type MessageRequestBody, type MessageRequestParams, type MessageTemplateObject, MessageTypes, MessageTypesEnum, MessageTypesType, type MessageWebhookValue, type MessagesClass, type MessagesResponse, type MessagingLimitTier, type MetaError, type MetaErrorData, type MetaErrorDetail, type OTPButton, type OTPTemplateOptions, type OrderMessage, type Pagination, type PaginationCursors, type Paging, ParametersTypes, ParametersTypesEnum, ParametersTypesType, type PaymentConfiguration, type PaymentConfigurationCode, type PaymentConfigurationCreateRequest, type PaymentConfigurationCreateResponse, type PaymentConfigurationDeleteRequest, type PaymentConfigurationOauthLinkRequest, type PaymentConfigurationOauthLinkResponse, type PaymentConfigurationProvider, type PaymentConfigurationStatus, type PaymentConfigurationUpdateRequest, type PaymentConfigurationUpdateResponse, type PaymentConfigurationsResponse, type PaymentsClass, type PhoneNumberButton, type PhoneNumberClass, type PhoneNumberField, type PhoneNumberFieldsParam, type PhoneNumberFilter, type PhoneNumberResponse, type PhoneNumberSort, type PhoneNumberStatus, type PhoneNumbersListParams, type PhoneNumbersResponse, type PlatformType, type PreAcceptCallRequest, type ProductCardCarouselTemplateOptions, type ProductCarouselCard, type ProductParameter, type ProductSection, type QrCodeClass, type QrCodeResponse, type QrCodesResponse, type QualityRating, type QualityScore, type QuickReplyButton, type ReactionMessage, type ReactionParams, ReferralSourceTypes, ReferralSourceTypesEnum, ReferralSourceTypesType, type RegistrationClass, type RegistrationRequest, type RejectCallRequest, RequestCodeMethods, RequestCodeMethodsEnum, RequestCodeMethodsType, type RequestVerificationCodeRequest, type RequesterClass, type RequesterResponseInterface, type ResponseData, type ResponseHeaderValue, type ResponseHeaders, type ResponseJSONBody, type ResponsePagination, type ResponseSuccess, type SPMButton, type SPMTemplateOptions, type SipServer, type SipSettings, type SipStatus, Status, StatusEnum, type StatusParams, type StatusResponse, StatusType, type StatusWebhook, type StatusWebhookValue, type StickerMediaObject, StickerMediaTypes, StickerMediaTypesEnum, StickerMediaTypesType, type StickerMessage, SubType, SubTypeEnum, SubTypeType, SystemChangeTypes, SystemChangeTypesEnum, SystemChangeTypesType, type SystemMessage, 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, TemplateStatus, TemplateStatusEnum, TemplateStatusType, type TerminateCallRequest, type TextMessage, type TextMessageParams, type TextObject, type TextParameter, type Throughput, type ThroughputLevel, type TwoStepVerificationClass, type TwoStepVerificationParams, type TwoStepVerificationRequest, type URLButton, type UnifiedCertStatus, type UnsupportedMessage, type UpdateBusinessProfileRequest, type UpdateCallingSettingsRequest, type UpdateCommerceSettingsRequest, type UpdateFlowResponse, type UpdateGroupSettingsRequest, type UpdateQrCodeRequest, type UpdateWabaSubscription, UploadMediaResponse, type ValidateFlowJsonResponse, type VerifyCodeRequest, type VideoMediaObject, VideoMediaTypes, VideoMediaTypesEnum, VideoMediaTypesType, type VideoMessage, type WABAClass, type WabaAccount, type WabaAccountFields, type WabaAccountFieldsParam, WabaAccountReviewStatus, WabaAccountStatus, WabaBusinessVerificationStatus, WabaConfigEnum, type WabaConfigType, type WabaHealthStatus, WabaHealthStatusCanSendMessage, type WabaHealthStatusEntity, type WabaHealthStatusError, type WabaSubscription, type WabaSubscriptions, type WebhookContact, type WebhookEvent, type WebhookMessage, type WebhookPayload, WebhookTypes, WebhookTypesEnum, WebhookTypesType, type WebhookValue, type WeeklyOperatingHours, type WhatsAppConfig, type WhatsAppErrorCode, type WhatsAppMessage };
4133
4328
  //# sourceMappingURL=index.d.ts.map