@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.
Files changed (8) hide show
  1. package/dist/generated/schema.d.ts +209 -44
  2. package/dist/generated/version.d.ts +1 -1
  3. package/dist/generated/version.d.ts.map +1 -1
  4. package/dist/generated/version.js +1 -1
  5. package/dist/generated/version.js.map +1 -1
  6. package/dist/generated/version.ts +1 -1
  7. package/openapi.json +377 -51
  8. package/package.json +1 -1
package/openapi.json CHANGED
@@ -75,6 +75,15 @@
75
75
  "properties": {
76
76
  "type": {
77
77
  "type": "string",
78
+ "enum": [
79
+ "invalid_request_error",
80
+ "authentication_error",
81
+ "permission_error",
82
+ "not_found",
83
+ "conflict",
84
+ "rate_limit_error",
85
+ "api_error"
86
+ ],
78
87
  "example": "invalid_request_error"
79
88
  },
80
89
  "code": {
@@ -162,7 +171,36 @@
162
171
  ]
163
172
  },
164
173
  "to": {
165
- "type": "string"
174
+ "type": [
175
+ "string",
176
+ "null"
177
+ ],
178
+ "example": "+628123456789",
179
+ "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."
180
+ },
181
+ "bsuid": {
182
+ "type": [
183
+ "string",
184
+ "null"
185
+ ],
186
+ "example": "US.13491208655302741918",
187
+ "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."
188
+ },
189
+ "parent_bsuid": {
190
+ "type": [
191
+ "string",
192
+ "null"
193
+ ],
194
+ "example": "US.ENT.11815799212886844830",
195
+ "description": "Parent BSUID for managed businesses with linked business portfolios. NULL for regular accounts."
196
+ },
197
+ "username": {
198
+ "type": [
199
+ "string",
200
+ "null"
201
+ ],
202
+ "example": "pablomorales",
203
+ "description": "Recipient contact's WhatsApp username (case-insensitive comparison; case-preserving in storage). NULL when the contact has not adopted the WhatsApp username feature."
166
204
  },
167
205
  "type": {
168
206
  "type": "string"
@@ -375,6 +413,19 @@
375
413
  "type": "string"
376
414
  }
377
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
+ },
378
429
  "status": {
379
430
  "type": "string",
380
431
  "enum": [
@@ -439,6 +490,7 @@
439
490
  "url",
440
491
  "description",
441
492
  "events",
493
+ "phone_number_ids",
442
494
  "status",
443
495
  "disabled_reason",
444
496
  "consecutive_failures",
@@ -678,7 +730,33 @@
678
730
  "type": [
679
731
  "string",
680
732
  "null"
681
- ]
733
+ ],
734
+ "example": "+628123456789",
735
+ "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."
736
+ },
737
+ "bsuid": {
738
+ "type": [
739
+ "string",
740
+ "null"
741
+ ],
742
+ "example": "US.13491208655302741918",
743
+ "description": "Business-Scoped User ID. Populated by inbound webhooks or when the contact was created via BSUID. Format: `{ISO alpha-2 country}.{alphanumeric ≤128}`."
744
+ },
745
+ "parent_bsuid": {
746
+ "type": [
747
+ "string",
748
+ "null"
749
+ ],
750
+ "example": "US.ENT.11815799212886844830",
751
+ "description": "Parent BSUID (managed businesses only). Format: `{ISO alpha-2 country}.ENT.{alphanumeric ≤128}`."
752
+ },
753
+ "username": {
754
+ "type": [
755
+ "string",
756
+ "null"
757
+ ],
758
+ "example": "pablomorales",
759
+ "description": "WhatsApp username of the contact, if the user has adopted the username feature. Case-insensitive when comparing per Meta rules; `.` and `_` are significant."
682
760
  },
683
761
  "name": {
684
762
  "type": [
@@ -715,6 +793,9 @@
715
793
  "id",
716
794
  "object",
717
795
  "phone_number",
796
+ "bsuid",
797
+ "parent_bsuid",
798
+ "username",
718
799
  "name",
719
800
  "email",
720
801
  "metadata",
@@ -2615,7 +2696,15 @@
2615
2696
  ]
2616
2697
  },
