@blezgo/api-sdk 0.1.3 → 0.1.5
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/account/generated.d.ts +153 -153
- package/dist/account/generated.d.ts.map +1 -1
- package/dist/activity/generated.d.ts +57 -57
- package/dist/activity/generated.d.ts.map +1 -1
- package/dist/addon/generated.d.ts +104 -104
- package/dist/addon/generated.d.ts.map +1 -1
- package/dist/admin/generated.d.ts +85 -85
- package/dist/admin/generated.d.ts.map +1 -1
- package/dist/affiliate/generated.d.ts +89 -89
- package/dist/affiliate/generated.d.ts.map +1 -1
- package/dist/analytics/generated.d.ts +15 -15
- package/dist/analytics/generated.d.ts.map +1 -1
- package/dist/announcements/generated.d.ts +52 -52
- package/dist/announcements/generated.d.ts.map +1 -1
- package/dist/apikeys/generated.d.ts +43 -43
- package/dist/apikeys/generated.d.ts.map +1 -1
- package/dist/assistance/generated.d.ts +15 -15
- package/dist/assistance/generated.d.ts.map +1 -1
- package/dist/authentication/generated.d.ts +116 -116
- package/dist/authentication/generated.d.ts.map +1 -1
- package/dist/blog/generated.d.ts +168 -168
- package/dist/blog/generated.d.ts.map +1 -1
- package/dist/bundle/generated.d.ts +116 -116
- package/dist/bundle/generated.d.ts.map +1 -1
- package/dist/cache/generated.d.ts +30 -30
- package/dist/cache/generated.d.ts.map +1 -1
- package/dist/calendar/generated.d.ts +37 -37
- package/dist/calendar/generated.d.ts.map +1 -1
- package/dist/campaigns/generated.d.ts +157 -157
- package/dist/campaigns/generated.d.ts.map +1 -1
- package/dist/cart/generated.d.ts +30 -30
- package/dist/cart/generated.d.ts.map +1 -1
- package/dist/changelog/generated.d.ts +107 -107
- package/dist/changelog/generated.d.ts.map +1 -1
- package/dist/channel/generated.d.ts +231 -231
- package/dist/channel/generated.d.ts.map +1 -1
- package/dist/company/generated.d.ts +44 -44
- package/dist/company/generated.d.ts.map +1 -1
- package/dist/conference/generated.d.ts +14 -14
- package/dist/conference/generated.d.ts.map +1 -1
- package/dist/config/generated.d.ts +60 -60
- package/dist/config/generated.d.ts.map +1 -1
- package/dist/content/generated.d.ts +527 -527
- package/dist/content/generated.d.ts.map +1 -1
- package/dist/cookies/generated.d.ts +60 -60
- package/dist/cookies/generated.d.ts.map +1 -1
- package/dist/courses/generated.d.ts +348 -348
- package/dist/courses/generated.d.ts.map +1 -1
- package/dist/custom/generated.d.ts +96 -96
- package/dist/custom/generated.d.ts.map +1 -1
- package/dist/dashboard/generated.d.ts +124 -124
- package/dist/dashboard/generated.d.ts.map +1 -1
- package/dist/elasticsearch/generated.d.ts +15 -15
- package/dist/elasticsearch/generated.d.ts.map +1 -1
- package/dist/enrollments/generated.d.ts +15 -15
- package/dist/enrollments/generated.d.ts.map +1 -1
- package/dist/errors/generated.d.ts +24 -24
- package/dist/errors/generated.d.ts.map +1 -1
- package/dist/eventconfig/generated.d.ts +103 -103
- package/dist/eventconfig/generated.d.ts.map +1 -1
- package/dist/funnels/generated.d.ts +111 -111
- package/dist/funnels/generated.d.ts.map +1 -1
- package/dist/gamification/generated.d.ts +105 -105
- package/dist/gamification/generated.d.ts.map +1 -1
- package/dist/impersonation/generated.d.ts +27 -27
- package/dist/impersonation/generated.d.ts.map +1 -1
- package/dist/inbox/generated.d.ts +117 -117
- package/dist/inbox/generated.d.ts.map +1 -1
- package/dist/internal/generated.d.ts +15 -15
- package/dist/internal/generated.d.ts.map +1 -1
- package/dist/internationalization/generated.d.ts +15 -15
- package/dist/internationalization/generated.d.ts.map +1 -1
- package/dist/invitations/generated.d.ts +85 -85
- package/dist/invitations/generated.d.ts.map +1 -1
- package/dist/meetings/generated.d.ts +295 -295
- package/dist/meetings/generated.d.ts.map +1 -1
- package/dist/metas/generated.d.ts +191 -191
- package/dist/metas/generated.d.ts.map +1 -1
- package/dist/notification/generated.d.ts +261 -261
- package/dist/notification/generated.d.ts.map +1 -1
- package/dist/notifications/generated.d.ts +15 -15
- package/dist/notifications/generated.d.ts.map +1 -1
- package/dist/onboarding/generated.d.ts +116 -116
- package/dist/onboarding/generated.d.ts.map +1 -1
- package/dist/packages/generated.d.ts +21 -21
- package/dist/packages/generated.d.ts.map +1 -1
- package/dist/payments/generated.d.ts +548 -548
- package/dist/payments/generated.d.ts.map +1 -1
- package/dist/payouts/generated.d.ts +15 -15
- package/dist/payouts/generated.d.ts.map +1 -1
- package/dist/plans/generated.d.ts +349 -349
- package/dist/plans/generated.d.ts.map +1 -1
- package/dist/pricing/generated.d.ts +41 -41
- package/dist/pricing/generated.d.ts.map +1 -1
- package/dist/products/generated.d.ts +398 -398
- package/dist/products/generated.d.ts.map +1 -1
- package/dist/profile/generated.d.ts +333 -333
- package/dist/profile/generated.d.ts.map +1 -1
- package/dist/reasons/generated.d.ts +81 -81
- package/dist/reasons/generated.d.ts.map +1 -1
- package/dist/registration/generated.d.ts +178 -178
- package/dist/registration/generated.d.ts.map +1 -1
- package/dist/reviews/generated.d.ts +63 -63
- package/dist/reviews/generated.d.ts.map +1 -1
- package/dist/role/generated.d.ts +218 -218
- package/dist/role/generated.d.ts.map +1 -1
- package/dist/scheduling/generated.d.ts +96 -96
- package/dist/scheduling/generated.d.ts.map +1 -1
- package/dist/services/generated.d.ts +957 -957
- package/dist/services/generated.d.ts.map +1 -1
- package/dist/sessions/generated.d.ts +370 -370
- package/dist/sessions/generated.d.ts.map +1 -1
- package/dist/spaces/generated.d.ts +533 -533
- package/dist/spaces/generated.d.ts.map +1 -1
- package/dist/storefront/generated.d.ts +15 -15
- package/dist/storefront/generated.d.ts.map +1 -1
- package/dist/support/generated.d.ts +1426 -1426
- package/dist/support/generated.d.ts.map +1 -1
- package/dist/sync/generated.d.ts +127 -127
- package/dist/sync/generated.d.ts.map +1 -1
- package/dist/tenant/generated.d.ts +528 -528
- package/dist/tenant/generated.d.ts.map +1 -1
- package/dist/testimonials/generated.d.ts +56 -56
- package/dist/testimonials/generated.d.ts.map +1 -1
- package/dist/tests/generated.d.ts +509 -509
- package/dist/tests/generated.d.ts.map +1 -1
- package/dist/tokens/generated.d.ts +50 -50
- package/dist/tokens/generated.d.ts.map +1 -1
- package/dist/uploads/generated.d.ts +29 -29
- package/dist/uploads/generated.d.ts.map +1 -1
- package/dist/upsell/generated.d.ts +80 -80
- package/dist/upsell/generated.d.ts.map +1 -1
- package/dist/user/generated.d.ts +76 -70
- package/dist/user/generated.d.ts.map +1 -1
- package/dist/webinars/generated.d.ts +336 -336
- package/dist/webinars/generated.d.ts.map +1 -1
- package/package.json +1 -1
- package/test-commit.txt +1 -0
|
@@ -1355,68 +1355,6 @@ export interface paths {
|
|
|
1355
1355
|
export type webhooks = Record<string, never>;
|
|
1356
1356
|
export interface components {
|
|
1357
1357
|
schemas: {
|
|
1358
|
-
/**
|
|
1359
|
-
* QuotaSettingsUpdateRequest
|
|
1360
|
-
* @description Request schema for updating quota settings (auto-recharge, daily caps).
|
|
1361
|
-
*
|
|
1362
|
-
* Example:
|
|
1363
|
-
* {
|
|
1364
|
-
* "channel_type": "sms",
|
|
1365
|
-
* "auto_recharge_enabled": true,
|
|
1366
|
-
* "auto_recharge_threshold": 100,
|
|
1367
|
-
* "auto_recharge_amount": 1000,
|
|
1368
|
-
* "daily_quota_cap": 5000
|
|
1369
|
-
* }
|
|
1370
|
-
*/
|
|
1371
|
-
QuotaSettingsUpdateRequest: {
|
|
1372
|
-
/** @description Channel type (sms or whatsapp) */
|
|
1373
|
-
channel_type: components["schemas"]["ChannelType"];
|
|
1374
|
-
/**
|
|
1375
|
-
* Auto Recharge Enabled
|
|
1376
|
-
* @description Enable automatic quota recharge
|
|
1377
|
-
*/
|
|
1378
|
-
auto_recharge_enabled?: boolean | null;
|
|
1379
|
-
/**
|
|
1380
|
-
* Auto Recharge Threshold
|
|
1381
|
-
* @description Trigger recharge when quota falls below this
|
|
1382
|
-
*/
|
|
1383
|
-
auto_recharge_threshold?: number | null;
|
|
1384
|
-
/**
|
|
1385
|
-
* Auto Recharge Amount
|
|
1386
|
-
* @description Amount to purchase on auto-recharge
|
|
1387
|
-
*/
|
|
1388
|
-
auto_recharge_amount?: number | null;
|
|
1389
|
-
/**
|
|
1390
|
-
* Daily Quota Cap
|
|
1391
|
-
* @description Max SMS/WhatsApp per day (cost leakage prevention)
|
|
1392
|
-
*/
|
|
1393
|
-
daily_quota_cap?: number | null;
|
|
1394
|
-
};
|
|
1395
|
-
/**
|
|
1396
|
-
* QuotaUpdateRequest
|
|
1397
|
-
* @description Request schema for admin quota adjustments (add/subtract quota manually).
|
|
1398
|
-
*
|
|
1399
|
-
* Example:
|
|
1400
|
-
* {
|
|
1401
|
-
* "channel_type": "sms",
|
|
1402
|
-
* "amount": 5000,
|
|
1403
|
-
* "notes": "Bonus quota for premium customer"
|
|
1404
|
-
* }
|
|
1405
|
-
*/
|
|
1406
|
-
QuotaUpdateRequest: {
|
|
1407
|
-
/** @description Channel type (sms or whatsapp) */
|
|
1408
|
-
channel_type: components["schemas"]["ChannelType"];
|
|
1409
|
-
/**
|
|
1410
|
-
* Amount
|
|
1411
|
-
* @description Quota amount (positive to add, negative to subtract)
|
|
1412
|
-
*/
|
|
1413
|
-
amount: number;
|
|
1414
|
-
/**
|
|
1415
|
-
* Notes
|
|
1416
|
-
* @description Reason for adjustment
|
|
1417
|
-
*/
|
|
1418
|
-
notes?: string | null;
|
|
1419
|
-
};
|
|
1420
1358
|
/**
|
|
1421
1359
|
* CredentialUpdateRequest
|
|
1422
1360
|
* @description Request schema for updating an existing credential.
|
|
@@ -1443,88 +1381,46 @@ export interface components {
|
|
|
1443
1381
|
is_default?: boolean | null;
|
|
1444
1382
|
};
|
|
1445
1383
|
/**
|
|
1446
|
-
*
|
|
1447
|
-
*
|
|
1448
|
-
* "message": "Operation successful",
|
|
1449
|
-
* "message_code": "api_suc_20001",
|
|
1450
|
-
* "data": {},
|
|
1451
|
-
* "metadata": {
|
|
1452
|
-
* "timestamp": "2026-03-26T10:00:00.000Z",
|
|
1453
|
-
* "requestId": "07e22004-cb60-4dfc-bc9c-b6f99664dca1",
|
|
1454
|
-
* "traceId": "a9f1204c-bb82-41de-b234-7c3a9e120000",
|
|
1455
|
-
* "version": "v1",
|
|
1456
|
-
* "executionTime": 42,
|
|
1457
|
-
* "language": "en-US"
|
|
1458
|
-
* }
|
|
1459
|
-
* }
|
|
1460
|
-
*/
|
|
1461
|
-
StandardResponse: {
|
|
1462
|
-
/** @example success */
|
|
1463
|
-
status?: string;
|
|
1464
|
-
data?: Record<string, never> | null;
|
|
1465
|
-
/** @example Operation successful */
|
|
1466
|
-
message?: string | null;
|
|
1467
|
-
/** @example api_suc_20001 */
|
|
1468
|
-
message_code?: string | null;
|
|
1469
|
-
metadata?: Record<string, never> | null;
|
|
1470
|
-
error?: components["schemas"]["ErrorResponse"];
|
|
1471
|
-
};
|
|
1472
|
-
/**
|
|
1473
|
-
* CredentialCreateRequest
|
|
1474
|
-
* @description Request schema for creating a new channel credential.
|
|
1475
|
-
*
|
|
1476
|
-
* Example (SMTP):
|
|
1477
|
-
* {
|
|
1478
|
-
* "provider_code": "smtp",
|
|
1479
|
-
* "display_name": "Marketing SMTP",
|
|
1480
|
-
* "credentials": {
|
|
1481
|
-
* "host": "smtp.gmail.com",
|
|
1482
|
-
* "port": 587,
|
|
1483
|
-
* "user": "marketing@example.com",
|
|
1484
|
-
* "password": "app_password_here",
|
|
1485
|
-
* "from_email": "marketing@example.com",
|
|
1486
|
-
* "from_name": "Marketing Team",
|
|
1487
|
-
* "use_tls": true
|
|
1488
|
-
* },
|
|
1489
|
-
* "is_default": true
|
|
1490
|
-
* }
|
|
1491
|
-
*
|
|
1492
|
-
* Example (Twilio SMS):
|
|
1493
|
-
* {
|
|
1494
|
-
* "provider_code": "twilio_sms",
|
|
1495
|
-
* "display_name": "Main Twilio Account",
|
|
1496
|
-
* "credentials": {
|
|
1497
|
-
* "account_sid": "AC1234567890abcdef1234567890abcdef",
|
|
1498
|
-
* "auth_token": "your_auth_token_here",
|
|
1499
|
-
* "from_number": "+15551234567"
|
|
1500
|
-
* },
|
|
1501
|
-
* "is_default": false
|
|
1502
|
-
* }
|
|
1384
|
+
* DLTRegistrationCreateRequest
|
|
1385
|
+
* @description Create a new DLT registration (India compliance).
|
|
1503
1386
|
*/
|
|
1504
|
-
|
|
1387
|
+
DLTRegistrationCreateRequest: {
|
|
1505
1388
|
/**
|
|
1506
|
-
*
|
|
1507
|
-
* @description
|
|
1389
|
+
* Credential Id
|
|
1390
|
+
* @description External ID of SMS credential
|
|
1508
1391
|
*/
|
|
1509
|
-
|
|
1392
|
+
credential_id: string;
|
|
1510
1393
|
/**
|
|
1511
|
-
*
|
|
1512
|
-
* @description
|
|
1394
|
+
* Entity Id
|
|
1395
|
+
* @description DLT Entity ID from provider
|
|
1513
1396
|
*/
|
|
1514
|
-
|
|
1397
|
+
entity_id: string;
|
|
1515
1398
|
/**
|
|
1516
|
-
*
|
|
1517
|
-
* @description
|
|
1399
|
+
* Sender Id
|
|
1400
|
+
* @description 6-char alphanumeric sender ID
|
|
1518
1401
|
*/
|
|
1519
|
-
|
|
1520
|
-
[key: string]: unknown;
|
|
1521
|
-
};
|
|
1402
|
+
sender_id: string;
|
|
1522
1403
|
/**
|
|
1523
|
-
*
|
|
1524
|
-
* @description
|
|
1525
|
-
* @default false
|
|
1404
|
+
* Template Id
|
|
1405
|
+
* @description Pre-registered template ID
|
|
1526
1406
|
*/
|
|
1527
|
-
|
|
1407
|
+
template_id?: string | null;
|
|
1408
|
+
/**
|
|
1409
|
+
* Template Name
|
|
1410
|
+
* @description Human-friendly template name
|
|
1411
|
+
*/
|
|
1412
|
+
template_name?: string | null;
|
|
1413
|
+
/**
|
|
1414
|
+
* Template Content
|
|
1415
|
+
* @description Template with {#var#} placeholders
|
|
1416
|
+
*/
|
|
1417
|
+
template_content?: string | null;
|
|
1418
|
+
/**
|
|
1419
|
+
* Template Type
|
|
1420
|
+
* @description transactional, promotional, service
|
|
1421
|
+
* @default transactional
|
|
1422
|
+
*/
|
|
1423
|
+
template_type: string;
|
|
1528
1424
|
};
|
|
1529
1425
|
/**
|
|
1530
1426
|
* RoutingRuleCreateRequest
|
|
@@ -1604,6 +1500,58 @@ export interface components {
|
|
|
1604
1500
|
*/
|
|
1605
1501
|
sms_hourly_limit: number;
|
|
1606
1502
|
};
|
|
1503
|
+
/**
|
|
1504
|
+
* QuotaUpdateRequest
|
|
1505
|
+
* @description Request schema for admin quota adjustments (add/subtract quota manually).
|
|
1506
|
+
*
|
|
1507
|
+
* Example:
|
|
1508
|
+
* {
|
|
1509
|
+
* "channel_type": "sms",
|
|
1510
|
+
* "amount": 5000,
|
|
1511
|
+
* "notes": "Bonus quota for premium customer"
|
|
1512
|
+
* }
|
|
1513
|
+
*/
|
|
1514
|
+
app__models__sms_quota__quota_schemas__QuotaUpdateRequest: {
|
|
1515
|
+
/** @description Channel type (sms or whatsapp) */
|
|
1516
|
+
channel_type: components["schemas"]["ChannelType"];
|
|
1517
|
+
/**
|
|
1518
|
+
* Amount
|
|
1519
|
+
* @description Quota amount (positive to add, negative to subtract)
|
|
1520
|
+
*/
|
|
1521
|
+
amount: number;
|
|
1522
|
+
/**
|
|
1523
|
+
* Notes
|
|
1524
|
+
* @description Reason for adjustment
|
|
1525
|
+
*/
|
|
1526
|
+
notes?: string | null;
|
|
1527
|
+
};
|
|
1528
|
+
/**
|
|
1529
|
+
* @example {
|
|
1530
|
+
* "status": "success",
|
|
1531
|
+
* "message": "Operation successful",
|
|
1532
|
+
* "message_code": "api_suc_20001",
|
|
1533
|
+
* "data": {},
|
|
1534
|
+
* "metadata": {
|
|
1535
|
+
* "timestamp": "2026-03-26T10:00:00.000Z",
|
|
1536
|
+
* "requestId": "07e22004-cb60-4dfc-bc9c-b6f99664dca1",
|
|
1537
|
+
* "traceId": "a9f1204c-bb82-41de-b234-7c3a9e120000",
|
|
1538
|
+
* "version": "v1",
|
|
1539
|
+
* "executionTime": 42,
|
|
1540
|
+
* "language": "en-US"
|
|
1541
|
+
* }
|
|
1542
|
+
* }
|
|
1543
|
+
*/
|
|
1544
|
+
StandardResponse: {
|
|
1545
|
+
/** @example success */
|
|
1546
|
+
status?: string;
|
|
1547
|
+
data?: Record<string, never> | null;
|
|
1548
|
+
/** @example Operation successful */
|
|
1549
|
+
message?: string | null;
|
|
1550
|
+
/** @example api_suc_20001 */
|
|
1551
|
+
message_code?: string | null;
|
|
1552
|
+
metadata?: Record<string, never> | null;
|
|
1553
|
+
error?: components["schemas"]["ErrorResponse"];
|
|
1554
|
+
};
|
|
1607
1555
|
/**
|
|
1608
1556
|
* DLTRegistrationUpdateRequest
|
|
1609
1557
|
* @description Update DLT registration.
|
|
@@ -1625,76 +1573,15 @@ export interface components {
|
|
|
1625
1573
|
/** Is Active */
|
|
1626
1574
|
is_active?: boolean | null;
|
|
1627
1575
|
};
|
|
1628
|
-
|
|
1629
|
-
|
|
1630
|
-
|
|
1631
|
-
|
|
1632
|
-
|
|
1633
|
-
|
|
1634
|
-
|
|
1635
|
-
|
|
1636
|
-
*/
|
|
1637
|
-
credential_id: string;
|
|
1638
|
-
/**
|
|
1639
|
-
* Entity Id
|
|
1640
|
-
* @description DLT Entity ID from provider
|
|
1641
|
-
*/
|
|
1642
|
-
entity_id: string;
|
|
1643
|
-
/**
|
|
1644
|
-
* Sender Id
|
|
1645
|
-
* @description 6-char alphanumeric sender ID
|
|
1646
|
-
*/
|
|
1647
|
-
sender_id: string;
|
|
1648
|
-
/**
|
|
1649
|
-
* Template Id
|
|
1650
|
-
* @description Pre-registered template ID
|
|
1651
|
-
*/
|
|
1652
|
-
template_id?: string | null;
|
|
1653
|
-
/**
|
|
1654
|
-
* Template Name
|
|
1655
|
-
* @description Human-friendly template name
|
|
1656
|
-
*/
|
|
1657
|
-
template_name?: string | null;
|
|
1658
|
-
/**
|
|
1659
|
-
* Template Content
|
|
1660
|
-
* @description Template with {#var#} placeholders
|
|
1661
|
-
*/
|
|
1662
|
-
template_content?: string | null;
|
|
1663
|
-
/**
|
|
1664
|
-
* Template Type
|
|
1665
|
-
* @description transactional, promotional, service
|
|
1666
|
-
* @default transactional
|
|
1667
|
-
*/
|
|
1668
|
-
template_type: string;
|
|
1669
|
-
};
|
|
1670
|
-
/**
|
|
1671
|
-
* CapabilityCheckRequest
|
|
1672
|
-
* @description Check channel capability for a recipient.
|
|
1673
|
-
*/
|
|
1674
|
-
CapabilityCheckRequest: {
|
|
1675
|
-
/**
|
|
1676
|
-
* Channel
|
|
1677
|
-
* @description Channel to check: sms, email, whatsapp
|
|
1678
|
-
*/
|
|
1679
|
-
channel: string;
|
|
1680
|
-
/**
|
|
1681
|
-
* Recipient
|
|
1682
|
-
* @description Phone (E.164) or email address
|
|
1683
|
-
*/
|
|
1684
|
-
recipient: string;
|
|
1685
|
-
/**
|
|
1686
|
-
* Purpose
|
|
1687
|
-
* @description Purpose: otp, marketing, transactional
|
|
1688
|
-
* @default otp
|
|
1689
|
-
*/
|
|
1690
|
-
purpose: string;
|
|
1576
|
+
Extensions: {
|
|
1577
|
+
/** @example GENERIC_ERROR */
|
|
1578
|
+
message_code?: string;
|
|
1579
|
+
/** @example [] */
|
|
1580
|
+
invalid_params?: components["schemas"]["InvalidParam"][];
|
|
1581
|
+
extra_data?: Record<string, never> | null;
|
|
1582
|
+
/** @example Detailed debug information */
|
|
1583
|
+
debug?: string | null;
|
|
1691
1584
|
};
|
|
1692
|
-
/**
|
|
1693
|
-
* ChannelType
|
|
1694
|
-
* @description Channel types for quota.
|
|
1695
|
-
* @enum {string}
|
|
1696
|
-
*/
|
|
1697
|
-
ChannelType: "sms" | "whatsapp";
|
|
1698
1585
|
/**
|
|
1699
1586
|
* RoutingRuleUpdateRequest
|
|
1700
1587
|
* @description Update an existing routing rule.
|
|
@@ -1727,12 +1614,108 @@ export interface components {
|
|
|
1727
1614
|
/** Is Active */
|
|
1728
1615
|
is_active?: boolean | null;
|
|
1729
1616
|
};
|
|
1617
|
+
/**
|
|
1618
|
+
* ChannelType
|
|
1619
|
+
* @description Channel types for quota.
|
|
1620
|
+
* @enum {string}
|
|
1621
|
+
*/
|
|
1622
|
+
ChannelType: "sms" | "whatsapp";
|
|
1730
1623
|
InvalidParam: {
|
|
1731
1624
|
/** @example items[0].quantity */
|
|
1732
1625
|
field?: string;
|
|
1733
1626
|
/** @example Input should be greater than or equal to 1 */
|
|
1734
1627
|
error?: string;
|
|
1735
1628
|
};
|
|
1629
|
+
/**
|
|
1630
|
+
* QuotaPurchaseRequest
|
|
1631
|
+
* @description Request schema for purchasing SMS/WhatsApp quota.
|
|
1632
|
+
*
|
|
1633
|
+
* CRITICAL: idempotency_key MUST be unique per purchase to prevent duplicate charges.
|
|
1634
|
+
*
|
|
1635
|
+
* Example:
|
|
1636
|
+
* {
|
|
1637
|
+
* "channel_type": "sms",
|
|
1638
|
+
* "amount": 1000,
|
|
1639
|
+
* "payment_reference_id": "pay_abc123xyz",
|
|
1640
|
+
* "idempotency_key": "purchase_20260129_123456_org123"
|
|
1641
|
+
* }
|
|
1642
|
+
*/
|
|
1643
|
+
QuotaPurchaseRequest: {
|
|
1644
|
+
/** @description Channel type (sms or whatsapp) */
|
|
1645
|
+
channel_type: components["schemas"]["ChannelType"];
|
|
1646
|
+
/**
|
|
1647
|
+
* Amount
|
|
1648
|
+
* @description Quota amount to purchase (1-1,000,000)
|
|
1649
|
+
*/
|
|
1650
|
+
amount: number;
|
|
1651
|
+
/**
|
|
1652
|
+
* Payment Reference Id
|
|
1653
|
+
* @description Payment gateway reference ID
|
|
1654
|
+
*/
|
|
1655
|
+
payment_reference_id?: string | null;
|
|
1656
|
+
/**
|
|
1657
|
+
* Idempotency Key
|
|
1658
|
+
* @description Unique key to prevent duplicate purchases (e.g., purchase_YYYYMMDD_HHMMSS_orgID)
|
|
1659
|
+
*/
|
|
1660
|
+
idempotency_key: string;
|
|
1661
|
+
};
|
|
1662
|
+
/**
|
|
1663
|
+
* CredentialCreateRequest
|
|
1664
|
+
* @description Request schema for creating a new channel credential.
|
|
1665
|
+
*
|
|
1666
|
+
* Example (SMTP):
|
|
1667
|
+
* {
|
|
1668
|
+
* "provider_code": "smtp",
|
|
1669
|
+
* "display_name": "Marketing SMTP",
|
|
1670
|
+
* "credentials": {
|
|
1671
|
+
* "host": "smtp.gmail.com",
|
|
1672
|
+
* "port": 587,
|
|
1673
|
+
* "user": "marketing@example.com",
|
|
1674
|
+
* "password": "app_password_here",
|
|
1675
|
+
* "from_email": "marketing@example.com",
|
|
1676
|
+
* "from_name": "Marketing Team",
|
|
1677
|
+
* "use_tls": true
|
|
1678
|
+
* },
|
|
1679
|
+
* "is_default": true
|
|
1680
|
+
* }
|
|
1681
|
+
*
|
|
1682
|
+
* Example (Twilio SMS):
|
|
1683
|
+
* {
|
|
1684
|
+
* "provider_code": "twilio_sms",
|
|
1685
|
+
* "display_name": "Main Twilio Account",
|
|
1686
|
+
* "credentials": {
|
|
1687
|
+
* "account_sid": "AC1234567890abcdef1234567890abcdef",
|
|
1688
|
+
* "auth_token": "your_auth_token_here",
|
|
1689
|
+
* "from_number": "+15551234567"
|
|
1690
|
+
* },
|
|
1691
|
+
* "is_default": false
|
|
1692
|
+
* }
|
|
1693
|
+
*/
|
|
1694
|
+
CredentialCreateRequest: {
|
|
1695
|
+
/**
|
|
1696
|
+
* Provider Code
|
|
1697
|
+
* @description Provider code (smtp, ses_email_identity, twilio_sms, etc.)
|
|
1698
|
+
*/
|
|
1699
|
+
provider_code: string;
|
|
1700
|
+
/**
|
|
1701
|
+
* Display Name
|
|
1702
|
+
* @description User-friendly name (e.g., 'Marketing SMTP')
|
|
1703
|
+
*/
|
|
1704
|
+
display_name?: string | null;
|
|
1705
|
+
/**
|
|
1706
|
+
* Credentials
|
|
1707
|
+
* @description Provider-specific credentials (will be encrypted)
|
|
1708
|
+
*/
|
|
1709
|
+
credentials: {
|
|
1710
|
+
[key: string]: unknown;
|
|
1711
|
+
};
|
|
1712
|
+
/**
|
|
1713
|
+
* Is Default
|
|
1714
|
+
* @description Set as default credential for this channel type
|
|
1715
|
+
* @default false
|
|
1716
|
+
*/
|
|
1717
|
+
is_default: boolean;
|
|
1718
|
+
};
|
|
1736
1719
|
/**
|
|
1737
1720
|
* QuotaRefundRequest
|
|
1738
1721
|
* @description Request schema for refunding quota.
|
|
@@ -1764,15 +1747,6 @@ export interface components {
|
|
|
1764
1747
|
*/
|
|
1765
1748
|
notes?: string | null;
|
|
1766
1749
|
};
|
|
1767
|
-
Extensions: {
|
|
1768
|
-
/** @example GENERIC_ERROR */
|
|
1769
|
-
message_code?: string;
|
|
1770
|
-
/** @example [] */
|
|
1771
|
-
invalid_params?: components["schemas"]["InvalidParam"][];
|
|
1772
|
-
extra_data?: Record<string, never> | null;
|
|
1773
|
-
/** @example Detailed debug information */
|
|
1774
|
-
debug?: string | null;
|
|
1775
|
-
};
|
|
1776
1750
|
ErrorResponse: {
|
|
1777
1751
|
/** @example about:blank */
|
|
1778
1752
|
type?: string;
|
|
@@ -1789,37 +1763,63 @@ export interface components {
|
|
|
1789
1763
|
extensions?: components["schemas"]["Extensions"];
|
|
1790
1764
|
};
|
|
1791
1765
|
/**
|
|
1792
|
-
*
|
|
1793
|
-
* @description Request schema for
|
|
1794
|
-
*
|
|
1795
|
-
* CRITICAL: idempotency_key MUST be unique per purchase to prevent duplicate charges.
|
|
1766
|
+
* QuotaSettingsUpdateRequest
|
|
1767
|
+
* @description Request schema for updating quota settings (auto-recharge, daily caps).
|
|
1796
1768
|
*
|
|
1797
1769
|
* Example:
|
|
1798
1770
|
* {
|
|
1799
1771
|
* "channel_type": "sms",
|
|
1800
|
-
* "
|
|
1801
|
-
* "
|
|
1802
|
-
* "
|
|
1772
|
+
* "auto_recharge_enabled": true,
|
|
1773
|
+
* "auto_recharge_threshold": 100,
|
|
1774
|
+
* "auto_recharge_amount": 1000,
|
|
1775
|
+
* "daily_quota_cap": 5000
|
|
1803
1776
|
* }
|
|
1804
1777
|
*/
|
|
1805
|
-
|
|
1778
|
+
QuotaSettingsUpdateRequest: {
|
|
1806
1779
|
/** @description Channel type (sms or whatsapp) */
|
|
1807
1780
|
channel_type: components["schemas"]["ChannelType"];
|
|
1808
1781
|
/**
|
|
1809
|
-
*
|
|
1810
|
-
* @description
|
|
1782
|
+
* Auto Recharge Enabled
|
|
1783
|
+
* @description Enable automatic quota recharge
|
|
1811
1784
|
*/
|
|
1812
|
-
|
|
1785
|
+
auto_recharge_enabled?: boolean | null;
|
|
1813
1786
|
/**
|
|
1814
|
-
*
|
|
1815
|
-
* @description
|
|
1787
|
+
* Auto Recharge Threshold
|
|
1788
|
+
* @description Trigger recharge when quota falls below this
|
|
1816
1789
|
*/
|
|
1817
|
-
|
|
1790
|
+
auto_recharge_threshold?: number | null;
|
|
1818
1791
|
/**
|
|
1819
|
-
*
|
|
1820
|
-
* @description
|
|
1792
|
+
* Auto Recharge Amount
|
|
1793
|
+
* @description Amount to purchase on auto-recharge
|
|
1821
1794
|
*/
|
|
1822
|
-
|
|
1795
|
+
auto_recharge_amount?: number | null;
|
|
1796
|
+
/**
|
|
1797
|
+
* Daily Quota Cap
|
|
1798
|
+
* @description Max SMS/WhatsApp per day (cost leakage prevention)
|
|
1799
|
+
*/
|
|
1800
|
+
daily_quota_cap?: number | null;
|
|
1801
|
+
};
|
|
1802
|
+
/**
|
|
1803
|
+
* CapabilityCheckRequest
|
|
1804
|
+
* @description Check channel capability for a recipient.
|
|
1805
|
+
*/
|
|
1806
|
+
CapabilityCheckRequest: {
|
|
1807
|
+
/**
|
|
1808
|
+
* Channel
|
|
1809
|
+
* @description Channel to check: sms, email, whatsapp
|
|
1810
|
+
*/
|
|
1811
|
+
channel: string;
|
|
1812
|
+
/**
|
|
1813
|
+
* Recipient
|
|
1814
|
+
* @description Phone (E.164) or email address
|
|
1815
|
+
*/
|
|
1816
|
+
recipient: string;
|
|
1817
|
+
/**
|
|
1818
|
+
* Purpose
|
|
1819
|
+
* @description Purpose: otp, marketing, transactional
|
|
1820
|
+
* @default otp
|
|
1821
|
+
*/
|
|
1822
|
+
purpose: string;
|
|
1823
1823
|
};
|
|
1824
1824
|
};
|
|
1825
1825
|
responses: never;
|
|
@@ -6327,7 +6327,7 @@ export interface operations {
|
|
|
6327
6327
|
};
|
|
6328
6328
|
requestBody: {
|
|
6329
6329
|
content: {
|
|
6330
|
-
"application/json": components["schemas"]["
|
|
6330
|
+
"application/json": components["schemas"]["app__models__sms_quota__quota_schemas__QuotaUpdateRequest"];
|
|
6331
6331
|
};
|
|
6332
6332
|
};
|
|
6333
6333
|
responses: {
|