@blezgo/api-sdk 0.1.5 → 0.1.6
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 +238 -238
- 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 +82 -82
- package/dist/addon/generated.d.ts.map +1 -1
- package/dist/admin/generated.d.ts +102 -102
- package/dist/admin/generated.d.ts.map +1 -1
- package/dist/affiliate/generated.d.ts +81 -81
- package/dist/affiliate/generated.d.ts.map +1 -1
- package/dist/analytics/generated.d.ts +22 -22
- package/dist/analytics/generated.d.ts.map +1 -1
- package/dist/announcements/generated.d.ts +134 -134
- package/dist/announcements/generated.d.ts.map +1 -1
- package/dist/apikeys/generated.d.ts +69 -69
- package/dist/apikeys/generated.d.ts.map +1 -1
- package/dist/assistance/generated.d.ts +22 -22
- package/dist/assistance/generated.d.ts.map +1 -1
- package/dist/authentication/generated.d.ts +61 -61
- package/dist/authentication/generated.d.ts.map +1 -1
- package/dist/blog/generated.d.ts +206 -206
- package/dist/blog/generated.d.ts.map +1 -1
- package/dist/bundle/generated.d.ts +84 -84
- package/dist/bundle/generated.d.ts.map +1 -1
- package/dist/cache/generated.d.ts +38 -38
- package/dist/cache/generated.d.ts.map +1 -1
- package/dist/calendar/generated.d.ts +28 -28
- package/dist/calendar/generated.d.ts.map +1 -1
- package/dist/campaigns/generated.d.ts +174 -174
- package/dist/campaigns/generated.d.ts.map +1 -1
- package/dist/cart/generated.d.ts +28 -28
- 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 +224 -224
- package/dist/channel/generated.d.ts.map +1 -1
- package/dist/company/generated.d.ts +43 -43
- package/dist/company/generated.d.ts.map +1 -1
- package/dist/conference/generated.d.ts +74 -74
- package/dist/conference/generated.d.ts.map +1 -1
- package/dist/config/generated.d.ts +68 -68
- package/dist/config/generated.d.ts.map +1 -1
- package/dist/content/generated.d.ts +541 -541
- package/dist/content/generated.d.ts.map +1 -1
- package/dist/cookies/generated.d.ts +36 -36
- package/dist/cookies/generated.d.ts.map +1 -1
- package/dist/courses/generated.d.ts +436 -436
- package/dist/courses/generated.d.ts.map +1 -1
- package/dist/custom/generated.d.ts +83 -83
- package/dist/custom/generated.d.ts.map +1 -1
- package/dist/dashboard/generated.d.ts +214 -214
- package/dist/dashboard/generated.d.ts.map +1 -1
- package/dist/elasticsearch/generated.d.ts +22 -22
- package/dist/elasticsearch/generated.d.ts.map +1 -1
- package/dist/enrollments/generated.d.ts +22 -22
- package/dist/enrollments/generated.d.ts.map +1 -1
- package/dist/errors/generated.d.ts +51 -51
- package/dist/errors/generated.d.ts.map +1 -1
- package/dist/eventconfig/generated.d.ts +113 -113
- package/dist/eventconfig/generated.d.ts.map +1 -1
- package/dist/funnels/generated.d.ts +124 -124
- package/dist/funnels/generated.d.ts.map +1 -1
- package/dist/gamification/generated.d.ts +194 -194
- package/dist/gamification/generated.d.ts.map +1 -1
- package/dist/impersonation/generated.d.ts +35 -35
- package/dist/impersonation/generated.d.ts.map +1 -1
- package/dist/inbox/generated.d.ts +138 -138
- package/dist/inbox/generated.d.ts.map +1 -1
- package/dist/internal/generated.d.ts +22 -22
- package/dist/internal/generated.d.ts.map +1 -1
- package/dist/internationalization/generated.d.ts +22 -22
- package/dist/internationalization/generated.d.ts.map +1 -1
- package/dist/invitations/generated.d.ts +111 -111
- package/dist/invitations/generated.d.ts.map +1 -1
- package/dist/meetings/generated.d.ts +323 -323
- package/dist/meetings/generated.d.ts.map +1 -1
- package/dist/metas/generated.d.ts +160 -160
- package/dist/metas/generated.d.ts.map +1 -1
- package/dist/notification/generated.d.ts +246 -246
- package/dist/notification/generated.d.ts.map +1 -1
- package/dist/notifications/generated.d.ts +22 -22
- package/dist/notifications/generated.d.ts.map +1 -1
- package/dist/onboarding/generated.d.ts +118 -118
- package/dist/onboarding/generated.d.ts.map +1 -1
- package/dist/packages/generated.d.ts +80 -80
- package/dist/packages/generated.d.ts.map +1 -1
- package/dist/payments/generated.d.ts +557 -557
- package/dist/payments/generated.d.ts.map +1 -1
- package/dist/payouts/generated.d.ts +22 -22
- package/dist/payouts/generated.d.ts.map +1 -1
- package/dist/plans/generated.d.ts +472 -472
- package/dist/plans/generated.d.ts.map +1 -1
- package/dist/pricing/generated.d.ts +100 -100
- package/dist/pricing/generated.d.ts.map +1 -1
- package/dist/products/generated.d.ts +617 -617
- package/dist/products/generated.d.ts.map +1 -1
- package/dist/profile/generated.d.ts +328 -328
- package/dist/profile/generated.d.ts.map +1 -1
- package/dist/reasons/generated.d.ts +97 -97
- package/dist/reasons/generated.d.ts.map +1 -1
- package/dist/registration/generated.d.ts +184 -184
- package/dist/registration/generated.d.ts.map +1 -1
- package/dist/reviews/generated.d.ts +69 -69
- package/dist/reviews/generated.d.ts.map +1 -1
- package/dist/role/generated.d.ts +210 -210
- package/dist/role/generated.d.ts.map +1 -1
- package/dist/scheduling/generated.d.ts +80 -80
- package/dist/scheduling/generated.d.ts.map +1 -1
- package/dist/services/generated.d.ts +937 -937
- package/dist/services/generated.d.ts.map +1 -1
- package/dist/sessions/generated.d.ts +363 -363
- package/dist/sessions/generated.d.ts.map +1 -1
- package/dist/spaces/generated.d.ts +403 -403
- package/dist/spaces/generated.d.ts.map +1 -1
- package/dist/storefront/generated.d.ts +22 -22
- package/dist/storefront/generated.d.ts.map +1 -1
- package/dist/support/generated.d.ts +1440 -1440
- package/dist/support/generated.d.ts.map +1 -1
- package/dist/sync/generated.d.ts +193 -193
- package/dist/sync/generated.d.ts.map +1 -1
- package/dist/tenant/generated.d.ts +482 -482
- package/dist/tenant/generated.d.ts.map +1 -1
- package/dist/testimonials/generated.d.ts +65 -65
- package/dist/testimonials/generated.d.ts.map +1 -1
- package/dist/tests/generated.d.ts +445 -445
- package/dist/tests/generated.d.ts.map +1 -1
- package/dist/tokens/generated.d.ts +39 -39
- package/dist/tokens/generated.d.ts.map +1 -1
- package/dist/uploads/generated.d.ts +20 -20
- package/dist/uploads/generated.d.ts.map +1 -1
- package/dist/upsell/generated.d.ts +108 -108
- package/dist/upsell/generated.d.ts.map +1 -1
- package/dist/user/generated.d.ts +107 -107
- package/dist/user/generated.d.ts.map +1 -1
- package/dist/webinars/generated.d.ts +308 -308
- package/dist/webinars/generated.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -1356,71 +1356,134 @@ export type webhooks = Record<string, never>;
|
|
|
1356
1356
|
export interface components {
|
|
1357
1357
|
schemas: {
|
|
1358
1358
|
/**
|
|
1359
|
-
*
|
|
1360
|
-
* @description Request schema for
|
|
1361
|
-
*
|
|
1362
|
-
* CRITICAL: Only display_name and is_default can be updated.
|
|
1363
|
-
* To change credentials, delete and recreate (security best practice).
|
|
1359
|
+
* QuotaUpdateRequest
|
|
1360
|
+
* @description Request schema for admin quota adjustments (add/subtract quota manually).
|
|
1364
1361
|
*
|
|
1365
1362
|
* Example:
|
|
1366
1363
|
* {
|
|
1367
|
-
* "
|
|
1368
|
-
* "
|
|
1364
|
+
* "channel_type": "sms",
|
|
1365
|
+
* "amount": 5000,
|
|
1366
|
+
* "notes": "Bonus quota for premium customer"
|
|
1369
1367
|
* }
|
|
1370
1368
|
*/
|
|
1371
|
-
|
|
1369
|
+
app__models__sms_quota__quota_schemas__QuotaUpdateRequest: {
|
|
1370
|
+
/** @description Channel type (sms or whatsapp) */
|
|
1371
|
+
channel_type: components["schemas"]["ChannelType"];
|
|
1372
1372
|
/**
|
|
1373
|
-
*
|
|
1374
|
-
* @description
|
|
1373
|
+
* Amount
|
|
1374
|
+
* @description Quota amount (positive to add, negative to subtract)
|
|
1375
1375
|
*/
|
|
1376
|
-
|
|
1376
|
+
amount: number;
|
|
1377
1377
|
/**
|
|
1378
|
-
*
|
|
1379
|
-
* @description
|
|
1378
|
+
* Notes
|
|
1379
|
+
* @description Reason for adjustment
|
|
1380
1380
|
*/
|
|
1381
|
-
|
|
1381
|
+
notes?: string | null;
|
|
1382
1382
|
};
|
|
1383
1383
|
/**
|
|
1384
|
-
*
|
|
1385
|
-
* @description
|
|
1384
|
+
* RoutingRuleUpdateRequest
|
|
1385
|
+
* @description Update an existing routing rule.
|
|
1386
1386
|
*/
|
|
1387
|
-
|
|
1388
|
-
/**
|
|
1389
|
-
|
|
1390
|
-
|
|
1391
|
-
|
|
1392
|
-
|
|
1393
|
-
|
|
1394
|
-
|
|
1395
|
-
|
|
1396
|
-
|
|
1397
|
-
|
|
1387
|
+
RoutingRuleUpdateRequest: {
|
|
1388
|
+
/** Primary Channel */
|
|
1389
|
+
primary_channel?: string | null;
|
|
1390
|
+
/** Fallback Channel */
|
|
1391
|
+
fallback_channel?: string | null;
|
|
1392
|
+
/** Sms Credential Id */
|
|
1393
|
+
sms_credential_id?: string | null;
|
|
1394
|
+
/** Whatsapp Credential Id */
|
|
1395
|
+
whatsapp_credential_id?: string | null;
|
|
1396
|
+
/** Email Credential Id */
|
|
1397
|
+
email_credential_id?: string | null;
|
|
1398
|
+
/** Sms Enabled */
|
|
1399
|
+
sms_enabled?: boolean | null;
|
|
1400
|
+
/** Sms Requires Dlt */
|
|
1401
|
+
sms_requires_dlt?: boolean | null;
|
|
1402
|
+
/** Sms Requires Sender Id */
|
|
1403
|
+
sms_requires_sender_id?: boolean | null;
|
|
1404
|
+
/** Whatsapp Enabled */
|
|
1405
|
+
whatsapp_enabled?: boolean | null;
|
|
1406
|
+
/** Email Enabled */
|
|
1407
|
+
email_enabled?: boolean | null;
|
|
1408
|
+
/** Sms Daily Limit */
|
|
1409
|
+
sms_daily_limit?: number | null;
|
|
1410
|
+
/** Sms Hourly Limit */
|
|
1411
|
+
sms_hourly_limit?: number | null;
|
|
1412
|
+
/** Is Active */
|
|
1413
|
+
is_active?: boolean | null;
|
|
1414
|
+
};
|
|
1415
|
+
/**
|
|
1416
|
+
* DLTRegistrationUpdateRequest
|
|
1417
|
+
* @description Update DLT registration.
|
|
1418
|
+
*/
|
|
1419
|
+
DLTRegistrationUpdateRequest: {
|
|
1420
|
+
/** Template Id */
|
|
1421
|
+
template_id?: string | null;
|
|
1422
|
+
/** Template Name */
|
|
1423
|
+
template_name?: string | null;
|
|
1424
|
+
/** Template Content */
|
|
1425
|
+
template_content?: string | null;
|
|
1426
|
+
/** Template Type */
|
|
1427
|
+
template_type?: string | null;
|
|
1398
1428
|
/**
|
|
1399
|
-
*
|
|
1400
|
-
* @description
|
|
1429
|
+
* Registration Status
|
|
1430
|
+
* @description pending, approved, rejected, expired
|
|
1401
1431
|
*/
|
|
1402
|
-
|
|
1432
|
+
registration_status?: string | null;
|
|
1433
|
+
/** Is Active */
|
|
1434
|
+
is_active?: boolean | null;
|
|
1435
|
+
};
|
|
1436
|
+
ErrorResponse: {
|
|
1437
|
+
/** @example about:blank */
|
|
1438
|
+
type?: string;
|
|
1439
|
+
/** @example GENERIC_ERROR */
|
|
1440
|
+
code?: string;
|
|
1441
|
+
/** @example Client Error */
|
|
1442
|
+
title?: string;
|
|
1443
|
+
/** @example 400 */
|
|
1444
|
+
status?: number;
|
|
1445
|
+
/** @example An error occurred */
|
|
1446
|
+
detail?: string;
|
|
1447
|
+
/** @example /v1/cart/items */
|
|
1448
|
+
instance?: string;
|
|
1449
|
+
extensions?: components["schemas"]["Extensions"];
|
|
1450
|
+
};
|
|
1451
|
+
/**
|
|
1452
|
+
* QuotaSettingsUpdateRequest
|
|
1453
|
+
* @description Request schema for updating quota settings (auto-recharge, daily caps).
|
|
1454
|
+
*
|
|
1455
|
+
* Example:
|
|
1456
|
+
* {
|
|
1457
|
+
* "channel_type": "sms",
|
|
1458
|
+
* "auto_recharge_enabled": true,
|
|
1459
|
+
* "auto_recharge_threshold": 100,
|
|
1460
|
+
* "auto_recharge_amount": 1000,
|
|
1461
|
+
* "daily_quota_cap": 5000
|
|
1462
|
+
* }
|
|
1463
|
+
*/
|
|
1464
|
+
QuotaSettingsUpdateRequest: {
|
|
1465
|
+
/** @description Channel type (sms or whatsapp) */
|
|
1466
|
+
channel_type: components["schemas"]["ChannelType"];
|
|
1403
1467
|
/**
|
|
1404
|
-
*
|
|
1405
|
-
* @description
|
|
1468
|
+
* Auto Recharge Enabled
|
|
1469
|
+
* @description Enable automatic quota recharge
|
|
1406
1470
|
*/
|
|
1407
|
-
|
|
1471
|
+
auto_recharge_enabled?: boolean | null;
|
|
1408
1472
|
/**
|
|
1409
|
-
*
|
|
1410
|
-
* @description
|
|
1473
|
+
* Auto Recharge Threshold
|
|
1474
|
+
* @description Trigger recharge when quota falls below this
|
|
1411
1475
|
*/
|
|
1412
|
-
|
|
1476
|
+
auto_recharge_threshold?: number | null;
|
|
1413
1477
|
/**
|
|
1414
|
-
*
|
|
1415
|
-
* @description
|
|
1478
|
+
* Auto Recharge Amount
|
|
1479
|
+
* @description Amount to purchase on auto-recharge
|
|
1416
1480
|
*/
|
|
1417
|
-
|
|
1481
|
+
auto_recharge_amount?: number | null;
|
|
1418
1482
|
/**
|
|
1419
|
-
*
|
|
1420
|
-
* @description
|
|
1421
|
-
* @default transactional
|
|
1483
|
+
* Daily Quota Cap
|
|
1484
|
+
* @description Max SMS/WhatsApp per day (cost leakage prevention)
|
|
1422
1485
|
*/
|
|
1423
|
-
|
|
1486
|
+
daily_quota_cap?: number | null;
|
|
1424
1487
|
};
|
|
1425
1488
|
/**
|
|
1426
1489
|
* RoutingRuleCreateRequest
|
|
@@ -1500,79 +1563,6 @@ export interface components {
|
|
|
1500
1563
|
*/
|
|
1501
1564
|
sms_hourly_limit: number;
|
|
1502
1565
|
};
|
|
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
|
-
};
|
|
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
1566
|
Extensions: {
|
|
1577
1567
|
/** @example GENERIC_ERROR */
|
|
1578
1568
|
message_code?: string;
|
|
@@ -1582,37 +1572,11 @@ export interface components {
|
|
|
1582
1572
|
/** @example Detailed debug information */
|
|
1583
1573
|
debug?: string | null;
|
|
1584
1574
|
};
|
|
1585
|
-
|
|
1586
|
-
|
|
1587
|
-
|
|
1588
|
-
|
|
1589
|
-
|
|
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;
|
|
1575
|
+
InvalidParam: {
|
|
1576
|
+
/** @example items[0].quantity */
|
|
1577
|
+
field?: string;
|
|
1578
|
+
/** @example Input should be greater than or equal to 1 */
|
|
1579
|
+
error?: string;
|
|
1616
1580
|
};
|
|
1617
1581
|
/**
|
|
1618
1582
|
* ChannelType
|
|
@@ -1620,44 +1584,72 @@ export interface components {
|
|
|
1620
1584
|
* @enum {string}
|
|
1621
1585
|
*/
|
|
1622
1586
|
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
1587
|
/**
|
|
1630
|
-
*
|
|
1631
|
-
* @description Request schema for
|
|
1588
|
+
* CredentialUpdateRequest
|
|
1589
|
+
* @description Request schema for updating an existing credential.
|
|
1632
1590
|
*
|
|
1633
|
-
* CRITICAL:
|
|
1591
|
+
* CRITICAL: Only display_name and is_default can be updated.
|
|
1592
|
+
* To change credentials, delete and recreate (security best practice).
|
|
1634
1593
|
*
|
|
1635
1594
|
* Example:
|
|
1636
1595
|
* {
|
|
1637
|
-
* "
|
|
1638
|
-
* "
|
|
1639
|
-
* "payment_reference_id": "pay_abc123xyz",
|
|
1640
|
-
* "idempotency_key": "purchase_20260129_123456_org123"
|
|
1596
|
+
* "display_name": "Updated Marketing SMTP",
|
|
1597
|
+
* "is_default": true
|
|
1641
1598
|
* }
|
|
1642
1599
|
*/
|
|
1643
|
-
|
|
1644
|
-
/** @description Channel type (sms or whatsapp) */
|
|
1645
|
-
channel_type: components["schemas"]["ChannelType"];
|
|
1600
|
+
CredentialUpdateRequest: {
|
|
1646
1601
|
/**
|
|
1647
|
-
*
|
|
1648
|
-
* @description
|
|
1602
|
+
* Display Name
|
|
1603
|
+
* @description User-friendly name
|
|
1649
1604
|
*/
|
|
1650
|
-
|
|
1605
|
+
display_name?: string | null;
|
|
1651
1606
|
/**
|
|
1652
|
-
*
|
|
1653
|
-
* @description
|
|
1607
|
+
* Is Default
|
|
1608
|
+
* @description Set as default credential
|
|
1654
1609
|
*/
|
|
1655
|
-
|
|
1610
|
+
is_default?: boolean | null;
|
|
1611
|
+
};
|
|
1612
|
+
/**
|
|
1613
|
+
* DLTRegistrationCreateRequest
|
|
1614
|
+
* @description Create a new DLT registration (India compliance).
|
|
1615
|
+
*/
|
|
1616
|
+
DLTRegistrationCreateRequest: {
|
|
1656
1617
|
/**
|
|
1657
|
-
*
|
|
1658
|
-
* @description
|
|
1618
|
+
* Credential Id
|
|
1619
|
+
* @description External ID of SMS credential
|
|
1659
1620
|
*/
|
|
1660
|
-
|
|
1621
|
+
credential_id: string;
|
|
1622
|
+
/**
|
|
1623
|
+
* Entity Id
|
|
1624
|
+
* @description DLT Entity ID from provider
|
|
1625
|
+
*/
|
|
1626
|
+
entity_id: string;
|
|
1627
|
+
/**
|
|
1628
|
+
* Sender Id
|
|
1629
|
+
* @description 6-char alphanumeric sender ID
|
|
1630
|
+
*/
|
|
1631
|
+
sender_id: string;
|
|
1632
|
+
/**
|
|
1633
|
+
* Template Id
|
|
1634
|
+
* @description Pre-registered template ID
|
|
1635
|
+
*/
|
|
1636
|
+
template_id?: string | null;
|
|
1637
|
+
/**
|
|
1638
|
+
* Template Name
|
|
1639
|
+
* @description Human-friendly template name
|
|
1640
|
+
*/
|
|
1641
|
+
template_name?: string | null;
|
|
1642
|
+
/**
|
|
1643
|
+
* Template Content
|
|
1644
|
+
* @description Template with {#var#} placeholders
|
|
1645
|
+
*/
|
|
1646
|
+
template_content?: string | null;
|
|
1647
|
+
/**
|
|
1648
|
+
* Template Type
|
|
1649
|
+
* @description transactional, promotional, service
|
|
1650
|
+
* @default transactional
|
|
1651
|
+
*/
|
|
1652
|
+
template_type: string;
|
|
1661
1653
|
};
|
|
1662
1654
|
/**
|
|
1663
1655
|
* CredentialCreateRequest
|
|
@@ -1747,58 +1739,6 @@ export interface components {
|
|
|
1747
1739
|
*/
|
|
1748
1740
|
notes?: string | null;
|
|
1749
1741
|
};
|
|
1750
|
-
ErrorResponse: {
|
|
1751
|
-
/** @example about:blank */
|
|
1752
|
-
type?: string;
|
|
1753
|
-
/** @example GENERIC_ERROR */
|
|
1754
|
-
code?: string;
|
|
1755
|
-
/** @example Client Error */
|
|
1756
|
-
title?: string;
|
|
1757
|
-
/** @example 400 */
|
|
1758
|
-
status?: number;
|
|
1759
|
-
/** @example An error occurred */
|
|
1760
|
-
detail?: string;
|
|
1761
|
-
/** @example /v1/cart/items */
|
|
1762
|
-
instance?: string;
|
|
1763
|
-
extensions?: components["schemas"]["Extensions"];
|
|
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
1742
|
/**
|
|
1803
1743
|
* CapabilityCheckRequest
|
|
1804
1744
|
* @description Check channel capability for a recipient.
|
|
@@ -1821,6 +1761,66 @@ export interface components {
|
|
|
1821
1761
|
*/
|
|
1822
1762
|
purpose: string;
|
|
1823
1763
|
};
|
|
1764
|
+
/**
|
|
1765
|
+
* QuotaPurchaseRequest
|
|
1766
|
+
* @description Request schema for purchasing SMS/WhatsApp quota.
|
|
1767
|
+
*
|
|
1768
|
+
* CRITICAL: idempotency_key MUST be unique per purchase to prevent duplicate charges.
|
|
1769
|
+
*
|
|
1770
|
+
* Example:
|
|
1771
|
+
* {
|
|
1772
|
+
* "channel_type": "sms",
|
|
1773
|
+
* "amount": 1000,
|
|
1774
|
+
* "payment_reference_id": "pay_abc123xyz",
|
|
1775
|
+
* "idempotency_key": "purchase_20260129_123456_org123"
|
|
1776
|
+
* }
|
|
1777
|
+
*/
|
|
1778
|
+
QuotaPurchaseRequest: {
|
|
1779
|
+
/** @description Channel type (sms or whatsapp) */
|
|
1780
|
+
channel_type: components["schemas"]["ChannelType"];
|
|
1781
|
+
/**
|
|
1782
|
+
* Amount
|
|
1783
|
+
* @description Quota amount to purchase (1-1,000,000)
|
|
1784
|
+
*/
|
|
1785
|
+
amount: number;
|
|
1786
|
+
/**
|
|
1787
|
+
* Payment Reference Id
|
|
1788
|
+
* @description Payment gateway reference ID
|
|
1789
|
+
*/
|
|
1790
|
+
payment_reference_id?: string | null;
|
|
1791
|
+
/**
|
|
1792
|
+
* Idempotency Key
|
|
1793
|
+
* @description Unique key to prevent duplicate purchases (e.g., purchase_YYYYMMDD_HHMMSS_orgID)
|
|
1794
|
+
*/
|
|
1795
|
+
idempotency_key: string;
|
|
1796
|
+
};
|
|
1797
|
+
/**
|
|
1798
|
+
* @example {
|
|
1799
|
+
* "status": "success",
|
|
1800
|
+
* "message": "Operation successful",
|
|
1801
|
+
* "message_code": "api_suc_20001",
|
|
1802
|
+
* "data": {},
|
|
1803
|
+
* "metadata": {
|
|
1804
|
+
* "timestamp": "2026-03-26T10:00:00.000Z",
|
|
1805
|
+
* "requestId": "07e22004-cb60-4dfc-bc9c-b6f99664dca1",
|
|
1806
|
+
* "traceId": "a9f1204c-bb82-41de-b234-7c3a9e120000",
|
|
1807
|
+
* "version": "v1",
|
|
1808
|
+
* "executionTime": 42,
|
|
1809
|
+
* "language": "en-US"
|
|
1810
|
+
* }
|
|
1811
|
+
* }
|
|
1812
|
+
*/
|
|
1813
|
+
StandardResponse: {
|
|
1814
|
+
/** @example success */
|
|
1815
|
+
status?: string;
|
|
1816
|
+
data?: Record<string, never> | null;
|
|
1817
|
+
/** @example Operation successful */
|
|
1818
|
+
message?: string | null;
|
|
1819
|
+
/** @example api_suc_20001 */
|
|
1820
|
+
message_code?: string | null;
|
|
1821
|
+
metadata?: Record<string, never> | null;
|
|
1822
|
+
error?: components["schemas"]["ErrorResponse"];
|
|
1823
|
+
};
|
|
1824
1824
|
};
|
|
1825
1825
|
responses: never;
|
|
1826
1826
|
parameters: never;
|