@blezgo/api-sdk 0.1.4 → 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 +230 -230
- package/dist/account/generated.d.ts.map +1 -1
- package/dist/activity/generated.d.ts +46 -46
- package/dist/activity/generated.d.ts.map +1 -1
- package/dist/addon/generated.d.ts +101 -101
- package/dist/addon/generated.d.ts.map +1 -1
- package/dist/admin/generated.d.ts +122 -122
- package/dist/admin/generated.d.ts.map +1 -1
- package/dist/affiliate/generated.d.ts +82 -82
- package/dist/affiliate/generated.d.ts.map +1 -1
- package/dist/analytics/generated.d.ts +21 -21
- package/dist/analytics/generated.d.ts.map +1 -1
- package/dist/announcements/generated.d.ts +119 -119
- package/dist/announcements/generated.d.ts.map +1 -1
- package/dist/apikeys/generated.d.ts +129 -129
- package/dist/apikeys/generated.d.ts.map +1 -1
- package/dist/assistance/generated.d.ts +21 -21
- package/dist/assistance/generated.d.ts.map +1 -1
- package/dist/authentication/generated.d.ts +83 -83
- package/dist/authentication/generated.d.ts.map +1 -1
- package/dist/blog/generated.d.ts +212 -212
- package/dist/blog/generated.d.ts.map +1 -1
- package/dist/bundle/generated.d.ts +185 -185
- package/dist/bundle/generated.d.ts.map +1 -1
- package/dist/cache/generated.d.ts +27 -27
- package/dist/cache/generated.d.ts.map +1 -1
- package/dist/calendar/generated.d.ts +54 -54
- package/dist/calendar/generated.d.ts.map +1 -1
- package/dist/campaigns/generated.d.ts +206 -206
- package/dist/campaigns/generated.d.ts.map +1 -1
- package/dist/cart/generated.d.ts +42 -42
- package/dist/cart/generated.d.ts.map +1 -1
- package/dist/changelog/generated.d.ts +101 -101
- package/dist/changelog/generated.d.ts.map +1 -1
- package/dist/channel/generated.d.ts +213 -213
- package/dist/channel/generated.d.ts.map +1 -1
- package/dist/company/generated.d.ts +57 -57
- package/dist/company/generated.d.ts.map +1 -1
- package/dist/conference/generated.d.ts +109 -109
- package/dist/conference/generated.d.ts.map +1 -1
- package/dist/config/generated.d.ts +55 -55
- package/dist/config/generated.d.ts.map +1 -1
- package/dist/content/generated.d.ts +613 -613
- package/dist/content/generated.d.ts.map +1 -1
- package/dist/cookies/generated.d.ts +71 -71
- package/dist/cookies/generated.d.ts.map +1 -1
- package/dist/courses/generated.d.ts +453 -453
- package/dist/courses/generated.d.ts.map +1 -1
- package/dist/custom/generated.d.ts +78 -78
- package/dist/custom/generated.d.ts.map +1 -1
- package/dist/dashboard/generated.d.ts +138 -138
- package/dist/dashboard/generated.d.ts.map +1 -1
- package/dist/elasticsearch/generated.d.ts +21 -21
- package/dist/elasticsearch/generated.d.ts.map +1 -1
- package/dist/enrollments/generated.d.ts +21 -21
- package/dist/enrollments/generated.d.ts.map +1 -1
- package/dist/errors/generated.d.ts +54 -54
- package/dist/errors/generated.d.ts.map +1 -1
- package/dist/eventconfig/generated.d.ts +53 -53
- package/dist/eventconfig/generated.d.ts.map +1 -1
- package/dist/funnels/generated.d.ts +117 -117
- package/dist/funnels/generated.d.ts.map +1 -1
- package/dist/gamification/generated.d.ts +177 -177
- package/dist/gamification/generated.d.ts.map +1 -1
- package/dist/impersonation/generated.d.ts +52 -52
- package/dist/impersonation/generated.d.ts.map +1 -1
- package/dist/inbox/generated.d.ts +122 -122
- package/dist/inbox/generated.d.ts.map +1 -1
- package/dist/internal/generated.d.ts +21 -21
- package/dist/internal/generated.d.ts.map +1 -1
- package/dist/internationalization/generated.d.ts +21 -21
- package/dist/internationalization/generated.d.ts.map +1 -1
- package/dist/invitations/generated.d.ts +156 -156
- package/dist/invitations/generated.d.ts.map +1 -1
- package/dist/meetings/generated.d.ts +372 -372
- package/dist/meetings/generated.d.ts.map +1 -1
- package/dist/metas/generated.d.ts +199 -199
- package/dist/metas/generated.d.ts.map +1 -1
- package/dist/notification/generated.d.ts +356 -356
- package/dist/notification/generated.d.ts.map +1 -1
- package/dist/notifications/generated.d.ts +21 -21
- package/dist/notifications/generated.d.ts.map +1 -1
- package/dist/onboarding/generated.d.ts +77 -77
- package/dist/onboarding/generated.d.ts.map +1 -1
- package/dist/packages/generated.d.ts +59 -59
- package/dist/packages/generated.d.ts.map +1 -1
- package/dist/payments/generated.d.ts +523 -523
- package/dist/payments/generated.d.ts.map +1 -1
- package/dist/payouts/generated.d.ts +21 -21
- package/dist/payouts/generated.d.ts.map +1 -1
- package/dist/plans/generated.d.ts +323 -323
- package/dist/plans/generated.d.ts.map +1 -1
- package/dist/pricing/generated.d.ts +38 -38
- package/dist/pricing/generated.d.ts.map +1 -1
- package/dist/products/generated.d.ts +443 -443
- package/dist/products/generated.d.ts.map +1 -1
- package/dist/profile/generated.d.ts +354 -354
- package/dist/profile/generated.d.ts.map +1 -1
- package/dist/reasons/generated.d.ts +101 -101
- package/dist/reasons/generated.d.ts.map +1 -1
- package/dist/registration/generated.d.ts +171 -171
- package/dist/registration/generated.d.ts.map +1 -1
- package/dist/reviews/generated.d.ts +57 -57
- package/dist/reviews/generated.d.ts.map +1 -1
- package/dist/role/generated.d.ts +191 -191
- package/dist/role/generated.d.ts.map +1 -1
- package/dist/scheduling/generated.d.ts +103 -103
- package/dist/scheduling/generated.d.ts.map +1 -1
- package/dist/services/generated.d.ts +1017 -1017
- package/dist/services/generated.d.ts.map +1 -1
- package/dist/sessions/generated.d.ts +362 -362
- package/dist/sessions/generated.d.ts.map +1 -1
- package/dist/spaces/generated.d.ts +600 -600
- package/dist/spaces/generated.d.ts.map +1 -1
- package/dist/storefront/generated.d.ts +21 -21
- package/dist/storefront/generated.d.ts.map +1 -1
- package/dist/support/generated.d.ts +1403 -1403
- package/dist/support/generated.d.ts.map +1 -1
- package/dist/sync/generated.d.ts +182 -182
- package/dist/sync/generated.d.ts.map +1 -1
- package/dist/tenant/generated.d.ts +737 -737
- package/dist/tenant/generated.d.ts.map +1 -1
- package/dist/testimonials/generated.d.ts +50 -50
- package/dist/testimonials/generated.d.ts.map +1 -1
- package/dist/tests/generated.d.ts +472 -472
- package/dist/tests/generated.d.ts.map +1 -1
- package/dist/tokens/generated.d.ts +54 -54
- package/dist/tokens/generated.d.ts.map +1 -1
- package/dist/uploads/generated.d.ts +69 -69
- package/dist/uploads/generated.d.ts.map +1 -1
- package/dist/upsell/generated.d.ts +130 -130
- package/dist/upsell/generated.d.ts.map +1 -1
- package/dist/user/generated.d.ts +72 -72
- package/dist/user/generated.d.ts.map +1 -1
- package/dist/webinars/generated.d.ts +329 -329
- package/dist/webinars/generated.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -1356,96 +1356,29 @@ export type webhooks = Record<string, never>;
|
|
|
1356
1356
|
export interface components {
|
|
1357
1357
|
schemas: {
|
|
1358
1358
|
/**
|
|
1359
|
-
*
|
|
1360
|
-
* @description
|
|
1361
|
-
*/
|
|
1362
|
-
CapabilityCheckRequest: {
|
|
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
|
+
* QuotaUpdateRequest
|
|
1360
|
+
* @description Request schema for admin quota adjustments (add/subtract quota manually).
|
|
1383
1361
|
*
|
|
1384
1362
|
* Example:
|
|
1385
1363
|
* {
|
|
1386
1364
|
* "channel_type": "sms",
|
|
1387
|
-
* "
|
|
1388
|
-
* "
|
|
1389
|
-
* "auto_recharge_amount": 1000,
|
|
1390
|
-
* "daily_quota_cap": 5000
|
|
1365
|
+
* "amount": 5000,
|
|
1366
|
+
* "notes": "Bonus quota for premium customer"
|
|
1391
1367
|
* }
|
|
1392
1368
|
*/
|
|
1393
|
-
|
|
1369
|
+
app__models__sms_quota__quota_schemas__QuotaUpdateRequest: {
|
|
1394
1370
|
/** @description Channel type (sms or whatsapp) */
|
|
1395
1371
|
channel_type: components["schemas"]["ChannelType"];
|
|
1396
1372
|
/**
|
|
1397
|
-
*
|
|
1398
|
-
* @description
|
|
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;
|
|
1406
|
-
/**
|
|
1407
|
-
* Auto Recharge Amount
|
|
1408
|
-
* @description Amount to purchase on auto-recharge
|
|
1373
|
+
* Amount
|
|
1374
|
+
* @description Quota amount (positive to add, negative to subtract)
|
|
1409
1375
|
*/
|
|
1410
|
-
|
|
1376
|
+
amount: number;
|
|
1411
1377
|
/**
|
|
1412
|
-
*
|
|
1413
|
-
* @description
|
|
1378
|
+
* Notes
|
|
1379
|
+
* @description Reason for adjustment
|
|
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"];
|
|
1381
|
+
notes?: string | null;
|
|
1449
1382
|
};
|
|
1450
1383
|
/**
|
|
1451
1384
|
* RoutingRuleUpdateRequest
|
|
@@ -1480,138 +1413,77 @@ export interface components {
|
|
|
1480
1413
|
is_active?: boolean | null;
|
|
1481
1414
|
};
|
|
1482
1415
|
/**
|
|
1483
|
-
*
|
|
1484
|
-
* @description
|
|
1416
|
+
* DLTRegistrationUpdateRequest
|
|
1417
|
+
* @description Update DLT registration.
|
|
1485
1418
|
*/
|
|
1486
|
-
|
|
1487
|
-
/**
|
|
1488
|
-
* Credential Id
|
|
1489
|
-
* @description External ID of SMS credential
|
|
1490
|
-
*/
|
|
1491
|
-
credential_id: string;
|
|
1492
|
-
/**
|
|
1493
|
-
* Entity Id
|
|
1494
|
-
* @description DLT Entity ID from provider
|
|
1495
|
-
*/
|
|
1496
|
-
entity_id: string;
|
|
1497
|
-
/**
|
|
1498
|
-
* Sender Id
|
|
1499
|
-
* @description 6-char alphanumeric sender ID
|
|
1500
|
-
*/
|
|
1501
|
-
sender_id: string;
|
|
1502
|
-
/**
|
|
1503
|
-
* Template Id
|
|
1504
|
-
* @description Pre-registered template ID
|
|
1505
|
-
*/
|
|
1419
|
+
DLTRegistrationUpdateRequest: {
|
|
1420
|
+
/** Template Id */
|
|
1506
1421
|
template_id?: string | null;
|
|
1507
|
-
/**
|
|
1508
|
-
* Template Name
|
|
1509
|
-
* @description Human-friendly template name
|
|
1510
|
-
*/
|
|
1422
|
+
/** Template Name */
|
|
1511
1423
|
template_name?: string | null;
|
|
1512
|
-
/**
|
|
1513
|
-
* Template Content
|
|
1514
|
-
* @description Template with {#var#} placeholders
|
|
1515
|
-
*/
|
|
1424
|
+
/** Template Content */
|
|
1516
1425
|
template_content?: string | null;
|
|
1426
|
+
/** Template Type */
|
|
1427
|
+
template_type?: string | null;
|
|
1517
1428
|
/**
|
|
1518
|
-
*
|
|
1519
|
-
* @description
|
|
1520
|
-
* @default transactional
|
|
1429
|
+
* Registration Status
|
|
1430
|
+
* @description pending, approved, rejected, expired
|
|
1521
1431
|
*/
|
|
1522
|
-
|
|
1432
|
+
registration_status?: string | null;
|
|
1433
|
+
/** Is Active */
|
|
1434
|
+
is_active?: boolean | null;
|
|
1523
1435
|
};
|
|
1524
|
-
|
|
1436
|
+
ErrorResponse: {
|
|
1437
|
+
/** @example about:blank */
|
|
1438
|
+
type?: string;
|
|
1525
1439
|
/** @example GENERIC_ERROR */
|
|
1526
|
-
|
|
1527
|
-
/** @example
|
|
1528
|
-
|
|
1529
|
-
|
|
1530
|
-
|
|
1531
|
-
|
|
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"];
|
|
1532
1450
|
};
|
|
1533
1451
|
/**
|
|
1534
|
-
*
|
|
1535
|
-
* @description
|
|
1536
|
-
* @enum {string}
|
|
1537
|
-
*/
|
|
1538
|
-
ChannelType: "sms" | "whatsapp";
|
|
1539
|
-
/**
|
|
1540
|
-
* QuotaRefundRequest
|
|
1541
|
-
* @description Request schema for refunding quota.
|
|
1452
|
+
* QuotaSettingsUpdateRequest
|
|
1453
|
+
* @description Request schema for updating quota settings (auto-recharge, daily caps).
|
|
1542
1454
|
*
|
|
1543
1455
|
* Example:
|
|
1544
1456
|
* {
|
|
1545
1457
|
* "channel_type": "sms",
|
|
1546
|
-
* "
|
|
1547
|
-
* "
|
|
1548
|
-
* "
|
|
1458
|
+
* "auto_recharge_enabled": true,
|
|
1459
|
+
* "auto_recharge_threshold": 100,
|
|
1460
|
+
* "auto_recharge_amount": 1000,
|
|
1461
|
+
* "daily_quota_cap": 5000
|
|
1549
1462
|
* }
|
|
1550
1463
|
*/
|
|
1551
|
-
|
|
1464
|
+
QuotaSettingsUpdateRequest: {
|
|
1552
1465
|
/** @description Channel type (sms or whatsapp) */
|
|
1553
1466
|
channel_type: components["schemas"]["ChannelType"];
|
|
1554
1467
|
/**
|
|
1555
|
-
*
|
|
1556
|
-
* @description
|
|
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
|
|
1468
|
+
* Auto Recharge Enabled
|
|
1469
|
+
* @description Enable automatic quota recharge
|
|
1567
1470
|
*/
|
|
1568
|
-
|
|
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: {
|
|
1471
|
+
auto_recharge_enabled?: boolean | null;
|
|
1584
1472
|
/**
|
|
1585
|
-
*
|
|
1586
|
-
* @description
|
|
1473
|
+
* Auto Recharge Threshold
|
|
1474
|
+
* @description Trigger recharge when quota falls below this
|
|
1587
1475
|
*/
|
|
1588
|
-
|
|
1476
|
+
auto_recharge_threshold?: number | null;
|
|
1589
1477
|
/**
|
|
1590
|
-
*
|
|
1591
|
-
* @description
|
|
1478
|
+
* Auto Recharge Amount
|
|
1479
|
+
* @description Amount to purchase on auto-recharge
|
|
1592
1480
|
*/
|
|
1593
|
-
|
|
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;
|
|
1481
|
+
auto_recharge_amount?: number | null;
|
|
1608
1482
|
/**
|
|
1609
|
-
*
|
|
1610
|
-
* @description
|
|
1483
|
+
* Daily Quota Cap
|
|
1484
|
+
* @description Max SMS/WhatsApp per day (cost leakage prevention)
|
|
1611
1485
|
*/
|
|
1612
|
-
|
|
1613
|
-
/** Is Active */
|
|
1614
|
-
is_active?: boolean | null;
|
|
1486
|
+
daily_quota_cap?: number | null;
|
|
1615
1487
|
};
|
|
1616
1488
|
/**
|
|
1617
1489
|
* RoutingRuleCreateRequest
|
|
@@ -1691,30 +1563,93 @@ export interface components {
|
|
|
1691
1563
|
*/
|
|
1692
1564
|
sms_hourly_limit: number;
|
|
1693
1565
|
};
|
|
1566
|
+
Extensions: {
|
|
1567
|
+
/** @example GENERIC_ERROR */
|
|
1568
|
+
message_code?: string;
|
|
1569
|
+
/** @example [] */
|
|
1570
|
+
invalid_params?: components["schemas"]["InvalidParam"][];
|
|
1571
|
+
extra_data?: Record<string, never> | null;
|
|
1572
|
+
/** @example Detailed debug information */
|
|
1573
|
+
debug?: string | null;
|
|
1574
|
+
};
|
|
1575
|
+
InvalidParam: {
|
|
1576
|
+
/** @example items[0].quantity */
|
|
1577
|
+
field?: string;
|
|
1578
|
+
/** @example Input should be greater than or equal to 1 */
|
|
1579
|
+
error?: string;
|
|
1580
|
+
};
|
|
1694
1581
|
/**
|
|
1695
|
-
*
|
|
1696
|
-
* @description
|
|
1582
|
+
* ChannelType
|
|
1583
|
+
* @description Channel types for quota.
|
|
1584
|
+
* @enum {string}
|
|
1585
|
+
*/
|
|
1586
|
+
ChannelType: "sms" | "whatsapp";
|
|
1587
|
+
/**
|
|
1588
|
+
* CredentialUpdateRequest
|
|
1589
|
+
* @description Request schema for updating an existing credential.
|
|
1590
|
+
*
|
|
1591
|
+
* CRITICAL: Only display_name and is_default can be updated.
|
|
1592
|
+
* To change credentials, delete and recreate (security best practice).
|
|
1697
1593
|
*
|
|
1698
1594
|
* Example:
|
|
1699
1595
|
* {
|
|
1700
|
-
* "
|
|
1701
|
-
* "
|
|
1702
|
-
* "notes": "Bonus quota for premium customer"
|
|
1596
|
+
* "display_name": "Updated Marketing SMTP",
|
|
1597
|
+
* "is_default": true
|
|
1703
1598
|
* }
|
|
1704
1599
|
*/
|
|
1705
|
-
|
|
1706
|
-
/** @description Channel type (sms or whatsapp) */
|
|
1707
|
-
channel_type: components["schemas"]["ChannelType"];
|
|
1600
|
+
CredentialUpdateRequest: {
|
|
1708
1601
|
/**
|
|
1709
|
-
*
|
|
1710
|
-
* @description
|
|
1602
|
+
* Display Name
|
|
1603
|
+
* @description User-friendly name
|
|
1711
1604
|
*/
|
|
1712
|
-
|
|
1605
|
+
display_name?: string | null;
|
|
1713
1606
|
/**
|
|
1714
|
-
*
|
|
1715
|
-
* @description
|
|
1607
|
+
* Is Default
|
|
1608
|
+
* @description Set as default credential
|
|
1716
1609
|
*/
|
|
1717
|
-
|
|
1610
|
+
is_default?: boolean | null;
|
|
1611
|
+
};
|
|
1612
|
+
/**
|
|
1613
|
+
* DLTRegistrationCreateRequest
|
|
1614
|
+
* @description Create a new DLT registration (India compliance).
|
|
1615
|
+
*/
|
|
1616
|
+
DLTRegistrationCreateRequest: {
|
|
1617
|
+
/**
|
|
1618
|
+
* Credential Id
|
|
1619
|
+
* @description External ID of SMS credential
|
|
1620
|
+
*/
|
|
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;
|
|
1718
1653
|
};
|
|
1719
1654
|
/**
|
|
1720
1655
|
* CredentialCreateRequest
|
|
@@ -1773,6 +1708,59 @@ export interface components {
|
|
|
1773
1708
|
*/
|
|
1774
1709
|
is_default: boolean;
|
|
1775
1710
|
};
|
|
1711
|
+
/**
|
|
1712
|
+
* QuotaRefundRequest
|
|
1713
|
+
* @description Request schema for refunding quota.
|
|
1714
|
+
*
|
|
1715
|
+
* Example:
|
|
1716
|
+
* {
|
|
1717
|
+
* "channel_type": "sms",
|
|
1718
|
+
* "amount": 1000,
|
|
1719
|
+
* "refund_reference_id": "refund_abc123",
|
|
1720
|
+
* "notes": "Refund for unused quota"
|
|
1721
|
+
* }
|
|
1722
|
+
*/
|
|
1723
|
+
QuotaRefundRequest: {
|
|
1724
|
+
/** @description Channel type (sms or whatsapp) */
|
|
1725
|
+
channel_type: components["schemas"]["ChannelType"];
|
|
1726
|
+
/**
|
|
1727
|
+
* Amount
|
|
1728
|
+
* @description Quota amount to refund
|
|
1729
|
+
*/
|
|
1730
|
+
amount: number;
|
|
1731
|
+
/**
|
|
1732
|
+
* Refund Reference Id
|
|
1733
|
+
* @description Refund reference ID
|
|
1734
|
+
*/
|
|
1735
|
+
refund_reference_id?: string | null;
|
|
1736
|
+
/**
|
|
1737
|
+
* Notes
|
|
1738
|
+
* @description Refund reason
|
|
1739
|
+
*/
|
|
1740
|
+
notes?: string | null;
|
|
1741
|
+
};
|
|
1742
|
+
/**
|
|
1743
|
+
* CapabilityCheckRequest
|
|
1744
|
+
* @description Check channel capability for a recipient.
|
|
1745
|
+
*/
|
|
1746
|
+
CapabilityCheckRequest: {
|
|
1747
|
+
/**
|
|
1748
|
+
* Channel
|
|
1749
|
+
* @description Channel to check: sms, email, whatsapp
|
|
1750
|
+
*/
|
|
1751
|
+
channel: string;
|
|
1752
|
+
/**
|
|
1753
|
+
* Recipient
|
|
1754
|
+
* @description Phone (E.164) or email address
|
|
1755
|
+
*/
|
|
1756
|
+
recipient: string;
|
|
1757
|
+
/**
|
|
1758
|
+
* Purpose
|
|
1759
|
+
* @description Purpose: otp, marketing, transactional
|
|
1760
|
+
* @default otp
|
|
1761
|
+
*/
|
|
1762
|
+
purpose: string;
|
|
1763
|
+
};
|
|
1776
1764
|
/**
|
|
1777
1765
|
* QuotaPurchaseRequest
|
|
1778
1766
|
* @description Request schema for purchasing SMS/WhatsApp quota.
|
|
@@ -1806,20 +1794,32 @@ export interface components {
|
|
|
1806
1794
|
*/
|
|
1807
1795
|
idempotency_key: string;
|
|
1808
1796
|
};
|
|
1809
|
-
|
|
1810
|
-
|
|
1811
|
-
|
|
1812
|
-
|
|
1813
|
-
|
|
1814
|
-
|
|
1815
|
-
|
|
1816
|
-
|
|
1817
|
-
|
|
1818
|
-
|
|
1819
|
-
|
|
1820
|
-
|
|
1821
|
-
|
|
1822
|
-
|
|
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
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: {
|