2617
2698
  "to": {
2618
- "type": "string"
2699
+ "type": "string",
2700
+ "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).",
2701
+ "example": "628123456789"
2702
+ },
2703
+ "recipient": {
2704
+ "type": "string",
2705
+ "pattern": "^[A-Z]{2}\\.(ENT\\.)?[A-Za-z0-9]{1,128}$",
2706
+ "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.",
2707
+ "example": "US.13491208655302741918"
2619
2708
  },
2620
2709
  "context": {
2621
2710
  "type": "object",
@@ -2657,7 +2746,6 @@
2657
2746
  },
2658
2747
  "required": [
2659
2748
  "messaging_product",
2660
- "to",
2661
2749
  "type",
2662
2750
  "text"
2663
2751
  ],
@@ -2679,7 +2767,15 @@
2679
2767
  ]
2680
2768
  },
2681
2769
  "to": {
2682
- "type": "string"
2770
+ "type": "string",
2771
+ "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).",
2772
+ "example": "628123456789"
2773
+ },
2774
+ "recipient": {
2775
+ "type": "string",
2776
+ "pattern": "^[A-Z]{2}\\.(ENT\\.)?[A-Za-z0-9]{1,128}$",
2777
+ "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.",
2778
+ "example": "US.13491208655302741918"
2683
2779
  },
2684
2780
  "context": {
2685
2781
  "type": "object",
@@ -2727,7 +2823,6 @@
2727
2823
  },
2728
2824
  "required": [
2729
2825
  "messaging_product",
2730
- "to",
2731
2826
  "type",
2732
2827
  "image"
2733
2828
  ],
@@ -2749,7 +2844,15 @@
2749
2844
  ]
2750
2845
  },
2751
2846
  "to": {
2752
- "type": "string"
2847
+ "type": "string",
2848
+ "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).",
2849
+ "example": "628123456789"
2850
+ },
2851
+ "recipient": {
2852
+ "type": "string",
2853
+ "pattern": "^[A-Z]{2}\\.(ENT\\.)?[A-Za-z0-9]{1,128}$",
2854
+ "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.",
2855
+ "example": "US.13491208655302741918"
2753
2856
  },
2754
2857
  "context": {
2755
2858
  "type": "object",
@@ -2797,7 +2900,6 @@
2797
2900
  },
2798
2901
  "required": [
2799
2902
  "messaging_product",
2800
- "to",
2801
2903
  "type",
2802
2904
  "document"
2803
2905
  ],
@@ -2819,7 +2921,15 @@
2819
2921
  ]
2820
2922
  },
2821
2923
  "to": {
2822
- "type": "string"
2924
+ "type": "string",
2925
+ "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).",
2926
+ "example": "628123456789"
2927
+ },
2928
+ "recipient": {
2929
+ "type": "string",
2930
+ "pattern": "^[A-Z]{2}\\.(ENT\\.)?[A-Za-z0-9]{1,128}$",
2931
+ "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.",
2932
+ "example": "US.13491208655302741918"
2823
2933
  },
2824
2934
  "context": {
2825
2935
  "type": "object",
@@ -2867,7 +2977,6 @@
2867
2977
  },
2868
2978
  "required": [
2869
2979
  "messaging_product",
2870
- "to",
2871
2980
  "type",
2872
2981
  "video"
2873
2982
  ],
@@ -2889,7 +2998,15 @@
2889
2998
  ]
2890
2999
  },
2891
3000
  "to": {
2892
- "type": "string"
3001
+ "type": "string",
3002
+ "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).",
3003
+ "example": "628123456789"
3004
+ },
3005
+ "recipient": {
3006
+ "type": "string",
3007
+ "pattern": "^[A-Z]{2}\\.(ENT\\.)?[A-Za-z0-9]{1,128}$",
3008
+ "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.",
3009
+ "example": "US.13491208655302741918"
2893
3010
  },
2894
3011
  "context": {
2895
3012
  "type": "object",
@@ -2940,7 +3057,6 @@
2940
3057
  },
2941
3058
  "required": [
2942
3059
  "messaging_product",
2943
- "to",
2944
3060
  "type",
2945
3061
  "audio"
2946
3062
  ],
@@ -2962,7 +3078,15 @@
2962
3078
  ]
2963
3079
  },
2964
3080
  "to": {
2965
- "type": "string"
3081
+ "type": "string",
3082
+ "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).",
3083
+ "example": "628123456789"
3084
+ },
3085
+ "recipient": {
3086
+ "type": "string",
3087
+ "pattern": "^[A-Z]{2}\\.(ENT\\.)?[A-Za-z0-9]{1,128}$",
3088
+ "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.",
3089
+ "example": "US.13491208655302741918"
2966
3090
  },
