meta-cloud-api 3.3.0 → 3.5.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.
- package/README.md +1 -0
- package/dist/index.d.mts +331 -63
- package/dist/index.d.mts.map +1 -1
- package/dist/index.mjs +4 -4
- package/dist/index.mjs.map +1 -1
- package/dist/types/enums.d.ts +7 -1
- package/dist/types/enums.d.ts.map +1 -1
- package/dist/types/enums.js +1 -1
- package/dist/types/enums.js.map +1 -1
- package/dist/types/index.d.ts +215 -52
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/index.js +1 -1
- package/dist/types/index.js.map +1 -1
- package/dist/utils/index.d.ts +2 -2
- package/dist/utils/index.js +1 -1
- package/dist/utils/index.js.map +1 -1
- package/package.json +1 -1
package/dist/types/index.d.ts
CHANGED
|
@@ -1142,10 +1142,51 @@ declare class MessagesClass extends BaseClass {
|
|
|
1142
1142
|
* @see https://developers.facebook.com/documentation/business-messaging/whatsapp/marketing-messages/send-marketing-messages/
|
|
1143
1143
|
*/
|
|
1144
1144
|
type MarketingMessageRequest = {
|
|
1145
|
-
|
|
1145
|
+
/**
|
|
1146
|
+
* WhatsApp user phone number. Omit when addressing the user by `recipient`
|
|
1147
|
+
* (BSUID) instead.
|
|
1148
|
+
*/
|
|
1149
|
+
to?: string;
|
|
1150
|
+
/**
|
|
1151
|
+
* Business-scoped user ID (BSUID) or parent BSUID of the recipient, used in
|
|
1152
|
+
* place of `to` for individual messages.
|
|
1153
|
+
*
|
|
1154
|
+
* Templates carrying `bid_spec` (max price) cannot be sent to a BSUID
|
|
1155
|
+
* recipient — that combination fails with error `131062`.
|
|
1156
|
+
*/
|
|
1157
|
+
recipient?: string;
|
|
1146
1158
|
template: MessageTemplateObject<ComponentTypesEnum>;
|
|
1147
1159
|
message_activity_sharing?: boolean;
|
|
1148
1160
|
product_policy?: 'CLOUD_API_FALLBACK' | 'STRICT';
|
|
1161
|
+
/**
|
|
1162
|
+
* Per-message max price adjustment. Scales the template's `bid_amount`
|
|
1163
|
+
* (set in `optimization_spec`) for this send only, without editing the
|
|
1164
|
+
* template.
|
|
1165
|
+
*
|
|
1166
|
+
* Meta's recommendation: set the template's `bid_amount` to the highest
|
|
1167
|
+
* price you are willing to pay, then use a multiplier below 1 to scale
|
|
1168
|
+
* individual messages down. This gives the delivery system the widest
|
|
1169
|
+
* range to optimize against.
|
|
1170
|
+
*
|
|
1171
|
+
* The message-level multiplier is subject to change during the beta.
|
|
1172
|
+
*/
|
|
1173
|
+
bid_spec?: MarketingMessageBidSpec;
|
|
1174
|
+
};
|
|
1175
|
+
/**
|
|
1176
|
+
* Send-time max price multiplier for `POST /{PHONE_NUMBER_ID}/marketing_messages`.
|
|
1177
|
+
*
|
|
1178
|
+
* Meta keeps the `bid_spec` object name on the send call even though template
|
|
1179
|
+
* create/update moved from `bid_spec` to `optimization_spec` on July 31, 2026.
|
|
1180
|
+
*
|
|
1181
|
+
* @see https://developers.facebook.com/documentation/business-messaging/whatsapp/marketing-messages/pricing
|
|
1182
|
+
*/
|
|
1183
|
+
type MarketingMessageBidSpec = {
|
|
1184
|
+
/**
|
|
1185
|
+
* Positive multiplier applied to the template's `bid_amount`. Defaults to
|
|
1186
|
+
* `1` (the template amount unchanged); `1.5` raises the max price for this
|
|
1187
|
+
* message by 50%, `0.5` halves it.
|
|
1188
|
+
*/
|
|
1189
|
+
per_message_bid_multiplier: number;
|
|
1149
1190
|
};
|
|
1150
1191
|
interface MarketingMessagesClass {
|
|
1151
1192
|
sendTemplateMessage(params: MarketingMessageRequest): Promise<MessagesResponse>;
|
|
@@ -1793,11 +1834,47 @@ type ProductCarouselCard = {
|
|
|
1793
1834
|
components: TemplateHeader[];
|
|
1794
1835
|
};
|
|
1795
1836
|
type ComponentTypes = TemplateHeader | TemplateBody | TemplateFooter | TemplateButtons | TemplateLimitedTimeOffer | TemplateCarousel;
|
|
1837
|
+
/**
|
|
1838
|
+
* Max price ("bid") configuration for a marketing template.
|
|
1839
|
+
*
|
|
1840
|
+
* Max price is set per template, and templates carrying it must be sent through
|
|
1841
|
+
* the Marketing Messages API (`POST /{PHONE_NUMBER_ID}/marketing_messages`).
|
|
1842
|
+
* Sending one through the Cloud API `/messages` endpoint fails with error
|
|
1843
|
+
* `131061`; sending one to a BSUID recipient fails with error `131062`.
|
|
1844
|
+
* Omitting `optimization_spec` leaves the template on standard rate card pricing.
|
|
1845
|
+
*
|
|
1846
|
+
* As of August 31, 2026, eligible templates can be switched between rate card
|
|
1847
|
+
* pricing and max price without creating a new template — send
|
|
1848
|
+
* `optimization_spec` to `POST /{TEMPLATE_ID}` ({@link TemplateClass.updateTemplate}).
|
|
1849
|
+
*
|
|
1850
|
+
* @see https://developers.facebook.com/documentation/business-messaging/whatsapp/marketing-messages/pricing
|
|
1851
|
+
*/
|
|
1852
|
+
type TemplateOptimizationSpec = {
|
|
1853
|
+
/** Bid strategy. Only `LOWEST_COST_WITH_BID_CAP` is currently accepted. */bid_strategy: 'LOWEST_COST_WITH_BID_CAP';
|
|
1854
|
+
/**
|
|
1855
|
+
* Maximum price per 1,000 message deliveries, in the smallest unit of the
|
|
1856
|
+
* WABA's currency. Multiply the desired per-delivery price by 1,000 after
|
|
1857
|
+
* converting it to the smallest unit.
|
|
1858
|
+
*/
|
|
1859
|
+
bid_amount: number;
|
|
1860
|
+
};
|
|
1861
|
+
/**
|
|
1862
|
+
* @deprecated Meta deprecated `bid_spec` on template create/update on
|
|
1863
|
+
* July 31, 2026. Use {@link TemplateOptimizationSpec} with `optimization_spec`.
|
|
1864
|
+
*/
|
|
1865
|
+
type TemplateBidSpec = {
|
|
1866
|
+
/** Maximum price per 1,000 message deliveries, in the WABA currency's smallest unit. */bid_amount: number;
|
|
1867
|
+
};
|
|
1796
1868
|
type TemplateRequestBody = GeneralRequestBody & {
|
|
1797
1869
|
name: string;
|
|
1798
1870
|
language: LanguagesEnum;
|
|
1799
1871
|
category?: CategoryEnum;
|
|
1800
|
-
components?: ComponentTypes[];
|
|
1872
|
+
components?: ComponentTypes[]; /** Max price configuration. Marketing templates only, MM API sends only. */
|
|
1873
|
+
optimization_spec?: TemplateOptimizationSpec;
|
|
1874
|
+
/**
|
|
1875
|
+
* @deprecated Deprecated by Meta on July 31, 2026. Use `optimization_spec`.
|
|
1876
|
+
*/
|
|
1877
|
+
bid_spec?: TemplateBidSpec;
|
|
1801
1878
|
};
|
|
1802
1879
|
type TemplateResponse = {
|
|
1803
1880
|
id: string;
|
|
@@ -1805,7 +1882,8 @@ type TemplateResponse = {
|
|
|
1805
1882
|
language: LanguagesEnum;
|
|
1806
1883
|
category: CategoryEnum;
|
|
1807
1884
|
name: string;
|
|
1808
|
-
components: ComponentTypes[];
|
|
1885
|
+
components: ComponentTypes[]; /** Max price configuration, returned for templates created with one. */
|
|
1886
|
+
optimization_spec?: TemplateOptimizationSpec;
|
|
1809
1887
|
};
|
|
1810
1888
|
type TemplateGetParams = {
|
|
1811
1889
|
limit?: number;
|
|
@@ -3120,12 +3198,25 @@ interface OrderMessage extends BaseMessage {
|
|
|
3120
3198
|
}>;
|
|
3121
3199
|
};
|
|
3122
3200
|
}
|
|
3201
|
+
/**
|
|
3202
|
+
* System message webhook (identity changes).
|
|
3203
|
+
*
|
|
3204
|
+
* - `user_changed_number` — the user's phone number changed; `wa_id` holds the new number.
|
|
3205
|
+
* - `user_identity_changed` — the user's identity (profile) changed.
|
|
3206
|
+
* - `user_changed_user_id` — the user's business-scoped user ID (BSUID) changed;
|
|
3207
|
+
* `user_id` / `parent_user_id` hold the new BSUID / parent BSUID.
|
|
3208
|
+
*
|
|
3209
|
+
* Note: there is no subscribable `user_id_update` webhook field. BSUID changes are
|
|
3210
|
+
* delivered as these `messages` field system messages.
|
|
3211
|
+
*/
|
|
3123
3212
|
interface SystemMessage extends BaseMessage {
|
|
3124
3213
|
type: MessageTypesEnum.System;
|
|
3125
3214
|
system: {
|
|
3126
|
-
body: string;
|
|
3127
|
-
wa_id: string;
|
|
3128
|
-
|
|
3215
|
+
/** Human-readable description, e.g. "User A changed from <OLD_BSUID> to <NEW_BSUID>" */body: string; /** New WhatsApp ID of the user */
|
|
3216
|
+
wa_id: string; /** New business-scoped user ID, present for `user_changed_user_id` */
|
|
3217
|
+
user_id?: string; /** New parent business-scoped user ID, present for `user_changed_user_id` */
|
|
3218
|
+
parent_user_id?: string;
|
|
3219
|
+
type: 'user_changed_number' | 'user_identity_changed' | 'user_changed_user_id';
|
|
3129
3220
|
};
|
|
3130
3221
|
}
|
|
3131
3222
|
/**
|
|
@@ -3426,6 +3517,39 @@ interface MessageEchoesWebhookValue {
|
|
|
3426
3517
|
value: MessageEchoesValue;
|
|
3427
3518
|
}
|
|
3428
3519
|
//#endregion
|
|
3520
|
+
//#region src/core/webhook/types/status.d.ts
|
|
3521
|
+
interface StatusWebhook {
|
|
3522
|
+
id: string;
|
|
3523
|
+
status: 'sent' | 'delivered' | 'read' | 'failed';
|
|
3524
|
+
timestamp: string;
|
|
3525
|
+
recipient_id: string;
|
|
3526
|
+
recipient_type?: 'group';
|
|
3527
|
+
recipient_participant_id?: string;
|
|
3528
|
+
recipient_identity_key_hash?: string;
|
|
3529
|
+
biz_opaque_callback_data?: string;
|
|
3530
|
+
/**
|
|
3531
|
+
* ID of the template used to send a Direct Send message.
|
|
3532
|
+
* Present only on statuses for messages sent with a `category` field.
|
|
3533
|
+
*
|
|
3534
|
+
* @see {@link https://developers.facebook.com/documentation/business-messaging/whatsapp/direct-send/supported-message-types | Direct Send}
|
|
3535
|
+
*/
|
|
3536
|
+
template_id?: string;
|
|
3537
|
+
conversation?: {
|
|
3538
|
+
id: string;
|
|
3539
|
+
expiration_timestamp?: string;
|
|
3540
|
+
origin: {
|
|
3541
|
+
type: 'authentication' | 'authentication_international' | 'marketing' | 'marketing_lite' | 'referral_conversion' | 'service' | 'utility';
|
|
3542
|
+
};
|
|
3543
|
+
};
|
|
3544
|
+
pricing?: {
|
|
3545
|
+
billable: boolean;
|
|
3546
|
+
pricing_model: 'CBP' | 'PMP';
|
|
3547
|
+
type: 'regular' | 'free_customer_service' | 'free_entry_point';
|
|
3548
|
+
category: 'authentication' | 'authentication_international' | 'marketing' | 'marketing_lite' | 'referral_conversion' | 'service' | 'utility';
|
|
3549
|
+
};
|
|
3550
|
+
errors?: Array<WebhookError>;
|
|
3551
|
+
}
|
|
3552
|
+
//#endregion
|
|
3429
3553
|
//#region src/core/webhook/types/messaging.d.ts
|
|
3430
3554
|
interface MessagingHandoverControlPassed {
|
|
3431
3555
|
/** Optional metadata string passed with the handover */
|
|
@@ -3451,19 +3575,86 @@ interface MessagingHandoversWebhookValue {
|
|
|
3451
3575
|
field: 'messaging_handovers';
|
|
3452
3576
|
value: MessagingHandoversValue;
|
|
3453
3577
|
}
|
|
3578
|
+
/**
|
|
3579
|
+
* Flow definition attached to a standby message echo, present only for flow
|
|
3580
|
+
* message echoes.
|
|
3581
|
+
*/
|
|
3582
|
+
interface StandbyMessageEchoFlow {
|
|
3583
|
+
id: string;
|
|
3584
|
+
name: string;
|
|
3585
|
+
status: string;
|
|
3586
|
+
categories: string[];
|
|
3587
|
+
}
|
|
3588
|
+
/**
|
|
3589
|
+
* A single echoed outbound message observed while in standby. Carries the raw
|
|
3590
|
+
* Send Message API request body used by the active handler, not rendered content.
|
|
3591
|
+
*/
|
|
3592
|
+
interface StandbyMessageEcho {
|
|
3593
|
+
/** WhatsApp message ID (wamid.*) of the echoed outbound message */
|
|
3594
|
+
id: string;
|
|
3595
|
+
/** Unix timestamp (seconds, as a string) of when the message was sent */
|
|
3596
|
+
timestamp: string;
|
|
3597
|
+
/**
|
|
3598
|
+
* The exact Send Message API request body used to send the message, e.g.
|
|
3599
|
+
* `{ messaging_product, to, recipient_type?, type, [type]: {...}, context? }`.
|
|
3600
|
+
* For template messages the send-time variable values live here under `template`.
|
|
3601
|
+
*/
|
|
3602
|
+
message: {
|
|
3603
|
+
messaging_product: 'whatsapp';
|
|
3604
|
+
recipient_type?: string;
|
|
3605
|
+
to: string;
|
|
3606
|
+
type: string;
|
|
3607
|
+
context?: {
|
|
3608
|
+
message_id: string;
|
|
3609
|
+
};
|
|
3610
|
+
[key: string]: unknown;
|
|
3611
|
+
};
|
|
3612
|
+
/**
|
|
3613
|
+
* Full unhydrated template definition (layout with placeholders). Present only
|
|
3614
|
+
* for template message echoes, alongside `message`.
|
|
3615
|
+
*/
|
|
3616
|
+
template?: Record<string, unknown>;
|
|
3617
|
+
/** Full flow definition. Present only for flow message echoes, alongside `message`. */
|
|
3618
|
+
flow?: StandbyMessageEchoFlow;
|
|
3619
|
+
}
|
|
3620
|
+
/**
|
|
3621
|
+
* The standby event payload nested under `value.standby`. Contains exactly one of
|
|
3622
|
+
* `messages`, `message_echoes`, or `statuses` (with `contacts` alongside `messages`).
|
|
3623
|
+
*/
|
|
3624
|
+
interface StandbyEvent {
|
|
3625
|
+
/** Contact profiles for the users in an inbound standby message event */
|
|
3626
|
+
contacts?: WebhookContact[];
|
|
3627
|
+
/** Inbound messages received while your app is not the active handler */
|
|
3628
|
+
messages?: WhatsAppMessage[];
|
|
3629
|
+
/** Echoes of outbound messages sent by the active handler (e.g. Meta Business Agent) */
|
|
3630
|
+
message_echoes?: StandbyMessageEcho[];
|
|
3631
|
+
/** Delivery/read status updates for messages sent by the active handler */
|
|
3632
|
+
statuses?: StatusWebhook[];
|
|
3633
|
+
}
|
|
3454
3634
|
interface StandbyValue {
|
|
3455
3635
|
messaging_product: 'whatsapp';
|
|
3456
|
-
|
|
3636
|
+
metadata: WebhookMetadata;
|
|
3637
|
+
/** The standby event payload; carries exactly one event array */
|
|
3638
|
+
standby: StandbyEvent;
|
|
3457
3639
|
}
|
|
3458
3640
|
interface StandbyWebhookValue {
|
|
3459
3641
|
field: 'standby';
|
|
3460
3642
|
value: StandbyValue;
|
|
3461
3643
|
}
|
|
3462
3644
|
interface UserPreferenceEntry {
|
|
3463
|
-
/** WhatsApp ID of the user */
|
|
3464
|
-
wa_id
|
|
3465
|
-
/**
|
|
3466
|
-
|
|
3645
|
+
/** WhatsApp ID of the user. May be absent when only BSUIDs are shared. */
|
|
3646
|
+
wa_id?: string;
|
|
3647
|
+
/**
|
|
3648
|
+
* Business-scoped user ID the preference applies to (e.g. "US.1234567").
|
|
3649
|
+
* The preference is always scoped to this ID.
|
|
3650
|
+
*/
|
|
3651
|
+
user_id?: string;
|
|
3652
|
+
/**
|
|
3653
|
+
* Parent business-scoped user ID of the user, when the user is enrolled in a
|
|
3654
|
+
* parent BSUID. Informational only — preferences are never applied at the
|
|
3655
|
+
* parent BSUID level.
|
|
3656
|
+
*/
|
|
3657
|
+
parent_user_id?: string;
|
|
3467
3658
|
/** Human-readable description of the preference change */
|
|
3468
3659
|
detail: string;
|
|
3469
3660
|
/**
|
|
@@ -3473,9 +3664,9 @@ interface UserPreferenceEntry {
|
|
|
3473
3664
|
category: 'marketing_messages' | string;
|
|
3474
3665
|
/**
|
|
3475
3666
|
* New preference value.
|
|
3476
|
-
* Known
|
|
3667
|
+
* Known values: "stop" (user opted out), "resume" (user opted back in)
|
|
3477
3668
|
*/
|
|
3478
|
-
value: 'stop' | string;
|
|
3669
|
+
value: 'stop' | 'resume' | string;
|
|
3479
3670
|
/** Unix timestamp of when the preference was changed */
|
|
3480
3671
|
timestamp: number;
|
|
3481
3672
|
/** Signup ID associated with the preference, if applicable */
|
|
@@ -3486,10 +3677,12 @@ interface UserPreferencesContact {
|
|
|
3486
3677
|
/** Display name of the user */name: string; /** WhatsApp username, if available */
|
|
3487
3678
|
username?: string;
|
|
3488
3679
|
};
|
|
3489
|
-
/** WhatsApp ID of the user */
|
|
3490
|
-
wa_id
|
|
3491
|
-
/**
|
|
3680
|
+
/** WhatsApp ID of the user. May be absent when only BSUIDs are shared. */
|
|
3681
|
+
wa_id?: string;
|
|
3682
|
+
/** Business-scoped user ID of the user */
|
|
3492
3683
|
user_id?: string;
|
|
3684
|
+
/** Parent business-scoped user ID of the user, when enrolled */
|
|
3685
|
+
parent_user_id?: string;
|
|
3493
3686
|
}
|
|
3494
3687
|
interface UserPreferencesValue {
|
|
3495
3688
|
messaging_product: 'whatsapp';
|
|
@@ -3602,39 +3795,6 @@ interface SecurityWebhookValue {
|
|
|
3602
3795
|
value: SecurityValue;
|
|
3603
3796
|
}
|
|
3604
3797
|
//#endregion
|
|
3605
|
-
//#region src/core/webhook/types/status.d.ts
|
|
3606
|
-
interface StatusWebhook {
|
|
3607
|
-
id: string;
|
|
3608
|
-
status: 'sent' | 'delivered' | 'read' | 'failed';
|
|
3609
|
-
timestamp: string;
|
|
3610
|
-
recipient_id: string;
|
|
3611
|
-
recipient_type?: 'group';
|
|
3612
|
-
recipient_participant_id?: string;
|
|
3613
|
-
recipient_identity_key_hash?: string;
|
|
3614
|
-
biz_opaque_callback_data?: string;
|
|
3615
|
-
/**
|
|
3616
|
-
* ID of the template used to send a Direct Send message.
|
|
3617
|
-
* Present only on statuses for messages sent with a `category` field.
|
|
3618
|
-
*
|
|
3619
|
-
* @see {@link https://developers.facebook.com/documentation/business-messaging/whatsapp/direct-send/supported-message-types | Direct Send}
|
|
3620
|
-
*/
|
|
3621
|
-
template_id?: string;
|
|
3622
|
-
conversation?: {
|
|
3623
|
-
id: string;
|
|
3624
|
-
expiration_timestamp?: string;
|
|
3625
|
-
origin: {
|
|
3626
|
-
type: 'authentication' | 'authentication_international' | 'marketing' | 'marketing_lite' | 'referral_conversion' | 'service' | 'utility';
|
|
3627
|
-
};
|
|
3628
|
-
};
|
|
3629
|
-
pricing?: {
|
|
3630
|
-
billable: boolean;
|
|
3631
|
-
pricing_model: 'CBP' | 'PMP';
|
|
3632
|
-
type: 'regular' | 'free_customer_service' | 'free_entry_point';
|
|
3633
|
-
category: 'authentication' | 'authentication_international' | 'marketing' | 'marketing_lite' | 'referral_conversion' | 'service' | 'utility';
|
|
3634
|
-
};
|
|
3635
|
-
errors?: Array<WebhookError>;
|
|
3636
|
-
}
|
|
3637
|
-
//#endregion
|
|
3638
3798
|
//#region src/core/webhook/types/template.d.ts
|
|
3639
3799
|
/**
|
|
3640
3800
|
* Message template status events
|
|
@@ -3827,7 +3987,7 @@ type MetaErrorData = {
|
|
|
3827
3987
|
interface MetaError extends Error {
|
|
3828
3988
|
error: MetaErrorData;
|
|
3829
3989
|
}
|
|
3830
|
-
declare const WHATSAPP_ERROR_CODES: readonly [0, 1, 2, 3, 4, 10, 33, 100, 190, 200, 299, 368, 613, 80007, 130429, 130472, 130497, 131000, 131005, 131008, 131009, 131016, 131020, 131021, 131026, 131030, 131031, 131037, 131041, 131042, 131044, 131045, 131047, 131048, 131049, 131050, 131051, 131052, 131053, 131055, 131056, 131057, 131059, 131201, 131202, 131203, 131204, 131207, 131208, 131209, 131210, 131211, 131212, 131213, 131214, 131215, 132000, 132001, 132005, 132007, 132008, 132012, 132015, 132016, 132068, 132069, 133000, 133004, 133005, 133006, 133008, 133009, 133010, 133015, 133016, 134011, 134100, 134101, 134102, 135000, 137000, 138000, 138001, 138002, 138003, 138004, 138005, 138006, 138007, 138009, 138012, 138013, 138018, 139000, 139001, 139002, 139003, 139004, 139100, 139101, 139102, 139103, 147005, 200005, 200006, 200007, 1752041, 2388001, 2388012, 2388019, 2388040, 2388047, 2388072, 2388073, 2388091, 2388093, 2388103, 2388293, 2388299, 2494100, 2593079, 2593085, 2593107, 2593108];
|
|
3990
|
+
declare const WHATSAPP_ERROR_CODES: readonly [0, 1, 2, 3, 4, 10, 33, 100, 190, 200, 299, 368, 613, 80007, 130429, 130472, 130497, 131000, 131005, 131008, 131009, 131016, 131020, 131021, 131026, 131030, 131031, 131037, 131041, 131042, 131044, 131045, 131047, 131048, 131049, 131050, 131051, 131052, 131053, 131055, 131056, 131057, 131059, 131061, 131062, 131201, 131202, 131203, 131204, 131207, 131208, 131209, 131210, 131211, 131212, 131213, 131214, 131215, 132000, 132001, 132005, 132007, 132008, 132012, 132015, 132016, 132068, 132069, 133000, 133004, 133005, 133006, 133008, 133009, 133010, 133015, 133016, 134011, 134100, 134101, 134102, 135000, 137000, 138000, 138001, 138002, 138003, 138004, 138005, 138006, 138007, 138009, 138012, 138013, 138018, 139000, 139001, 139002, 139003, 139004, 139100, 139101, 139102, 139103, 147005, 200005, 200006, 200007, 1752041, 2388001, 2388012, 2388019, 2388040, 2388047, 2388072, 2388073, 2388091, 2388093, 2388103, 2388293, 2388299, 2494100, 2593079, 2593085, 2593107, 2593108];
|
|
3831
3991
|
type ApiPermissionErrorCode = number;
|
|
3832
3992
|
type WhatsAppErrorCode = (typeof WHATSAPP_ERROR_CODES)[number] | ApiPermissionErrorCode;
|
|
3833
3993
|
//#endregion
|
|
@@ -4407,8 +4567,11 @@ declare const WebhookTypes: {
|
|
|
4407
4567
|
};
|
|
4408
4568
|
type WebhookTypesType = (typeof WebhookTypes)[keyof typeof WebhookTypes];
|
|
4409
4569
|
declare const SystemChangeTypes: {
|
|
4410
|
-
readonly CustomerChangedNumber: "customer_changed_number";
|
|
4570
|
+
/** @deprecated Meta renamed this to `user_changed_number`. Use `UserChangedNumber`. */readonly CustomerChangedNumber: "customer_changed_number"; /** @deprecated Meta renamed this to `user_identity_changed`. Use `UserIdentityChanged`. */
|
|
4411
4571
|
readonly CustomerIdentityChanged: "customer_identity_changed";
|
|
4572
|
+
readonly UserChangedNumber: "user_changed_number";
|
|
4573
|
+
readonly UserIdentityChanged: "user_identity_changed"; /** The user's business-scoped user ID (BSUID) changed. */
|
|
4574
|
+
readonly UserChangedUserId: "user_changed_user_id";
|
|
4412
4575
|
};
|
|
4413
4576
|
type SystemChangeTypesType = (typeof SystemChangeTypes)[keyof typeof SystemChangeTypes];
|
|
4414
4577
|
declare const ReferralSourceTypes: {
|
|
@@ -4539,5 +4702,5 @@ interface LoggerInterface {
|
|
|
4539
4702
|
debug(...data: any[]): void;
|
|
4540
4703
|
}
|
|
4541
4704
|
//#endregion
|
|
4542
|
-
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, CarouselCard, type CarouselOptions, CatalogButton, type CatalogTemplateOptions, Category, CategoryEnum, CategoryType, type CodeVerificationStatus, type CommerceClass, type CommerceSetting, type CommerceSettingsResponse, ComponentType, ComponentTypeType, ComponentTypes, ComponentTypesEnum, type ContactObject, type ContactsMessage, ConversationTypes, ConversationTypesEnum, ConversationTypesType, CopyCodeButton, type CouponTemplateOptions, type 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, 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, MPMButton, type MPMTemplateOptions, type MarketingMessageRequest, type MarketingMessagesClass, type MediaCardCarouselTemplateOptions, MediaCarouselCard, MediaClass, type MediaParameter, MediaResponse, MediasResponse, MessageCategory, MessageCategoryEnum, MessageCategoryType, 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, 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, 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, ProductCarouselCard, type ProductParameter, type ProductSection, type QrCodeClass, type QrCodeResponse, type QrCodesResponse, type QualityRating, type QualityScore, 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, 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, TemplateBody, TemplateButton, TemplateButtons, TemplateCarousel, TemplateClass, TemplateDeleteParams, TemplateFooter, TemplateFormat, TemplateGetParams, TemplateHeader, TemplateHeaderExample, TemplateLimitedTimeOffer, type TemplateOptions, type TemplateParameter, TemplateRequestBody, TemplateResponse, TemplateStatus, TemplateStatusEnum, TemplateStatusType, type TerminateCallRequest, type TextMessage, type TextMessageParams, type TextObject, type TextParameter, type Throughput, type ThroughputLevel, type TwoStepVerificationClass, type TwoStepVerificationParams, type TwoStepVerificationRequest, 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 };
|
|
4705
|
+
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, CarouselCard, type CarouselOptions, CatalogButton, type CatalogTemplateOptions, Category, CategoryEnum, CategoryType, type CodeVerificationStatus, type CommerceClass, type CommerceSetting, type CommerceSettingsResponse, ComponentType, ComponentTypeType, ComponentTypes, ComponentTypesEnum, type ContactObject, type ContactsMessage, ConversationTypes, ConversationTypesEnum, ConversationTypesType, CopyCodeButton, type CouponTemplateOptions, type 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, 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, MPMButton, type MPMTemplateOptions, type MarketingMessageBidSpec, type MarketingMessageRequest, type MarketingMessagesClass, type MediaCardCarouselTemplateOptions, MediaCarouselCard, MediaClass, type MediaParameter, MediaResponse, MediasResponse, MessageCategory, MessageCategoryEnum, MessageCategoryType, 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, 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, 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, ProductCarouselCard, type ProductParameter, type ProductSection, type QrCodeClass, type QrCodeResponse, type QrCodesResponse, type QualityRating, type QualityScore, 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, 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, TemplateBidSpec, TemplateBody, TemplateButton, TemplateButtons, TemplateCarousel, TemplateClass, TemplateDeleteParams, TemplateFooter, TemplateFormat, TemplateGetParams, TemplateHeader, TemplateHeaderExample, TemplateLimitedTimeOffer, TemplateOptimizationSpec, type TemplateOptions, type TemplateParameter, TemplateRequestBody, TemplateResponse, TemplateStatus, TemplateStatusEnum, TemplateStatusType, type TerminateCallRequest, type TextMessage, type TextMessageParams, type TextObject, type TextParameter, type Throughput, type ThroughputLevel, type TwoStepVerificationClass, type TwoStepVerificationParams, type TwoStepVerificationRequest, 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 };
|
|
4543
4706
|
//# sourceMappingURL=index.d.ts.map
|