@kirimdev/sdk 3.10.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 +58 -2
- package/dist/generated/version.d.ts +1 -1
- package/dist/generated/version.js +1 -1
- package/dist/generated/version.ts +1 -1
- package/openapi.json +177 -0
- package/package.json +1 -1
|
@@ -545,9 +545,38 @@ export interface paths {
|
|
|
545
545
|
interactive: {
|
|
546
546
|
/** @enum {string} */
|
|
547
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
|
+
};
|
|
548
574
|
body: {
|
|
549
575
|
text: string;
|
|
550
576
|
};
|
|
577
|
+
footer?: {
|
|
578
|
+
text: string;
|
|
579
|
+
};
|
|
551
580
|
action: {
|
|
552
581
|
/** @enum {string} */
|
|
553
582
|
name: "cta_url";
|
|
@@ -1420,7 +1449,8 @@ export interface paths {
|
|
|
1420
1449
|
/** Format: uri */
|
|
1421
1450
|
url: string;
|
|
1422
1451
|
description?: string;
|
|
1423
|
-
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[];
|
|
1424
1454
|
};
|
|
1425
1455
|
};
|
|
1426
1456
|
};
|
|
@@ -1452,6 +1482,15 @@ export interface paths {
|
|
|
1452
1482
|
"application/json": components["schemas"]["ApiErrorEnvelope"];
|
|
1453
1483
|
};
|
|
1454
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
|
+
};
|
|
1455
1494
|
/** @description Rate limit exceeded */
|
|
1456
1495
|
429: {
|
|
1457
1496
|
headers: {
|
|
@@ -1653,9 +1692,10 @@ export interface paths {
|
|
|
1653
1692
|
/** Format: uri */
|
|
1654
1693
|
url?: string;
|
|
1655
1694
|
description?: string | null;
|
|
1656
|
-
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")[];
|
|
1657
1696
|
/** @enum {string} */
|
|
1658
1697
|
status?: "active" | "paused";
|
|
1698
|
+
phone_number_ids?: string[] | null;
|
|
1659
1699
|
};
|
|
1660
1700
|
};
|
|
1661
1701
|
};
|
|
@@ -1696,6 +1736,15 @@ export interface paths {
|
|
|
1696
1736
|
"application/json": components["schemas"]["ApiErrorEnvelope"];
|
|
1697
1737
|
};
|
|
1698
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
|
+
};
|
|
1699
1748
|
/** @description Rate limit exceeded */
|
|
1700
1749
|
429: {
|
|
1701
1750
|
headers: {
|
|
@@ -4964,6 +5013,13 @@ export interface components {
|
|
|
4964
5013
|
url: string;
|
|
4965
5014
|
description: string | null;
|
|
4966
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;
|
|
4967
5023
|
/** @enum {string} */
|
|
4968
5024
|
status: "active" | "paused" | "disabled";
|
|
4969
5025
|
disabled_reason: string | null;
|
|
@@ -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
|
package/openapi.json
CHANGED
|
@@ -413,6 +413,19 @@
|
|
|
413
413
|
"type": "string"
|
|
414
414
|
}
|
|
415
415
|
},
|
|
416
|
+
"phone_number_ids": {
|
|
417
|
+
"type": [
|
|
418
|
+
"array",
|
|
419
|
+
"null"
|
|
420
|
+
],
|
|
421
|
+
"items": {
|
|
422
|
+
"type": "string"
|
|
423
|
+
},
|
|
424
|
+
"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.",
|
|
425
|
+
"example": [
|
|
426
|
+
"1234567890"
|
|
427
|
+
]
|
|
428
|
+
},
|
|
416
429
|
"status": {
|
|
417
430
|
"type": "string",
|
|
418
431
|
"enum": [
|
|
@@ -477,6 +490,7 @@
|
|
|
477
490
|
"url",
|
|
478
491
|
"description",
|
|
479
492
|
"events",
|
|
493
|
+
"phone_number_ids",
|
|
480
494
|
"status",
|
|
481
495
|
"disabled_reason",
|
|
482
496
|
"consecutive_failures",
|
|
@@ -3241,6 +3255,115 @@
|
|
|
3241
3255
|
"cta_url"
|
|
3242
3256
|
]
|
|
3243
3257
|
},
|
|
3258
|
+
"header": {
|
|
3259
|
+
"oneOf": [
|
|
3260
|
+
{
|
|
3261
|
+
"type": "object",
|
|
3262
|
+
"properties": {
|
|
3263
|
+
"type": {
|
|
3264
|
+
"type": "string",
|
|
3265
|
+
"enum": [
|
|
3266
|
+
"text"
|
|
3267
|
+
]
|
|
3268
|
+
},
|
|
3269
|
+
"text": {
|
|
3270
|
+
"type": "string",
|
|
3271
|
+
"minLength": 1,
|
|
3272
|
+
"maxLength": 60
|
|
3273
|
+
}
|
|
3274
|
+
},
|
|
3275
|
+
"required": [
|
|
3276
|
+
"type",
|
|
3277
|
+
"text"
|
|
3278
|
+
],
|
|
3279
|
+
"title": "Text header"
|
|
3280
|
+
},
|
|
3281
|
+
{
|
|
3282
|
+
"type": "object",
|
|
3283
|
+
"properties": {
|
|
3284
|
+
"type": {
|
|
3285
|
+
"type": "string",
|
|
3286
|
+
"enum": [
|
|
3287
|
+
"image"
|
|
3288
|
+
]
|
|
3289
|
+
},
|
|
3290
|
+
"image": {
|
|
3291
|
+
"type": "object",
|
|
3292
|
+
"properties": {
|
|
3293
|
+
"link": {
|
|
3294
|
+
"type": "string",
|
|
3295
|
+
"format": "uri"
|
|
3296
|
+
}
|
|
3297
|
+
},
|
|
3298
|
+
"required": [
|
|
3299
|
+
"link"
|
|
3300
|
+
]
|
|
3301
|
+
}
|
|
3302
|
+
},
|
|
3303
|
+
"required": [
|
|
3304
|
+
"type",
|
|
3305
|
+
"image"
|
|
3306
|
+
],
|
|
3307
|
+
"title": "Image header"
|
|
3308
|
+
},
|
|
3309
|
+
{
|
|
3310
|
+
"type": "object",
|
|
3311
|
+
"properties": {
|
|
3312
|
+
"type": {
|
|
3313
|
+
"type": "string",
|
|
3314
|
+
"enum": [
|
|
3315
|
+
"video"
|
|
3316
|
+
]
|
|
3317
|
+
},
|
|
3318
|
+
"video": {
|
|
3319
|
+
"type": "object",
|
|
3320
|
+
"properties": {
|
|
3321
|
+
"link": {
|
|
3322
|
+
"type": "string",
|
|
3323
|
+
"format": "uri"
|
|
3324
|
+
}
|
|
3325
|
+
},
|
|
3326
|
+
"required": [
|
|
3327
|
+
"link"
|
|
3328
|
+
]
|
|
3329
|
+
}
|
|
3330
|
+
},
|
|
3331
|
+
"required": [
|
|
3332
|
+
"type",
|
|
3333
|
+
"video"
|
|
3334
|
+
],
|
|
3335
|
+
"title": "Video header"
|
|
3336
|
+
},
|
|
3337
|
+
{
|
|
3338
|
+
"type": "object",
|
|
3339
|
+
"properties": {
|
|
3340
|
+
"type": {
|
|
3341
|
+
"type": "string",
|
|
3342
|
+
"enum": [
|
|
3343
|
+
"document"
|
|
3344
|
+
]
|
|
3345
|
+
},
|
|
3346
|
+
"document": {
|
|
3347
|
+
"type": "object",
|
|
3348
|
+
"properties": {
|
|
3349
|
+
"link": {
|
|
3350
|
+
"type": "string",
|
|
3351
|
+
"format": "uri"
|
|
3352
|
+
}
|
|
3353
|
+
},
|
|
3354
|
+
"required": [
|
|
3355
|
+
"link"
|
|
3356
|
+
]
|
|
3357
|
+
}
|
|
3358
|
+
},
|
|
3359
|
+
"required": [
|
|
3360
|
+
"type",
|
|
3361
|
+
"document"
|
|
3362
|
+
],
|
|
3363
|
+
"title": "Document header"
|
|
3364
|
+
}
|
|
3365
|
+
]
|
|
3366
|
+
},
|
|
3244
3367
|
"body": {
|
|
3245
3368
|
"type": "object",
|
|
3246
3369
|
"properties": {
|
|
@@ -3254,6 +3377,19 @@
|
|
|
3254
3377
|
"text"
|
|
3255
3378
|
]
|
|
3256
3379
|
},
|
|
3380
|
+
"footer": {
|
|
3381
|
+
"type": "object",
|
|
3382
|
+
"properties": {
|
|
3383
|
+
"text": {
|
|
3384
|
+
"type": "string",
|
|
3385
|
+
"minLength": 1,
|
|
3386
|
+
"maxLength": 60
|
|
3387
|
+
}
|
|
3388
|
+
},
|
|
3389
|
+
"required": [
|
|
3390
|
+
"text"
|
|
3391
|
+
]
|
|
3392
|
+
},
|
|
3257
3393
|
"action": {
|
|
3258
3394
|
"type": "object",
|
|
3259
3395
|
"properties": {
|
|
@@ -4997,6 +5133,7 @@
|
|
|
4997
5133
|
"conversation.closed",
|
|
4998
5134
|
"contact.created",
|
|
4999
5135
|
"contact.updated",
|
|
5136
|
+
"contact.identity_updated",
|
|
5000
5137
|
"customer.created",
|
|
5001
5138
|
"customer.updated",
|
|
5002
5139
|
"customer.archived",
|
|
@@ -5006,6 +5143,14 @@
|
|
|
5006
5143
|
]
|
|
5007
5144
|
},
|
|
5008
5145
|
"minItems": 1
|
|
5146
|
+
},
|
|
5147
|
+
"phone_number_ids": {
|
|
5148
|
+
"type": "array",
|
|
5149
|
+
"items": {
|
|
5150
|
+
"type": "string",
|
|
5151
|
+
"pattern": "^\\d{6,20}$"
|
|
5152
|
+
},
|
|
5153
|
+
"maxItems": 50
|
|
5009
5154
|
}
|
|
5010
5155
|
},
|
|
5011
5156
|
"required": [
|
|
@@ -5047,6 +5192,16 @@
|
|
|
5047
5192
|
}
|
|
5048
5193
|
}
|
|
5049
5194
|
},
|
|
5195
|
+
"422": {
|
|
5196
|
+
"description": "Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found)",
|
|
5197
|
+
"content": {
|
|
5198
|
+
"application/json": {
|
|
5199
|
+
"schema": {
|
|
5200
|
+
"$ref": "#/components/schemas/ApiErrorEnvelope"
|
|
5201
|
+
}
|
|
5202
|
+
}
|
|
5203
|
+
}
|
|
5204
|
+
},
|
|
5050
5205
|
"429": {
|
|
5051
5206
|
"description": "Rate limit exceeded",
|
|
5052
5207
|
"content": {
|
|
@@ -5312,6 +5467,7 @@
|
|
|
5312
5467
|
"conversation.closed",
|
|
5313
5468
|
"contact.created",
|
|
5314
5469
|
"contact.updated",
|
|
5470
|
+
"contact.identity_updated",
|
|
5315
5471
|
"customer.created",
|
|
5316
5472
|
"customer.updated",
|
|
5317
5473
|
"customer.archived",
|
|
@@ -5328,6 +5484,17 @@
|
|
|
5328
5484
|
"active",
|
|
5329
5485
|
"paused"
|
|
5330
5486
|
]
|
|
5487
|
+
},
|
|
5488
|
+
"phone_number_ids": {
|
|
5489
|
+
"type": [
|
|
5490
|
+
"array",
|
|
5491
|
+
"null"
|
|
5492
|
+
],
|
|
5493
|
+
"items": {
|
|
5494
|
+
"type": "string",
|
|
5495
|
+
"pattern": "^\\d{6,20}$"
|
|
5496
|
+
},
|
|
5497
|
+
"maxItems": 50
|
|
5331
5498
|
}
|
|
5332
5499
|
}
|
|
5333
5500
|
}
|
|
@@ -5375,6 +5542,16 @@
|
|
|
5375
5542
|
}
|
|
5376
5543
|
}
|
|
5377
5544
|
},
|
|
5545
|
+
"422": {
|
|
5546
|
+
"description": "Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found)",
|
|
5547
|
+
"content": {
|
|
5548
|
+
"application/json": {
|
|
5549
|
+
"schema": {
|
|
5550
|
+
"$ref": "#/components/schemas/ApiErrorEnvelope"
|
|
5551
|
+
}
|
|
5552
|
+
}
|
|
5553
|
+
}
|
|
5554
|
+
},
|
|
5378
5555
|
"429": {
|
|
5379
5556
|
"description": "Rate limit exceeded",
|
|
5380
5557
|
"content": {
|