2967
3091
  "context": {
2968
3092
  "type": "object",
@@ -3068,7 +3192,6 @@
3068
3192
  },
3069
3193
  "required": [
3070
3194
  "messaging_product",
3071
- "to",
3072
3195
  "type",
3073
3196
  "template"
3074
3197
  ],
@@ -3090,7 +3213,15 @@
3090
3213
  ]
3091
3214
  },
3092
3215
  "to": {
3093
- "type": "string"
3216
+ "type": "string",
3217
+ "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).",
3218
+ "example": "628123456789"
3219
+ },
3220
+ "recipient": {
3221
+ "type": "string",
3222
+ "pattern": "^[A-Z]{2}\\.(ENT\\.)?[A-Za-z0-9]{1,128}$",
3223
+ "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.",
3224
+ "example": "US.13491208655302741918"
3094
3225
  },
3095
3226
  "context": {
3096
3227
  "type": "object",
@@ -3124,6 +3255,115 @@
3124
3255
  "cta_url"
3125
3256
  ]
3126
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
+ },
3127
3367
  "body": {
3128
3368
  "type": "object",
3129
3369
  "properties": {
@@ -3137,6 +3377,19 @@
3137
3377
  "text"
3138
3378
  ]
3139
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
+ },
3140
3393
  "action": {
3141
3394
  "type": "object",
3142
3395
  "properties": {
@@ -3721,7 +3974,6 @@
3721
3974
  },
3722
3975
  "required": [
3723
3976
  "messaging_product",
3724
- "to",
3725
3977
  "type",
3726
3978
  "interactive"
3727
3979
  ],
@@ -3818,7 +4070,7 @@
3818
4070
  }
3819
4071
  },
