@blezgo/api-sdk 0.1.2 → 0.1.3
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 +64 -64
- 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 +120 -120
- package/dist/admin/generated.d.ts.map +1 -1
- package/dist/affiliate/generated.d.ts +84 -85
- 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 +100 -100
- package/dist/announcements/generated.d.ts.map +1 -1
- package/dist/apikeys/generated.d.ts +100 -100
- package/dist/apikeys/generated.d.ts.map +1 -1
- package/dist/assistance/generated.d.ts +12 -12
- package/dist/assistance/generated.d.ts.map +1 -1
- package/dist/authentication/generated.d.ts +95 -95
- package/dist/authentication/generated.d.ts.map +1 -1
- package/dist/blog/generated.d.ts +169 -169
- package/dist/blog/generated.d.ts.map +1 -1
- package/dist/bundle/generated.d.ts +168 -168
- 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 +38 -38
- package/dist/calendar/generated.d.ts.map +1 -1
- package/dist/campaigns/generated.d.ts +196 -196
- package/dist/campaigns/generated.d.ts.map +1 -1
- package/dist/cart/generated.d.ts +9 -9
- package/dist/cart/generated.d.ts.map +1 -1
- package/dist/changelog/generated.d.ts +88 -88
- package/dist/changelog/generated.d.ts.map +1 -1
- package/dist/channel/generated.d.ts +252 -252
- package/dist/channel/generated.d.ts.map +1 -1
- package/dist/company/generated.d.ts +58 -58
- package/dist/company/generated.d.ts.map +1 -1
- package/dist/conference/generated.d.ts +30 -30
- package/dist/conference/generated.d.ts.map +1 -1
- package/dist/config/generated.d.ts +25 -25
- package/dist/config/generated.d.ts.map +1 -1
- package/dist/content/generated.d.ts +658 -658
- package/dist/content/generated.d.ts.map +1 -1
- package/dist/cookies/generated.d.ts +46 -46
- package/dist/cookies/generated.d.ts.map +1 -1
- package/dist/courses/generated.d.ts +250 -250
- 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 +202 -202
- package/dist/dashboard/generated.d.ts.map +1 -1
- package/dist/elasticsearch/generated.d.ts +25 -25
- package/dist/elasticsearch/generated.d.ts.map +1 -1
- package/dist/enrollments/generated.d.ts +9 -9
- package/dist/enrollments/generated.d.ts.map +1 -1
- package/dist/errors/generated.d.ts +30 -30
- package/dist/errors/generated.d.ts.map +1 -1
- package/dist/eventconfig/generated.d.ts +103 -103
- package/dist/eventconfig/generated.d.ts.map +1 -1
- package/dist/funnels/generated.d.ts +94 -95
- package/dist/funnels/generated.d.ts.map +1 -1
- package/dist/gamification/generated.d.ts +103 -103
- package/dist/gamification/generated.d.ts.map +1 -1
- package/dist/impersonation/generated.d.ts +77 -77
- package/dist/impersonation/generated.d.ts.map +1 -1
- package/dist/inbox/generated.d.ts +99 -99
- package/dist/inbox/generated.d.ts.map +1 -1
- package/dist/internal/generated.d.ts +9 -9
- package/dist/internal/generated.d.ts.map +1 -1
- package/dist/internationalization/generated.d.ts +11 -11
- package/dist/internationalization/generated.d.ts.map +1 -1
- package/dist/invitations/generated.d.ts +131 -131
- package/dist/invitations/generated.d.ts.map +1 -1
- package/dist/meetings/generated.d.ts +251 -251
- package/dist/meetings/generated.d.ts.map +1 -1
- package/dist/metas/generated.d.ts +183 -183
- package/dist/metas/generated.d.ts.map +1 -1
- package/dist/notification/generated.d.ts +379 -379
- package/dist/notification/generated.d.ts.map +1 -1
- package/dist/notifications/generated.d.ts +9 -9
- package/dist/notifications/generated.d.ts.map +1 -1
- package/dist/onboarding/generated.d.ts +124 -124
- 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 +555 -558
- package/dist/payments/generated.d.ts.map +1 -1
- package/dist/payouts/generated.d.ts +9 -9
- package/dist/payouts/generated.d.ts.map +1 -1
- package/dist/plans/generated.d.ts +227 -227
- package/dist/plans/generated.d.ts.map +1 -1
- package/dist/pricing/generated.d.ts +34 -34
- package/dist/pricing/generated.d.ts.map +1 -1
- package/dist/products/generated.d.ts +610 -610
- package/dist/products/generated.d.ts.map +1 -1
- package/dist/profile/generated.d.ts +286 -286
- package/dist/profile/generated.d.ts.map +1 -1
- package/dist/reasons/generated.d.ts +32 -32
- package/dist/reasons/generated.d.ts.map +1 -1
- package/dist/registration/generated.d.ts +164 -164
- package/dist/registration/generated.d.ts.map +1 -1
- package/dist/reviews/generated.d.ts +51 -51
- package/dist/reviews/generated.d.ts.map +1 -1
- package/dist/role/generated.d.ts +899 -401
- package/dist/role/generated.d.ts.map +1 -1
- package/dist/scheduling/generated.d.ts +156 -156
- package/dist/scheduling/generated.d.ts.map +1 -1
- package/dist/services/generated.d.ts +1028 -1028
- package/dist/services/generated.d.ts.map +1 -1
- package/dist/sessions/generated.d.ts +247 -247
- package/dist/sessions/generated.d.ts.map +1 -1
- package/dist/spaces/generated.d.ts +419 -419
- package/dist/spaces/generated.d.ts.map +1 -1
- package/dist/storefront/generated.d.ts +9 -9
- package/dist/storefront/generated.d.ts.map +1 -1
- package/dist/support/generated.d.ts +1510 -1510
- package/dist/support/generated.d.ts.map +1 -1
- package/dist/sync/generated.d.ts +179 -179
- package/dist/sync/generated.d.ts.map +1 -1
- package/dist/tenant/generated.d.ts +537 -537
- package/dist/tenant/generated.d.ts.map +1 -1
- package/dist/testimonials/generated.d.ts +79 -79
- package/dist/testimonials/generated.d.ts.map +1 -1
- package/dist/tests/generated.d.ts +343 -343
- package/dist/tests/generated.d.ts.map +1 -1
- package/dist/tokens/generated.d.ts +37 -37
- package/dist/tokens/generated.d.ts.map +1 -1
- package/dist/uploads/generated.d.ts +33 -33
- package/dist/uploads/generated.d.ts.map +1 -1
- package/dist/upsell/generated.d.ts +82 -82
- package/dist/upsell/generated.d.ts.map +1 -1
- package/dist/user/generated.d.ts +280 -541
- package/dist/user/generated.d.ts.map +1 -1
- package/dist/webinars/generated.d.ts +183 -183
- package/dist/webinars/generated.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -1355,6 +1355,120 @@ export interface paths {
|
|
|
1355
1355
|
export type webhooks = Record<string, never>;
|
|
1356
1356
|
export interface components {
|
|
1357
1357
|
schemas: {
|
|
1358
|
+
/**
|
|
1359
|
+
* QuotaSettingsUpdateRequest
|
|
1360
|
+
* @description Request schema for updating quota settings (auto-recharge, daily caps).
|
|
1361
|
+
*
|
|
1362
|
+
* Example:
|
|
1363
|
+
* {
|
|
1364
|
+
* "channel_type": "sms",
|
|
1365
|
+
* "auto_recharge_enabled": true,
|
|
1366
|
+
* "auto_recharge_threshold": 100,
|
|
1367
|
+
* "auto_recharge_amount": 1000,
|
|
1368
|
+
* "daily_quota_cap": 5000
|
|
1369
|
+
* }
|
|
1370
|
+
*/
|
|
1371
|
+
QuotaSettingsUpdateRequest: {
|
|
1372
|
+
/** @description Channel type (sms or whatsapp) */
|
|
1373
|
+
channel_type: components["schemas"]["ChannelType"];
|
|
1374
|
+
/**
|
|
1375
|
+
* Auto Recharge Enabled
|
|
1376
|
+
* @description Enable automatic quota recharge
|
|
1377
|
+
*/
|
|
1378
|
+
auto_recharge_enabled?: boolean | null;
|
|
1379
|
+
/**
|
|
1380
|
+
* Auto Recharge Threshold
|
|
1381
|
+
* @description Trigger recharge when quota falls below this
|
|
1382
|
+
*/
|
|
1383
|
+
auto_recharge_threshold?: number | null;
|
|
1384
|
+
/**
|
|
1385
|
+
* Auto Recharge Amount
|
|
1386
|
+
* @description Amount to purchase on auto-recharge
|
|
1387
|
+
*/
|
|
1388
|
+
auto_recharge_amount?: number | null;
|
|
1389
|
+
/**
|
|
1390
|
+
* Daily Quota Cap
|
|
1391
|
+
* @description Max SMS/WhatsApp per day (cost leakage prevention)
|
|
1392
|
+
*/
|
|
1393
|
+
daily_quota_cap?: number | null;
|
|
1394
|
+
};
|
|
1395
|
+
/**
|
|
1396
|
+
* QuotaUpdateRequest
|
|
1397
|
+
* @description Request schema for admin quota adjustments (add/subtract quota manually).
|
|
1398
|
+
*
|
|
1399
|
+
* Example:
|
|
1400
|
+
* {
|
|
1401
|
+
* "channel_type": "sms",
|
|
1402
|
+
* "amount": 5000,
|
|
1403
|
+
* "notes": "Bonus quota for premium customer"
|
|
1404
|
+
* }
|
|
1405
|
+
*/
|
|
1406
|
+
QuotaUpdateRequest: {
|
|
1407
|
+
/** @description Channel type (sms or whatsapp) */
|
|
1408
|
+
channel_type: components["schemas"]["ChannelType"];
|
|
1409
|
+
/**
|
|
1410
|
+
* Amount
|
|
1411
|
+
* @description Quota amount (positive to add, negative to subtract)
|
|
1412
|
+
*/
|
|
1413
|
+
amount: number;
|
|
1414
|
+
/**
|
|
1415
|
+
* Notes
|
|
1416
|
+
* @description Reason for adjustment
|
|
1417
|
+
*/
|
|
1418
|
+
notes?: string | null;
|
|
1419
|
+
};
|
|
1420
|
+
/**
|
|
1421
|
+
* CredentialUpdateRequest
|
|
1422
|
+
* @description Request schema for updating an existing credential.
|
|
1423
|
+
*
|
|
1424
|
+
* CRITICAL: Only display_name and is_default can be updated.
|
|
1425
|
+
* To change credentials, delete and recreate (security best practice).
|
|
1426
|
+
*
|
|
1427
|
+
* Example:
|
|
1428
|
+
* {
|
|
1429
|
+
* "display_name": "Updated Marketing SMTP",
|
|
1430
|
+
* "is_default": true
|
|
1431
|
+
* }
|
|
1432
|
+
*/
|
|
1433
|
+
CredentialUpdateRequest: {
|
|
1434
|
+
/**
|
|
1435
|
+
* Display Name
|
|
1436
|
+
* @description User-friendly name
|
|
1437
|
+
*/
|
|
1438
|
+
display_name?: string | null;
|
|
1439
|
+
/**
|
|
1440
|
+
* Is Default
|
|
1441
|
+
* @description Set as default credential
|
|
1442
|
+
*/
|
|
1443
|
+
is_default?: boolean | null;
|
|
1444
|
+
};
|
|
1445
|
+
/**
|
|
1446
|
+
* @example {
|
|
1447
|
+
* "status": "success",
|
|
1448
|
+
* "message": "Operation successful",
|
|
1449
|
+
* "message_code": "api_suc_20001",
|
|
1450
|
+
* "data": {},
|
|
1451
|
+
* "metadata": {
|
|
1452
|
+
* "timestamp": "2026-03-26T10:00:00.000Z",
|
|
1453
|
+
* "requestId": "07e22004-cb60-4dfc-bc9c-b6f99664dca1",
|
|
1454
|
+
* "traceId": "a9f1204c-bb82-41de-b234-7c3a9e120000",
|
|
1455
|
+
* "version": "v1",
|
|
1456
|
+
* "executionTime": 42,
|
|
1457
|
+
* "language": "en-US"
|
|
1458
|
+
* }
|
|
1459
|
+
* }
|
|
1460
|
+
*/
|
|
1461
|
+
StandardResponse: {
|
|
1462
|
+
/** @example success */
|
|
1463
|
+
status?: string;
|
|
1464
|
+
data?: Record<string, never> | null;
|
|
1465
|
+
/** @example Operation successful */
|
|
1466
|
+
message?: string | null;
|
|
1467
|
+
/** @example api_suc_20001 */
|
|
1468
|
+
message_code?: string | null;
|
|
1469
|
+
metadata?: Record<string, never> | null;
|
|
1470
|
+
error?: components["schemas"]["ErrorResponse"];
|
|
1471
|
+
};
|
|
1358
1472
|
/**
|
|
1359
1473
|
* CredentialCreateRequest
|
|
1360
1474
|
* @description Request schema for creating a new channel credential.
|
|
@@ -1412,127 +1526,6 @@ export interface components {
|
|
|
1412
1526
|
*/
|
|
1413
1527
|
is_default: boolean;
|
|
1414
1528
|
};
|
|
1415
|
-
/**
|
|
1416
|
-
* ChannelType
|
|
1417
|
-
* @description Channel types for quota.
|
|
1418
|
-
* @enum {string}
|
|
1419
|
-
*/
|
|
1420
|
-
ChannelType: "sms" | "whatsapp";
|
|
1421
|
-
/**
|
|
1422
|
-
* DLTRegistrationCreateRequest
|
|
1423
|
-
* @description Create a new DLT registration (India compliance).
|
|
1424
|
-
*/
|
|
1425
|
-
DLTRegistrationCreateRequest: {
|
|
1426
|
-
/**
|
|
1427
|
-
* Credential Id
|
|
1428
|
-
* @description External ID of SMS credential
|
|
1429
|
-
*/
|
|
1430
|
-
credential_id: string;
|
|
1431
|
-
/**
|
|
1432
|
-
* Entity Id
|
|
1433
|
-
* @description DLT Entity ID from provider
|
|
1434
|
-
*/
|
|
1435
|
-
entity_id: string;
|
|
1436
|
-
/**
|
|
1437
|
-
* Sender Id
|
|
1438
|
-
* @description 6-char alphanumeric sender ID
|
|
1439
|
-
*/
|
|
1440
|
-
sender_id: string;
|
|
1441
|
-
/**
|
|
1442
|
-
* Template Id
|
|
1443
|
-
* @description Pre-registered template ID
|
|
1444
|
-
*/
|
|
1445
|
-
template_id?: string | null;
|
|
1446
|
-
/**
|
|
1447
|
-
* Template Name
|
|
1448
|
-
* @description Human-friendly template name
|
|
1449
|
-
*/
|
|
1450
|
-
template_name?: string | null;
|
|
1451
|
-
/**
|
|
1452
|
-
* Template Content
|
|
1453
|
-
* @description Template with {#var#} placeholders
|
|
1454
|
-
*/
|
|
1455
|
-
template_content?: string | null;
|
|
1456
|
-
/**
|
|
1457
|
-
* Template Type
|
|
1458
|
-
* @description transactional, promotional, service
|
|
1459
|
-
* @default transactional
|
|
1460
|
-
*/
|
|
1461
|
-
template_type: string;
|
|
1462
|
-
};
|
|
1463
|
-
/**
|
|
1464
|
-
* QuotaUpdateRequest
|
|
1465
|
-
* @description Request schema for admin quota adjustments (add/subtract quota manually).
|
|
1466
|
-
*
|
|
1467
|
-
* Example:
|
|
1468
|
-
* {
|
|
1469
|
-
* "channel_type": "sms",
|
|
1470
|
-
* "amount": 5000,
|
|
1471
|
-
* "notes": "Bonus quota for premium customer"
|
|
1472
|
-
* }
|
|
1473
|
-
*/
|
|
1474
|
-
app__models__sms_quota__quota_schemas__QuotaUpdateRequest: {
|
|
1475
|
-
/** @description Channel type (sms or whatsapp) */
|
|
1476
|
-
channel_type: components["schemas"]["ChannelType"];
|
|
1477
|
-
/**
|
|
1478
|
-
* Amount
|
|
1479
|
-
* @description Quota amount (positive to add, negative to subtract)
|
|
1480
|
-
*/
|
|
1481
|
-
amount: number;
|
|
1482
|
-
/**
|
|
1483
|
-
* Notes
|
|
1484
|
-
* @description Reason for adjustment
|
|
1485
|
-
*/
|
|
1486
|
-
notes?: string | null;
|
|
1487
|
-
};
|
|
1488
|
-
/**
|
|
1489
|
-
* QuotaPurchaseRequest
|
|
1490
|
-
* @description Request schema for purchasing SMS/WhatsApp quota.
|
|
1491
|
-
*
|
|
1492
|
-
* CRITICAL: idempotency_key MUST be unique per purchase to prevent duplicate charges.
|
|
1493
|
-
*
|
|
1494
|
-
* Example:
|
|
1495
|
-
* {
|
|
1496
|
-
* "channel_type": "sms",
|
|
1497
|
-
* "amount": 1000,
|
|
1498
|
-
* "payment_reference_id": "pay_abc123xyz",
|
|
1499
|
-
* "idempotency_key": "purchase_20260129_123456_org123"
|
|
1500
|
-
* }
|
|
1501
|
-
*/
|
|
1502
|
-
QuotaPurchaseRequest: {
|
|
1503
|
-
/** @description Channel type (sms or whatsapp) */
|
|
1504
|
-
channel_type: components["schemas"]["ChannelType"];
|
|
1505
|
-
/**
|
|
1506
|
-
* Amount
|
|
1507
|
-
* @description Quota amount to purchase (1-1,000,000)
|
|
1508
|
-
*/
|
|
1509
|
-
amount: number;
|
|
1510
|
-
/**
|
|
1511
|
-
* Payment Reference Id
|
|
1512
|
-
* @description Payment gateway reference ID
|
|
1513
|
-
*/
|
|
1514
|
-
payment_reference_id?: string | null;
|
|
1515
|
-
/**
|
|
1516
|
-
* Idempotency Key
|
|
1517
|
-
* @description Unique key to prevent duplicate purchases (e.g., purchase_YYYYMMDD_HHMMSS_orgID)
|
|
1518
|
-
*/
|
|
1519
|
-
idempotency_key: string;
|
|
1520
|
-
};
|
|
1521
|
-
ErrorResponse: {
|
|
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"];
|
|
1535
|
-
};
|
|
1536
1529
|
/**
|
|
1537
1530
|
* RoutingRuleCreateRequest
|
|
1538
1531
|
* @description Create a new channel routing rule for org + country.
|
|
@@ -1612,97 +1605,67 @@ export interface components {
|
|
|
1612
1605
|
sms_hourly_limit: number;
|
|
1613
1606
|
};
|
|
1614
1607
|
/**
|
|
1615
|
-
*
|
|
1616
|
-
* @description
|
|
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
|
-
* }
|
|
1608
|
+
* DLTRegistrationUpdateRequest
|
|
1609
|
+
* @description Update DLT registration.
|
|
1626
1610
|
*/
|
|
1627
|
-
|
|
1628
|
-
/**
|
|
1629
|
-
|
|
1630
|
-
/**
|
|
1631
|
-
|
|
1632
|
-
|
|
1633
|
-
|
|
1634
|
-
|
|
1611
|
+
DLTRegistrationUpdateRequest: {
|
|
1612
|
+
/** Template Id */
|
|
1613
|
+
template_id?: string | null;
|
|
1614
|
+
/** Template Name */
|
|
1615
|
+
template_name?: string | null;
|
|
1616
|
+
/** Template Content */
|
|
1617
|
+
template_content?: string | null;
|
|
1618
|
+
/** Template Type */
|
|
1619
|
+
template_type?: string | null;
|
|
1635
1620
|
/**
|
|
1636
|
-
*
|
|
1637
|
-
* @description
|
|
1621
|
+
* Registration Status
|
|
1622
|
+
* @description pending, approved, rejected, expired
|
|
1638
1623
|
*/
|
|
1639
|
-
|
|
1624
|
+
registration_status?: string | null;
|
|
1625
|
+
/** Is Active */
|
|
1626
|
+
is_active?: boolean | null;
|
|
1627
|
+
};
|
|
1628
|
+
/**
|
|
1629
|
+
* DLTRegistrationCreateRequest
|
|
1630
|
+
* @description Create a new DLT registration (India compliance).
|
|
1631
|
+
*/
|
|
1632
|
+
DLTRegistrationCreateRequest: {
|
|
1640
1633
|
/**
|
|
1641
|
-
*
|
|
1642
|
-
* @description
|
|
1634
|
+
* Credential Id
|
|
1635
|
+
* @description External ID of SMS credential
|
|
1643
1636
|
*/
|
|
1644
|
-
|
|
1637
|
+
credential_id: string;
|
|
1645
1638
|
/**
|
|
1646
|
-
*
|
|
1647
|
-
* @description
|
|
1639
|
+
* Entity Id
|
|
1640
|
+
* @description DLT Entity ID from provider
|
|
1648
1641
|
*/
|
|
1649
|
-
|
|
1650
|
-
};
|
|
1651
|
-
/**
|
|
1652
|
-
* QuotaRefundRequest
|
|
1653
|
-
* @description Request schema for refunding quota.
|
|
1654
|
-
*
|
|
1655
|
-
* Example:
|
|
1656
|
-
* {
|
|
1657
|
-
* "channel_type": "sms",
|
|
1658
|
-
* "amount": 1000,
|
|
1659
|
-
* "refund_reference_id": "refund_abc123",
|
|
1660
|
-
* "notes": "Refund for unused quota"
|
|
1661
|
-
* }
|
|
1662
|
-
*/
|
|
1663
|
-
QuotaRefundRequest: {
|
|
1664
|
-
/** @description Channel type (sms or whatsapp) */
|
|
1665
|
-
channel_type: components["schemas"]["ChannelType"];
|
|
1642
|
+
entity_id: string;
|
|
1666
1643
|
/**
|
|
1667
|
-
*
|
|
1668
|
-
* @description
|
|
1644
|
+
* Sender Id
|
|
1645
|
+
* @description 6-char alphanumeric sender ID
|
|
1669
1646
|
*/
|
|
1670
|
-
|
|
1647
|
+
sender_id: string;
|
|
1671
1648
|
/**
|
|
1672
|
-
*
|
|
1673
|
-
* @description
|
|
1649
|
+
* Template Id
|
|
1650
|
+
* @description Pre-registered template ID
|
|
1674
1651
|
*/
|
|
1675
|
-
|
|
1652
|
+
template_id?: string | null;
|
|
1676
1653
|
/**
|
|
1677
|
-
*
|
|
1678
|
-
* @description
|
|
1654
|
+
* Template Name
|
|
1655
|
+
* @description Human-friendly template name
|
|
1679
1656
|
*/
|
|
1680
|
-
|
|
1681
|
-
};
|
|
1682
|
-
/**
|
|
1683
|
-
* CredentialUpdateRequest
|
|
1684
|
-
* @description Request schema for updating an existing credential.
|
|
1685
|
-
*
|
|
1686
|
-
* CRITICAL: Only display_name and is_default can be updated.
|
|
1687
|
-
* To change credentials, delete and recreate (security best practice).
|
|
1688
|
-
*
|
|
1689
|
-
* Example:
|
|
1690
|
-
* {
|
|
1691
|
-
* "display_name": "Updated Marketing SMTP",
|
|
1692
|
-
* "is_default": true
|
|
1693
|
-
* }
|
|
1694
|
-
*/
|
|
1695
|
-
CredentialUpdateRequest: {
|
|
1657
|
+
template_name?: string | null;
|
|
1696
1658
|
/**
|
|
1697
|
-
*
|
|
1698
|
-
* @description
|
|
1659
|
+
* Template Content
|
|
1660
|
+
* @description Template with {#var#} placeholders
|
|
1699
1661
|
*/
|
|
1700
|
-
|
|
1662
|
+
template_content?: string | null;
|
|
1701
1663
|
/**
|
|
1702
|
-
*
|
|
1703
|
-
* @description
|
|
1664
|
+
* Template Type
|
|
1665
|
+
* @description transactional, promotional, service
|
|
1666
|
+
* @default transactional
|
|
1704
1667
|
*/
|
|
1705
|
-
|
|
1668
|
+
template_type: string;
|
|
1706
1669
|
};
|
|
1707
1670
|
/**
|
|
1708
1671
|
* CapabilityCheckRequest
|
|
@@ -1726,48 +1689,12 @@ export interface components {
|
|
|
1726
1689
|
*/
|
|
1727
1690
|
purpose: string;
|
|
1728
1691
|
};
|
|
1729
|
-
Extensions: {
|
|
1730
|
-
/** @example GENERIC_ERROR */
|
|
1731
|
-
message_code?: string;
|
|
1732
|
-
/** @example [] */
|
|
1733
|
-
invalid_params?: components["schemas"]["InvalidParam"][];
|
|
1734
|
-
extra_data?: Record<string, never> | null;
|
|
1735
|
-
/** @example Detailed debug information */
|
|
1736
|
-
debug?: string | null;
|
|
1737
|
-
};
|
|
1738
1692
|
/**
|
|
1739
|
-
*
|
|
1740
|
-
*
|
|
1741
|
-
*
|
|
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
|
-
* }
|
|
1693
|
+
* ChannelType
|
|
1694
|
+
* @description Channel types for quota.
|
|
1695
|
+
* @enum {string}
|
|
1753
1696
|
*/
|
|
1754
|
-
|
|
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
|
-
};
|
|
1697
|
+
ChannelType: "sms" | "whatsapp";
|
|
1771
1698
|
/**
|
|
1772
1699
|
* RoutingRuleUpdateRequest
|
|
1773
1700
|
* @description Update an existing routing rule.
|
|
@@ -1800,26 +1727,99 @@ export interface components {
|
|
|
1800
1727
|
/** Is Active */
|
|
1801
1728
|
is_active?: boolean | null;
|
|
1802
1729
|
};
|
|
1730
|
+
InvalidParam: {
|
|
1731
|
+
/** @example items[0].quantity */
|
|
1732
|
+
field?: string;
|
|
1733
|
+
/** @example Input should be greater than or equal to 1 */
|
|
1734
|
+
error?: string;
|
|
1735
|
+
};
|
|
1803
1736
|
/**
|
|
1804
|
-
*
|
|
1805
|
-
* @description
|
|
1737
|
+
* QuotaRefundRequest
|
|
1738
|
+
* @description Request schema for refunding quota.
|
|
1739
|
+
*
|
|
1740
|
+
* Example:
|
|
1741
|
+
* {
|
|
1742
|
+
* "channel_type": "sms",
|
|
1743
|
+
* "amount": 1000,
|
|
1744
|
+
* "refund_reference_id": "refund_abc123",
|
|
1745
|
+
* "notes": "Refund for unused quota"
|
|
1746
|
+
* }
|
|
1806
1747
|
*/
|
|
1807
|
-
|
|
1808
|
-
/**
|
|
1809
|
-
|
|
1810
|
-
/** Template Name */
|
|
1811
|
-
template_name?: string | null;
|
|
1812
|
-
/** Template Content */
|
|
1813
|
-
template_content?: string | null;
|
|
1814
|
-
/** Template Type */
|
|
1815
|
-
template_type?: string | null;
|
|
1748
|
+
QuotaRefundRequest: {
|
|
1749
|
+
/** @description Channel type (sms or whatsapp) */
|
|
1750
|
+
channel_type: components["schemas"]["ChannelType"];
|
|
1816
1751
|
/**
|
|
1817
|
-
*
|
|
1818
|
-
* @description
|
|
1752
|
+
* Amount
|
|
1753
|
+
* @description Quota amount to refund
|
|
1819
1754
|
*/
|
|
1820
|
-
|
|
1821
|
-
/**
|
|
1822
|
-
|
|
1755
|
+
amount: number;
|
|
1756
|
+
/**
|
|
1757
|
+
* Refund Reference Id
|
|
1758
|
+
* @description Refund reference ID
|
|
1759
|
+
*/
|
|
1760
|
+
refund_reference_id?: string | null;
|
|
1761
|
+
/**
|
|
1762
|
+
* Notes
|
|
1763
|
+
* @description Refund reason
|
|
1764
|
+
*/
|
|
1765
|
+
notes?: string | null;
|
|
1766
|
+
};
|
|
1767
|
+
Extensions: {
|
|
1768
|
+
/** @example GENERIC_ERROR */
|
|
1769
|
+
message_code?: string;
|
|
1770
|
+
/** @example [] */
|
|
1771
|
+
invalid_params?: components["schemas"]["InvalidParam"][];
|
|
1772
|
+
extra_data?: Record<string, never> | null;
|
|
1773
|
+
/** @example Detailed debug information */
|
|
1774
|
+
debug?: string | null;
|
|
1775
|
+
};
|
|
1776
|
+
ErrorResponse: {
|
|
1777
|
+
/** @example about:blank */
|
|
1778
|
+
type?: string;
|
|
1779
|
+
/** @example GENERIC_ERROR */
|
|
1780
|
+
code?: string;
|
|
1781
|
+
/** @example Client Error */
|
|
1782
|
+
title?: string;
|
|
1783
|
+
/** @example 400 */
|
|
1784
|
+
status?: number;
|
|
1785
|
+
/** @example An error occurred */
|
|
1786
|
+
detail?: string;
|
|
1787
|
+
/** @example /v1/cart/items */
|
|
1788
|
+
instance?: string;
|
|
1789
|
+
extensions?: components["schemas"]["Extensions"];
|
|
1790
|
+
};
|
|
1791
|
+
/**
|
|
1792
|
+
* QuotaPurchaseRequest
|
|
1793
|
+
* @description Request schema for purchasing SMS/WhatsApp quota.
|
|
1794
|
+
*
|
|
1795
|
+
* CRITICAL: idempotency_key MUST be unique per purchase to prevent duplicate charges.
|
|
1796
|
+
*
|
|
1797
|
+
* Example:
|
|
1798
|
+
* {
|
|
1799
|
+
* "channel_type": "sms",
|
|
1800
|
+
* "amount": 1000,
|
|
1801
|
+
* "payment_reference_id": "pay_abc123xyz",
|
|
1802
|
+
* "idempotency_key": "purchase_20260129_123456_org123"
|
|
1803
|
+
* }
|
|
1804
|
+
*/
|
|
1805
|
+
QuotaPurchaseRequest: {
|
|
1806
|
+
/** @description Channel type (sms or whatsapp) */
|
|
1807
|
+
channel_type: components["schemas"]["ChannelType"];
|
|
1808
|
+
/**
|
|
1809
|
+
* Amount
|
|
1810
|
+
* @description Quota amount to purchase (1-1,000,000)
|
|
1811
|
+
*/
|
|
1812
|
+
amount: number;
|
|
1813
|
+
/**
|
|
1814
|
+
* Payment Reference Id
|
|
1815
|
+
* @description Payment gateway reference ID
|
|
1816
|
+
*/
|
|
1817
|
+
payment_reference_id?: string | null;
|
|
1818
|
+
/**
|
|
1819
|
+
* Idempotency Key
|
|
1820
|
+
* @description Unique key to prevent duplicate purchases (e.g., purchase_YYYYMMDD_HHMMSS_orgID)
|
|
1821
|
+
*/
|
|
1822
|
+
idempotency_key: string;
|
|
1823
1823
|
};
|
|
1824
1824
|
};
|
|
1825
1825
|
responses: never;
|
|
@@ -6327,7 +6327,7 @@ export interface operations {
|
|
|
6327
6327
|
};
|
|
6328
6328
|
requestBody: {
|
|
6329
6329
|
content: {
|
|
6330
|
-
"application/json": components["schemas"]["
|
|
6330
|
+
"application/json": components["schemas"]["QuotaUpdateRequest"];
|
|
6331
6331
|
};
|
|
6332
6332
|
};
|
|
6333
6333
|
responses: {
|