@blezgo/api-sdk 0.1.4 → 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 +193 -193
- package/dist/account/generated.d.ts.map +1 -1
- package/dist/activity/generated.d.ts +82 -82
- package/dist/activity/generated.d.ts.map +1 -1
- package/dist/addon/generated.d.ts +96 -96
- 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 +87 -87
- 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 +34 -34
- package/dist/announcements/generated.d.ts.map +1 -1
- package/dist/apikeys/generated.d.ts +99 -99
- 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 +74 -74
- package/dist/authentication/generated.d.ts.map +1 -1
- package/dist/blog/generated.d.ts +144 -144
- package/dist/blog/generated.d.ts.map +1 -1
- package/dist/bundle/generated.d.ts +177 -177
- package/dist/bundle/generated.d.ts.map +1 -1
- package/dist/cache/generated.d.ts +37 -37
- package/dist/cache/generated.d.ts.map +1 -1
- package/dist/calendar/generated.d.ts +69 -69
- package/dist/calendar/generated.d.ts.map +1 -1
- package/dist/campaigns/generated.d.ts +215 -215
- package/dist/campaigns/generated.d.ts.map +1 -1
- package/dist/cart/generated.d.ts +57 -57
- package/dist/cart/generated.d.ts.map +1 -1
- package/dist/changelog/generated.d.ts +103 -103
- package/dist/changelog/generated.d.ts.map +1 -1
- package/dist/channel/generated.d.ts +221 -221
- package/dist/channel/generated.d.ts.map +1 -1
- package/dist/company/generated.d.ts +35 -35
- package/dist/company/generated.d.ts.map +1 -1
- package/dist/conference/generated.d.ts +155 -155
- package/dist/conference/generated.d.ts.map +1 -1
- package/dist/config/generated.d.ts +44 -44
- package/dist/config/generated.d.ts.map +1 -1
- package/dist/content/generated.d.ts +500 -500
- package/dist/content/generated.d.ts.map +1 -1
- package/dist/cookies/generated.d.ts +89 -89
- package/dist/cookies/generated.d.ts.map +1 -1
- package/dist/courses/generated.d.ts +350 -350
- package/dist/courses/generated.d.ts.map +1 -1
- package/dist/custom/generated.d.ts +70 -70
- package/dist/custom/generated.d.ts.map +1 -1
- package/dist/dashboard/generated.d.ts +185 -185
- 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 +15 -15
- package/dist/errors/generated.d.ts.map +1 -1
- package/dist/eventconfig/generated.d.ts +95 -95
- package/dist/eventconfig/generated.d.ts.map +1 -1
- package/dist/funnels/generated.d.ts +131 -131
- package/dist/funnels/generated.d.ts.map +1 -1
- package/dist/gamification/generated.d.ts +144 -144
- package/dist/gamification/generated.d.ts.map +1 -1
- package/dist/impersonation/generated.d.ts +60 -60
- package/dist/impersonation/generated.d.ts.map +1 -1
- package/dist/inbox/generated.d.ts +133 -133
- 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 +124 -124
- package/dist/invitations/generated.d.ts.map +1 -1
- package/dist/meetings/generated.d.ts +213 -213
- package/dist/meetings/generated.d.ts.map +1 -1
- package/dist/metas/generated.d.ts +169 -169
- package/dist/metas/generated.d.ts.map +1 -1
- package/dist/notification/generated.d.ts +411 -411
- 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 +96 -96
- package/dist/onboarding/generated.d.ts.map +1 -1
- package/dist/packages/generated.d.ts +78 -78
- package/dist/packages/generated.d.ts.map +1 -1
- package/dist/payments/generated.d.ts +530 -530
- 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 +281 -281
- package/dist/plans/generated.d.ts.map +1 -1
- package/dist/pricing/generated.d.ts +97 -97
- package/dist/pricing/generated.d.ts.map +1 -1
- package/dist/products/generated.d.ts +491 -491
- package/dist/products/generated.d.ts.map +1 -1
- package/dist/profile/generated.d.ts +265 -265
- package/dist/profile/generated.d.ts.map +1 -1
- package/dist/reasons/generated.d.ts +100 -100
- package/dist/reasons/generated.d.ts.map +1 -1
- package/dist/registration/generated.d.ts +140 -140
- package/dist/registration/generated.d.ts.map +1 -1
- package/dist/reviews/generated.d.ts +67 -67
- package/dist/reviews/generated.d.ts.map +1 -1
- package/dist/role/generated.d.ts +216 -216
- package/dist/role/generated.d.ts.map +1 -1
- package/dist/scheduling/generated.d.ts +118 -118
- package/dist/scheduling/generated.d.ts.map +1 -1
- package/dist/services/generated.d.ts +819 -819
- package/dist/services/generated.d.ts.map +1 -1
- package/dist/sessions/generated.d.ts +236 -236
- package/dist/sessions/generated.d.ts.map +1 -1
- package/dist/spaces/generated.d.ts +423 -423
- 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 +1605 -1605
- package/dist/support/generated.d.ts.map +1 -1
- package/dist/sync/generated.d.ts +156 -156
- package/dist/sync/generated.d.ts.map +1 -1
- package/dist/tenant/generated.d.ts +435 -435
- package/dist/tenant/generated.d.ts.map +1 -1
- package/dist/testimonials/generated.d.ts +60 -60
- package/dist/testimonials/generated.d.ts.map +1 -1
- package/dist/tests/generated.d.ts +415 -415
- package/dist/tests/generated.d.ts.map +1 -1
- package/dist/tokens/generated.d.ts +48 -48
- package/dist/tokens/generated.d.ts.map +1 -1
- package/dist/uploads/generated.d.ts +56 -56
- package/dist/uploads/generated.d.ts.map +1 -1
- package/dist/upsell/generated.d.ts +86 -86
- package/dist/upsell/generated.d.ts.map +1 -1
- package/dist/user/generated.d.ts +99 -99
- package/dist/user/generated.d.ts.map +1 -1
- package/dist/webinars/generated.d.ts +185 -185
- package/dist/webinars/generated.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -1356,128 +1356,29 @@ export type webhooks = Record<string, never>;
|
|
|
1356
1356
|
export interface components {
|
|
1357
1357
|
schemas: {
|
|
1358
1358
|
/**
|
|
1359
|
-
*
|
|
1360
|
-
* @description
|
|
1361
|
-
|
|
1362
|
-
|
|
1363
|
-
|
|
1364
|
-
* Channel
|
|
1365
|
-
* @description Channel to check: sms, email, whatsapp
|
|
1366
|
-
*/
|
|
1367
|
-
channel: string;
|
|
1368
|
-
/**
|
|
1369
|
-
* Recipient
|
|
1370
|
-
* @description Phone (E.164) or email address
|
|
1371
|
-
*/
|
|
1372
|
-
recipient: string;
|
|
1373
|
-
/**
|
|
1374
|
-
* Purpose
|
|
1375
|
-
* @description Purpose: otp, marketing, transactional
|
|
1376
|
-
* @default otp
|
|
1377
|
-
*/
|
|
1378
|
-
purpose: string;
|
|
1379
|
-
};
|
|
1380
|
-
/**
|
|
1381
|
-
* QuotaSettingsUpdateRequest
|
|
1382
|
-
* @description Request schema for updating quota settings (auto-recharge, daily caps).
|
|
1359
|
+
* CredentialUpdateRequest
|
|
1360
|
+
* @description Request schema for updating an existing credential.
|
|
1361
|
+
*
|
|
1362
|
+
* CRITICAL: Only display_name and is_default can be updated.
|
|
1363
|
+
* To change credentials, delete and recreate (security best practice).
|
|
1383
1364
|
*
|
|
1384
1365
|
* Example:
|
|
1385
1366
|
* {
|
|
1386
|
-
* "
|
|
1387
|
-
* "
|
|
1388
|
-
* "auto_recharge_threshold": 100,
|
|
1389
|
-
* "auto_recharge_amount": 1000,
|
|
1390
|
-
* "daily_quota_cap": 5000
|
|
1367
|
+
* "display_name": "Updated Marketing SMTP",
|
|
1368
|
+
* "is_default": true
|
|
1391
1369
|
* }
|
|
1392
1370
|
*/
|
|
1393
|
-
|
|
1394
|
-
/** @description Channel type (sms or whatsapp) */
|
|
1395
|
-
channel_type: components["schemas"]["ChannelType"];
|
|
1396
|
-
/**
|
|
1397
|
-
* Auto Recharge Enabled
|
|
1398
|
-
* @description Enable automatic quota recharge
|
|
1399
|
-
*/
|
|
1400
|
-
auto_recharge_enabled?: boolean | null;
|
|
1401
|
-
/**
|
|
1402
|
-
* Auto Recharge Threshold
|
|
1403
|
-
* @description Trigger recharge when quota falls below this
|
|
1404
|
-
*/
|
|
1405
|
-
auto_recharge_threshold?: number | null;
|
|
1371
|
+
CredentialUpdateRequest: {
|
|
1406
1372
|
/**
|
|
1407
|
-
*
|
|
1408
|
-
* @description
|
|
1373
|
+
* Display Name
|
|
1374
|
+
* @description User-friendly name
|
|
1409
1375
|
*/
|
|
1410
|
-
|
|
1376
|
+
display_name?: string | null;
|
|
1411
1377
|
/**
|
|
1412
|
-
*
|
|
1413
|
-
* @description
|
|
1378
|
+
* Is Default
|
|
1379
|
+
* @description Set as default credential
|
|
1414
1380
|
*/
|
|
1415
|
-
|
|
1416
|
-
};
|
|
1417
|
-
InvalidParam: {
|
|
1418
|
-
/** @example items[0].quantity */
|
|
1419
|
-
field?: string;
|
|
1420
|
-
/** @example Input should be greater than or equal to 1 */
|
|
1421
|
-
error?: string;
|
|
1422
|
-
};
|
|
1423
|
-
/**
|
|
1424
|
-
* @example {
|
|
1425
|
-
* "status": "success",
|
|
1426
|
-
* "message": "Operation successful",
|
|
1427
|
-
* "message_code": "api_suc_20001",
|
|
1428
|
-
* "data": {},
|
|
1429
|
-
* "metadata": {
|
|
1430
|
-
* "timestamp": "2026-03-26T10:00:00.000Z",
|
|
1431
|
-
* "requestId": "07e22004-cb60-4dfc-bc9c-b6f99664dca1",
|
|
1432
|
-
* "traceId": "a9f1204c-bb82-41de-b234-7c3a9e120000",
|
|
1433
|
-
* "version": "v1",
|
|
1434
|
-
* "executionTime": 42,
|
|
1435
|
-
* "language": "en-US"
|
|
1436
|
-
* }
|
|
1437
|
-
* }
|
|
1438
|
-
*/
|
|
1439
|
-
StandardResponse: {
|
|
1440
|
-
/** @example success */
|
|
1441
|
-
status?: string;
|
|
1442
|
-
data?: Record<string, never> | null;
|
|
1443
|
-
/** @example Operation successful */
|
|
1444
|
-
message?: string | null;
|
|
1445
|
-
/** @example api_suc_20001 */
|
|
1446
|
-
message_code?: string | null;
|
|
1447
|
-
metadata?: Record<string, never> | null;
|
|
1448
|
-
error?: components["schemas"]["ErrorResponse"];
|
|
1449
|
-
};
|
|
1450
|
-
/**
|
|
1451
|
-
* RoutingRuleUpdateRequest
|
|
1452
|
-
* @description Update an existing routing rule.
|
|
1453
|
-
*/
|
|
1454
|
-
RoutingRuleUpdateRequest: {
|
|
1455
|
-
/** Primary Channel */
|
|
1456
|
-
primary_channel?: string | null;
|
|
1457
|
-
/** Fallback Channel */
|
|
1458
|
-
fallback_channel?: string | null;
|
|
1459
|
-
/** Sms Credential Id */
|
|
1460
|
-
sms_credential_id?: string | null;
|
|
1461
|
-
/** Whatsapp Credential Id */
|
|
1462
|
-
whatsapp_credential_id?: string | null;
|
|
1463
|
-
/** Email Credential Id */
|
|
1464
|
-
email_credential_id?: string | null;
|
|
1465
|
-
/** Sms Enabled */
|
|
1466
|
-
sms_enabled?: boolean | null;
|
|
1467
|
-
/** Sms Requires Dlt */
|
|
1468
|
-
sms_requires_dlt?: boolean | null;
|
|
1469
|
-
/** Sms Requires Sender Id */
|
|
1470
|
-
sms_requires_sender_id?: boolean | null;
|
|
1471
|
-
/** Whatsapp Enabled */
|
|
1472
|
-
whatsapp_enabled?: boolean | null;
|
|
1473
|
-
/** Email Enabled */
|
|
1474
|
-
email_enabled?: boolean | null;
|
|
1475
|
-
/** Sms Daily Limit */
|
|
1476
|
-
sms_daily_limit?: number | null;
|
|
1477
|
-
/** Sms Hourly Limit */
|
|
1478
|
-
sms_hourly_limit?: number | null;
|
|
1479
|
-
/** Is Active */
|
|
1480
|
-
is_active?: boolean | null;
|
|
1381
|
+
is_default?: boolean | null;
|
|
1481
1382
|
};
|
|
1482
1383
|
/**
|
|
1483
1384
|
* DLTRegistrationCreateRequest
|
|
@@ -1521,98 +1422,6 @@ export interface components {
|
|
|
1521
1422
|
*/
|
|
1522
1423
|
template_type: string;
|
|
1523
1424
|
};
|
|
1524
|
-
Extensions: {
|
|
1525
|
-
/** @example GENERIC_ERROR */
|
|
1526
|
-
message_code?: string;
|
|
1527
|
-
/** @example [] */
|
|
1528
|
-
invalid_params?: components["schemas"]["InvalidParam"][];
|
|
1529
|
-
extra_data?: Record<string, never> | null;
|
|
1530
|
-
/** @example Detailed debug information */
|
|
1531
|
-
debug?: string | null;
|
|
1532
|
-
};
|
|
1533
|
-
/**
|
|
1534
|
-
* ChannelType
|
|
1535
|
-
* @description Channel types for quota.
|
|
1536
|
-
* @enum {string}
|
|
1537
|
-
*/
|
|
1538
|
-
ChannelType: "sms" | "whatsapp";
|
|
1539
|
-
/**
|
|
1540
|
-
* QuotaRefundRequest
|
|
1541
|
-
* @description Request schema for refunding quota.
|
|
1542
|
-
*
|
|
1543
|
-
* Example:
|
|
1544
|
-
* {
|
|
1545
|
-
* "channel_type": "sms",
|
|
1546
|
-
* "amount": 1000,
|
|
1547
|
-
* "refund_reference_id": "refund_abc123",
|
|
1548
|
-
* "notes": "Refund for unused quota"
|
|
1549
|
-
* }
|
|
1550
|
-
*/
|
|
1551
|
-
QuotaRefundRequest: {
|
|
1552
|
-
/** @description Channel type (sms or whatsapp) */
|
|
1553
|
-
channel_type: components["schemas"]["ChannelType"];
|
|
1554
|
-
/**
|
|
1555
|
-
* Amount
|
|
1556
|
-
* @description Quota amount to refund
|
|
1557
|
-
*/
|
|
1558
|
-
amount: number;
|
|
1559
|
-
/**
|
|
1560
|
-
* Refund Reference Id
|
|
1561
|
-
* @description Refund reference ID
|
|
1562
|
-
*/
|
|
1563
|
-
refund_reference_id?: string | null;
|
|
1564
|
-
/**
|
|
1565
|
-
* Notes
|
|
1566
|
-
* @description Refund reason
|
|
1567
|
-
*/
|
|
1568
|
-
notes?: string | null;
|
|
1569
|
-
};
|
|
1570
|
-
/**
|
|
1571
|
-
* CredentialUpdateRequest
|
|
1572
|
-
* @description Request schema for updating an existing credential.
|
|
1573
|
-
*
|
|
1574
|
-
* CRITICAL: Only display_name and is_default can be updated.
|
|
1575
|
-
* To change credentials, delete and recreate (security best practice).
|
|
1576
|
-
*
|
|
1577
|
-
* Example:
|
|
1578
|
-
* {
|
|
1579
|
-
* "display_name": "Updated Marketing SMTP",
|
|
1580
|
-
* "is_default": true
|
|
1581
|
-
* }
|
|
1582
|
-
*/
|
|
1583
|
-
CredentialUpdateRequest: {
|
|
1584
|
-
/**
|
|
1585
|
-
* Display Name
|
|
1586
|
-
* @description User-friendly name
|
|
1587
|
-
*/
|
|
1588
|
-
display_name?: string | null;
|
|
1589
|
-
/**
|
|
1590
|
-
* Is Default
|
|
1591
|
-
* @description Set as default credential
|
|
1592
|
-
*/
|
|
1593
|
-
is_default?: boolean | null;
|
|
1594
|
-
};
|
|
1595
|
-
/**
|
|
1596
|
-
* DLTRegistrationUpdateRequest
|
|
1597
|
-
* @description Update DLT registration.
|
|
1598
|
-
*/
|
|
1599
|
-
DLTRegistrationUpdateRequest: {
|
|
1600
|
-
/** Template Id */
|
|
1601
|
-
template_id?: string | null;
|
|
1602
|
-
/** Template Name */
|
|
1603
|
-
template_name?: string | null;
|
|
1604
|
-
/** Template Content */
|
|
1605
|
-
template_content?: string | null;
|
|
1606
|
-
/** Template Type */
|
|
1607
|
-
template_type?: string | null;
|
|
1608
|
-
/**
|
|
1609
|
-
* Registration Status
|
|
1610
|
-
* @description pending, approved, rejected, expired
|
|
1611
|
-
*/
|
|
1612
|
-
registration_status?: string | null;
|
|
1613
|
-
/** Is Active */
|
|
1614
|
-
is_active?: boolean | null;
|
|
1615
|
-
};
|
|
1616
1425
|
/**
|
|
1617
1426
|
* RoutingRuleCreateRequest
|
|
1618
1427
|
* @description Create a new channel routing rule for org + country.
|
|
@@ -1702,7 +1511,7 @@ export interface components {
|
|
|
1702
1511
|
* "notes": "Bonus quota for premium customer"
|
|
1703
1512
|
* }
|
|
1704
1513
|
*/
|
|
1705
|
-
|
|
1514
|
+
app__models__sms_quota__quota_schemas__QuotaUpdateRequest: {
|
|
1706
1515
|
/** @description Channel type (sms or whatsapp) */
|
|
1707
1516
|
channel_type: components["schemas"]["ChannelType"];
|
|
1708
1517
|
/**
|
|
@@ -1716,6 +1525,140 @@ export interface components {
|
|
|
1716
1525
|
*/
|
|
1717
1526
|
notes?: string | null;
|
|
1718
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
|
+
};
|
|
1555
|
+
/**
|
|
1556
|
+
* DLTRegistrationUpdateRequest
|
|
1557
|
+
* @description Update DLT registration.
|
|
1558
|
+
*/
|
|
1559
|
+
DLTRegistrationUpdateRequest: {
|
|
1560
|
+
/** Template Id */
|
|
1561
|
+
template_id?: string | null;
|
|
1562
|
+
/** Template Name */
|
|
1563
|
+
template_name?: string | null;
|
|
1564
|
+
/** Template Content */
|
|
1565
|
+
template_content?: string | null;
|
|
1566
|
+
/** Template Type */
|
|
1567
|
+
template_type?: string | null;
|
|
1568
|
+
/**
|
|
1569
|
+
* Registration Status
|
|
1570
|
+
* @description pending, approved, rejected, expired
|
|
1571
|
+
*/
|
|
1572
|
+
registration_status?: string | null;
|
|
1573
|
+
/** Is Active */
|
|
1574
|
+
is_active?: boolean | null;
|
|
1575
|
+
};
|
|
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;
|
|
1584
|
+
};
|
|
1585
|
+
/**
|
|
1586
|
+
* RoutingRuleUpdateRequest
|
|
1587
|
+
* @description Update an existing routing rule.
|
|
1588
|
+
*/
|
|
1589
|
+
RoutingRuleUpdateRequest: {
|
|
1590
|
+
/** Primary Channel */
|
|
1591
|
+
primary_channel?: string | null;
|
|
1592
|
+
/** Fallback Channel */
|
|
1593
|
+
fallback_channel?: string | null;
|
|
1594
|
+
/** Sms Credential Id */
|
|
1595
|
+
sms_credential_id?: string | null;
|
|
1596
|
+
/** Whatsapp Credential Id */
|
|
1597
|
+
whatsapp_credential_id?: string | null;
|
|
1598
|
+
/** Email Credential Id */
|
|
1599
|
+
email_credential_id?: string | null;
|
|
1600
|
+
/** Sms Enabled */
|
|
1601
|
+
sms_enabled?: boolean | null;
|
|
1602
|
+
/** Sms Requires Dlt */
|
|
1603
|
+
sms_requires_dlt?: boolean | null;
|
|
1604
|
+
/** Sms Requires Sender Id */
|
|
1605
|
+
sms_requires_sender_id?: boolean | null;
|
|
1606
|
+
/** Whatsapp Enabled */
|
|
1607
|
+
whatsapp_enabled?: boolean | null;
|
|
1608
|
+
/** Email Enabled */
|
|
1609
|
+
email_enabled?: boolean | null;
|
|
1610
|
+
/** Sms Daily Limit */
|
|
1611
|
+
sms_daily_limit?: number | null;
|
|
1612
|
+
/** Sms Hourly Limit */
|
|
1613
|
+
sms_hourly_limit?: number | null;
|
|
1614
|
+
/** Is Active */
|
|
1615
|
+
is_active?: boolean | null;
|
|
1616
|
+
};
|
|
1617
|
+
/**
|
|
1618
|
+
* ChannelType
|
|
1619
|
+
* @description Channel types for quota.
|
|
1620
|
+
* @enum {string}
|
|
1621
|
+
*/
|
|
1622
|
+
ChannelType: "sms" | "whatsapp";
|
|
1623
|
+
InvalidParam: {
|
|
1624
|
+
/** @example items[0].quantity */
|
|
1625
|
+
field?: string;
|
|
1626
|
+
/** @example Input should be greater than or equal to 1 */
|
|
1627
|
+
error?: string;
|
|
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
|
+
};
|
|
1719
1662
|
/**
|
|
1720
1663
|
* CredentialCreateRequest
|
|
1721
1664
|
* @description Request schema for creating a new channel credential.
|
|
@@ -1774,37 +1717,35 @@ export interface components {
|
|
|
1774
1717
|
is_default: boolean;
|
|
1775
1718
|
};
|
|
1776
1719
|
/**
|
|
1777
|
-
*
|
|
1778
|
-
* @description Request schema for
|
|
1779
|
-
*
|
|
1780
|
-
* CRITICAL: idempotency_key MUST be unique per purchase to prevent duplicate charges.
|
|
1720
|
+
* QuotaRefundRequest
|
|
1721
|
+
* @description Request schema for refunding quota.
|
|
1781
1722
|
*
|
|
1782
1723
|
* Example:
|
|
1783
1724
|
* {
|
|
1784
1725
|
* "channel_type": "sms",
|
|
1785
1726
|
* "amount": 1000,
|
|
1786
|
-
* "
|
|
1787
|
-
* "
|
|
1727
|
+
* "refund_reference_id": "refund_abc123",
|
|
1728
|
+
* "notes": "Refund for unused quota"
|
|
1788
1729
|
* }
|
|
1789
1730
|
*/
|
|
1790
|
-
|
|
1731
|
+
QuotaRefundRequest: {
|
|
1791
1732
|
/** @description Channel type (sms or whatsapp) */
|
|
1792
1733
|
channel_type: components["schemas"]["ChannelType"];
|
|
1793
1734
|
/**
|
|
1794
1735
|
* Amount
|
|
1795
|
-
* @description Quota amount to
|
|
1736
|
+
* @description Quota amount to refund
|
|
1796
1737
|
*/
|
|
1797
1738
|
amount: number;
|
|
1798
1739
|
/**
|
|
1799
|
-
*
|
|
1800
|
-
* @description
|
|
1740
|
+
* Refund Reference Id
|
|
1741
|
+
* @description Refund reference ID
|
|
1801
1742
|
*/
|
|
1802
|
-
|
|
1743
|
+
refund_reference_id?: string | null;
|
|
1803
1744
|
/**
|
|
1804
|
-
*
|
|
1805
|
-
* @description
|
|
1745
|
+
* Notes
|
|
1746
|
+
* @description Refund reason
|
|
1806
1747
|
*/
|
|
1807
|
-
|
|
1748
|
+
notes?: string | null;
|
|
1808
1749
|
};
|
|
1809
1750
|
ErrorResponse: {
|
|
1810
1751
|
/** @example about:blank */
|
|
@@ -1821,6 +1762,65 @@ export interface components {
|
|
|
1821
1762
|
instance?: string;
|
|
1822
1763
|
extensions?: components["schemas"]["Extensions"];
|
|
1823
1764
|
};
|
|
1765
|
+
/**
|
|
1766
|
+
* QuotaSettingsUpdateRequest
|
|
1767
|
+
* @description Request schema for updating quota settings (auto-recharge, daily caps).
|
|
1768
|
+
*
|
|
1769
|
+
* Example:
|
|
1770
|
+
* {
|
|
1771
|
+
* "channel_type": "sms",
|
|
1772
|
+
* "auto_recharge_enabled": true,
|
|
1773
|
+
* "auto_recharge_threshold": 100,
|
|
1774
|
+
* "auto_recharge_amount": 1000,
|
|
1775
|
+
* "daily_quota_cap": 5000
|
|
1776
|
+
* }
|
|
1777
|
+
*/
|
|
1778
|
+
QuotaSettingsUpdateRequest: {
|
|
1779
|
+
/** @description Channel type (sms or whatsapp) */
|
|
1780
|
+
channel_type: components["schemas"]["ChannelType"];
|
|
1781
|
+
/**
|
|
1782
|
+
* Auto Recharge Enabled
|
|
1783
|
+
* @description Enable automatic quota recharge
|
|
1784
|
+
*/
|
|
1785
|
+
auto_recharge_enabled?: boolean | null;
|
|
1786
|
+
/**
|
|
1787
|
+
* Auto Recharge Threshold
|
|
1788
|
+
* @description Trigger recharge when quota falls below this
|
|
1789
|
+
*/
|
|
1790
|
+
auto_recharge_threshold?: number | null;
|
|
1791
|
+
/**
|
|
1792
|
+
* Auto Recharge Amount
|
|
1793
|
+
* @description Amount to purchase on auto-recharge
|
|
1794
|
+
*/
|
|
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
|
+
};
|
|
1824
1824
|
};
|
|
1825
1825
|
responses: never;
|
|
1826
1826
|
parameters: 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: {
|