@blezgo/api-sdk 0.1.2 → 0.1.4
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 +183 -183
- 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 +88 -88
- package/dist/addon/generated.d.ts.map +1 -1
- package/dist/admin/generated.d.ts +42 -42
- package/dist/admin/generated.d.ts.map +1 -1
- package/dist/affiliate/generated.d.ts +97 -98
- package/dist/affiliate/generated.d.ts.map +1 -1
- package/dist/analytics/generated.d.ts +27 -27
- package/dist/analytics/generated.d.ts.map +1 -1
- package/dist/announcements/generated.d.ts +118 -118
- package/dist/announcements/generated.d.ts.map +1 -1
- package/dist/apikeys/generated.d.ts +46 -46
- package/dist/apikeys/generated.d.ts.map +1 -1
- package/dist/assistance/generated.d.ts +24 -24
- package/dist/assistance/generated.d.ts.map +1 -1
- package/dist/authentication/generated.d.ts +73 -73
- package/dist/authentication/generated.d.ts.map +1 -1
- package/dist/blog/generated.d.ts +142 -142
- package/dist/blog/generated.d.ts.map +1 -1
- package/dist/bundle/generated.d.ts +124 -124
- package/dist/bundle/generated.d.ts.map +1 -1
- package/dist/cache/generated.d.ts +32 -32
- package/dist/cache/generated.d.ts.map +1 -1
- package/dist/calendar/generated.d.ts +59 -59
- package/dist/calendar/generated.d.ts.map +1 -1
- package/dist/campaigns/generated.d.ts +151 -151
- package/dist/campaigns/generated.d.ts.map +1 -1
- package/dist/cart/generated.d.ts +41 -41
- package/dist/cart/generated.d.ts.map +1 -1
- package/dist/changelog/generated.d.ts +90 -90
- package/dist/changelog/generated.d.ts.map +1 -1
- package/dist/channel/generated.d.ts +256 -256
- package/dist/channel/generated.d.ts.map +1 -1
- package/dist/company/generated.d.ts +73 -73
- package/dist/company/generated.d.ts.map +1 -1
- package/dist/conference/generated.d.ts +160 -160
- package/dist/conference/generated.d.ts.map +1 -1
- package/dist/config/generated.d.ts +57 -57
- package/dist/config/generated.d.ts.map +1 -1
- package/dist/content/generated.d.ts +620 -620
- package/dist/content/generated.d.ts.map +1 -1
- package/dist/cookies/generated.d.ts +85 -85
- package/dist/cookies/generated.d.ts.map +1 -1
- package/dist/courses/generated.d.ts +381 -381
- package/dist/courses/generated.d.ts.map +1 -1
- package/dist/custom/generated.d.ts +103 -103
- package/dist/custom/generated.d.ts.map +1 -1
- package/dist/dashboard/generated.d.ts +148 -148
- package/dist/dashboard/generated.d.ts.map +1 -1
- package/dist/elasticsearch/generated.d.ts +37 -37
- 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 +21 -21
- package/dist/errors/generated.d.ts.map +1 -1
- package/dist/eventconfig/generated.d.ts +88 -88
- package/dist/eventconfig/generated.d.ts.map +1 -1
- package/dist/funnels/generated.d.ts +124 -125
- package/dist/funnels/generated.d.ts.map +1 -1
- package/dist/gamification/generated.d.ts +151 -151
- package/dist/gamification/generated.d.ts.map +1 -1
- package/dist/impersonation/generated.d.ts +33 -33
- package/dist/impersonation/generated.d.ts.map +1 -1
- package/dist/inbox/generated.d.ts +154 -154
- 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 +23 -23
- package/dist/internationalization/generated.d.ts.map +1 -1
- package/dist/invitations/generated.d.ts +107 -107
- package/dist/invitations/generated.d.ts.map +1 -1
- package/dist/meetings/generated.d.ts +332 -332
- package/dist/meetings/generated.d.ts.map +1 -1
- package/dist/metas/generated.d.ts +200 -200
- package/dist/metas/generated.d.ts.map +1 -1
- package/dist/notification/generated.d.ts +279 -279
- 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 +95 -95
- package/dist/onboarding/generated.d.ts.map +1 -1
- package/dist/packages/generated.d.ts +77 -77
- package/dist/packages/generated.d.ts.map +1 -1
- package/dist/payments/generated.d.ts +628 -631
- 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 +405 -405
- package/dist/plans/generated.d.ts.map +1 -1
- package/dist/pricing/generated.d.ts +75 -75
- package/dist/pricing/generated.d.ts.map +1 -1
- package/dist/products/generated.d.ts +420 -420
- package/dist/products/generated.d.ts.map +1 -1
- package/dist/profile/generated.d.ts +310 -310
- package/dist/profile/generated.d.ts.map +1 -1
- package/dist/reasons/generated.d.ts +64 -64
- package/dist/reasons/generated.d.ts.map +1 -1
- package/dist/registration/generated.d.ts +163 -163
- package/dist/registration/generated.d.ts.map +1 -1
- package/dist/reviews/generated.d.ts +47 -47
- package/dist/reviews/generated.d.ts.map +1 -1
- package/dist/role/generated.d.ts +944 -446
- package/dist/role/generated.d.ts.map +1 -1
- package/dist/scheduling/generated.d.ts +76 -76
- package/dist/scheduling/generated.d.ts.map +1 -1
- package/dist/services/generated.d.ts +1119 -1119
- package/dist/services/generated.d.ts.map +1 -1
- package/dist/sessions/generated.d.ts +313 -313
- package/dist/sessions/generated.d.ts.map +1 -1
- package/dist/spaces/generated.d.ts +340 -340
- 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 +1624 -1624
- package/dist/support/generated.d.ts.map +1 -1
- package/dist/sync/generated.d.ts +176 -176
- package/dist/sync/generated.d.ts.map +1 -1
- package/dist/tenant/generated.d.ts +487 -487
- package/dist/tenant/generated.d.ts.map +1 -1
- package/dist/testimonials/generated.d.ts +86 -86
- package/dist/testimonials/generated.d.ts.map +1 -1
- package/dist/tests/generated.d.ts +456 -456
- 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 +65 -65
- package/dist/uploads/generated.d.ts.map +1 -1
- package/dist/upsell/generated.d.ts +105 -105
- package/dist/upsell/generated.d.ts.map +1 -1
- package/dist/user/generated.d.ts +272 -527
- package/dist/user/generated.d.ts.map +1 -1
- package/dist/webinars/generated.d.ts +260 -260
- package/dist/webinars/generated.d.ts.map +1 -1
- package/package.json +1 -1
- package/test-commit.txt +1 -0
|
@@ -1356,68 +1356,129 @@ export type webhooks = Record<string, never>;
|
|
|
1356
1356
|
export interface components {
|
|
1357
1357
|
schemas: {
|
|
1358
1358
|
/**
|
|
1359
|
-
*
|
|
1360
|
-
* @description
|
|
1361
|
-
|
|
1362
|
-
|
|
1363
|
-
|
|
1364
|
-
|
|
1365
|
-
|
|
1366
|
-
|
|
1367
|
-
|
|
1368
|
-
|
|
1369
|
-
|
|
1370
|
-
|
|
1371
|
-
|
|
1372
|
-
|
|
1373
|
-
|
|
1374
|
-
|
|
1375
|
-
|
|
1376
|
-
|
|
1359
|
+
* CapabilityCheckRequest
|
|
1360
|
+
* @description Check channel capability for a recipient.
|
|
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).
|
|
1377
1383
|
*
|
|
1378
|
-
* Example
|
|
1384
|
+
* Example:
|
|
1379
1385
|
* {
|
|
1380
|
-
* "
|
|
1381
|
-
* "
|
|
1382
|
-
* "
|
|
1383
|
-
*
|
|
1384
|
-
*
|
|
1385
|
-
* "from_number": "+15551234567"
|
|
1386
|
-
* },
|
|
1387
|
-
* "is_default": false
|
|
1386
|
+
* "channel_type": "sms",
|
|
1387
|
+
* "auto_recharge_enabled": true,
|
|
1388
|
+
* "auto_recharge_threshold": 100,
|
|
1389
|
+
* "auto_recharge_amount": 1000,
|
|
1390
|
+
* "daily_quota_cap": 5000
|
|
1388
1391
|
* }
|
|
1389
1392
|
*/
|
|
1390
|
-
|
|
1393
|
+
QuotaSettingsUpdateRequest: {
|
|
1394
|
+
/** @description Channel type (sms or whatsapp) */
|
|
1395
|
+
channel_type: components["schemas"]["ChannelType"];
|
|
1391
1396
|
/**
|
|
1392
|
-
*
|
|
1393
|
-
* @description
|
|
1397
|
+
* Auto Recharge Enabled
|
|
1398
|
+
* @description Enable automatic quota recharge
|
|
1394
1399
|
*/
|
|
1395
|
-
|
|
1400
|
+
auto_recharge_enabled?: boolean | null;
|
|
1396
1401
|
/**
|
|
1397
|
-
*
|
|
1398
|
-
* @description
|
|
1402
|
+
* Auto Recharge Threshold
|
|
1403
|
+
* @description Trigger recharge when quota falls below this
|
|
1399
1404
|
*/
|
|
1400
|
-
|
|
1405
|
+
auto_recharge_threshold?: number | null;
|
|
1401
1406
|
/**
|
|
1402
|
-
*
|
|
1403
|
-
* @description
|
|
1407
|
+
* Auto Recharge Amount
|
|
1408
|
+
* @description Amount to purchase on auto-recharge
|
|
1404
1409
|
*/
|
|
1405
|
-
|
|
1406
|
-
[key: string]: unknown;
|
|
1407
|
-
};
|
|
1410
|
+
auto_recharge_amount?: number | null;
|
|
1408
1411
|
/**
|
|
1409
|
-
*
|
|
1410
|
-
* @description
|
|
1411
|
-
* @default false
|
|
1412
|
+
* Daily Quota Cap
|
|
1413
|
+
* @description Max SMS/WhatsApp per day (cost leakage prevention)
|
|
1412
1414
|
*/
|
|
1413
|
-
|
|
1415
|
+
daily_quota_cap?: number | null;
|
|
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;
|
|
1414
1422
|
};
|
|
1415
1423
|
/**
|
|
1416
|
-
*
|
|
1417
|
-
*
|
|
1418
|
-
*
|
|
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
|
+
* }
|
|
1419
1438
|
*/
|
|
1420
|
-
|
|
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;
|
|
1481
|
+
};
|
|
1421
1482
|
/**
|
|
1422
1483
|
* DLTRegistrationCreateRequest
|
|
1423
1484
|
* @description Create a new DLT registration (India compliance).
|
|
@@ -1460,78 +1521,97 @@ export interface components {
|
|
|
1460
1521
|
*/
|
|
1461
1522
|
template_type: string;
|
|
1462
1523
|
};
|
|
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
|
+
};
|
|
1463
1533
|
/**
|
|
1464
|
-
*
|
|
1465
|
-
* @description
|
|
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.
|
|
1466
1542
|
*
|
|
1467
1543
|
* Example:
|
|
1468
1544
|
* {
|
|
1469
1545
|
* "channel_type": "sms",
|
|
1470
|
-
* "amount":
|
|
1471
|
-
* "
|
|
1546
|
+
* "amount": 1000,
|
|
1547
|
+
* "refund_reference_id": "refund_abc123",
|
|
1548
|
+
* "notes": "Refund for unused quota"
|
|
1472
1549
|
* }
|
|
1473
1550
|
*/
|
|
1474
|
-
|
|
1551
|
+
QuotaRefundRequest: {
|
|
1475
1552
|
/** @description Channel type (sms or whatsapp) */
|
|
1476
1553
|
channel_type: components["schemas"]["ChannelType"];
|
|
1477
1554
|
/**
|
|
1478
1555
|
* Amount
|
|
1479
|
-
* @description Quota amount
|
|
1556
|
+
* @description Quota amount to refund
|
|
1480
1557
|
*/
|
|
1481
1558
|
amount: number;
|
|
1559
|
+
/**
|
|
1560
|
+
* Refund Reference Id
|
|
1561
|
+
* @description Refund reference ID
|
|
1562
|
+
*/
|
|
1563
|
+
refund_reference_id?: string | null;
|
|
1482
1564
|
/**
|
|
1483
1565
|
* Notes
|
|
1484
|
-
* @description
|
|
1566
|
+
* @description Refund reason
|
|
1485
1567
|
*/
|
|
1486
1568
|
notes?: string | null;
|
|
1487
1569
|
};
|
|
1488
1570
|
/**
|
|
1489
|
-
*
|
|
1490
|
-
* @description Request schema for
|
|
1571
|
+
* CredentialUpdateRequest
|
|
1572
|
+
* @description Request schema for updating an existing credential.
|
|
1491
1573
|
*
|
|
1492
|
-
* CRITICAL:
|
|
1574
|
+
* CRITICAL: Only display_name and is_default can be updated.
|
|
1575
|
+
* To change credentials, delete and recreate (security best practice).
|
|
1493
1576
|
*
|
|
1494
1577
|
* Example:
|
|
1495
1578
|
* {
|
|
1496
|
-
* "
|
|
1497
|
-
* "
|
|
1498
|
-
* "payment_reference_id": "pay_abc123xyz",
|
|
1499
|
-
* "idempotency_key": "purchase_20260129_123456_org123"
|
|
1579
|
+
* "display_name": "Updated Marketing SMTP",
|
|
1580
|
+
* "is_default": true
|
|
1500
1581
|
* }
|
|
1501
1582
|
*/
|
|
1502
|
-
|
|
1503
|
-
/** @description Channel type (sms or whatsapp) */
|
|
1504
|
-
channel_type: components["schemas"]["ChannelType"];
|
|
1583
|
+
CredentialUpdateRequest: {
|
|
1505
1584
|
/**
|
|
1506
|
-
*
|
|
1507
|
-
* @description
|
|
1585
|
+
* Display Name
|
|
1586
|
+
* @description User-friendly name
|
|
1508
1587
|
*/
|
|
1509
|
-
|
|
1588
|
+
display_name?: string | null;
|
|
1510
1589
|
/**
|
|
1511
|
-
*
|
|
1512
|
-
* @description
|
|
1590
|
+
* Is Default
|
|
1591
|
+
* @description Set as default credential
|
|
1513
1592
|
*/
|
|
1514
|
-
|
|
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;
|
|
1515
1608
|
/**
|
|
1516
|
-
*
|
|
1517
|
-
* @description
|
|
1609
|
+
* Registration Status
|
|
1610
|
+
* @description pending, approved, rejected, expired
|
|
1518
1611
|
*/
|
|
1519
|
-
|
|
1520
|
-
|
|
1521
|
-
|
|
1522
|
-
/** @example about:blank */
|
|
1523
|
-
type?: string;
|
|
1524
|
-
/** @example GENERIC_ERROR */
|
|
1525
|
-
code?: string;
|
|
1526
|
-
/** @example Client Error */
|
|
1527
|
-
title?: string;
|
|
1528
|
-
/** @example 400 */
|
|
1529
|
-
status?: number;
|
|
1530
|
-
/** @example An error occurred */
|
|
1531
|
-
detail?: string;
|
|
1532
|
-
/** @example /v1/cart/items */
|
|
1533
|
-
instance?: string;
|
|
1534
|
-
extensions?: components["schemas"]["Extensions"];
|
|
1612
|
+
registration_status?: string | null;
|
|
1613
|
+
/** Is Active */
|
|
1614
|
+
is_active?: boolean | null;
|
|
1535
1615
|
};
|
|
1536
1616
|
/**
|
|
1537
1617
|
* RoutingRuleCreateRequest
|
|
@@ -1612,214 +1692,134 @@ export interface components {
|
|
|
1612
1692
|
sms_hourly_limit: number;
|
|
1613
1693
|
};
|
|
1614
1694
|
/**
|
|
1615
|
-
*
|
|
1616
|
-
* @description Request schema for
|
|
1617
|
-
*
|
|
1618
|
-
* Example:
|
|
1619
|
-
* {
|
|
1620
|
-
* "channel_type": "sms",
|
|
1621
|
-
* "auto_recharge_enabled": true,
|
|
1622
|
-
* "auto_recharge_threshold": 100,
|
|
1623
|
-
* "auto_recharge_amount": 1000,
|
|
1624
|
-
* "daily_quota_cap": 5000
|
|
1625
|
-
* }
|
|
1626
|
-
*/
|
|
1627
|
-
QuotaSettingsUpdateRequest: {
|
|
1628
|
-
/** @description Channel type (sms or whatsapp) */
|
|
1629
|
-
channel_type: components["schemas"]["ChannelType"];
|
|
1630
|
-
/**
|
|
1631
|
-
* Auto Recharge Enabled
|
|
1632
|
-
* @description Enable automatic quota recharge
|
|
1633
|
-
*/
|
|
1634
|
-
auto_recharge_enabled?: boolean | null;
|
|
1635
|
-
/**
|
|
1636
|
-
* Auto Recharge Threshold
|
|
1637
|
-
* @description Trigger recharge when quota falls below this
|
|
1638
|
-
*/
|
|
1639
|
-
auto_recharge_threshold?: number | null;
|
|
1640
|
-
/**
|
|
1641
|
-
* Auto Recharge Amount
|
|
1642
|
-
* @description Amount to purchase on auto-recharge
|
|
1643
|
-
*/
|
|
1644
|
-
auto_recharge_amount?: number | null;
|
|
1645
|
-
/**
|
|
1646
|
-
* Daily Quota Cap
|
|
1647
|
-
* @description Max SMS/WhatsApp per day (cost leakage prevention)
|
|
1648
|
-
*/
|
|
1649
|
-
daily_quota_cap?: number | null;
|
|
1650
|
-
};
|
|
1651
|
-
/**
|
|
1652
|
-
* QuotaRefundRequest
|
|
1653
|
-
* @description Request schema for refunding quota.
|
|
1695
|
+
* QuotaUpdateRequest
|
|
1696
|
+
* @description Request schema for admin quota adjustments (add/subtract quota manually).
|
|
1654
1697
|
*
|
|
1655
1698
|
* Example:
|
|
1656
1699
|
* {
|
|
1657
1700
|
* "channel_type": "sms",
|
|
1658
|
-
* "amount":
|
|
1659
|
-
* "
|
|
1660
|
-
* "notes": "Refund for unused quota"
|
|
1701
|
+
* "amount": 5000,
|
|
1702
|
+
* "notes": "Bonus quota for premium customer"
|
|
1661
1703
|
* }
|
|
1662
1704
|
*/
|
|
1663
|
-
|
|
1705
|
+
QuotaUpdateRequest: {
|
|
1664
1706
|
/** @description Channel type (sms or whatsapp) */
|
|
1665
1707
|
channel_type: components["schemas"]["ChannelType"];
|
|
1666
1708
|
/**
|
|
1667
1709
|
* Amount
|
|
1668
|
-
* @description Quota amount to
|
|
1710
|
+
* @description Quota amount (positive to add, negative to subtract)
|
|
1669
1711
|
*/
|
|
1670
1712
|
amount: number;
|
|
1671
|
-
/**
|
|
1672
|
-
* Refund Reference Id
|
|
1673
|
-
* @description Refund reference ID
|
|
1674
|
-
*/
|
|
1675
|
-
refund_reference_id?: string | null;
|
|
1676
1713
|
/**
|
|
1677
1714
|
* Notes
|
|
1678
|
-
* @description
|
|
1715
|
+
* @description Reason for adjustment
|
|
1679
1716
|
*/
|
|
1680
1717
|
notes?: string | null;
|
|
1681
1718
|
};
|
|
1682
1719
|
/**
|
|
1683
|
-
*
|
|
1684
|
-
* @description Request schema for
|
|
1685
|
-
*
|
|
1686
|
-
* CRITICAL: Only display_name and is_default can be updated.
|
|
1687
|
-
* To change credentials, delete and recreate (security best practice).
|
|
1720
|
+
* CredentialCreateRequest
|
|
1721
|
+
* @description Request schema for creating a new channel credential.
|
|
1688
1722
|
*
|
|
1689
|
-
* Example:
|
|
1723
|
+
* Example (SMTP):
|
|
1690
1724
|
* {
|
|
1691
|
-
* "
|
|
1725
|
+
* "provider_code": "smtp",
|
|
1726
|
+
* "display_name": "Marketing SMTP",
|
|
1727
|
+
* "credentials": {
|
|
1728
|
+
* "host": "smtp.gmail.com",
|
|
1729
|
+
* "port": 587,
|
|
1730
|
+
* "user": "marketing@example.com",
|
|
1731
|
+
* "password": "app_password_here",
|
|
1732
|
+
* "from_email": "marketing@example.com",
|
|
1733
|
+
* "from_name": "Marketing Team",
|
|
1734
|
+
* "use_tls": true
|
|
1735
|
+
* },
|
|
1692
1736
|
* "is_default": true
|
|
1693
1737
|
* }
|
|
1738
|
+
*
|
|
1739
|
+
* Example (Twilio SMS):
|
|
1740
|
+
* {
|
|
1741
|
+
* "provider_code": "twilio_sms",
|
|
1742
|
+
* "display_name": "Main Twilio Account",
|
|
1743
|
+
* "credentials": {
|
|
1744
|
+
* "account_sid": "AC1234567890abcdef1234567890abcdef",
|
|
1745
|
+
* "auth_token": "your_auth_token_here",
|
|
1746
|
+
* "from_number": "+15551234567"
|
|
1747
|
+
* },
|
|
1748
|
+
* "is_default": false
|
|
1749
|
+
* }
|
|
1694
1750
|
*/
|
|
1695
|
-
|
|
1751
|
+
CredentialCreateRequest: {
|
|
1752
|
+
/**
|
|
1753
|
+
* Provider Code
|
|
1754
|
+
* @description Provider code (smtp, ses_email_identity, twilio_sms, etc.)
|
|
1755
|
+
*/
|
|
1756
|
+
provider_code: string;
|
|
1696
1757
|
/**
|
|
1697
1758
|
* Display Name
|
|
1698
|
-
* @description User-friendly name
|
|
1759
|
+
* @description User-friendly name (e.g., 'Marketing SMTP')
|
|
1699
1760
|
*/
|
|
1700
1761
|
display_name?: string | null;
|
|
1762
|
+
/**
|
|
1763
|
+
* Credentials
|
|
1764
|
+
* @description Provider-specific credentials (will be encrypted)
|
|
1765
|
+
*/
|
|
1766
|
+
credentials: {
|
|
1767
|
+
[key: string]: unknown;
|
|
1768
|
+
};
|
|
1701
1769
|
/**
|
|
1702
1770
|
* Is Default
|
|
1703
|
-
* @description Set as default credential
|
|
1771
|
+
* @description Set as default credential for this channel type
|
|
1772
|
+
* @default false
|
|
1704
1773
|
*/
|
|
1705
|
-
is_default
|
|
1774
|
+
is_default: boolean;
|
|
1706
1775
|
};
|
|
1707
1776
|
/**
|
|
1708
|
-
*
|
|
1709
|
-
* @description
|
|
1777
|
+
* QuotaPurchaseRequest
|
|
1778
|
+
* @description Request schema for purchasing SMS/WhatsApp quota.
|
|
1779
|
+
*
|
|
1780
|
+
* CRITICAL: idempotency_key MUST be unique per purchase to prevent duplicate charges.
|
|
1781
|
+
*
|
|
1782
|
+
* Example:
|
|
1783
|
+
* {
|
|
1784
|
+
* "channel_type": "sms",
|
|
1785
|
+
* "amount": 1000,
|
|
1786
|
+
* "payment_reference_id": "pay_abc123xyz",
|
|
1787
|
+
* "idempotency_key": "purchase_20260129_123456_org123"
|
|
1788
|
+
* }
|
|
1710
1789
|
*/
|
|
1711
|
-
|
|
1790
|
+
QuotaPurchaseRequest: {
|
|
1791
|
+
/** @description Channel type (sms or whatsapp) */
|
|
1792
|
+
channel_type: components["schemas"]["ChannelType"];
|
|
1712
1793
|
/**
|
|
1713
|
-
*
|
|
1714
|
-
* @description
|
|
1794
|
+
* Amount
|
|
1795
|
+
* @description Quota amount to purchase (1-1,000,000)
|
|
1715
1796
|
*/
|
|
1716
|
-
|
|
1797
|
+
amount: number;
|
|
1717
1798
|
/**
|
|
1718
|
-
*
|
|
1719
|
-
* @description
|
|
1799
|
+
* Payment Reference Id
|
|
1800
|
+
* @description Payment gateway reference ID
|
|
1720
1801
|
*/
|
|
1721
|
-
|
|
1802
|
+
payment_reference_id?: string | null;
|
|
1722
1803
|
/**
|
|
1723
|
-
*
|
|
1724
|
-
* @description
|
|
1725
|
-
* @default otp
|
|
1804
|
+
* Idempotency Key
|
|
1805
|
+
* @description Unique key to prevent duplicate purchases (e.g., purchase_YYYYMMDD_HHMMSS_orgID)
|
|
1726
1806
|
*/
|
|
1727
|
-
|
|
1807
|
+
idempotency_key: string;
|
|
1728
1808
|
};
|
|
1729
|
-
|
|
1809
|
+
ErrorResponse: {
|
|
1810
|
+
/** @example about:blank */
|
|
1811
|
+
type?: string;
|
|
1730
1812
|
/** @example GENERIC_ERROR */
|
|
1731
|
-
|
|
1732
|
-
/** @example
|
|
1733
|
-
|
|
1734
|
-
|
|
1735
|
-
|
|
1736
|
-
|
|
1737
|
-
|
|
1738
|
-
|
|
1739
|
-
|
|
1740
|
-
|
|
1741
|
-
* "message": "Operation successful",
|
|
1742
|
-
* "message_code": "api_suc_20001",
|
|
1743
|
-
* "data": {},
|
|
1744
|
-
* "metadata": {
|
|
1745
|
-
* "timestamp": "2026-03-26T10:00:00.000Z",
|
|
1746
|
-
* "requestId": "07e22004-cb60-4dfc-bc9c-b6f99664dca1",
|
|
1747
|
-
* "traceId": "a9f1204c-bb82-41de-b234-7c3a9e120000",
|
|
1748
|
-
* "version": "v1",
|
|
1749
|
-
* "executionTime": 42,
|
|
1750
|
-
* "language": "en-US"
|
|
1751
|
-
* }
|
|
1752
|
-
* }
|
|
1753
|
-
*/
|
|
1754
|
-
StandardResponse: {
|
|
1755
|
-
/** @example success */
|
|
1756
|
-
status?: string;
|
|
1757
|
-
data?: Record<string, never> | null;
|
|
1758
|
-
/** @example Operation successful */
|
|
1759
|
-
message?: string | null;
|
|
1760
|
-
/** @example api_suc_20001 */
|
|
1761
|
-
message_code?: string | null;
|
|
1762
|
-
metadata?: Record<string, never> | null;
|
|
1763
|
-
error?: components["schemas"]["ErrorResponse"];
|
|
1764
|
-
};
|
|
1765
|
-
InvalidParam: {
|
|
1766
|
-
/** @example items[0].quantity */
|
|
1767
|
-
field?: string;
|
|
1768
|
-
/** @example Input should be greater than or equal to 1 */
|
|
1769
|
-
error?: string;
|
|
1770
|
-
};
|
|
1771
|
-
/**
|
|
1772
|
-
* RoutingRuleUpdateRequest
|
|
1773
|
-
* @description Update an existing routing rule.
|
|
1774
|
-
*/
|
|
1775
|
-
RoutingRuleUpdateRequest: {
|
|
1776
|
-
/** Primary Channel */
|
|
1777
|
-
primary_channel?: string | null;
|
|
1778
|
-
/** Fallback Channel */
|
|
1779
|
-
fallback_channel?: string | null;
|
|
1780
|
-
/** Sms Credential Id */
|
|
1781
|
-
sms_credential_id?: string | null;
|
|
1782
|
-
/** Whatsapp Credential Id */
|
|
1783
|
-
whatsapp_credential_id?: string | null;
|
|
1784
|
-
/** Email Credential Id */
|
|
1785
|
-
email_credential_id?: string | null;
|
|
1786
|
-
/** Sms Enabled */
|
|
1787
|
-
sms_enabled?: boolean | null;
|
|
1788
|
-
/** Sms Requires Dlt */
|
|
1789
|
-
sms_requires_dlt?: boolean | null;
|
|
1790
|
-
/** Sms Requires Sender Id */
|
|
1791
|
-
sms_requires_sender_id?: boolean | null;
|
|
1792
|
-
/** Whatsapp Enabled */
|
|
1793
|
-
whatsapp_enabled?: boolean | null;
|
|
1794
|
-
/** Email Enabled */
|
|
1795
|
-
email_enabled?: boolean | null;
|
|
1796
|
-
/** Sms Daily Limit */
|
|
1797
|
-
sms_daily_limit?: number | null;
|
|
1798
|
-
/** Sms Hourly Limit */
|
|
1799
|
-
sms_hourly_limit?: number | null;
|
|
1800
|
-
/** Is Active */
|
|
1801
|
-
is_active?: boolean | null;
|
|
1802
|
-
};
|
|
1803
|
-
/**
|
|
1804
|
-
* DLTRegistrationUpdateRequest
|
|
1805
|
-
* @description Update DLT registration.
|
|
1806
|
-
*/
|
|
1807
|
-
DLTRegistrationUpdateRequest: {
|
|
1808
|
-
/** Template Id */
|
|
1809
|
-
template_id?: string | null;
|
|
1810
|
-
/** Template Name */
|
|
1811
|
-
template_name?: string | null;
|
|
1812
|
-
/** Template Content */
|
|
1813
|
-
template_content?: string | null;
|
|
1814
|
-
/** Template Type */
|
|
1815
|
-
template_type?: string | null;
|
|
1816
|
-
/**
|
|
1817
|
-
* Registration Status
|
|
1818
|
-
* @description pending, approved, rejected, expired
|
|
1819
|
-
*/
|
|
1820
|
-
registration_status?: string | null;
|
|
1821
|
-
/** Is Active */
|
|
1822
|
-
is_active?: boolean | null;
|
|
1813
|
+
code?: string;
|
|
1814
|
+
/** @example Client Error */
|
|
1815
|
+
title?: string;
|
|
1816
|
+
/** @example 400 */
|
|
1817
|
+
status?: number;
|
|
1818
|
+
/** @example An error occurred */
|
|
1819
|
+
detail?: string;
|
|
1820
|
+
/** @example /v1/cart/items */
|
|
1821
|
+
instance?: string;
|
|
1822
|
+
extensions?: components["schemas"]["Extensions"];
|
|
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"]["QuotaUpdateRequest"];
|
|
6331
6331
|
};
|
|
6332
6332
|
};
|
|
6333
6333
|
responses: {
|