@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
|
@@ -1205,104 +1205,33 @@ export type webhooks = Record<string, never>;
|
|
|
1205
1205
|
export interface components {
|
|
1206
1206
|
schemas: {
|
|
1207
1207
|
/**
|
|
1208
|
-
*
|
|
1209
|
-
* @description
|
|
1210
|
-
*/
|
|
1211
|
-
CampaignCreateRequest: {
|
|
1212
|
-
/**
|
|
1213
|
-
* Name
|
|
1214
|
-
* @description Campaign name (unique per org/company)
|
|
1215
|
-
*/
|
|
1216
|
-
name: string;
|
|
1217
|
-
/**
|
|
1218
|
-
* Description
|
|
1219
|
-
* @description Campaign description
|
|
1220
|
-
*/
|
|
1221
|
-
description?: string | null;
|
|
1222
|
-
/**
|
|
1223
|
-
* Campaign Type
|
|
1224
|
-
* @description Campaign type
|
|
1225
|
-
*/
|
|
1226
|
-
campaign_type: string;
|
|
1227
|
-
/**
|
|
1228
|
-
* Starts At
|
|
1229
|
-
* Format: date-time
|
|
1230
|
-
* @description Campaign start datetime (UTC)
|
|
1231
|
-
*/
|
|
1232
|
-
starts_at: string;
|
|
1233
|
-
/**
|
|
1234
|
-
* Ends At
|
|
1235
|
-
* @description Campaign end datetime (UTC), null = no end
|
|
1236
|
-
*/
|
|
1237
|
-
ends_at?: string | null;
|
|
1238
|
-
/**
|
|
1239
|
-
* Priority
|
|
1240
|
-
* @description Campaign priority (0-100, higher = higher priority)
|
|
1241
|
-
* @default 0
|
|
1242
|
-
*/
|
|
1243
|
-
priority: number;
|
|
1244
|
-
/**
|
|
1245
|
-
* Budget Amount
|
|
1246
|
-
* @description Total budget limit
|
|
1247
|
-
*/
|
|
1248
|
-
budget_amount?: number | null;
|
|
1249
|
-
/**
|
|
1250
|
-
* Currency
|
|
1251
|
-
* @description Currency code (ISO 4217)
|
|
1252
|
-
* @default USD
|
|
1253
|
-
*/
|
|
1254
|
-
currency: string;
|
|
1255
|
-
/** @description Discount configuration (required for discount campaigns) */
|
|
1256
|
-
discount?: components["schemas"]["CampaignDiscountRequest"] | null;
|
|
1257
|
-
/**
|
|
1258
|
-
* Targeting
|
|
1259
|
-
* @description Targeting rules
|
|
1260
|
-
*/
|
|
1261
|
-
targeting?: components["schemas"]["CampaignTargetingRequest"][] | null;
|
|
1262
|
-
};
|
|
1263
|
-
/**
|
|
1264
|
-
* CampaignValidateRequest
|
|
1265
|
-
* @description Advisory validation request - no side effects.
|
|
1266
|
-
*
|
|
1267
|
-
* Used to check if a campaign would apply to a cart.
|
|
1208
|
+
* CampaignTargetingRequest
|
|
1209
|
+
* @description Targeting rule configuration.
|
|
1268
1210
|
*/
|
|
1269
|
-
|
|
1270
|
-
/**
|
|
1271
|
-
* Campaign Id
|
|
1272
|
-
* @description Campaign external_id (camp_xxx)
|
|
1273
|
-
*/
|
|
1274
|
-
campaign_id?: string | null;
|
|
1275
|
-
/**
|
|
1276
|
-
* Utm Campaign
|
|
1277
|
-
* @description UTM campaign parameter for lookup
|
|
1278
|
-
*/
|
|
1279
|
-
utm_campaign?: string | null;
|
|
1280
|
-
/**
|
|
1281
|
-
* Cart Total
|
|
1282
|
-
* @description Cart total amount
|
|
1283
|
-
*/
|
|
1284
|
-
cart_total: number;
|
|
1211
|
+
CampaignTargetingRequest: {
|
|
1285
1212
|
/**
|
|
1286
|
-
*
|
|
1287
|
-
* @description
|
|
1288
|
-
* @default USD
|
|
1213
|
+
* Target Type
|
|
1214
|
+
* @description Type of target: user_segment, product, category, bundle
|
|
1289
1215
|
*/
|
|
1290
|
-
|
|
1216
|
+
target_type: string;
|
|
1291
1217
|
/**
|
|
1292
|
-
*
|
|
1293
|
-
* @description
|
|
1218
|
+
* Target Ids
|
|
1219
|
+
* @description List of target IDs
|
|
1294
1220
|
*/
|
|
1295
|
-
|
|
1221
|
+
target_ids: number[];
|
|
1296
1222
|
/**
|
|
1297
|
-
*
|
|
1298
|
-
* @description
|
|
1223
|
+
* Include Exclude
|
|
1224
|
+
* @description Include or exclude these targets
|
|
1225
|
+
* @default include
|
|
1299
1226
|
*/
|
|
1300
|
-
|
|
1227
|
+
include_exclude: string;
|
|
1301
1228
|
/**
|
|
1302
|
-
*
|
|
1303
|
-
* @description
|
|
1229
|
+
* Conditions
|
|
1230
|
+
* @description Additional targeting conditions
|
|
1304
1231
|
*/
|
|
1305
|
-
|
|
1232
|
+
conditions?: {
|
|
1233
|
+
[key: string]: unknown;
|
|
1234
|
+
} | null;
|
|
1306
1235
|
};
|
|
1307
1236
|
/**
|
|
1308
1237
|
* CampaignUpdateRequest
|
|
@@ -1358,34 +1287,68 @@ export interface components {
|
|
|
1358
1287
|
*/
|
|
1359
1288
|
reason?: string | null;
|
|
1360
1289
|
};
|
|
1290
|
+
ErrorResponse: {
|
|
1291
|
+
/** @example about:blank */
|
|
1292
|
+
type?: string;
|
|
1293
|
+
/** @example GENERIC_ERROR */
|
|
1294
|
+
code?: string;
|
|
1295
|
+
/** @example Client Error */
|
|
1296
|
+
title?: string;
|
|
1297
|
+
/** @example 400 */
|
|
1298
|
+
status?: number;
|
|
1299
|
+
/** @example An error occurred */
|
|
1300
|
+
detail?: string;
|
|
1301
|
+
/** @example /v1/cart/items */
|
|
1302
|
+
instance?: string;
|
|
1303
|
+
extensions?: components["schemas"]["Extensions"];
|
|
1304
|
+
};
|
|
1305
|
+
Extensions: {
|
|
1306
|
+
/** @example GENERIC_ERROR */
|
|
1307
|
+
message_code?: string;
|
|
1308
|
+
/** @example [] */
|
|
1309
|
+
invalid_params?: components["schemas"]["InvalidParam"][];
|
|
1310
|
+
extra_data?: Record<string, never> | null;
|
|
1311
|
+
/** @example Detailed debug information */
|
|
1312
|
+
debug?: string | null;
|
|
1313
|
+
};
|
|
1361
1314
|
/**
|
|
1362
|
-
*
|
|
1363
|
-
* @description
|
|
1315
|
+
* CampaignApplyRequest
|
|
1316
|
+
* @description Apply campaign discount request - re-validates server-side.
|
|
1317
|
+
*
|
|
1318
|
+
* Never trust prior /validate response.
|
|
1364
1319
|
*/
|
|
1365
|
-
|
|
1320
|
+
CampaignApplyRequest: {
|
|
1366
1321
|
/**
|
|
1367
|
-
*
|
|
1368
|
-
* @description
|
|
1322
|
+
* Campaign Id
|
|
1323
|
+
* @description Campaign external_id (camp_xxx)
|
|
1369
1324
|
*/
|
|
1370
|
-
|
|
1325
|
+
campaign_id: string;
|
|
1371
1326
|
/**
|
|
1372
|
-
*
|
|
1373
|
-
* @description
|
|
1327
|
+
* Cart Id
|
|
1328
|
+
* @description Cart external_id
|
|
1374
1329
|
*/
|
|
1375
|
-
|
|
1330
|
+
cart_id: string;
|
|
1376
1331
|
/**
|
|
1377
|
-
*
|
|
1378
|
-
* @description
|
|
1379
|
-
* @default include
|
|
1332
|
+
* Cart Total
|
|
1333
|
+
* @description Current cart total
|
|
1380
1334
|
*/
|
|
1381
|
-
|
|
1335
|
+
cart_total: number;
|
|
1382
1336
|
/**
|
|
1383
|
-
*
|
|
1384
|
-
* @description
|
|
1337
|
+
* Cart Currency
|
|
1338
|
+
* @description Cart currency
|
|
1339
|
+
* @default USD
|
|
1385
1340
|
*/
|
|
1386
|
-
|
|
1387
|
-
|
|
1388
|
-
|
|
1341
|
+
cart_currency: string;
|
|
1342
|
+
/**
|
|
1343
|
+
* Product Ids
|
|
1344
|
+
* @description Product IDs in cart
|
|
1345
|
+
*/
|
|
1346
|
+
product_ids: number[];
|
|
1347
|
+
/**
|
|
1348
|
+
* Category Ids
|
|
1349
|
+
* @description Category IDs of products in cart
|
|
1350
|
+
*/
|
|
1351
|
+
category_ids?: number[] | null;
|
|
1389
1352
|
};
|
|
1390
1353
|
/**
|
|
1391
1354
|
* CampaignTrackingRequest
|
|
@@ -1425,79 +1388,104 @@ export interface components {
|
|
|
1425
1388
|
error?: string;
|
|
1426
1389
|
};
|
|
1427
1390
|
/**
|
|
1428
|
-
*
|
|
1429
|
-
*
|
|
1430
|
-
* "message": "Operation successful",
|
|
1431
|
-
* "message_code": "api_suc_20001",
|
|
1432
|
-
* "data": {},
|
|
1433
|
-
* "metadata": {
|
|
1434
|
-
* "timestamp": "2026-03-26T10:00:00.000Z",
|
|
1435
|
-
* "requestId": "07e22004-cb60-4dfc-bc9c-b6f99664dca1",
|
|
1436
|
-
* "traceId": "a9f1204c-bb82-41de-b234-7c3a9e120000",
|
|
1437
|
-
* "version": "v1",
|
|
1438
|
-
* "executionTime": 42,
|
|
1439
|
-
* "language": "en-US"
|
|
1440
|
-
* }
|
|
1441
|
-
* }
|
|
1442
|
-
*/
|
|
1443
|
-
StandardResponse: {
|
|
1444
|
-
/** @example success */
|
|
1445
|
-
status?: string;
|
|
1446
|
-
data?: Record<string, never> | null;
|
|
1447
|
-
/** @example Operation successful */
|
|
1448
|
-
message?: string | null;
|
|
1449
|
-
/** @example api_suc_20001 */
|
|
1450
|
-
message_code?: string | null;
|
|
1451
|
-
metadata?: Record<string, never> | null;
|
|
1452
|
-
error?: components["schemas"]["ErrorResponse"];
|
|
1453
|
-
};
|
|
1454
|
-
/**
|
|
1455
|
-
* BulkArchiveRequest
|
|
1456
|
-
* @description Request to bulk archive campaigns.
|
|
1391
|
+
* CampaignCreateRequest
|
|
1392
|
+
* @description Request to create a new campaign.
|
|
1457
1393
|
*/
|
|
1458
|
-
|
|
1394
|
+
CampaignCreateRequest: {
|
|
1459
1395
|
/**
|
|
1460
|
-
*
|
|
1461
|
-
* @description
|
|
1396
|
+
* Name
|
|
1397
|
+
* @description Campaign name (unique per org/company)
|
|
1462
1398
|
*/
|
|
1463
|
-
|
|
1399
|
+
name: string;
|
|
1464
1400
|
/**
|
|
1465
|
-
*
|
|
1466
|
-
* @description
|
|
1401
|
+
* Description
|
|
1402
|
+
* @description Campaign description
|
|
1467
1403
|
*/
|
|
1468
|
-
|
|
1469
|
-
|
|
1470
|
-
|
|
1471
|
-
|
|
1472
|
-
|
|
1473
|
-
|
|
1474
|
-
|
|
1475
|
-
|
|
1476
|
-
|
|
1477
|
-
|
|
1404
|
+
description?: string | null;
|
|
1405
|
+
/**
|
|
1406
|
+
* Campaign Type
|
|
1407
|
+
* @description Campaign type
|
|
1408
|
+
*/
|
|
1409
|
+
campaign_type: string;
|
|
1410
|
+
/**
|
|
1411
|
+
* Starts At
|
|
1412
|
+
* Format: date-time
|
|
1413
|
+
* @description Campaign start datetime (UTC)
|
|
1414
|
+
*/
|
|
1415
|
+
starts_at: string;
|
|
1416
|
+
/**
|
|
1417
|
+
* Ends At
|
|
1418
|
+
* @description Campaign end datetime (UTC), null = no end
|
|
1419
|
+
*/
|
|
1420
|
+
ends_at?: string | null;
|
|
1421
|
+
/**
|
|
1422
|
+
* Priority
|
|
1423
|
+
* @description Campaign priority (0-100, higher = higher priority)
|
|
1424
|
+
* @default 0
|
|
1425
|
+
*/
|
|
1426
|
+
priority: number;
|
|
1427
|
+
/**
|
|
1428
|
+
* Budget Amount
|
|
1429
|
+
* @description Total budget limit
|
|
1430
|
+
*/
|
|
1431
|
+
budget_amount?: number | null;
|
|
1432
|
+
/**
|
|
1433
|
+
* Currency
|
|
1434
|
+
* @description Currency code (ISO 4217)
|
|
1435
|
+
* @default USD
|
|
1436
|
+
*/
|
|
1437
|
+
currency: string;
|
|
1438
|
+
/** @description Discount configuration (required for discount campaigns) */
|
|
1439
|
+
discount?: components["schemas"]["CampaignDiscountRequest"] | null;
|
|
1440
|
+
/**
|
|
1441
|
+
* Targeting
|
|
1442
|
+
* @description Targeting rules
|
|
1443
|
+
*/
|
|
1444
|
+
targeting?: components["schemas"]["CampaignTargetingRequest"][] | null;
|
|
1478
1445
|
};
|
|
1479
1446
|
/**
|
|
1480
|
-
*
|
|
1481
|
-
* @description
|
|
1447
|
+
* CampaignValidateRequest
|
|
1448
|
+
* @description Advisory validation request - no side effects.
|
|
1449
|
+
*
|
|
1450
|
+
* Used to check if a campaign would apply to a cart.
|
|
1482
1451
|
*/
|
|
1483
|
-
|
|
1452
|
+
CampaignValidateRequest: {
|
|
1484
1453
|
/**
|
|
1485
1454
|
* Campaign Id
|
|
1486
|
-
* @description Campaign external_id
|
|
1455
|
+
* @description Campaign external_id (camp_xxx)
|
|
1487
1456
|
*/
|
|
1488
|
-
campaign_id
|
|
1457
|
+
campaign_id?: string | null;
|
|
1489
1458
|
/**
|
|
1490
|
-
*
|
|
1491
|
-
* @description
|
|
1459
|
+
* Utm Campaign
|
|
1460
|
+
* @description UTM campaign parameter for lookup
|
|
1492
1461
|
*/
|
|
1493
|
-
|
|
1462
|
+
utm_campaign?: string | null;
|
|
1494
1463
|
/**
|
|
1495
|
-
*
|
|
1496
|
-
* @description
|
|
1464
|
+
* Cart Total
|
|
1465
|
+
* @description Cart total amount
|
|
1497
1466
|
*/
|
|
1498
|
-
|
|
1499
|
-
|
|
1500
|
-
|
|
1467
|
+
cart_total: number;
|
|
1468
|
+
/**
|
|
1469
|
+
* Cart Currency
|
|
1470
|
+
* @description Cart currency
|
|
1471
|
+
* @default USD
|
|
1472
|
+
*/
|
|
1473
|
+
cart_currency: string;
|
|
1474
|
+
/**
|
|
1475
|
+
* Product Ids
|
|
1476
|
+
* @description Product IDs in cart
|
|
1477
|
+
*/
|
|
1478
|
+
product_ids?: number[] | null;
|
|
1479
|
+
/**
|
|
1480
|
+
* Category Ids
|
|
1481
|
+
* @description Category IDs of products in cart
|
|
1482
|
+
*/
|
|
1483
|
+
category_ids?: number[] | null;
|
|
1484
|
+
/**
|
|
1485
|
+
* User Id
|
|
1486
|
+
* @description User ID for per-user limit check
|
|
1487
|
+
*/
|
|
1488
|
+
user_id?: number | null;
|
|
1501
1489
|
};
|
|
1502
1490
|
/**
|
|
1503
1491
|
* CampaignDiscountRequest
|
|
@@ -1541,58 +1529,70 @@ export interface components {
|
|
|
1541
1529
|
max_redemptions_per_user?: number | null;
|
|
1542
1530
|
};
|
|
1543
1531
|
/**
|
|
1544
|
-
*
|
|
1545
|
-
* @description
|
|
1546
|
-
*
|
|
1547
|
-
* Never trust prior /validate response.
|
|
1532
|
+
* BulkArchiveRequest
|
|
1533
|
+
* @description Request to bulk archive campaigns.
|
|
1548
1534
|
*/
|
|
1549
|
-
|
|
1550
|
-
/**
|
|
1551
|
-
* Campaign Id
|
|
1552
|
-
* @description Campaign external_id (camp_xxx)
|
|
1553
|
-
*/
|
|
1554
|
-
campaign_id: string;
|
|
1535
|
+
BulkArchiveRequest: {
|
|
1555
1536
|
/**
|
|
1556
|
-
*
|
|
1557
|
-
* @description
|
|
1537
|
+
* Campaign Ids
|
|
1538
|
+
* @description List of campaign external_ids
|
|
1558
1539
|
*/
|
|
1559
|
-
|
|
1540
|
+
campaign_ids: string[];
|
|
1560
1541
|
/**
|
|
1561
|
-
*
|
|
1562
|
-
* @description
|
|
1542
|
+
* Reason
|
|
1543
|
+
* @description Reason for bulk operation
|
|
1563
1544
|
*/
|
|
1564
|
-
|
|
1545
|
+
reason?: string | null;
|
|
1546
|
+
};
|
|
1547
|
+
/**
|
|
1548
|
+
* @example {
|
|
1549
|
+
* "status": "success",
|
|
1550
|
+
* "message": "Operation successful",
|
|
1551
|
+
* "message_code": "api_suc_20001",
|
|
1552
|
+
* "data": {},
|
|
1553
|
+
* "metadata": {
|
|
1554
|
+
* "timestamp": "2026-03-26T10:00:00.000Z",
|
|
1555
|
+
* "requestId": "07e22004-cb60-4dfc-bc9c-b6f99664dca1",
|
|
1556
|
+
* "traceId": "a9f1204c-bb82-41de-b234-7c3a9e120000",
|
|
1557
|
+
* "version": "v1",
|
|
1558
|
+
* "executionTime": 42,
|
|
1559
|
+
* "language": "en-US"
|
|
1560
|
+
* }
|
|
1561
|
+
* }
|
|
1562
|
+
*/
|
|
1563
|
+
StandardResponse: {
|
|
1564
|
+
/** @example success */
|
|
1565
|
+
status?: string;
|
|
1566
|
+
data?: Record<string, never> | null;
|
|
1567
|
+
/** @example Operation successful */
|
|
1568
|
+
message?: string | null;
|
|
1569
|
+
/** @example api_suc_20001 */
|
|
1570
|
+
message_code?: string | null;
|
|
1571
|
+
metadata?: Record<string, never> | null;
|
|
1572
|
+
error?: components["schemas"]["ErrorResponse"];
|
|
1573
|
+
};
|
|
1574
|
+
/**
|
|
1575
|
+
* CampaignPreviewRequest
|
|
1576
|
+
* @description Request to preview campaign targeting/discount for an existing campaign.
|
|
1577
|
+
*/
|
|
1578
|
+
CampaignPreviewRequest: {
|
|
1565
1579
|
/**
|
|
1566
|
-
*
|
|
1567
|
-
* @description
|
|
1568
|
-
* @default USD
|
|
1580
|
+
* Campaign Id
|
|
1581
|
+
* @description Campaign external_id to preview
|
|
1569
1582
|
*/
|
|
1570
|
-
|
|
1583
|
+
campaign_id: string;
|
|
1571
1584
|
/**
|
|
1572
|
-
*
|
|
1573
|
-
* @description
|
|
1585
|
+
* Test User Id
|
|
1586
|
+
* @description User ID to test targeting against
|
|
1574
1587
|
*/
|
|
1575
|
-
|
|
1588
|
+
test_user_id?: number | null;
|
|
1576
1589
|
/**
|
|
1577
|
-
*
|
|
1578
|
-
* @description
|
|
1590
|
+
* Test Context
|
|
1591
|
+
* @description Test context (products, cart_amount, category_ids, etc.)
|
|
1579
1592
|
*/
|
|
1580
|
-
|
|
1581
|
-
|
|
1582
|
-
|
|
1583
|
-
/** @example about:blank */
|
|
1584
|
-
type?: string;
|
|
1585
|
-
/** @example GENERIC_ERROR */
|
|
1586
|
-
code?: string;
|
|
1587
|
-
/** @example Client Error */
|
|
1588
|
-
title?: string;
|
|
1589
|
-
/** @example 400 */
|
|
1590
|
-
status?: number;
|
|
1591
|
-
/** @example An error occurred */
|
|
1592
|
-
detail?: string;
|
|
1593
|
-
/** @example /v1/cart/items */
|
|
1594
|
-
instance?: string;
|
|
1595
|
-
extensions?: components["schemas"]["Extensions"];
|
|
1593
|
+
test_context?: {
|
|
1594
|
+
[key: string]: unknown;
|
|
1595
|
+
} | null;
|
|
1596
1596
|
};
|
|
1597
1597
|
};
|
|
1598
1598
|
responses: never;
|