3820
4072
  "422": {
3821
- "description": "Semantic failure (e.g. idempotency key reuse)",
4073
+ "description": "Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found)",
3822
4074
  "content": {
3823
4075
  "application/json": {
3824
4076
  "schema": {
@@ -3997,7 +4249,7 @@
3997
4249
  }
3998
4250
  },
3999
4251
  "422": {
4000
- "description": "Semantic failure (e.g. idempotency key reuse)",
4252
+ "description": "Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found)",
4001
4253
  "content": {
4002
4254
  "application/json": {
4003
4255
  "schema": {
@@ -4125,7 +4377,7 @@
4125
4377
  }
4126
4378
  },
4127
4379
  "422": {
4128
- "description": "Semantic failure (e.g. idempotency key reuse)",
4380
+ "description": "Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found)",
4129
4381
  "content": {
4130
4382
  "application/json": {
4131
4383
  "schema": {
@@ -4267,7 +4519,7 @@
4267
4519
  }
4268
4520
  },
4269
4521
  "422": {
4270
- "description": "Semantic failure (e.g. idempotency key reuse)",
4522
+ "description": "Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found)",
4271
4523
  "content": {
4272
4524
  "application/json": {
4273
4525
  "schema": {
@@ -4572,7 +4824,7 @@
4572
4824
  }
4573
4825
  },
4574
4826
  "422": {
4575
- "description": "Semantic failure (e.g. idempotency key reuse)",
4827
+ "description": "Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found)",
4576
4828
  "content": {
4577
4829
  "application/json": {
4578
4830
  "schema": {
@@ -4701,7 +4953,7 @@
4701
4953
  }
4702
4954
  },
4703
4955
  "422": {
4704
- "description": "Semantic failure (e.g. idempotency key reuse)",
4956
+ "description": "Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found)",
4705
4957
  "content": {
4706
4958
  "application/json": {
4707
4959
  "schema": {
@@ -4801,7 +5053,7 @@
4801
5053
  }
4802
5054
  },
4803
5055
  "422": {
4804
- "description": "Semantic failure (e.g. idempotency key reuse)",
5056
+ "description": "Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found)",
4805
5057
  "content": {
4806
5058
  "application/json": {
4807
5059
  "schema": {
@@ -4881,6 +5133,7 @@
4881
5133
  "conversation.closed",
4882
5134
  "contact.created",
4883
5135
  "contact.updated",
5136
+ "contact.identity_updated",
4884
5137
  "customer.created",
4885
5138
  "customer.updated",
4886
5139
  "customer.archived",
@@ -4890,6 +5143,14 @@
4890
5143
  ]
4891
5144
  },
4892
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
4893
5154
  }
4894
5155
  },
4895
5156
  "required": [
@@ -4931,6 +5192,16 @@
4931
5192
  }
4932
5193
  }
4933
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
+ },
4934
5205
  "429": {
4935
5206
  "description": "Rate limit exceeded",
4936
5207
  "content": {
@@ -5196,6 +5467,7 @@
5196
5467
  "conversation.closed",
5197
5468
  "contact.created",
5198
5469
  "contact.updated",
5470
+ "contact.identity_updated",
5199
5471
  "customer.created",
5200
5472
  "customer.updated",
5201
5473
  "customer.archived",
@@ -5212,6 +5484,17 @@
5212
5484
  "active",
5213
5485
  "paused"
5214
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
5215
5498
  }
5216
5499
  }
5217
5500
  }
@@ -5259,6 +5542,16 @@
5259
5542
  }
5260
5543
  }
5261
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
+ },
5262
5555
  "429": {
5263
5556
  "description": "Rate limit exceeded",
5264
5557
  "content": {
@@ -5562,7 +5855,7 @@
5562
5855
  }
5563
5856
  },
5564
5857
  "422": {
5565
- "description": "Semantic failure (e.g. idempotency key reuse)",
5858
+ "description": "Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found)",
5566
5859
  "content": {
5567
5860
  "application/json": {
5568
5861
  "schema": {
@@ -6172,7 +6465,7 @@
6172
6465
  }
6173
6466
  },
6174
6467
  "422": {
6175
- "description": "Semantic failure (e.g. idempotency key reuse)",
6468
+ "description": "Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found)",
6176
6469
  "content": {
6177
6470
  "application/json": {
6178
6471
  "schema": {
@@ -6280,7 +6573,7 @@
6280
6573
  }
6281
6574
  },
6282
6575
  "422": {
6283
- "description": "Semantic failure (e.g. idempotency key reuse)",
6576
+ "description": "Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found)",
6284
6577
  "content": {
6285
6578
  "application/json": {
6286
6579
  "schema": {
@@ -6414,7 +6707,7 @@
6414
6707
  }
6415
6708
  },
6416
6709
  "422": {
6417
- "description": "Semantic failure (e.g. idempotency key reuse)",
6710
+ "description": "Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found)",
6418
6711
  "content": {
6419
6712
  "application/json": {
6420
6713
  "schema": {
@@ -6479,6 +6772,25 @@
6479
6772
  "name": "phone",
6480
6773
  "in": "query"
6481
6774
  },
6775
+ {
6776
+ "schema": {
6777
+ "type": "string",
6778
+ "pattern": "^[A-Z]{2}\\.(ENT\\.)?[A-Za-z0-9]{1,128}$"
6779
+ },
6780
+ "required": false,
6781
+ "name": "bsuid",
6782
+ "in": "query"
6783
+ },
6784
+ {
6785
+ "schema": {
6786
+ "type": "string",
6787
+ "minLength": 1,
6788
+ "maxLength": 100
6789
+ },
6790
+ "required": false,
6791
+ "name": "username",
6792
+ "in": "query"
6793
+ },
6482
6794
  {
6483
6795
  "schema": {
6484
6796
  "type": "string",
@@ -6549,7 +6861,7 @@
6549
6861
  }
6550
6862
  },
6551
6863
  "422": {
6552
- "description": "Semantic failure (e.g. idempotency key reuse)",
6864
+ "description": "Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found)",
6553
6865
  "content": {
6554
6866
  "application/json": {
6555
6867
  "schema": {
@@ -6614,6 +6926,15 @@
6614
6926
  "phone_number": {
6615
6927
  "type": "string"
6616
6928
  },
6929
+ "bsuid": {
6930
+ "type": "string",
6931
+ "pattern": "^[A-Z]{2}\\.(ENT\\.)?[A-Za-z0-9]{1,128}$"
6932
+ },
6933
+ "username": {
6934
+ "type": "string",
6935
+ "minLength": 1,
6936
+ "maxLength": 100
6937
+ },
6617
6938
  "name": {
6618
6939
  "type": "string",
6619
6940
  "minLength": 1,
@@ -6631,10 +6952,7 @@
6631
6952
  "type": "object",
6632
6953
  "additionalProperties": {}
6633
6954
  }
6634
- },
6635
- "required": [
6636
- "phone_number"
6637
- ]
6955
+ }
6638
6956
  }
6639
6957
  }
6640
6958
  }
@@ -6681,7 +6999,7 @@
6681
6999
  }
6682
7000
  },
6683
7001
  "422": {
6684
- "description": "Semantic failure (e.g. idempotency key reuse)",
7002
+ "description": "Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found)",
6685
7003
  "content": {
6686
7004
  "application/json": {
6687
7005
  "schema": {
@@ -6789,7 +7107,7 @@
6789
7107
  }
6790
7108
  },
6791
7109
  "422": {
6792
- "description": "Semantic failure (e.g. idempotency key reuse)",
7110
+ "description": "Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found)",
6793
7111
  "content": {
6794
7112
  "application/json": {
6795
7113
  "schema": {
@@ -6868,6 +7186,14 @@
6868
7186
  "minLength": 1,
6869
7187
  "maxLength": 200
6870
7188
  },
7189
+ "username": {
7190
+ "type": [
7191
+ "string",
7192
+ "null"
7193
+ ],
7194
+ "minLength": 1,
7195
+ "maxLength": 100
7196
+ },
6871
7197
  "email": {
6872
7198
  "anyOf": [
6873
7199
  {
@@ -6940,7 +7266,7 @@
6940
7266
  }
6941
7267
  },
6942
7268
  "422": {
6943
- "description": "Semantic failure (e.g. idempotency key reuse)",
7269
+ "description": "Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found)",
6944
7270
  "content": {
6945
7271
  "application/json": {
6946
7272
  "schema": {
@@ -7047,7 +7373,7 @@
7047
7373
  }
7048
7374
  },
7049
7375
  "422": {
7050
- "description": "Semantic failure (e.g. idempotency key reuse)",
7376
+ "description": "Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found)",
7051
7377
  "content": {
7052
7378
  "application/json": {
7053
7379
  "schema": {
@@ -7157,7 +7483,7 @@
7157
7483
  }
7158
7484
  },
7159
7485
  "422": {
7160
- "description": "Semantic failure (e.g. idempotency key reuse)",
7486
+ "description": "Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found)",
7161
7487
  "content": {
7162
7488
  "application/json": {
7163
7489
  "schema": {
@@ -7284,7 +7610,7 @@
7284
7610
  }
7285
7611
  },
7286
7612
  "422": {
7287
- "description": "Semantic failure (e.g. idempotency key reuse)",
7613
+ "description": "Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found)",
7288
7614
  "content": {
7289
7615
  "application/json": {
7290
7616
  "schema": {
@@ -7401,7 +7727,7 @@
7401
7727
  }
7402
7728
  },
7403
7729
  "422": {
7404
- "description": "Semantic failure (e.g. idempotency key reuse)",
7730
+ "description": "Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found)",
7405
7731
  "content": {
7406
7732
  "application/json": {
7407
7733
  "schema": {
@@ -7537,7 +7863,7 @@
7537
7863
  }
7538
7864
  },
7539
7865
  "422": {
7540
- "description": "Semantic failure (e.g. idempotency key reuse)",
7866
+ "description": "Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found)",
7541
7867
  "content": {
7542
7868
  "application/json": {
7543
7869
  "schema": {
@@ -7663,7 +7989,7 @@
7663
7989
  }
7664
7990
  },
7665
7991
  "422": {
7666
- "description": "Semantic failure (e.g. idempotency key reuse)",
7992
+ "description": "Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found)",
7667
7993
  "content": {
7668
7994
  "application/json": {
7669
7995
  "schema": {
@@ -7780,7 +8106,7 @@
7780
8106
  }
7781
8107
  },
7782
8108
  "422": {
7783
- "description": "Semantic failure (e.g. idempotency key reuse)",
8109
+ "description": "Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found)",
7784
8110
  "content": {
7785
8111
  "application/json": {
7786
8112
  "schema": {
@@ -8380,7 +8706,7 @@
8380
8706
  }
8381
8707
  },
8382
8708
  "402": {
8383
- "description": "Plan / quota / subscription gate (e.g. feature_not_entitled, quota_exceeded, subscription_inactive)",
8709
+ "description": "Billing / entitlement gate — subscription inactive, quota exceeded, or plan tier missing a feature (feature_not_entitled). Upgrade to continue.",
8384
8710
  "content": {
8385
8711
  "application/json": {
8386
8712
  "schema": {
@@ -8487,7 +8813,7 @@
8487
8813
  }
8488
8814
  },
8489
8815
  "402": {
8490
- "description": "Plan / quota / subscription gate (e.g. feature_not_entitled, quota_exceeded, subscription_inactive)",
8816
+ "description": "Billing / entitlement gate — subscription inactive, quota exceeded, or plan tier missing a feature (feature_not_entitled). Upgrade to continue.",
8491
8817
  "content": {
8492
8818
  "application/json": {
8493
8819
  "schema": {
@@ -8573,7 +8899,7 @@
8573
8899
  }
8574
8900
  },
8575
8901
  "402": {
8576
- "description": "Plan / quota / subscription gate (e.g. feature_not_entitled, quota_exceeded, subscription_inactive)",
8902
+ "description": "Billing / entitlement gate — subscription inactive, quota exceeded, or plan tier missing a feature (feature_not_entitled). Upgrade to continue.",
8577
8903
  "content": {
8578
8904
  "application/json": {
8579
8905
  "schema": {
@@ -8706,7 +9032,7 @@
8706
9032
  }
8707
9033
  },
8708
9034
  "402": {
8709
- "description": "Plan / quota / subscription gate (e.g. feature_not_entitled, quota_exceeded, subscription_inactive)",
9035
+ "description": "Billing / entitlement gate — subscription inactive, quota exceeded, or plan tier missing a feature (feature_not_entitled). Upgrade to continue.",
8710
9036
  "content": {
8711
9037
  "application/json": {
8712
9038
  "schema": {
@@ -8801,7 +9127,7 @@
8801
9127
  }
8802
9128
  },
8803
9129
  "402": {
8804
- "description": "Plan / quota / subscription gate (e.g. feature_not_entitled, quota_exceeded, subscription_inactive)",
9130
+ "description": "Billing / entitlement gate — subscription inactive, quota exceeded, or plan tier missing a feature (feature_not_entitled). Upgrade to continue.",
8805
9131
  "content": {
8806
9132
  "application/json": {
8807
9133
  "schema": {
@@ -8912,7 +9238,7 @@
8912
9238
  }
8913
9239
  },
8914
9240
  "402": {
8915
- "description": "Plan / quota / subscription gate (e.g. feature_not_entitled, quota_exceeded, subscription_inactive)",
9241
+ "description": "Billing / entitlement gate — subscription inactive, quota exceeded, or plan tier missing a feature (feature_not_entitled). Upgrade to continue.",
8916
9242
  "content": {
8917
9243
  "application/json": {
8918
9244
  "schema": {
@@ -9033,7 +9359,7 @@
9033
9359
  }
9034
9360
  },
9035
9361
  "402": {
9036
- "description": "Plan / quota / subscription gate (e.g. feature_not_entitled, quota_exceeded, subscription_inactive)",
9362
+ "description": "Billing / entitlement gate — subscription inactive, quota exceeded, or plan tier missing a feature (feature_not_entitled). Upgrade to continue.",
9037
9363
  "content": {
9038
9364
  "application/json": {
9039
9365
  "schema": {
@@ -9174,7 +9500,7 @@
9174
9500
  }
9175
9501
  },
9176
9502
  "402": {
9177
- "description": "Plan / quota / subscription gate (e.g. feature_not_entitled, quota_exceeded, subscription_inactive)",
9503
+ "description": "Billing / entitlement gate — subscription inactive, quota exceeded, or plan tier missing a feature (feature_not_entitled). Upgrade to continue.",
9178
9504
  "content": {
9179
9505
  "application/json": {
9180
9506
  "schema": {
@@ -9288,7 +9614,7 @@
9288
9614
  }
9289
9615
  },
9290
9616
  "402": {
9291
- "description": "Plan / quota / subscription gate (e.g. feature_not_entitled, quota_exceeded, subscription_inactive)",
9617
+ "description": "Billing / entitlement gate — subscription inactive, quota exceeded, or plan tier missing a feature (feature_not_entitled). Upgrade to continue.",
9292
9618
  "content": {
9293
9619
  "application/json": {
9294
9620
  "schema": {