@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
|
@@ -224,116 +224,90 @@ export type webhooks = Record<string, never>;
|
|
|
224
224
|
export interface components {
|
|
225
225
|
schemas: {
|
|
226
226
|
/**
|
|
227
|
-
*
|
|
228
|
-
* @description
|
|
227
|
+
* SessionCreateRequest
|
|
228
|
+
* @description Session creation request - inherits common fields, adds session-specific section
|
|
229
|
+
* @example {
|
|
230
|
+
* "identity": {
|
|
231
|
+
* "description": "Comprehensive Python workshop for beginners...",
|
|
232
|
+
* "locale": "en-US",
|
|
233
|
+
* "short_description": "Interactive Python workshop",
|
|
234
|
+
* "subtitle": "Learn Python fundamentals",
|
|
235
|
+
* "title": "Python Basics Workshop"
|
|
236
|
+
* },
|
|
237
|
+
* "pricing": {
|
|
238
|
+
* "product_price": {
|
|
239
|
+
* "amount": 1500,
|
|
240
|
+
* "currency": "INR",
|
|
241
|
+
* "price_type": "one_time"
|
|
242
|
+
* }
|
|
243
|
+
* },
|
|
244
|
+
* "product": {
|
|
245
|
+
* "company_id": 2,
|
|
246
|
+
* "featured": false,
|
|
247
|
+
* "is_digital": true,
|
|
248
|
+
* "is_org_level": true,
|
|
249
|
+
* "status": "draft",
|
|
250
|
+
* "visibility": "public"
|
|
251
|
+
* },
|
|
252
|
+
* "session": {
|
|
253
|
+
* "allows_questions": true,
|
|
254
|
+
* "conferencing_platform": "zoom",
|
|
255
|
+
* "duration_minutes": 120,
|
|
256
|
+
* "ends_at": "2025-12-20T12:00:00Z",
|
|
257
|
+
* "instructor_id": "usr_abc123def456",
|
|
258
|
+
* "is_recurring": false,
|
|
259
|
+
* "location_type": "virtual",
|
|
260
|
+
* "max_participants": 50,
|
|
261
|
+
* "starts_at": "2025-12-20T10:00:00Z",
|
|
262
|
+
* "status": "scheduled"
|
|
263
|
+
* }
|
|
264
|
+
* }
|
|
229
265
|
*/
|
|
230
|
-
|
|
231
|
-
/**
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
* Sku
|
|
238
|
-
* @description Stock Keeping Unit
|
|
239
|
-
*/
|
|
240
|
-
sku?: string | null;
|
|
241
|
-
/**
|
|
242
|
-
* Attributes
|
|
243
|
-
* @description Custom attributes
|
|
244
|
-
*/
|
|
245
|
-
attributes?: {
|
|
246
|
-
[key: string]: unknown;
|
|
247
|
-
} | null;
|
|
248
|
-
/**
|
|
249
|
-
* Is Default
|
|
250
|
-
* @description Set as default variant
|
|
251
|
-
* @default false
|
|
252
|
-
*/
|
|
253
|
-
is_default: boolean;
|
|
254
|
-
/**
|
|
255
|
-
* Track Inventory
|
|
256
|
-
* @description Track stock for this variant
|
|
257
|
-
* @default false
|
|
258
|
-
*/
|
|
259
|
-
track_inventory: boolean;
|
|
260
|
-
/**
|
|
261
|
-
* Stock Quantity
|
|
262
|
-
* @description Initial stock
|
|
263
|
-
*/
|
|
264
|
-
stock_quantity?: number | null;
|
|
265
|
-
/**
|
|
266
|
-
* Allow Backorder
|
|
267
|
-
* @description Allow orders when out of stock
|
|
268
|
-
* @default false
|
|
269
|
-
*/
|
|
270
|
-
allow_backorder: boolean;
|
|
271
|
-
/**
|
|
272
|
-
* Weight
|
|
273
|
-
* @description Weight in kg
|
|
274
|
-
*/
|
|
275
|
-
weight?: number | null;
|
|
276
|
-
/**
|
|
277
|
-
* Length
|
|
278
|
-
* @description Length in cm
|
|
279
|
-
*/
|
|
280
|
-
length?: number | null;
|
|
281
|
-
/**
|
|
282
|
-
* Width
|
|
283
|
-
* @description Width in cm
|
|
284
|
-
*/
|
|
285
|
-
width?: number | null;
|
|
266
|
+
SessionCreateRequest: {
|
|
267
|
+
/** @description Base product configuration */
|
|
268
|
+
product: components["schemas"]["ProductSection"];
|
|
269
|
+
/** @description Localized content (title, description) */
|
|
270
|
+
identity: components["schemas"]["IdentitySection"];
|
|
271
|
+
/** @description Pre-uploaded image IDs */
|
|
272
|
+
media?: components["schemas"]["MediaSection"] | null;
|
|
286
273
|
/**
|
|
287
|
-
*
|
|
288
|
-
* @description
|
|
274
|
+
* Tags
|
|
275
|
+
* @description Tag IDs to associate with product
|
|
289
276
|
*/
|
|
290
|
-
|
|
277
|
+
tags?: number[] | null;
|
|
291
278
|
/**
|
|
292
|
-
*
|
|
293
|
-
* @description
|
|
294
|
-
* @default 100
|
|
279
|
+
* Variants
|
|
280
|
+
* @description Product variants (optional)
|
|
295
281
|
*/
|
|
296
|
-
|
|
282
|
+
variants?: components["schemas"]["VariantItem"][] | null;
|
|
283
|
+
/** @description Pricing for product and variants */
|
|
284
|
+
pricing?: components["schemas"]["PricingSection"] | null;
|
|
285
|
+
/** @description Session-specific configuration */
|
|
286
|
+
session: components["schemas"]["SessionSection"];
|
|
287
|
+
};
|
|
288
|
+
/**
|
|
289
|
+
* PricingSection
|
|
290
|
+
* @description Pricing configuration (optional - can have product price, variant prices, or both)
|
|
291
|
+
*/
|
|
292
|
+
PricingSection: {
|
|
293
|
+
/** @description Base product price (no variant) */
|
|
294
|
+
product_price?: components["schemas"]["ProductPrice"] | null;
|
|
297
295
|
/**
|
|
298
|
-
*
|
|
299
|
-
* @description
|
|
296
|
+
* Variant Prices
|
|
297
|
+
* @description Variant-specific prices
|
|
300
298
|
*/
|
|
301
|
-
|
|
302
|
-
[key: string]: unknown;
|
|
303
|
-
} | null;
|
|
304
|
-
};
|
|
305
|
-
InvalidParam: {
|
|
306
|
-
/** @example items[0].quantity */
|
|
307
|
-
field?: string;
|
|
308
|
-
/** @example Input should be greater than or equal to 1 */
|
|
309
|
-
error?: string;
|
|
299
|
+
variant_prices?: components["schemas"]["VariantPrice"][] | null;
|
|
310
300
|
};
|
|
311
301
|
/**
|
|
312
|
-
*
|
|
313
|
-
*
|
|
314
|
-
* "message": "Operation successful",
|
|
315
|
-
* "message_code": "api_suc_20001",
|
|
316
|
-
* "data": {},
|
|
317
|
-
* "metadata": {
|
|
318
|
-
* "timestamp": "2026-03-26T10:00:00.000Z",
|
|
319
|
-
* "requestId": "07e22004-cb60-4dfc-bc9c-b6f99664dca1",
|
|
320
|
-
* "traceId": "a9f1204c-bb82-41de-b234-7c3a9e120000",
|
|
321
|
-
* "version": "v1",
|
|
322
|
-
* "executionTime": 42,
|
|
323
|
-
* "language": "en-US"
|
|
324
|
-
* }
|
|
325
|
-
* }
|
|
302
|
+
* MediaSection
|
|
303
|
+
* @description Product media files - direct media data
|
|
326
304
|
*/
|
|
327
|
-
|
|
328
|
-
/**
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
/** @example api_suc_20001 */
|
|
334
|
-
message_code?: string | null;
|
|
335
|
-
metadata?: Record<string, never> | null;
|
|
336
|
-
error?: components["schemas"]["ErrorResponse"];
|
|
305
|
+
MediaSection: {
|
|
306
|
+
/**
|
|
307
|
+
* Media Items
|
|
308
|
+
* @description List of media files to attach to product
|
|
309
|
+
*/
|
|
310
|
+
media_items?: components["schemas"]["MediaItem"][] | null;
|
|
337
311
|
};
|
|
338
312
|
/** Body_updateSession */
|
|
339
313
|
Body_updateSession: {
|
|
@@ -352,6 +326,72 @@ export interface components {
|
|
|
352
326
|
/** Requires Camera */
|
|
353
327
|
requires_camera?: boolean | null;
|
|
354
328
|
};
|
|
329
|
+
/**
|
|
330
|
+
* ProductSection
|
|
331
|
+
* @description Base product fields (maps to product_tbl)
|
|
332
|
+
*/
|
|
333
|
+
ProductSection: {
|
|
334
|
+
/**
|
|
335
|
+
* Visibility
|
|
336
|
+
* @description public, private, hidden, unlisted
|
|
337
|
+
* @default public
|
|
338
|
+
*/
|
|
339
|
+
visibility: string;
|
|
340
|
+
/**
|
|
341
|
+
* Is Digital
|
|
342
|
+
* @description Digital product flag
|
|
343
|
+
* @default true
|
|
344
|
+
*/
|
|
345
|
+
is_digital: boolean;
|
|
346
|
+
/**
|
|
347
|
+
* Company Id
|
|
348
|
+
* @description Multi-company support
|
|
349
|
+
*/
|
|
350
|
+
company_id?: number | null;
|
|
351
|
+
/**
|
|
352
|
+
* Status
|
|
353
|
+
* @description draft, published, archived, review_required, deleted
|
|
354
|
+
* @default draft
|
|
355
|
+
*/
|
|
356
|
+
status: string;
|
|
357
|
+
/**
|
|
358
|
+
* Is Org Level
|
|
359
|
+
* @description Org-level vs user-created product
|
|
360
|
+
* @default true
|
|
361
|
+
*/
|
|
362
|
+
is_org_level: boolean;
|
|
363
|
+
/**
|
|
364
|
+
* Staff Id
|
|
365
|
+
* @description Staff/instructor delivering product
|
|
366
|
+
*/
|
|
367
|
+
staff_id?: number | null;
|
|
368
|
+
/**
|
|
369
|
+
* Owner Id
|
|
370
|
+
* @description Owner of the product
|
|
371
|
+
*/
|
|
372
|
+
owner_id?: number | null;
|
|
373
|
+
/**
|
|
374
|
+
* Featured
|
|
375
|
+
* @description Featured product flag
|
|
376
|
+
* @default false
|
|
377
|
+
*/
|
|
378
|
+
featured: boolean;
|
|
379
|
+
};
|
|
380
|
+
ErrorResponse: {
|
|
381
|
+
/** @example about:blank */
|
|
382
|
+
type?: string;
|
|
383
|
+
/** @example GENERIC_ERROR */
|
|
384
|
+
code?: string;
|
|
385
|
+
/** @example Client Error */
|
|
386
|
+
title?: string;
|
|
387
|
+
/** @example 400 */
|
|
388
|
+
status?: number;
|
|
389
|
+
/** @example An error occurred */
|
|
390
|
+
detail?: string;
|
|
391
|
+
/** @example /v1/cart/items */
|
|
392
|
+
instance?: string;
|
|
393
|
+
extensions?: components["schemas"]["Extensions"];
|
|
394
|
+
};
|
|
355
395
|
/**
|
|
356
396
|
* MediaItem
|
|
357
397
|
* @description Single media file item
|
|
@@ -423,216 +463,155 @@ export interface components {
|
|
|
423
463
|
*/
|
|
424
464
|
is_primary: boolean;
|
|
425
465
|
};
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
*/
|
|
435
|
-
media_items?: components["schemas"]["MediaItem"][] | null;
|
|
466
|
+
Extensions: {
|
|
467
|
+
/** @example GENERIC_ERROR */
|
|
468
|
+
message_code?: string;
|
|
469
|
+
/** @example [] */
|
|
470
|
+
invalid_params?: components["schemas"]["InvalidParam"][];
|
|
471
|
+
extra_data?: Record<string, never> | null;
|
|
472
|
+
/** @example Detailed debug information */
|
|
473
|
+
debug?: string | null;
|
|
436
474
|
};
|
|
437
475
|
/**
|
|
438
|
-
*
|
|
439
|
-
* @description
|
|
476
|
+
* VariantPrice
|
|
477
|
+
* @description Variant-specific pricing (maps to product_pricings_tbl with variant_id set)
|
|
440
478
|
*/
|
|
441
|
-
|
|
442
|
-
/**
|
|
443
|
-
* Instructor Id
|
|
444
|
-
* @description External user ID of session instructor (usr_xxx)
|
|
445
|
-
*/
|
|
446
|
-
instructor_id?: string | null;
|
|
447
|
-
/**
|
|
448
|
-
* Starts At
|
|
449
|
-
* Format: date-time
|
|
450
|
-
* @description Session start time (UTC)
|
|
451
|
-
*/
|
|
452
|
-
starts_at: string;
|
|
479
|
+
VariantPrice: {
|
|
453
480
|
/**
|
|
454
|
-
*
|
|
455
|
-
*
|
|
456
|
-
* @description Session end time (UTC)
|
|
481
|
+
* Variant Index
|
|
482
|
+
* @description Index in variants array (0-based)
|
|
457
483
|
*/
|
|
458
|
-
|
|
484
|
+
variant_index: number;
|
|
459
485
|
/**
|
|
460
|
-
*
|
|
461
|
-
* @description
|
|
486
|
+
* Price Type
|
|
487
|
+
* @description free, one_time, subscription, monthly_plan
|
|
462
488
|
*/
|
|
463
|
-
|
|
489
|
+
price_type: string;
|
|
464
490
|
/**
|
|
465
|
-
*
|
|
466
|
-
* @description
|
|
467
|
-
* @default false
|
|
491
|
+
* Currency
|
|
492
|
+
* @description Currency code
|
|
468
493
|
*/
|
|
469
|
-
|
|
494
|
+
currency: string;
|
|
470
495
|
/**
|
|
471
|
-
*
|
|
472
|
-
* @description
|
|
496
|
+
* Amount
|
|
497
|
+
* @description Price amount
|
|
473
498
|
*/
|
|
474
|
-
|
|
499
|
+
amount: number;
|
|
475
500
|
/**
|
|
476
|
-
*
|
|
477
|
-
* @description
|
|
501
|
+
* Compare At Amount
|
|
502
|
+
* @description Original/strike-through price
|
|
478
503
|
*/
|
|
479
|
-
|
|
504
|
+
compare_at_amount?: number | null;
|
|
480
505
|
/**
|
|
481
|
-
*
|
|
482
|
-
* @description
|
|
506
|
+
* Interval
|
|
507
|
+
* @description day, week, month, year
|
|
483
508
|
*/
|
|
484
|
-
|
|
509
|
+
interval?: string | null;
|
|
485
510
|
/**
|
|
486
|
-
*
|
|
487
|
-
* @description
|
|
511
|
+
* Interval Count
|
|
512
|
+
* @description Number of intervals
|
|
488
513
|
*/
|
|
489
|
-
|
|
514
|
+
interval_count?: number | null;
|
|
490
515
|
/**
|
|
491
|
-
*
|
|
492
|
-
* @description
|
|
516
|
+
* Trial Period Days
|
|
517
|
+
* @description Free trial days
|
|
493
518
|
*/
|
|
494
|
-
|
|
519
|
+
trial_period_days?: number | null;
|
|
495
520
|
/**
|
|
496
|
-
*
|
|
497
|
-
* @description
|
|
521
|
+
* Initial Amount
|
|
522
|
+
* @description First payment amount
|
|
498
523
|
*/
|
|
499
|
-
|
|
524
|
+
initial_amount?: number | null;
|
|
500
525
|
/**
|
|
501
|
-
*
|
|
502
|
-
* @description
|
|
526
|
+
* Gateway
|
|
527
|
+
* @description stripe, razorpay, paypal, etc.
|
|
503
528
|
*/
|
|
504
|
-
|
|
529
|
+
gateway?: string | null;
|
|
505
530
|
/**
|
|
506
|
-
*
|
|
507
|
-
* @description
|
|
531
|
+
* Requires Payment Method Upfront
|
|
532
|
+
* @description Require payment method before trial
|
|
508
533
|
* @default true
|
|
509
534
|
*/
|
|
510
|
-
|
|
511
|
-
/**
|
|
512
|
-
* Requires Camera
|
|
513
|
-
* @description Require participants to turn on camera
|
|
514
|
-
* @default false
|
|
515
|
-
*/
|
|
516
|
-
requires_camera: boolean;
|
|
517
|
-
/**
|
|
518
|
-
* Interactive Mode
|
|
519
|
-
* @description full_interactive, semi_interactive, lecture_only
|
|
520
|
-
*/
|
|
521
|
-
interactive_mode?: string | null;
|
|
522
|
-
/**
|
|
523
|
-
* Status
|
|
524
|
-
* @description scheduled, in_progress, completed, cancelled
|
|
525
|
-
* @default scheduled
|
|
526
|
-
*/
|
|
527
|
-
status: string;
|
|
528
|
-
/**
|
|
529
|
-
* Locale
|
|
530
|
-
* @description Defaults to identity.locale if not provided
|
|
531
|
-
*/
|
|
532
|
-
locale?: string | null;
|
|
533
|
-
};
|
|
534
|
-
Extensions: {
|
|
535
|
-
/** @example GENERIC_ERROR */
|
|
536
|
-
message_code?: string;
|
|
537
|
-
/** @example [] */
|
|
538
|
-
invalid_params?: components["schemas"]["InvalidParam"][];
|
|
539
|
-
extra_data?: Record<string, never> | null;
|
|
540
|
-
/** @example Detailed debug information */
|
|
541
|
-
debug?: string | null;
|
|
535
|
+
requires_payment_method_upfront: boolean;
|
|
542
536
|
};
|
|
543
537
|
/**
|
|
544
|
-
*
|
|
545
|
-
* @description
|
|
538
|
+
* VariantItem
|
|
539
|
+
* @description Product variant (maps to product_variants_tbl)
|
|
546
540
|
*/
|
|
547
|
-
|
|
541
|
+
VariantItem: {
|
|
548
542
|
/**
|
|
549
|
-
*
|
|
550
|
-
* @description
|
|
551
|
-
* @default en-US
|
|
543
|
+
* Name
|
|
544
|
+
* @description Variant display name
|
|
552
545
|
*/
|
|
553
|
-
|
|
546
|
+
name: string;
|
|
554
547
|
/**
|
|
555
|
-
*
|
|
556
|
-
* @description
|
|
548
|
+
* Sku
|
|
549
|
+
* @description Stock Keeping Unit
|
|
557
550
|
*/
|
|
558
|
-
|
|
551
|
+
sku?: string | null;
|
|
559
552
|
/**
|
|
560
|
-
*
|
|
561
|
-
* @description
|
|
553
|
+
* Attributes
|
|
554
|
+
* @description Custom attributes
|
|
562
555
|
*/
|
|
563
|
-
|
|
556
|
+
attributes?: {
|
|
557
|
+
[key: string]: unknown;
|
|
558
|
+
} | null;
|
|
564
559
|
/**
|
|
565
|
-
*
|
|
566
|
-
* @description
|
|
560
|
+
* Is Default
|
|
561
|
+
* @description Set as default variant
|
|
562
|
+
* @default false
|
|
567
563
|
*/
|
|
568
|
-
|
|
564
|
+
is_default: boolean;
|
|
569
565
|
/**
|
|
570
|
-
*
|
|
571
|
-
* @description
|
|
566
|
+
* Track Inventory
|
|
567
|
+
* @description Track stock for this variant
|
|
568
|
+
* @default false
|
|
572
569
|
*/
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
* "identity": {
|
|
580
|
-
* "description": "Comprehensive Python workshop for beginners...",
|
|
581
|
-
* "locale": "en-US",
|
|
582
|
-
* "short_description": "Interactive Python workshop",
|
|
583
|
-
* "subtitle": "Learn Python fundamentals",
|
|
584
|
-
* "title": "Python Basics Workshop"
|
|
585
|
-
* },
|
|
586
|
-
* "pricing": {
|
|
587
|
-
* "product_price": {
|
|
588
|
-
* "amount": 1500,
|
|
589
|
-
* "currency": "INR",
|
|
590
|
-
* "price_type": "one_time"
|
|
591
|
-
* }
|
|
592
|
-
* },
|
|
593
|
-
* "product": {
|
|
594
|
-
* "company_id": 2,
|
|
595
|
-
* "featured": false,
|
|
596
|
-
* "is_digital": true,
|
|
597
|
-
* "is_org_level": true,
|
|
598
|
-
* "status": "draft",
|
|
599
|
-
* "visibility": "public"
|
|
600
|
-
* },
|
|
601
|
-
* "session": {
|
|
602
|
-
* "allows_questions": true,
|
|
603
|
-
* "conferencing_platform": "zoom",
|
|
604
|
-
* "duration_minutes": 120,
|
|
605
|
-
* "ends_at": "2025-12-20T12:00:00Z",
|
|
606
|
-
* "instructor_id": "usr_abc123def456",
|
|
607
|
-
* "is_recurring": false,
|
|
608
|
-
* "location_type": "virtual",
|
|
609
|
-
* "max_participants": 50,
|
|
610
|
-
* "starts_at": "2025-12-20T10:00:00Z",
|
|
611
|
-
* "status": "scheduled"
|
|
612
|
-
* }
|
|
613
|
-
* }
|
|
614
|
-
*/
|
|
615
|
-
SessionCreateRequest: {
|
|
616
|
-
/** @description Base product configuration */
|
|
617
|
-
product: components["schemas"]["ProductSection"];
|
|
618
|
-
/** @description Localized content (title, description) */
|
|
619
|
-
identity: components["schemas"]["IdentitySection"];
|
|
620
|
-
/** @description Pre-uploaded image IDs */
|
|
621
|
-
media?: components["schemas"]["MediaSection"] | null;
|
|
570
|
+
track_inventory: boolean;
|
|
571
|
+
/**
|
|
572
|
+
* Stock Quantity
|
|
573
|
+
* @description Initial stock
|
|
574
|
+
*/
|
|
575
|
+
stock_quantity?: number | null;
|
|
622
576
|
/**
|
|
623
|
-
*
|
|
624
|
-
* @description
|
|
577
|
+
* Allow Backorder
|
|
578
|
+
* @description Allow orders when out of stock
|
|
579
|
+
* @default false
|
|
625
580
|
*/
|
|
626
|
-
|
|
581
|
+
allow_backorder: boolean;
|
|
627
582
|
/**
|
|
628
|
-
*
|
|
629
|
-
* @description
|
|
583
|
+
* Weight
|
|
584
|
+
* @description Weight in kg
|
|
630
585
|
*/
|
|
631
|
-
|
|
632
|
-
/**
|
|
633
|
-
|
|
634
|
-
|
|
635
|
-
|
|
586
|
+
weight?: number | null;
|
|
587
|
+
/**
|
|
588
|
+
* Length
|
|
589
|
+
* @description Length in cm
|
|
590
|
+
*/
|
|
591
|
+
length?: number | null;
|
|
592
|
+
/**
|
|
593
|
+
* Width
|
|
594
|
+
* @description Width in cm
|
|
595
|
+
*/
|
|
596
|
+
width?: number | null;
|
|
597
|
+
/**
|
|
598
|
+
* Height
|
|
599
|
+
* @description Height in cm
|
|
600
|
+
*/
|
|
601
|
+
height?: number | null;
|
|
602
|
+
/**
|
|
603
|
+
* Display Order
|
|
604
|
+
* @description Display order
|
|
605
|
+
* @default 100
|
|
606
|
+
*/
|
|
607
|
+
display_order: number;
|
|
608
|
+
/**
|
|
609
|
+
* Metadata
|
|
610
|
+
* @description Flexible metadata
|
|
611
|
+
*/
|
|
612
|
+
metadata?: {
|
|
613
|
+
[key: string]: unknown;
|
|
614
|
+
} | null;
|
|
636
615
|
};
|
|
637
616
|
/**
|
|
638
617
|
* ProductPrice
|
|
@@ -691,146 +670,167 @@ export interface components {
|
|
|
691
670
|
*/
|
|
692
671
|
requires_payment_method_upfront: boolean;
|
|
693
672
|
};
|
|
673
|
+
InvalidParam: {
|
|
674
|
+
/** @example items[0].quantity */
|
|
675
|
+
field?: string;
|
|
676
|
+
/** @example Input should be greater than or equal to 1 */
|
|
677
|
+
error?: string;
|
|
678
|
+
};
|
|
694
679
|
/**
|
|
695
|
-
*
|
|
696
|
-
*
|
|
680
|
+
* @example {
|
|
681
|
+
* "status": "success",
|
|
682
|
+
* "message": "Operation successful",
|
|
683
|
+
* "message_code": "api_suc_20001",
|
|
684
|
+
* "data": {},
|
|
685
|
+
* "metadata": {
|
|
686
|
+
* "timestamp": "2026-03-26T10:00:00.000Z",
|
|
687
|
+
* "requestId": "07e22004-cb60-4dfc-bc9c-b6f99664dca1",
|
|
688
|
+
* "traceId": "a9f1204c-bb82-41de-b234-7c3a9e120000",
|
|
689
|
+
* "version": "v1",
|
|
690
|
+
* "executionTime": 42,
|
|
691
|
+
* "language": "en-US"
|
|
692
|
+
* }
|
|
693
|
+
* }
|
|
697
694
|
*/
|
|
698
|
-
|
|
695
|
+
StandardResponse: {
|
|
696
|
+
/** @example success */
|
|
697
|
+
status?: string;
|
|
698
|
+
data?: Record<string, never> | null;
|
|
699
|
+
/** @example Operation successful */
|
|
700
|
+
message?: string | null;
|
|
701
|
+
/** @example api_suc_20001 */
|
|
702
|
+
message_code?: string | null;
|
|
703
|
+
metadata?: Record<string, never> | null;
|
|
704
|
+
error?: components["schemas"]["ErrorResponse"];
|
|
705
|
+
};
|
|
706
|
+
/**
|
|
707
|
+
* SessionSection
|
|
708
|
+
* @description Session-specific fields (maps to sessions_tbl)
|
|
709
|
+
*/
|
|
710
|
+
SessionSection: {
|
|
699
711
|
/**
|
|
700
|
-
*
|
|
701
|
-
* @description
|
|
712
|
+
* Instructor Id
|
|
713
|
+
* @description External user ID of session instructor (usr_xxx)
|
|
702
714
|
*/
|
|
703
|
-
|
|
715
|
+
instructor_id?: string | null;
|
|
704
716
|
/**
|
|
705
|
-
*
|
|
706
|
-
*
|
|
717
|
+
* Starts At
|
|
718
|
+
* Format: date-time
|
|
719
|
+
* @description Session start time (UTC)
|
|
707
720
|
*/
|
|
708
|
-
|
|
721
|
+
starts_at: string;
|
|
709
722
|
/**
|
|
710
|
-
*
|
|
711
|
-
*
|
|
723
|
+
* Ends At
|
|
724
|
+
* Format: date-time
|
|
725
|
+
* @description Session end time (UTC)
|
|
712
726
|
*/
|
|
713
|
-
|
|
727
|
+
ends_at: string;
|
|
714
728
|
/**
|
|
715
|
-
*
|
|
716
|
-
* @description
|
|
729
|
+
* Duration Minutes
|
|
730
|
+
* @description Session duration in minutes
|
|
717
731
|
*/
|
|
718
|
-
|
|
732
|
+
duration_minutes?: number | null;
|
|
719
733
|
/**
|
|
720
|
-
*
|
|
721
|
-
* @description
|
|
734
|
+
* Is Recurring
|
|
735
|
+
* @description Is this a recurring session
|
|
736
|
+
* @default false
|
|
722
737
|
*/
|
|
723
|
-
|
|
738
|
+
is_recurring: boolean;
|
|
724
739
|
/**
|
|
725
|
-
*
|
|
726
|
-
* @description
|
|
740
|
+
* Recurrence Rule
|
|
741
|
+
* @description RRULE format for recurrence
|
|
727
742
|
*/
|
|
728
|
-
|
|
743
|
+
recurrence_rule?: string | null;
|
|
729
744
|
/**
|
|
730
|
-
*
|
|
731
|
-
* @description
|
|
745
|
+
* Recurrence End Date
|
|
746
|
+
* @description End date for recurring sessions
|
|
732
747
|
*/
|
|
733
|
-
|
|
748
|
+
recurrence_end_date?: string | null;
|
|
734
749
|
/**
|
|
735
|
-
*
|
|
736
|
-
* @description
|
|
750
|
+
* Max Participants
|
|
751
|
+
* @description Maximum number of participants
|
|
737
752
|
*/
|
|
738
|
-
|
|
753
|
+
max_participants?: number | null;
|
|
739
754
|
/**
|
|
740
|
-
*
|
|
741
|
-
* @description
|
|
755
|
+
* Location Type
|
|
756
|
+
* @description virtual, physical, hybrid
|
|
742
757
|
*/
|
|
743
|
-
|
|
758
|
+
location_type?: string | null;
|
|
744
759
|
/**
|
|
745
|
-
*
|
|
746
|
-
* @description
|
|
760
|
+
* Physical Location
|
|
761
|
+
* @description Physical location address
|
|
747
762
|
*/
|
|
748
|
-
|
|
763
|
+
physical_location?: string | null;
|
|
749
764
|
/**
|
|
750
|
-
*
|
|
751
|
-
* @description
|
|
752
|
-
* @default true
|
|
765
|
+
* Conferencing Platform
|
|
766
|
+
* @description zoom, teams, google_meet, webex, physical, none
|
|
753
767
|
*/
|
|
754
|
-
|
|
755
|
-
};
|
|
756
|
-
ErrorResponse: {
|
|
757
|
-
/** @example about:blank */
|
|
758
|
-
type?: string;
|
|
759
|
-
/** @example GENERIC_ERROR */
|
|
760
|
-
code?: string;
|
|
761
|
-
/** @example Client Error */
|
|
762
|
-
title?: string;
|
|
763
|
-
/** @example 400 */
|
|
764
|
-
status?: number;
|
|
765
|
-
/** @example An error occurred */
|
|
766
|
-
detail?: string;
|
|
767
|
-
/** @example /v1/cart/items */
|
|
768
|
-
instance?: string;
|
|
769
|
-
extensions?: components["schemas"]["Extensions"];
|
|
770
|
-
};
|
|
771
|
-
/**
|
|
772
|
-
* ProductSection
|
|
773
|
-
* @description Base product fields (maps to product_tbl)
|
|
774
|
-
*/
|
|
775
|
-
ProductSection: {
|
|
768
|
+
conferencing_platform?: string | null;
|
|
776
769
|
/**
|
|
777
|
-
*
|
|
778
|
-
* @description
|
|
779
|
-
* @default public
|
|
770
|
+
* Conference Account Id
|
|
771
|
+
* @description Specific conference account to use
|
|
780
772
|
*/
|
|
781
|
-
|
|
773
|
+
conference_account_id?: number | null;
|
|
782
774
|
/**
|
|
783
|
-
*
|
|
784
|
-
* @description
|
|
775
|
+
* Allows Questions
|
|
776
|
+
* @description Allow participants to ask questions
|
|
785
777
|
* @default true
|
|
786
778
|
*/
|
|
787
|
-
|
|
779
|
+
allows_questions: boolean;
|
|
788
780
|
/**
|
|
789
|
-
*
|
|
790
|
-
* @description
|
|
781
|
+
* Requires Camera
|
|
782
|
+
* @description Require participants to turn on camera
|
|
783
|
+
* @default false
|
|
791
784
|
*/
|
|
792
|
-
|
|
785
|
+
requires_camera: boolean;
|
|
786
|
+
/**
|
|
787
|
+
* Interactive Mode
|
|
788
|
+
* @description full_interactive, semi_interactive, lecture_only
|
|
789
|
+
*/
|
|
790
|
+
interactive_mode?: string | null;
|
|
793
791
|
/**
|
|
794
792
|
* Status
|
|
795
|
-
* @description
|
|
796
|
-
* @default
|
|
793
|
+
* @description scheduled, in_progress, completed, cancelled
|
|
794
|
+
* @default scheduled
|
|
797
795
|
*/
|
|
798
796
|
status: string;
|
|
799
797
|
/**
|
|
800
|
-
*
|
|
801
|
-
* @description
|
|
802
|
-
* @default true
|
|
798
|
+
* Locale
|
|
799
|
+
* @description Defaults to identity.locale if not provided
|
|
803
800
|
*/
|
|
804
|
-
|
|
801
|
+
locale?: string | null;
|
|
802
|
+
};
|
|
803
|
+
/**
|
|
804
|
+
* IdentitySection
|
|
805
|
+
* @description Localized product content (maps to product_identity_tbl)
|
|
806
|
+
*/
|
|
807
|
+
IdentitySection: {
|
|
805
808
|
/**
|
|
806
|
-
*
|
|
807
|
-
* @description
|
|
809
|
+
* Locale
|
|
810
|
+
* @description Locale: en-US, es-PR, fr-FR, pt-BR, etc.
|
|
811
|
+
* @default en-US
|
|
808
812
|
*/
|
|
809
|
-
|
|
813
|
+
locale: string;
|
|
810
814
|
/**
|
|
811
|
-
*
|
|
812
|
-
* @description
|
|
815
|
+
* Title
|
|
816
|
+
* @description Product title
|
|
813
817
|
*/
|
|
814
|
-
|
|
818
|
+
title: string;
|
|
815
819
|
/**
|
|
816
|
-
*
|
|
817
|
-
* @description
|
|
818
|
-
* @default false
|
|
820
|
+
* Subtitle
|
|
821
|
+
* @description Product subtitle
|
|
819
822
|
*/
|
|
820
|
-
|
|
821
|
-
};
|
|
822
|
-
/**
|
|
823
|
-
* PricingSection
|
|
824
|
-
* @description Pricing configuration (optional - can have product price, variant prices, or both)
|
|
825
|
-
*/
|
|
826
|
-
PricingSection: {
|
|
827
|
-
/** @description Base product price (no variant) */
|
|
828
|
-
product_price?: components["schemas"]["ProductPrice"] | null;
|
|
823
|
+
subtitle?: string | null;
|
|
829
824
|
/**
|
|
830
|
-
*
|
|
831
|
-
* @description
|
|
825
|
+
* Description
|
|
826
|
+
* @description Full product description
|
|
832
827
|
*/
|
|
833
|
-
|
|
828
|
+
description?: string | null;
|
|
829
|
+
/**
|
|
830
|
+
* Short Description
|
|
831
|
+
* @description Short description for listings/previews
|
|
832
|
+
*/
|
|
833
|
+
short_description?: string | null;
|
|
834
834
|
};
|
|
835
835
|
};
|
|
836
836
|
responses: never;
|