@kirimdev/sdk 3.0.0 → 3.0.2
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 +98 -97
- package/dist/client.js +1 -1
- package/dist/client.js.map +1 -1
- package/dist/generated/schema.d.ts +4010 -0
- package/openapi.json +68 -47
- package/package.json +5 -5
package/openapi.json
CHANGED
|
@@ -3,15 +3,15 @@
|
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "Kirim Public API",
|
|
5
5
|
"version": "1.0.0",
|
|
6
|
-
"description": "Self-service REST API for sending WhatsApp messages, subscribing to events, and managing your inbox programmatically. See docs.
|
|
6
|
+
"description": "Self-service REST API for sending WhatsApp messages, subscribing to events, and managing your inbox programmatically. See docs.kirimdev.com for guides and reference.",
|
|
7
7
|
"contact": {
|
|
8
|
-
"name": "
|
|
9
|
-
"url": "https://
|
|
8
|
+
"name": "Kirimdev Support",
|
|
9
|
+
"url": "https://kirimdev.com"
|
|
10
10
|
}
|
|
11
11
|
},
|
|
12
12
|
"servers": [
|
|
13
13
|
{
|
|
14
|
-
"url": "https://api.
|
|
14
|
+
"url": "https://api.kirimdev.com/v1",
|
|
15
15
|
"description": "Production"
|
|
16
16
|
}
|
|
17
17
|
],
|
|
@@ -263,8 +263,8 @@
|
|
|
263
263
|
"string",
|
|
264
264
|
"null"
|
|
265
265
|
],
|
|
266
|
-
"
|
|
267
|
-
"
|
|
266
|
+
"example": "106540352242922",
|
|
267
|
+
"description": "Meta WhatsApp Business `phone_number_id`. Use as the `{phone_number_id}` path parameter in `/v1/{phone_number_id}/...` endpoints. Nullable while onboarding is in flight."
|
|
268
268
|
},
|
|
269
269
|
"phone_number": {
|
|
270
270
|
"type": [
|
|
@@ -282,8 +282,8 @@
|
|
|
282
282
|
},
|
|
283
283
|
"status": {
|
|
284
284
|
"type": "string",
|
|
285
|
-
"
|
|
286
|
-
"
|
|
285
|
+
"example": "connected",
|
|
286
|
+
"description": "Lifecycle state of the account (e.g. `connected`, `disconnected`, `degraded`, `onboarding`)."
|
|
287
287
|
}
|
|
288
288
|
},
|
|
289
289
|
"required": [
|
|
@@ -2012,10 +2012,11 @@
|
|
|
2012
2012
|
"schema": {
|
|
2013
2013
|
"type": "string",
|
|
2014
2014
|
"pattern": "^\\d{6,20}$",
|
|
2015
|
-
"
|
|
2016
|
-
"
|
|
2015
|
+
"example": "106540352242922",
|
|
2016
|
+
"description": "Meta WhatsApp Business `phone_number_id` of the connected account that should send / own this resource. Discoverable via `GET /v1/accounts` (returned as `phone_number_id` on each row)."
|
|
2017
2017
|
},
|
|
2018
2018
|
"required": true,
|
|
2019
|
+
"description": "Meta WhatsApp Business `phone_number_id` of the connected account that should send / own this resource. Discoverable via `GET /v1/accounts` (returned as `phone_number_id` on each row).",
|
|
2019
2020
|
"name": "phone_number_id",
|
|
2020
2021
|
"in": "path"
|
|
2021
2022
|
},
|
|
@@ -2025,6 +2026,7 @@
|
|
|
2025
2026
|
"description": "Optional idempotency token. See /docs/idempotency."
|
|
2026
2027
|
},
|
|
2027
2028
|
"required": false,
|
|
2029
|
+
"description": "Optional idempotency token. See /docs/idempotency.",
|
|
2028
2030
|
"name": "idempotency-key",
|
|
2029
2031
|
"in": "header"
|
|
2030
2032
|
}
|
|
@@ -2397,7 +2399,8 @@
|
|
|
2397
2399
|
},
|
|
2398
2400
|
"required": [
|
|
2399
2401
|
"type"
|
|
2400
|
-
]
|
|
2402
|
+
],
|
|
2403
|
+
"additionalProperties": {}
|
|
2401
2404
|
}
|
|
2402
2405
|
}
|
|
2403
2406
|
},
|
|
@@ -3002,10 +3005,11 @@
|
|
|
3002
3005
|
"schema": {
|
|
3003
3006
|
"type": "string",
|
|
3004
3007
|
"pattern": "^\\d{6,20}$",
|
|
3005
|
-
"
|
|
3006
|
-
"
|
|
3008
|
+
"example": "106540352242922",
|
|
3009
|
+
"description": "Meta WhatsApp Business `phone_number_id` of the connected account that should send / own this resource. Discoverable via `GET /v1/accounts` (returned as `phone_number_id` on each row)."
|
|
3007
3010
|
},
|
|
3008
3011
|
"required": true,
|
|
3012
|
+
"description": "Meta WhatsApp Business `phone_number_id` of the connected account that should send / own this resource. Discoverable via `GET /v1/accounts` (returned as `phone_number_id` on each row).",
|
|
3009
3013
|
"name": "phone_number_id",
|
|
3010
3014
|
"in": "path"
|
|
3011
3015
|
},
|
|
@@ -3171,10 +3175,11 @@
|
|
|
3171
3175
|
"schema": {
|
|
3172
3176
|
"type": "string",
|
|
3173
3177
|
"pattern": "^\\d{6,20}$",
|
|
3174
|
-
"
|
|
3175
|
-
"
|
|
3178
|
+
"example": "106540352242922",
|
|
3179
|
+
"description": "Meta WhatsApp Business `phone_number_id` of the connected account that should send / own this resource. Discoverable via `GET /v1/accounts` (returned as `phone_number_id` on each row)."
|
|
3176
3180
|
},
|
|
3177
3181
|
"required": true,
|
|
3182
|
+
"description": "Meta WhatsApp Business `phone_number_id` of the connected account that should send / own this resource. Discoverable via `GET /v1/accounts` (returned as `phone_number_id` on each row).",
|
|
3178
3183
|
"name": "phone_number_id",
|
|
3179
3184
|
"in": "path"
|
|
3180
3185
|
},
|
|
@@ -3279,10 +3284,11 @@
|
|
|
3279
3284
|
"schema": {
|
|
3280
3285
|
"type": "string",
|
|
3281
3286
|
"pattern": "^\\d{6,20}$",
|
|
3282
|
-
"
|
|
3283
|
-
"
|
|
3287
|
+
"example": "106540352242922",
|
|
3288
|
+
"description": "Meta WhatsApp Business `phone_number_id` of the connected account that should send / own this resource. Discoverable via `GET /v1/accounts` (returned as `phone_number_id` on each row)."
|
|
3284
3289
|
},
|
|
3285
3290
|
"required": true,
|
|
3291
|
+
"description": "Meta WhatsApp Business `phone_number_id` of the connected account that should send / own this resource. Discoverable via `GET /v1/accounts` (returned as `phone_number_id` on each row).",
|
|
3286
3292
|
"name": "phone_number_id",
|
|
3287
3293
|
"in": "path"
|
|
3288
3294
|
},
|
|
@@ -3419,10 +3425,11 @@
|
|
|
3419
3425
|
"schema": {
|
|
3420
3426
|
"type": "string",
|
|
3421
3427
|
"pattern": "^\\d{6,20}$",
|
|
3422
|
-
"
|
|
3423
|
-
"
|
|
3428
|
+
"example": "106540352242922",
|
|
3429
|
+
"description": "Meta WhatsApp Business `phone_number_id` of the connected account that should send / own this resource. Discoverable via `GET /v1/accounts` (returned as `phone_number_id` on each row)."
|
|
3424
3430
|
},
|
|
3425
3431
|
"required": true,
|
|
3432
|
+
"description": "Meta WhatsApp Business `phone_number_id` of the connected account that should send / own this resource. Discoverable via `GET /v1/accounts` (returned as `phone_number_id` on each row).",
|
|
3426
3433
|
"name": "phone_number_id",
|
|
3427
3434
|
"in": "path"
|
|
3428
3435
|
},
|
|
@@ -4718,10 +4725,11 @@
|
|
|
4718
4725
|
"schema": {
|
|
4719
4726
|
"type": "string",
|
|
4720
4727
|
"pattern": "^\\d{6,20}$",
|
|
4721
|
-
"
|
|
4722
|
-
"
|
|
4728
|
+
"example": "106540352242922",
|
|
4729
|
+
"description": "Meta WhatsApp Business `phone_number_id` of the connected account that should send / own this resource. Discoverable via `GET /v1/accounts` (returned as `phone_number_id` on each row)."
|
|
4723
4730
|
},
|
|
4724
4731
|
"required": true,
|
|
4732
|
+
"description": "Meta WhatsApp Business `phone_number_id` of the connected account that should send / own this resource. Discoverable via `GET /v1/accounts` (returned as `phone_number_id` on each row).",
|
|
4725
4733
|
"name": "phone_number_id",
|
|
4726
4734
|
"in": "path"
|
|
4727
4735
|
},
|
|
@@ -4855,10 +4863,11 @@
|
|
|
4855
4863
|
"schema": {
|
|
4856
4864
|
"type": "string",
|
|
4857
4865
|
"pattern": "^\\d{6,20}$",
|
|
4858
|
-
"
|
|
4859
|
-
"
|
|
4866
|
+
"example": "106540352242922",
|
|
4867
|
+
"description": "Meta WhatsApp Business `phone_number_id` of the connected account that should send / own this resource. Discoverable via `GET /v1/accounts` (returned as `phone_number_id` on each row)."
|
|
4860
4868
|
},
|
|
4861
4869
|
"required": true,
|
|
4870
|
+
"description": "Meta WhatsApp Business `phone_number_id` of the connected account that should send / own this resource. Discoverable via `GET /v1/accounts` (returned as `phone_number_id` on each row).",
|
|
4862
4871
|
"name": "phone_number_id",
|
|
4863
4872
|
"in": "path"
|
|
4864
4873
|
},
|
|
@@ -4961,10 +4970,11 @@
|
|
|
4961
4970
|
"schema": {
|
|
4962
4971
|
"type": "string",
|
|
4963
4972
|
"pattern": "^\\d{6,20}$",
|
|
4964
|
-
"
|
|
4965
|
-
"
|
|
4973
|
+
"example": "106540352242922",
|
|
4974
|
+
"description": "Meta WhatsApp Business `phone_number_id` of the connected account that should send / own this resource. Discoverable via `GET /v1/accounts` (returned as `phone_number_id` on each row)."
|
|
4966
4975
|
},
|
|
4967
4976
|
"required": true,
|
|
4977
|
+
"description": "Meta WhatsApp Business `phone_number_id` of the connected account that should send / own this resource. Discoverable via `GET /v1/accounts` (returned as `phone_number_id` on each row).",
|
|
4968
4978
|
"name": "phone_number_id",
|
|
4969
4979
|
"in": "path"
|
|
4970
4980
|
},
|
|
@@ -5096,10 +5106,11 @@
|
|
|
5096
5106
|
"schema": {
|
|
5097
5107
|
"type": "string",
|
|
5098
5108
|
"pattern": "^\\d{6,20}$",
|
|
5099
|
-
"
|
|
5100
|
-
"
|
|
5109
|
+
"example": "106540352242922",
|
|
5110
|
+
"description": "Meta WhatsApp Business `phone_number_id` of the connected account that should send / own this resource. Discoverable via `GET /v1/accounts` (returned as `phone_number_id` on each row)."
|
|
5101
5111
|
},
|
|
5102
5112
|
"required": true,
|
|
5113
|
+
"description": "Meta WhatsApp Business `phone_number_id` of the connected account that should send / own this resource. Discoverable via `GET /v1/accounts` (returned as `phone_number_id` on each row).",
|
|
5103
5114
|
"name": "phone_number_id",
|
|
5104
5115
|
"in": "path"
|
|
5105
5116
|
},
|
|
@@ -5228,10 +5239,11 @@
|
|
|
5228
5239
|
"schema": {
|
|
5229
5240
|
"type": "string",
|
|
5230
5241
|
"pattern": "^\\d{6,20}$",
|
|
5231
|
-
"
|
|
5232
|
-
"
|
|
5242
|
+
"example": "106540352242922",
|
|
5243
|
+
"description": "Meta WhatsApp Business `phone_number_id` of the connected account that should send / own this resource. Discoverable via `GET /v1/accounts` (returned as `phone_number_id` on each row)."
|
|
5233
5244
|
},
|
|
5234
5245
|
"required": true,
|
|
5246
|
+
"description": "Meta WhatsApp Business `phone_number_id` of the connected account that should send / own this resource. Discoverable via `GET /v1/accounts` (returned as `phone_number_id` on each row).",
|
|
5235
5247
|
"name": "phone_number_id",
|
|
5236
5248
|
"in": "path"
|
|
5237
5249
|
}
|
|
@@ -5360,10 +5372,11 @@
|
|
|
5360
5372
|
"schema": {
|
|
5361
5373
|
"type": "string",
|
|
5362
5374
|
"pattern": "^\\d{6,20}$",
|
|
5363
|
-
"
|
|
5364
|
-
"
|
|
5375
|
+
"example": "106540352242922",
|
|
5376
|
+
"description": "Meta WhatsApp Business `phone_number_id` of the connected account that should send / own this resource. Discoverable via `GET /v1/accounts` (returned as `phone_number_id` on each row)."
|
|
5365
5377
|
},
|
|
5366
5378
|
"required": true,
|
|
5379
|
+
"description": "Meta WhatsApp Business `phone_number_id` of the connected account that should send / own this resource. Discoverable via `GET /v1/accounts` (returned as `phone_number_id` on each row).",
|
|
5367
5380
|
"name": "phone_number_id",
|
|
5368
5381
|
"in": "path"
|
|
5369
5382
|
},
|
|
@@ -5466,10 +5479,11 @@
|
|
|
5466
5479
|
"schema": {
|
|
5467
5480
|
"type": "string",
|
|
5468
5481
|
"pattern": "^\\d{6,20}$",
|
|
5469
|
-
"
|
|
5470
|
-
"
|
|
5482
|
+
"example": "106540352242922",
|
|
5483
|
+
"description": "Meta WhatsApp Business `phone_number_id` of the connected account that should send / own this resource. Discoverable via `GET /v1/accounts` (returned as `phone_number_id` on each row)."
|
|
5471
5484
|
},
|
|
5472
5485
|
"required": true,
|
|
5486
|
+
"description": "Meta WhatsApp Business `phone_number_id` of the connected account that should send / own this resource. Discoverable via `GET /v1/accounts` (returned as `phone_number_id` on each row).",
|
|
5473
5487
|
"name": "phone_number_id",
|
|
5474
5488
|
"in": "path"
|
|
5475
5489
|
},
|
|
@@ -5616,10 +5630,11 @@
|
|
|
5616
5630
|
"schema": {
|
|
5617
5631
|
"type": "string",
|
|
5618
5632
|
"pattern": "^\\d{6,20}$",
|
|
5619
|
-
"
|
|
5620
|
-
"
|
|
5633
|
+
"example": "106540352242922",
|
|
5634
|
+
"description": "Meta WhatsApp Business `phone_number_id` of the connected account that should send / own this resource. Discoverable via `GET /v1/accounts` (returned as `phone_number_id` on each row)."
|
|
5621
5635
|
},
|
|
5622
5636
|
"required": true,
|
|
5637
|
+
"description": "Meta WhatsApp Business `phone_number_id` of the connected account that should send / own this resource. Discoverable via `GET /v1/accounts` (returned as `phone_number_id` on each row).",
|
|
5623
5638
|
"name": "phone_number_id",
|
|
5624
5639
|
"in": "path"
|
|
5625
5640
|
},
|
|
@@ -5724,10 +5739,11 @@
|
|
|
5724
5739
|
"schema": {
|
|
5725
5740
|
"type": "string",
|
|
5726
5741
|
"pattern": "^\\d{6,20}$",
|
|
5727
|
-
"
|
|
5728
|
-
"
|
|
5742
|
+
"example": "106540352242922",
|
|
5743
|
+
"description": "Meta WhatsApp Business `phone_number_id` of the connected account that should send / own this resource. Discoverable via `GET /v1/accounts` (returned as `phone_number_id` on each row)."
|
|
5729
5744
|
},
|
|
5730
5745
|
"required": true,
|
|
5746
|
+
"description": "Meta WhatsApp Business `phone_number_id` of the connected account that should send / own this resource. Discoverable via `GET /v1/accounts` (returned as `phone_number_id` on each row).",
|
|
5731
5747
|
"name": "phone_number_id",
|
|
5732
5748
|
"in": "path"
|
|
5733
5749
|
},
|
|
@@ -5833,10 +5849,11 @@
|
|
|
5833
5849
|
"schema": {
|
|
5834
5850
|
"type": "string",
|
|
5835
5851
|
"pattern": "^\\d{6,20}$",
|
|
5836
|
-
"
|
|
5837
|
-
"
|
|
5852
|
+
"example": "106540352242922",
|
|
5853
|
+
"description": "Meta WhatsApp Business `phone_number_id` of the connected account that should send / own this resource. Discoverable via `GET /v1/accounts` (returned as `phone_number_id` on each row)."
|
|
5838
5854
|
},
|
|
5839
5855
|
"required": true,
|
|
5856
|
+
"description": "Meta WhatsApp Business `phone_number_id` of the connected account that should send / own this resource. Discoverable via `GET /v1/accounts` (returned as `phone_number_id` on each row).",
|
|
5840
5857
|
"name": "phone_number_id",
|
|
5841
5858
|
"in": "path"
|
|
5842
5859
|
},
|
|
@@ -5958,10 +5975,11 @@
|
|
|
5958
5975
|
"schema": {
|
|
5959
5976
|
"type": "string",
|
|
5960
5977
|
"pattern": "^\\d{6,20}$",
|
|
5961
|
-
"
|
|
5962
|
-
"
|
|
5978
|
+
"example": "106540352242922",
|
|
5979
|
+
"description": "Meta WhatsApp Business `phone_number_id` of the connected account that should send / own this resource. Discoverable via `GET /v1/accounts` (returned as `phone_number_id` on each row)."
|
|
5963
5980
|
},
|
|
5964
5981
|
"required": true,
|
|
5982
|
+
"description": "Meta WhatsApp Business `phone_number_id` of the connected account that should send / own this resource. Discoverable via `GET /v1/accounts` (returned as `phone_number_id` on each row).",
|
|
5965
5983
|
"name": "phone_number_id",
|
|
5966
5984
|
"in": "path"
|
|
5967
5985
|
},
|
|
@@ -6075,10 +6093,11 @@
|
|
|
6075
6093
|
"schema": {
|
|
6076
6094
|
"type": "string",
|
|
6077
6095
|
"pattern": "^\\d{6,20}$",
|
|
6078
|
-
"
|
|
6079
|
-
"
|
|
6096
|
+
"example": "106540352242922",
|
|
6097
|
+
"description": "Meta WhatsApp Business `phone_number_id` of the connected account that should send / own this resource. Discoverable via `GET /v1/accounts` (returned as `phone_number_id` on each row)."
|
|
6080
6098
|
},
|
|
6081
6099
|
"required": true,
|
|
6100
|
+
"description": "Meta WhatsApp Business `phone_number_id` of the connected account that should send / own this resource. Discoverable via `GET /v1/accounts` (returned as `phone_number_id` on each row).",
|
|
6082
6101
|
"name": "phone_number_id",
|
|
6083
6102
|
"in": "path"
|
|
6084
6103
|
}
|
|
@@ -6209,10 +6228,11 @@
|
|
|
6209
6228
|
"schema": {
|
|
6210
6229
|
"type": "string",
|
|
6211
6230
|
"pattern": "^\\d{6,20}$",
|
|
6212
|
-
"
|
|
6213
|
-
"
|
|
6231
|
+
"example": "106540352242922",
|
|
6232
|
+
"description": "Meta WhatsApp Business `phone_number_id` of the connected account that should send / own this resource. Discoverable via `GET /v1/accounts` (returned as `phone_number_id` on each row)."
|
|
6214
6233
|
},
|
|
6215
6234
|
"required": true,
|
|
6235
|
+
"description": "Meta WhatsApp Business `phone_number_id` of the connected account that should send / own this resource. Discoverable via `GET /v1/accounts` (returned as `phone_number_id` on each row).",
|
|
6216
6236
|
"name": "phone_number_id",
|
|
6217
6237
|
"in": "path"
|
|
6218
6238
|
},
|
|
@@ -6334,10 +6354,11 @@
|
|
|
6334
6354
|
"schema": {
|
|
6335
6355
|
"type": "string",
|
|
6336
6356
|
"pattern": "^\\d{6,20}$",
|
|
6337
|
-
"
|
|
6338
|
-
"
|
|
6357
|
+
"example": "106540352242922",
|
|
6358
|
+
"description": "Meta WhatsApp Business `phone_number_id` of the connected account that should send / own this resource. Discoverable via `GET /v1/accounts` (returned as `phone_number_id` on each row)."
|
|
6339
6359
|
},
|
|
6340
6360
|
"required": true,
|
|
6361
|
+
"description": "Meta WhatsApp Business `phone_number_id` of the connected account that should send / own this resource. Discoverable via `GET /v1/accounts` (returned as `phone_number_id` on each row).",
|
|
6341
6362
|
"name": "phone_number_id",
|
|
6342
6363
|
"in": "path"
|
|
6343
6364
|
},
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kirimdev/sdk",
|
|
3
|
-
"version": "3.0.
|
|
4
|
-
"description": "Official TypeScript SDK for the
|
|
3
|
+
"version": "3.0.2",
|
|
4
|
+
"description": "Official TypeScript SDK for the Kirimdev Public API.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"publishConfig": {
|
|
@@ -40,7 +40,7 @@
|
|
|
40
40
|
},
|
|
41
41
|
"scripts": {
|
|
42
42
|
"prebuild": "bun scripts/ensure-types.ts",
|
|
43
|
-
"build": "tsc -p tsconfig.build.json",
|
|
43
|
+
"build": "tsc -p tsconfig.build.json && bun scripts/copy-generated.ts",
|
|
44
44
|
"pretypecheck": "bun scripts/ensure-types.ts",
|
|
45
45
|
"typecheck": "tsc --noEmit",
|
|
46
46
|
"pretest": "bun scripts/ensure-types.ts",
|
|
@@ -49,13 +49,13 @@
|
|
|
49
49
|
"sync": "bun scripts/sync-openapi.ts && bun scripts/generate-types.ts",
|
|
50
50
|
"generate-types": "bun scripts/generate-types.ts",
|
|
51
51
|
"check:drift": "bun scripts/check-drift.ts",
|
|
52
|
-
"prepublishOnly": "bun run typecheck && bun run test && bun run build"
|
|
52
|
+
"prepublishOnly": "bun run typecheck && bun run test && bun run build && bun scripts/verify-dist.ts"
|
|
53
53
|
},
|
|
54
54
|
"dependencies": {
|
|
55
55
|
"openapi-fetch": "^0.13.0"
|
|
56
56
|
},
|
|
57
57
|
"devDependencies": {
|
|
58
|
-
"@
|
|
58
|
+
"@kirimdev/tsconfig": "workspace:*",
|
|
59
59
|
"@types/bun": "latest",
|
|
60
60
|
"openapi-typescript": "^7.4.0",
|
|
61
61
|
"typescript": "^5.8.0"
|