@kirimdev/sdk 3.9.0 → 3.11.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/dist/generated/schema.d.ts +209 -44
- package/dist/generated/version.d.ts +1 -1
- package/dist/generated/version.d.ts.map +1 -1
- package/dist/generated/version.js +1 -1
- package/dist/generated/version.js.map +1 -1
- package/dist/generated/version.ts +1 -1
- package/openapi.json +377 -51
- package/package.json +1 -1
|
@@ -260,7 +260,7 @@ export interface paths {
|
|
|
260
260
|
"application/json": components["schemas"]["ApiErrorEnvelope"];
|
|
261
261
|
};
|
|
262
262
|
};
|
|
263
|
-
/** @description Semantic failure (e.g. idempotency key reuse) */
|
|
263
|
+
/** @description Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found) */
|
|
264
264
|
422: {
|
|
265
265
|
headers: {
|
|
266
266
|
[name: string]: unknown;
|
|
@@ -320,7 +320,16 @@ export interface paths {
|
|
|
320
320
|
messaging_product: "whatsapp";
|
|
321
321
|
/** @enum {string} */
|
|
322
322
|
recipient_type?: "individual";
|
|
323
|
-
|
|
323
|
+
/**
|
|
324
|
+
* @description Recipient's WhatsApp phone number in E.164 (e.g. `628123456789`). Either `to` or `recipient` is required; if both are supplied, Meta uses `to` (documented precedence).
|
|
325
|
+
* @example 628123456789
|
|
326
|
+
*/
|
|
327
|
+
to?: string;
|
|
328
|
+
/**
|
|
329
|
+
* @description Recipient's Business-Scoped User ID (e.g. `US.13491208655302741918`) or parent BSUID. Alternative to `to`. Auth OTP templates (one-tap / zero-tap / copy-code) do NOT support BSUID recipients — Meta rejects with error 131062.
|
|
330
|
+
* @example US.13491208655302741918
|
|
331
|
+
*/
|
|
332
|
+
recipient?: string;
|
|
324
333
|
/** Reply context */
|
|
325
334
|
context?: {
|
|
326
335
|
/**
|
|
@@ -340,7 +349,16 @@ export interface paths {
|
|
|
340
349
|
messaging_product: "whatsapp";
|
|
341
350
|
/** @enum {string} */
|
|
342
351
|
recipient_type?: "individual";
|
|
343
|
-
|
|
352
|
+
/**
|
|
353
|
+
* @description Recipient's WhatsApp phone number in E.164 (e.g. `628123456789`). Either `to` or `recipient` is required; if both are supplied, Meta uses `to` (documented precedence).
|
|
354
|
+
* @example 628123456789
|
|
355
|
+
*/
|
|
356
|
+
to?: string;
|
|
357
|
+
/**
|
|
358
|
+
* @description Recipient's Business-Scoped User ID (e.g. `US.13491208655302741918`) or parent BSUID. Alternative to `to`. Auth OTP templates (one-tap / zero-tap / copy-code) do NOT support BSUID recipients — Meta rejects with error 131062.
|
|
359
|
+
* @example US.13491208655302741918
|
|
360
|
+
*/
|
|
361
|
+
recipient?: string;
|
|
344
362
|
/** Reply context */
|
|
345
363
|
context?: {
|
|
346
364
|
/**
|
|
@@ -363,7 +381,16 @@ export interface paths {
|
|
|
363
381
|
messaging_product: "whatsapp";
|
|
364
382
|
/** @enum {string} */
|
|
365
383
|
recipient_type?: "individual";
|
|
366
|
-
|
|
384
|
+
/**
|
|
385
|
+
* @description Recipient's WhatsApp phone number in E.164 (e.g. `628123456789`). Either `to` or `recipient` is required; if both are supplied, Meta uses `to` (documented precedence).
|
|
386
|
+
* @example 628123456789
|
|
387
|
+
*/
|
|
388
|
+
to?: string;
|
|
389
|
+
/**
|
|
390
|
+
* @description Recipient's Business-Scoped User ID (e.g. `US.13491208655302741918`) or parent BSUID. Alternative to `to`. Auth OTP templates (one-tap / zero-tap / copy-code) do NOT support BSUID recipients — Meta rejects with error 131062.
|
|
391
|
+
* @example US.13491208655302741918
|
|
392
|
+
*/
|
|
393
|
+
recipient?: string;
|
|
367
394
|
/** Reply context */
|
|
368
395
|
context?: {
|
|
369
396
|
/**
|
|
@@ -386,7 +413,16 @@ export interface paths {
|
|
|
386
413
|
messaging_product: "whatsapp";
|
|
387
414
|
/** @enum {string} */
|
|
388
415
|
recipient_type?: "individual";
|
|
389
|
-
|
|
416
|
+
/**
|
|
417
|
+
* @description Recipient's WhatsApp phone number in E.164 (e.g. `628123456789`). Either `to` or `recipient` is required; if both are supplied, Meta uses `to` (documented precedence).
|
|
418
|
+
* @example 628123456789
|
|
419
|
+
*/
|
|
420
|
+
to?: string;
|
|
421
|
+
/**
|
|
422
|
+
* @description Recipient's Business-Scoped User ID (e.g. `US.13491208655302741918`) or parent BSUID. Alternative to `to`. Auth OTP templates (one-tap / zero-tap / copy-code) do NOT support BSUID recipients — Meta rejects with error 131062.
|
|
423
|
+
* @example US.13491208655302741918
|
|
424
|
+
*/
|
|
425
|
+
recipient?: string;
|
|
390
426
|
/** Reply context */
|
|
391
427
|
context?: {
|
|
392
428
|
/**
|
|
@@ -409,7 +445,16 @@ export interface paths {
|
|
|
409
445
|
messaging_product: "whatsapp";
|
|
410
446
|
/** @enum {string} */
|
|
411
447
|
recipient_type?: "individual";
|
|
412
|
-
|
|
448
|
+
/**
|
|
449
|
+
* @description Recipient's WhatsApp phone number in E.164 (e.g. `628123456789`). Either `to` or `recipient` is required; if both are supplied, Meta uses `to` (documented precedence).
|
|
450
|
+
* @example 628123456789
|
|
451
|
+
*/
|
|
452
|
+
to?: string;
|
|
453
|
+
/**
|
|
454
|
+
* @description Recipient's Business-Scoped User ID (e.g. `US.13491208655302741918`) or parent BSUID. Alternative to `to`. Auth OTP templates (one-tap / zero-tap / copy-code) do NOT support BSUID recipients — Meta rejects with error 131062.
|
|
455
|
+
* @example US.13491208655302741918
|
|
456
|
+
*/
|
|
457
|
+
recipient?: string;
|
|
413
458
|
/** Reply context */
|
|
414
459
|
context?: {
|
|
415
460
|
/**
|
|
@@ -433,7 +478,16 @@ export interface paths {
|
|
|
433
478
|
messaging_product: "whatsapp";
|
|
434
479
|
/** @enum {string} */
|
|
435
480
|
recipient_type?: "individual";
|
|
436
|
-
|
|
481
|
+
/**
|
|
482
|
+
* @description Recipient's WhatsApp phone number in E.164 (e.g. `628123456789`). Either `to` or `recipient` is required; if both are supplied, Meta uses `to` (documented precedence).
|
|
483
|
+
* @example 628123456789
|
|
484
|
+
*/
|
|
485
|
+
to?: string;
|
|
486
|
+
/**
|
|
487
|
+
* @description Recipient's Business-Scoped User ID (e.g. `US.13491208655302741918`) or parent BSUID. Alternative to `to`. Auth OTP templates (one-tap / zero-tap / copy-code) do NOT support BSUID recipients — Meta rejects with error 131062.
|
|
488
|
+
* @example US.13491208655302741918
|
|
489
|
+
*/
|
|
490
|
+
recipient?: string;
|
|
437
491
|
/** Reply context */
|
|
438
492
|
context?: {
|
|
439
493
|
/**
|
|
@@ -468,7 +522,16 @@ export interface paths {
|
|
|
468
522
|
messaging_product: "whatsapp";
|
|
469
523
|
/** @enum {string} */
|
|
470
524
|
recipient_type?: "individual";
|
|
471
|
-
|
|
525
|
+
/**
|
|
526
|
+
* @description Recipient's WhatsApp phone number in E.164 (e.g. `628123456789`). Either `to` or `recipient` is required; if both are supplied, Meta uses `to` (documented precedence).
|
|
527
|
+
* @example 628123456789
|
|
528
|
+
*/
|
|
529
|
+
to?: string;
|
|
530
|
+
/**
|
|
531
|
+
* @description Recipient's Business-Scoped User ID (e.g. `US.13491208655302741918`) or parent BSUID. Alternative to `to`. Auth OTP templates (one-tap / zero-tap / copy-code) do NOT support BSUID recipients — Meta rejects with error 131062.
|
|
532
|
+
* @example US.13491208655302741918
|
|
533
|
+
*/
|
|
534
|
+
recipient?: string;
|
|
472
535
|
/** Reply context */
|
|
473
536
|
context?: {
|
|
474
537
|
/**
|
|
@@ -482,9 +545,38 @@ export interface paths {
|
|
|
482
545
|
interactive: {
|
|
483
546
|
/** @enum {string} */
|
|
484
547
|
type: "cta_url";
|
|
548
|
+
header?: {
|
|
549
|
+
/** @enum {string} */
|
|
550
|
+
type: "text";
|
|
551
|
+
text: string;
|
|
552
|
+
} | {
|
|
553
|
+
/** @enum {string} */
|
|
554
|
+
type: "image";
|
|
555
|
+
image: {
|
|
556
|
+
/** Format: uri */
|
|
557
|
+
link: string;
|
|
558
|
+
};
|
|
559
|
+
} | {
|
|
560
|
+
/** @enum {string} */
|
|
561
|
+
type: "video";
|
|
562
|
+
video: {
|
|
563
|
+
/** Format: uri */
|
|
564
|
+
link: string;
|
|
565
|
+
};
|
|
566
|
+
} | {
|
|
567
|
+
/** @enum {string} */
|
|
568
|
+
type: "document";
|
|
569
|
+
document: {
|
|
570
|
+
/** Format: uri */
|
|
571
|
+
link: string;
|
|
572
|
+
};
|
|
573
|
+
};
|
|
485
574
|
body: {
|
|
486
575
|
text: string;
|
|
487
576
|
};
|
|
577
|
+
footer?: {
|
|
578
|
+
text: string;
|
|
579
|
+
};
|
|
488
580
|
action: {
|
|
489
581
|
/** @enum {string} */
|
|
490
582
|
name: "cta_url";
|
|
@@ -669,7 +761,7 @@ export interface paths {
|
|
|
669
761
|
"application/json": components["schemas"]["ApiErrorEnvelope"];
|
|
670
762
|
};
|
|
671
763
|
};
|
|
672
|
-
/** @description Semantic failure (e.g. idempotency key reuse) */
|
|
764
|
+
/** @description Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found) */
|
|
673
765
|
422: {
|
|
674
766
|
headers: {
|
|
675
767
|
[name: string]: unknown;
|
|
@@ -784,7 +876,7 @@ export interface paths {
|
|
|
784
876
|
"application/json": components["schemas"]["ApiErrorEnvelope"];
|
|
785
877
|
};
|
|
786
878
|
};
|
|
787
|
-
/** @description Semantic failure (e.g. idempotency key reuse) */
|
|
879
|
+
/** @description Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found) */
|
|
788
880
|
422: {
|
|
789
881
|
headers: {
|
|
790
882
|
[name: string]: unknown;
|
|
@@ -885,7 +977,7 @@ export interface paths {
|
|
|
885
977
|
"application/json": components["schemas"]["ApiErrorEnvelope"];
|
|
886
978
|
};
|
|
887
979
|
};
|
|
888
|
-
/** @description Semantic failure (e.g. idempotency key reuse) */
|
|
980
|
+
/** @description Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found) */
|
|
889
981
|
422: {
|
|
890
982
|
headers: {
|
|
891
983
|
[name: string]: unknown;
|
|
@@ -1026,7 +1118,7 @@ export interface paths {
|
|
|
1026
1118
|
"application/json": components["schemas"]["ApiErrorEnvelope"];
|
|
1027
1119
|
};
|
|
1028
1120
|
};
|
|
1029
|
-
/** @description Semantic failure (e.g. idempotency key reuse) */
|
|
1121
|
+
/** @description Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found) */
|
|
1030
1122
|
422: {
|
|
1031
1123
|
headers: {
|
|
1032
1124
|
[name: string]: unknown;
|
|
@@ -1129,7 +1221,7 @@ export interface paths {
|
|
|
1129
1221
|
"application/json": components["schemas"]["ApiErrorEnvelope"];
|
|
1130
1222
|
};
|
|
1131
1223
|
};
|
|
1132
|
-
/** @description Semantic failure (e.g. idempotency key reuse) */
|
|
1224
|
+
/** @description Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found) */
|
|
1133
1225
|
422: {
|
|
1134
1226
|
headers: {
|
|
1135
1227
|
[name: string]: unknown;
|
|
@@ -1227,7 +1319,7 @@ export interface paths {
|
|
|
1227
1319
|
"application/json": components["schemas"]["ApiErrorEnvelope"];
|
|
1228
1320
|
};
|
|
1229
1321
|
};
|
|
1230
|
-
/** @description Semantic failure (e.g. idempotency key reuse) */
|
|
1322
|
+
/** @description Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found) */
|
|
1231
1323
|
422: {
|
|
1232
1324
|
headers: {
|
|
1233
1325
|
[name: string]: unknown;
|
|
@@ -1357,7 +1449,8 @@ export interface paths {
|
|
|
1357
1449
|
/** Format: uri */
|
|
1358
1450
|
url: string;
|
|
1359
1451
|
description?: string;
|
|
1360
|
-
events: ("message.received" | "message.status" | "message.sent" | "conversation.assigned" | "conversation.closed" | "contact.created" | "contact.updated" | "customer.created" | "customer.updated" | "customer.archived" | "customer.onboarded" | "customer.setup_link.created" | "customer.setup_link.consumed")[];
|
|
1452
|
+
events: ("message.received" | "message.status" | "message.sent" | "conversation.assigned" | "conversation.closed" | "contact.created" | "contact.updated" | "contact.identity_updated" | "customer.created" | "customer.updated" | "customer.archived" | "customer.onboarded" | "customer.setup_link.created" | "customer.setup_link.consumed")[];
|
|
1453
|
+
phone_number_ids?: string[];
|
|
1361
1454
|
};
|
|
1362
1455
|
};
|
|
1363
1456
|
};
|
|
@@ -1389,6 +1482,15 @@ export interface paths {
|
|
|
1389
1482
|
"application/json": components["schemas"]["ApiErrorEnvelope"];
|
|
1390
1483
|
};
|
|
1391
1484
|
};
|
|
1485
|
+
/** @description Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found) */
|
|
1486
|
+
422: {
|
|
1487
|
+
headers: {
|
|
1488
|
+
[name: string]: unknown;
|
|
1489
|
+
};
|
|
1490
|
+
content: {
|
|
1491
|
+
"application/json": components["schemas"]["ApiErrorEnvelope"];
|
|
1492
|
+
};
|
|
1493
|
+
};
|
|
1392
1494
|
/** @description Rate limit exceeded */
|
|
1393
1495
|
429: {
|
|
1394
1496
|
headers: {
|
|
@@ -1590,9 +1692,10 @@ export interface paths {
|
|
|
1590
1692
|
/** Format: uri */
|
|
1591
1693
|
url?: string;
|
|
1592
1694
|
description?: string | null;
|
|
1593
|
-
events?: ("message.received" | "message.status" | "message.sent" | "conversation.assigned" | "conversation.closed" | "contact.created" | "contact.updated" | "customer.created" | "customer.updated" | "customer.archived" | "customer.onboarded" | "customer.setup_link.created" | "customer.setup_link.consumed")[];
|
|
1695
|
+
events?: ("message.received" | "message.status" | "message.sent" | "conversation.assigned" | "conversation.closed" | "contact.created" | "contact.updated" | "contact.identity_updated" | "customer.created" | "customer.updated" | "customer.archived" | "customer.onboarded" | "customer.setup_link.created" | "customer.setup_link.consumed")[];
|
|
1594
1696
|
/** @enum {string} */
|
|
1595
1697
|
status?: "active" | "paused";
|
|
1698
|
+
phone_number_ids?: string[] | null;
|
|
1596
1699
|
};
|
|
1597
1700
|
};
|
|
1598
1701
|
};
|
|
@@ -1633,6 +1736,15 @@ export interface paths {
|
|
|
1633
1736
|
"application/json": components["schemas"]["ApiErrorEnvelope"];
|
|
1634
1737
|
};
|
|
1635
1738
|
};
|
|
1739
|
+
/** @description Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found) */
|
|
1740
|
+
422: {
|
|
1741
|
+
headers: {
|
|
1742
|
+
[name: string]: unknown;
|
|
1743
|
+
};
|
|
1744
|
+
content: {
|
|
1745
|
+
"application/json": components["schemas"]["ApiErrorEnvelope"];
|
|
1746
|
+
};
|
|
1747
|
+
};
|
|
1636
1748
|
/** @description Rate limit exceeded */
|
|
1637
1749
|
429: {
|
|
1638
1750
|
headers: {
|
|
@@ -1824,7 +1936,7 @@ export interface paths {
|
|
|
1824
1936
|
"application/json": components["schemas"]["ApiErrorEnvelope"];
|
|
1825
1937
|
};
|
|
1826
1938
|
};
|
|
1827
|
-
/** @description Semantic failure (e.g. idempotency key reuse) */
|
|
1939
|
+
/** @description Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found) */
|
|
1828
1940
|
422: {
|
|
1829
1941
|
headers: {
|
|
1830
1942
|
[name: string]: unknown;
|
|
@@ -2301,7 +2413,7 @@ export interface paths {
|
|
|
2301
2413
|
"application/json": components["schemas"]["ApiErrorEnvelope"];
|
|
2302
2414
|
};
|
|
2303
2415
|
};
|
|
2304
|
-
/** @description Semantic failure (e.g. idempotency key reuse) */
|
|
2416
|
+
/** @description Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found) */
|
|
2305
2417
|
422: {
|
|
2306
2418
|
headers: {
|
|
2307
2419
|
[name: string]: unknown;
|
|
@@ -2395,7 +2507,7 @@ export interface paths {
|
|
|
2395
2507
|
"application/json": components["schemas"]["ApiErrorEnvelope"];
|
|
2396
2508
|
};
|
|
2397
2509
|
};
|
|
2398
|
-
/** @description Semantic failure (e.g. idempotency key reuse) */
|
|
2510
|
+
/** @description Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found) */
|
|
2399
2511
|
422: {
|
|
2400
2512
|
headers: {
|
|
2401
2513
|
[name: string]: unknown;
|
|
@@ -2490,7 +2602,7 @@ export interface paths {
|
|
|
2490
2602
|
"application/json": components["schemas"]["ApiErrorEnvelope"];
|
|
2491
2603
|
};
|
|
2492
2604
|
};
|
|
2493
|
-
/** @description Semantic failure (e.g. idempotency key reuse) */
|
|
2605
|
+
/** @description Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found) */
|
|
2494
2606
|
422: {
|
|
2495
2607
|
headers: {
|
|
2496
2608
|
[name: string]: unknown;
|
|
@@ -2536,6 +2648,8 @@ export interface paths {
|
|
|
2536
2648
|
parameters: {
|
|
2537
2649
|
query?: {
|
|
2538
2650
|
phone?: string;
|
|
2651
|
+
bsuid?: string;
|
|
2652
|
+
username?: string;
|
|
2539
2653
|
search?: string;
|
|
2540
2654
|
limit?: string;
|
|
2541
2655
|
cursor?: string;
|
|
@@ -2585,7 +2699,7 @@ export interface paths {
|
|
|
2585
2699
|
"application/json": components["schemas"]["ApiErrorEnvelope"];
|
|
2586
2700
|
};
|
|
2587
2701
|
};
|
|
2588
|
-
/** @description Semantic failure (e.g. idempotency key reuse) */
|
|
2702
|
+
/** @description Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found) */
|
|
2589
2703
|
422: {
|
|
2590
2704
|
headers: {
|
|
2591
2705
|
[name: string]: unknown;
|
|
@@ -2632,7 +2746,9 @@ export interface paths {
|
|
|
2632
2746
|
requestBody?: {
|
|
2633
2747
|
content: {
|
|
2634
2748
|
"application/json": {
|
|
2635
|
-
phone_number
|
|
2749
|
+
phone_number?: string;
|
|
2750
|
+
bsuid?: string;
|
|
2751
|
+
username?: string;
|
|
2636
2752
|
name?: string;
|
|
2637
2753
|
/** Format: email */
|
|
2638
2754
|
email?: string | null;
|
|
@@ -2679,7 +2795,7 @@ export interface paths {
|
|
|
2679
2795
|
"application/json": components["schemas"]["ApiErrorEnvelope"];
|
|
2680
2796
|
};
|
|
2681
2797
|
};
|
|
2682
|
-
/** @description Semantic failure (e.g. idempotency key reuse) */
|
|
2798
|
+
/** @description Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found) */
|
|
2683
2799
|
422: {
|
|
2684
2800
|
headers: {
|
|
2685
2801
|
[name: string]: unknown;
|
|
@@ -2771,7 +2887,7 @@ export interface paths {
|
|
|
2771
2887
|
"application/json": components["schemas"]["ApiErrorEnvelope"];
|
|
2772
2888
|
};
|
|
2773
2889
|
};
|
|
2774
|
-
/** @description Semantic failure (e.g. idempotency key reuse) */
|
|
2890
|
+
/** @description Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found) */
|
|
2775
2891
|
422: {
|
|
2776
2892
|
headers: {
|
|
2777
2893
|
[name: string]: unknown;
|
|
@@ -2855,7 +2971,7 @@ export interface paths {
|
|
|
2855
2971
|
"application/json": components["schemas"]["ApiErrorEnvelope"];
|
|
2856
2972
|
};
|
|
2857
2973
|
};
|
|
2858
|
-
/** @description Semantic failure (e.g. idempotency key reuse) */
|
|
2974
|
+
/** @description Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found) */
|
|
2859
2975
|
422: {
|
|
2860
2976
|
headers: {
|
|
2861
2977
|
[name: string]: unknown;
|
|
@@ -2905,6 +3021,7 @@ export interface paths {
|
|
|
2905
3021
|
content: {
|
|
2906
3022
|
"application/json": {
|
|
2907
3023
|
name?: string | null;
|
|
3024
|
+
username?: string | null;
|
|
2908
3025
|
email?: string | "" | null;
|
|
2909
3026
|
metadata?: {
|
|
2910
3027
|
[key: string]: unknown;
|
|
@@ -2949,7 +3066,7 @@ export interface paths {
|
|
|
2949
3066
|
"application/json": components["schemas"]["ApiErrorEnvelope"];
|
|
2950
3067
|
};
|
|
2951
3068
|
};
|
|
2952
|
-
/** @description Semantic failure (e.g. idempotency key reuse) */
|
|
3069
|
+
/** @description Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found) */
|
|
2953
3070
|
422: {
|
|
2954
3071
|
headers: {
|
|
2955
3072
|
[name: string]: unknown;
|
|
@@ -3040,7 +3157,7 @@ export interface paths {
|
|
|
3040
3157
|
"application/json": components["schemas"]["ApiErrorEnvelope"];
|
|
3041
3158
|
};
|
|
3042
3159
|
};
|
|
3043
|
-
/** @description Semantic failure (e.g. idempotency key reuse) */
|
|
3160
|
+
/** @description Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found) */
|
|
3044
3161
|
422: {
|
|
3045
3162
|
headers: {
|
|
3046
3163
|
[name: string]: unknown;
|
|
@@ -3145,7 +3262,7 @@ export interface paths {
|
|
|
3145
3262
|
"application/json": components["schemas"]["ApiErrorEnvelope"];
|
|
3146
3263
|
};
|
|
3147
3264
|
};
|
|
3148
|
-
/** @description Semantic failure (e.g. idempotency key reuse) */
|
|
3265
|
+
/** @description Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found) */
|
|
3149
3266
|
422: {
|
|
3150
3267
|
headers: {
|
|
3151
3268
|
[name: string]: unknown;
|
|
@@ -3241,7 +3358,7 @@ export interface paths {
|
|
|
3241
3358
|
"application/json": components["schemas"]["ApiErrorEnvelope"];
|
|
3242
3359
|
};
|
|
3243
3360
|
};
|
|
3244
|
-
/** @description Semantic failure (e.g. idempotency key reuse) */
|
|
3361
|
+
/** @description Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found) */
|
|
3245
3362
|
422: {
|
|
3246
3363
|
headers: {
|
|
3247
3364
|
[name: string]: unknown;
|
|
@@ -3345,7 +3462,7 @@ export interface paths {
|
|
|
3345
3462
|
"application/json": components["schemas"]["ApiErrorEnvelope"];
|
|
3346
3463
|
};
|
|
3347
3464
|
};
|
|
3348
|
-
/** @description Semantic failure (e.g. idempotency key reuse) */
|
|
3465
|
+
/** @description Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found) */
|
|
3349
3466
|
422: {
|
|
3350
3467
|
headers: {
|
|
3351
3468
|
[name: string]: unknown;
|
|
@@ -3445,7 +3562,7 @@ export interface paths {
|
|
|
3445
3562
|
"application/json": components["schemas"]["ApiErrorEnvelope"];
|
|
3446
3563
|
};
|
|
3447
3564
|
};
|
|
3448
|
-
/** @description Semantic failure (e.g. idempotency key reuse) */
|
|
3565
|
+
/** @description Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found) */
|
|
3449
3566
|
422: {
|
|
3450
3567
|
headers: {
|
|
3451
3568
|
[name: string]: unknown;
|
|
@@ -3541,7 +3658,7 @@ export interface paths {
|
|
|
3541
3658
|
"application/json": components["schemas"]["ApiErrorEnvelope"];
|
|
3542
3659
|
};
|
|
3543
3660
|
};
|
|
3544
|
-
/** @description Semantic failure (e.g. idempotency key reuse) */
|
|
3661
|
+
/** @description Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found) */
|
|
3545
3662
|
422: {
|
|
3546
3663
|
headers: {
|
|
3547
3664
|
[name: string]: unknown;
|
|
@@ -4004,7 +4121,7 @@ export interface paths {
|
|
|
4004
4121
|
"application/json": components["schemas"]["ApiErrorEnvelope"];
|
|
4005
4122
|
};
|
|
4006
4123
|
};
|
|
4007
|
-
/** @description
|
|
4124
|
+
/** @description Billing / entitlement gate — subscription inactive, quota exceeded, or plan tier missing a feature (feature_not_entitled). Upgrade to continue. */
|
|
4008
4125
|
402: {
|
|
4009
4126
|
headers: {
|
|
4010
4127
|
[name: string]: unknown;
|
|
@@ -4086,7 +4203,7 @@ export interface paths {
|
|
|
4086
4203
|
"application/json": components["schemas"]["ApiErrorEnvelope"];
|
|
4087
4204
|
};
|
|
4088
4205
|
};
|
|
4089
|
-
/** @description
|
|
4206
|
+
/** @description Billing / entitlement gate — subscription inactive, quota exceeded, or plan tier missing a feature (feature_not_entitled). Upgrade to continue. */
|
|
4090
4207
|
402: {
|
|
4091
4208
|
headers: {
|
|
4092
4209
|
[name: string]: unknown;
|
|
@@ -4167,7 +4284,7 @@ export interface paths {
|
|
|
4167
4284
|
"application/json": components["schemas"]["ApiErrorEnvelope"];
|
|
4168
4285
|
};
|
|
4169
4286
|
};
|
|
4170
|
-
/** @description
|
|
4287
|
+
/** @description Billing / entitlement gate — subscription inactive, quota exceeded, or plan tier missing a feature (feature_not_entitled). Upgrade to continue. */
|
|
4171
4288
|
402: {
|
|
4172
4289
|
headers: {
|
|
4173
4290
|
[name: string]: unknown;
|
|
@@ -4249,7 +4366,7 @@ export interface paths {
|
|
|
4249
4366
|
"application/json": components["schemas"]["ApiErrorEnvelope"];
|
|
4250
4367
|
};
|
|
4251
4368
|
};
|
|
4252
|
-
/** @description
|
|
4369
|
+
/** @description Billing / entitlement gate — subscription inactive, quota exceeded, or plan tier missing a feature (feature_not_entitled). Upgrade to continue. */
|
|
4253
4370
|
402: {
|
|
4254
4371
|
headers: {
|
|
4255
4372
|
[name: string]: unknown;
|
|
@@ -4341,7 +4458,7 @@ export interface paths {
|
|
|
4341
4458
|
"application/json": components["schemas"]["ApiErrorEnvelope"];
|
|
4342
4459
|
};
|
|
4343
4460
|
};
|
|
4344
|
-
/** @description
|
|
4461
|
+
/** @description Billing / entitlement gate — subscription inactive, quota exceeded, or plan tier missing a feature (feature_not_entitled). Upgrade to continue. */
|
|
4345
4462
|
402: {
|
|
4346
4463
|
headers: {
|
|
4347
4464
|
[name: string]: unknown;
|
|
@@ -4432,7 +4549,7 @@ export interface paths {
|
|
|
4432
4549
|
"application/json": components["schemas"]["ApiErrorEnvelope"];
|
|
4433
4550
|
};
|
|
4434
4551
|
};
|
|
4435
|
-
/** @description
|
|
4552
|
+
/** @description Billing / entitlement gate — subscription inactive, quota exceeded, or plan tier missing a feature (feature_not_entitled). Upgrade to continue. */
|
|
4436
4553
|
402: {
|
|
4437
4554
|
headers: {
|
|
4438
4555
|
[name: string]: unknown;
|
|
@@ -4523,7 +4640,7 @@ export interface paths {
|
|
|
4523
4640
|
"application/json": components["schemas"]["ApiErrorEnvelope"];
|
|
4524
4641
|
};
|
|
4525
4642
|
};
|
|
4526
|
-
/** @description
|
|
4643
|
+
/** @description Billing / entitlement gate — subscription inactive, quota exceeded, or plan tier missing a feature (feature_not_entitled). Upgrade to continue. */
|
|
4527
4644
|
402: {
|
|
4528
4645
|
headers: {
|
|
4529
4646
|
[name: string]: unknown;
|
|
@@ -4620,7 +4737,7 @@ export interface paths {
|
|
|
4620
4737
|
"application/json": components["schemas"]["ApiErrorEnvelope"];
|
|
4621
4738
|
};
|
|
4622
4739
|
};
|
|
4623
|
-
/** @description
|
|
4740
|
+
/** @description Billing / entitlement gate — subscription inactive, quota exceeded, or plan tier missing a feature (feature_not_entitled). Upgrade to continue. */
|
|
4624
4741
|
402: {
|
|
4625
4742
|
headers: {
|
|
4626
4743
|
[name: string]: unknown;
|
|
@@ -4719,7 +4836,7 @@ export interface paths {
|
|
|
4719
4836
|
"application/json": components["schemas"]["ApiErrorEnvelope"];
|
|
4720
4837
|
};
|
|
4721
4838
|
};
|
|
4722
|
-
/** @description
|
|
4839
|
+
/** @description Billing / entitlement gate — subscription inactive, quota exceeded, or plan tier missing a feature (feature_not_entitled). Upgrade to continue. */
|
|
4723
4840
|
402: {
|
|
4724
4841
|
headers: {
|
|
4725
4842
|
[name: string]: unknown;
|
|
@@ -4774,8 +4891,11 @@ export interface components {
|
|
|
4774
4891
|
schemas: {
|
|
4775
4892
|
ApiErrorEnvelope: {
|
|
4776
4893
|
error: {
|
|
4777
|
-
/**
|
|
4778
|
-
|
|
4894
|
+
/**
|
|
4895
|
+
* @example invalid_request_error
|
|
4896
|
+
* @enum {string}
|
|
4897
|
+
*/
|
|
4898
|
+
type: "invalid_request_error" | "authentication_error" | "permission_error" | "not_found" | "conflict" | "rate_limit_error" | "api_error";
|
|
4779
4899
|
/** @example invalid_phone_number */
|
|
4780
4900
|
code: string;
|
|
4781
4901
|
message: string;
|
|
@@ -4803,7 +4923,26 @@ export interface components {
|
|
|
4803
4923
|
id: string;
|
|
4804
4924
|
/** @enum {string} */
|
|
4805
4925
|
object: "message";
|
|
4806
|
-
|
|
4926
|
+
/**
|
|
4927
|
+
* @description Recipient's phone number in E.164 (with leading `+`). NULL when the message targeted a Business-Scoped User ID (BSUID) recipient and the contact has no known phone number. See docs/meta-docs/bsuid.md.
|
|
4928
|
+
* @example +628123456789
|
|
4929
|
+
*/
|
|
4930
|
+
to?: string | null;
|
|
4931
|
+
/**
|
|
4932
|
+
* @description Recipient contact's Business-Scoped User ID. Present when the contact has been enriched with a BSUID from a Meta webhook (or from a BSUID-first send). NULL for phone-only contacts.
|
|
4933
|
+
* @example US.13491208655302741918
|
|
4934
|
+
*/
|
|
4935
|
+
bsuid?: string | null;
|
|
4936
|
+
/**
|
|
4937
|
+
* @description Parent BSUID for managed businesses with linked business portfolios. NULL for regular accounts.
|
|
4938
|
+
* @example US.ENT.11815799212886844830
|
|
4939
|
+
*/
|
|
4940
|
+
parent_bsuid?: string | null;
|
|
4941
|
+
/**
|
|
4942
|
+
* @description Recipient contact's WhatsApp username (case-insensitive comparison; case-preserving in storage). NULL when the contact has not adopted the WhatsApp username feature.
|
|
4943
|
+
* @example pablomorales
|
|
4944
|
+
*/
|
|
4945
|
+
username?: string | null;
|
|
4807
4946
|
type?: string;
|
|
4808
4947
|
/** @enum {string} */
|
|
4809
4948
|
status: "queued" | "pending" | "sent" | "delivered" | "read" | "failed";
|
|
@@ -4874,6 +5013,13 @@ export interface components {
|
|
|
4874
5013
|
url: string;
|
|
4875
5014
|
description: string | null;
|
|
4876
5015
|
events: string[];
|
|
5016
|
+
/**
|
|
5017
|
+
* @description Optional whitelist of Meta `business_phone_number_id` values. When `null` (default), the subscription fires for events from every WhatsApp account in the organization. When an array, only for events originating from these accounts. Org-level events (e.g. `customer.*`) IGNORE this filter and always fire.
|
|
5018
|
+
* @example [
|
|
5019
|
+
* "1234567890"
|
|
5020
|
+
* ]
|
|
5021
|
+
*/
|
|
5022
|
+
phone_number_ids: string[] | null;
|
|
4877
5023
|
/** @enum {string} */
|
|
4878
5024
|
status: "active" | "paused" | "disabled";
|
|
4879
5025
|
disabled_reason: string | null;
|
|
@@ -4948,7 +5094,26 @@ export interface components {
|
|
|
4948
5094
|
id: string;
|
|
4949
5095
|
/** @enum {string} */
|
|
4950
5096
|
object: "contact";
|
|
5097
|
+
/**
|
|
5098
|
+
* @description Phone number in E.164. NULL when the contact was created via BSUID (username-adopted user with no shared phone number). See docs/meta-docs/bsuid.md.
|
|
5099
|
+
* @example +628123456789
|
|
5100
|
+
*/
|
|
4951
5101
|
phone_number: string | null;
|
|
5102
|
+
/**
|
|
5103
|
+
* @description Business-Scoped User ID. Populated by inbound webhooks or when the contact was created via BSUID. Format: `{ISO alpha-2 country}.{alphanumeric ≤128}`.
|
|
5104
|
+
* @example US.13491208655302741918
|
|
5105
|
+
*/
|
|
5106
|
+
bsuid: string | null;
|
|
5107
|
+
/**
|
|
5108
|
+
* @description Parent BSUID (managed businesses only). Format: `{ISO alpha-2 country}.ENT.{alphanumeric ≤128}`.
|
|
5109
|
+
* @example US.ENT.11815799212886844830
|
|
5110
|
+
*/
|
|
5111
|
+
parent_bsuid: string | null;
|
|
5112
|
+
/**
|
|
5113
|
+
* @description WhatsApp username of the contact, if the user has adopted the username feature. Case-insensitive when comparing per Meta rules; `.` and `_` are significant.
|
|
5114
|
+
* @example pablomorales
|
|
5115
|
+
*/
|
|
5116
|
+
username: string | null;
|
|
4952
5117
|
name: string | null;
|
|
4953
5118
|
email: string | null;
|
|
4954
5119
|
metadata: {
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const SDK_VERSION: "3.
|
|
1
|
+
export declare const SDK_VERSION: "3.11.0";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/generated/version.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,WAAW,EAAG,
|
|
1
|
+
{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/generated/version.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,WAAW,EAAG,QAAiB,CAAA"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/generated/version.ts"],"names":[],"mappings":"AAAA,+DAA+D;AAC/D,8DAA8D;AAC9D,+DAA+D;AAC/D,qBAAqB;AAErB,MAAM,CAAC,MAAM,WAAW,GAAG,
|
|
1
|
+
{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/generated/version.ts"],"names":[],"mappings":"AAAA,+DAA+D;AAC/D,8DAA8D;AAC9D,+DAA+D;AAC/D,qBAAqB;AAErB,MAAM,CAAC,MAAM,WAAW,GAAG,QAAiB,CAAA"}
|