@blezgo/api-sdk 0.1.3 → 0.1.5
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 +153 -153
- package/dist/account/generated.d.ts.map +1 -1
- package/dist/activity/generated.d.ts +57 -57
- package/dist/activity/generated.d.ts.map +1 -1
- package/dist/addon/generated.d.ts +104 -104
- package/dist/addon/generated.d.ts.map +1 -1
- package/dist/admin/generated.d.ts +85 -85
- package/dist/admin/generated.d.ts.map +1 -1
- package/dist/affiliate/generated.d.ts +89 -89
- 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 +52 -52
- package/dist/announcements/generated.d.ts.map +1 -1
- package/dist/apikeys/generated.d.ts +43 -43
- package/dist/apikeys/generated.d.ts.map +1 -1
- package/dist/assistance/generated.d.ts +15 -15
- package/dist/assistance/generated.d.ts.map +1 -1
- package/dist/authentication/generated.d.ts +116 -116
- package/dist/authentication/generated.d.ts.map +1 -1
- package/dist/blog/generated.d.ts +168 -168
- package/dist/blog/generated.d.ts.map +1 -1
- package/dist/bundle/generated.d.ts +116 -116
- package/dist/bundle/generated.d.ts.map +1 -1
- package/dist/cache/generated.d.ts +30 -30
- package/dist/cache/generated.d.ts.map +1 -1
- package/dist/calendar/generated.d.ts +37 -37
- package/dist/calendar/generated.d.ts.map +1 -1
- package/dist/campaigns/generated.d.ts +157 -157
- package/dist/campaigns/generated.d.ts.map +1 -1
- package/dist/cart/generated.d.ts +30 -30
- package/dist/cart/generated.d.ts.map +1 -1
- package/dist/changelog/generated.d.ts +107 -107
- package/dist/changelog/generated.d.ts.map +1 -1
- package/dist/channel/generated.d.ts +231 -231
- package/dist/channel/generated.d.ts.map +1 -1
- package/dist/company/generated.d.ts +44 -44
- package/dist/company/generated.d.ts.map +1 -1
- package/dist/conference/generated.d.ts +14 -14
- package/dist/conference/generated.d.ts.map +1 -1
- package/dist/config/generated.d.ts +60 -60
- package/dist/config/generated.d.ts.map +1 -1
- package/dist/content/generated.d.ts +527 -527
- package/dist/content/generated.d.ts.map +1 -1
- package/dist/cookies/generated.d.ts +60 -60
- package/dist/cookies/generated.d.ts.map +1 -1
- package/dist/courses/generated.d.ts +348 -348
- package/dist/courses/generated.d.ts.map +1 -1
- package/dist/custom/generated.d.ts +96 -96
- package/dist/custom/generated.d.ts.map +1 -1
- package/dist/dashboard/generated.d.ts +124 -124
- package/dist/dashboard/generated.d.ts.map +1 -1
- package/dist/elasticsearch/generated.d.ts +15 -15
- package/dist/elasticsearch/generated.d.ts.map +1 -1
- package/dist/enrollments/generated.d.ts +15 -15
- package/dist/enrollments/generated.d.ts.map +1 -1
- package/dist/errors/generated.d.ts +24 -24
- 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 +111 -111
- package/dist/funnels/generated.d.ts.map +1 -1
- package/dist/gamification/generated.d.ts +105 -105
- package/dist/gamification/generated.d.ts.map +1 -1
- package/dist/impersonation/generated.d.ts +27 -27
- package/dist/impersonation/generated.d.ts.map +1 -1
- package/dist/inbox/generated.d.ts +117 -117
- package/dist/inbox/generated.d.ts.map +1 -1
- package/dist/internal/generated.d.ts +15 -15
- package/dist/internal/generated.d.ts.map +1 -1
- package/dist/internationalization/generated.d.ts +15 -15
- package/dist/internationalization/generated.d.ts.map +1 -1
- package/dist/invitations/generated.d.ts +85 -85
- package/dist/invitations/generated.d.ts.map +1 -1
- package/dist/meetings/generated.d.ts +295 -295
- package/dist/meetings/generated.d.ts.map +1 -1
- package/dist/metas/generated.d.ts +191 -191
- package/dist/metas/generated.d.ts.map +1 -1
- package/dist/notification/generated.d.ts +261 -261
- package/dist/notification/generated.d.ts.map +1 -1
- package/dist/notifications/generated.d.ts +15 -15
- package/dist/notifications/generated.d.ts.map +1 -1
- package/dist/onboarding/generated.d.ts +116 -116
- package/dist/onboarding/generated.d.ts.map +1 -1
- package/dist/packages/generated.d.ts +21 -21
- package/dist/packages/generated.d.ts.map +1 -1
- package/dist/payments/generated.d.ts +548 -548
- package/dist/payments/generated.d.ts.map +1 -1
- package/dist/payouts/generated.d.ts +15 -15
- package/dist/payouts/generated.d.ts.map +1 -1
- package/dist/plans/generated.d.ts +349 -349
- package/dist/plans/generated.d.ts.map +1 -1
- package/dist/pricing/generated.d.ts +41 -41
- package/dist/pricing/generated.d.ts.map +1 -1
- package/dist/products/generated.d.ts +398 -398
- package/dist/products/generated.d.ts.map +1 -1
- package/dist/profile/generated.d.ts +333 -333
- package/dist/profile/generated.d.ts.map +1 -1
- package/dist/reasons/generated.d.ts +81 -81
- package/dist/reasons/generated.d.ts.map +1 -1
- package/dist/registration/generated.d.ts +178 -178
- package/dist/registration/generated.d.ts.map +1 -1
- package/dist/reviews/generated.d.ts +63 -63
- package/dist/reviews/generated.d.ts.map +1 -1
- package/dist/role/generated.d.ts +218 -218
- package/dist/role/generated.d.ts.map +1 -1
- package/dist/scheduling/generated.d.ts +96 -96
- package/dist/scheduling/generated.d.ts.map +1 -1
- package/dist/services/generated.d.ts +957 -957
- package/dist/services/generated.d.ts.map +1 -1
- package/dist/sessions/generated.d.ts +370 -370
- package/dist/sessions/generated.d.ts.map +1 -1
- package/dist/spaces/generated.d.ts +533 -533
- package/dist/spaces/generated.d.ts.map +1 -1
- package/dist/storefront/generated.d.ts +15 -15
- package/dist/storefront/generated.d.ts.map +1 -1
- package/dist/support/generated.d.ts +1426 -1426
- package/dist/support/generated.d.ts.map +1 -1
- package/dist/sync/generated.d.ts +127 -127
- package/dist/sync/generated.d.ts.map +1 -1
- package/dist/tenant/generated.d.ts +528 -528
- package/dist/tenant/generated.d.ts.map +1 -1
- package/dist/testimonials/generated.d.ts +56 -56
- package/dist/testimonials/generated.d.ts.map +1 -1
- package/dist/tests/generated.d.ts +509 -509
- package/dist/tests/generated.d.ts.map +1 -1
- package/dist/tokens/generated.d.ts +50 -50
- package/dist/tokens/generated.d.ts.map +1 -1
- package/dist/uploads/generated.d.ts +29 -29
- package/dist/uploads/generated.d.ts.map +1 -1
- package/dist/upsell/generated.d.ts +80 -80
- package/dist/upsell/generated.d.ts.map +1 -1
- package/dist/user/generated.d.ts +76 -70
- package/dist/user/generated.d.ts.map +1 -1
- package/dist/webinars/generated.d.ts +336 -336
- package/dist/webinars/generated.d.ts.map +1 -1
- package/package.json +1 -1
- package/test-commit.txt +1 -0
|
@@ -223,56 +223,119 @@ export interface paths {
|
|
|
223
223
|
export type webhooks = Record<string, never>;
|
|
224
224
|
export interface components {
|
|
225
225
|
schemas: {
|
|
226
|
+
/** Body_updateSession */
|
|
227
|
+
Body_updateSession: {
|
|
228
|
+
/** Starts At */
|
|
229
|
+
starts_at?: string | null;
|
|
230
|
+
/** Ends At */
|
|
231
|
+
ends_at?: string | null;
|
|
232
|
+
/** Duration Minutes */
|
|
233
|
+
duration_minutes?: number | null;
|
|
234
|
+
/** Max Participants */
|
|
235
|
+
max_participants?: number | null;
|
|
236
|
+
/** Status */
|
|
237
|
+
status?: string | null;
|
|
238
|
+
/** Allows Questions */
|
|
239
|
+
allows_questions?: boolean | null;
|
|
240
|
+
/** Requires Camera */
|
|
241
|
+
requires_camera?: boolean | null;
|
|
242
|
+
};
|
|
226
243
|
/**
|
|
227
|
-
*
|
|
228
|
-
* @description
|
|
244
|
+
* SessionSection
|
|
245
|
+
* @description Session-specific fields (maps to sessions_tbl)
|
|
229
246
|
*/
|
|
230
|
-
|
|
247
|
+
SessionSection: {
|
|
231
248
|
/**
|
|
232
|
-
*
|
|
233
|
-
* @description
|
|
234
|
-
* @default public
|
|
249
|
+
* Instructor Id
|
|
250
|
+
* @description External user ID of session instructor (usr_xxx)
|
|
235
251
|
*/
|
|
236
|
-
|
|
252
|
+
instructor_id?: string | null;
|
|
237
253
|
/**
|
|
238
|
-
*
|
|
239
|
-
*
|
|
240
|
-
* @
|
|
254
|
+
* Starts At
|
|
255
|
+
* Format: date-time
|
|
256
|
+
* @description Session start time (UTC)
|
|
241
257
|
*/
|
|
242
|
-
|
|
258
|
+
starts_at: string;
|
|
243
259
|
/**
|
|
244
|
-
*
|
|
245
|
-
*
|
|
260
|
+
* Ends At
|
|
261
|
+
* Format: date-time
|
|
262
|
+
* @description Session end time (UTC)
|
|
246
263
|
*/
|
|
247
|
-
|
|
264
|
+
ends_at: string;
|
|
248
265
|
/**
|
|
249
|
-
*
|
|
250
|
-
* @description
|
|
251
|
-
* @default draft
|
|
266
|
+
* Duration Minutes
|
|
267
|
+
* @description Session duration in minutes
|
|
252
268
|
*/
|
|
253
|
-
|
|
269
|
+
duration_minutes?: number | null;
|
|
254
270
|
/**
|
|
255
|
-
* Is
|
|
256
|
-
* @description
|
|
257
|
-
* @default
|
|
271
|
+
* Is Recurring
|
|
272
|
+
* @description Is this a recurring session
|
|
273
|
+
* @default false
|
|
258
274
|
*/
|
|
259
|
-
|
|
275
|
+
is_recurring: boolean;
|
|
260
276
|
/**
|
|
261
|
-
*
|
|
262
|
-
* @description
|
|
277
|
+
* Recurrence Rule
|
|
278
|
+
* @description RRULE format for recurrence
|
|
263
279
|
*/
|
|
264
|
-
|
|
280
|
+
recurrence_rule?: string | null;
|
|
265
281
|
/**
|
|
266
|
-
*
|
|
267
|
-
* @description
|
|
282
|
+
* Recurrence End Date
|
|
283
|
+
* @description End date for recurring sessions
|
|
268
284
|
*/
|
|
269
|
-
|
|
285
|
+
recurrence_end_date?: string | null;
|
|
270
286
|
/**
|
|
271
|
-
*
|
|
272
|
-
* @description
|
|
287
|
+
* Max Participants
|
|
288
|
+
* @description Maximum number of participants
|
|
289
|
+
*/
|
|
290
|
+
max_participants?: number | null;
|
|
291
|
+
/**
|
|
292
|
+
* Location Type
|
|
293
|
+
* @description virtual, physical, hybrid
|
|
294
|
+
*/
|
|
295
|
+
location_type?: string | null;
|
|
296
|
+
/**
|
|
297
|
+
* Physical Location
|
|
298
|
+
* @description Physical location address
|
|
299
|
+
*/
|
|
300
|
+
physical_location?: string | null;
|
|
301
|
+
/**
|
|
302
|
+
* Conferencing Platform
|
|
303
|
+
* @description zoom, teams, google_meet, webex, physical, none
|
|
304
|
+
*/
|
|
305
|
+
conferencing_platform?: string | null;
|
|
306
|
+
/**
|
|
307
|
+
* Conference Account Id
|
|
308
|
+
* @description Specific conference account to use
|
|
309
|
+
*/
|
|
310
|
+
conference_account_id?: number | null;
|
|
311
|
+
/**
|
|
312
|
+
* Allows Questions
|
|
313
|
+
* @description Allow participants to ask questions
|
|
314
|
+
* @default true
|
|
315
|
+
*/
|
|
316
|
+
allows_questions: boolean;
|
|
317
|
+
/**
|
|
318
|
+
* Requires Camera
|
|
319
|
+
* @description Require participants to turn on camera
|
|
273
320
|
* @default false
|
|
274
321
|
*/
|
|
275
|
-
|
|
322
|
+
requires_camera: boolean;
|
|
323
|
+
/**
|
|
324
|
+
* Interactive Mode
|
|
325
|
+
* @description full_interactive, semi_interactive, lecture_only
|
|
326
|
+
*/
|
|
327
|
+
interactive_mode?: string | null;
|
|
328
|
+
/**
|
|
329
|
+
* Status
|
|
330
|
+
* @description scheduled, in_progress, completed, cancelled
|
|
331
|
+
* @default scheduled
|
|
332
|
+
*/
|
|
333
|
+
status: string;
|
|
334
|
+
/**
|
|
335
|
+
* Locale
|
|
336
|
+
* @description Defaults to identity.locale if not provided
|
|
337
|
+
*/
|
|
338
|
+
locale?: string | null;
|
|
276
339
|
};
|
|
277
340
|
/**
|
|
278
341
|
* @example {
|
|
@@ -302,149 +365,83 @@ export interface components {
|
|
|
302
365
|
error?: components["schemas"]["ErrorResponse"];
|
|
303
366
|
};
|
|
304
367
|
/**
|
|
305
|
-
*
|
|
306
|
-
* @description
|
|
368
|
+
* VariantItem
|
|
369
|
+
* @description Product variant (maps to product_variants_tbl)
|
|
307
370
|
*/
|
|
308
|
-
|
|
309
|
-
/**
|
|
310
|
-
* Price Type
|
|
311
|
-
* @description free, one_time, subscription, monthly_plan
|
|
312
|
-
*/
|
|
313
|
-
price_type: string;
|
|
314
|
-
/**
|
|
315
|
-
* Currency
|
|
316
|
-
* @description Currency code: INR, USD, EUR, etc.
|
|
317
|
-
*/
|
|
318
|
-
currency: string;
|
|
319
|
-
/**
|
|
320
|
-
* Amount
|
|
321
|
-
* @description Price amount
|
|
322
|
-
*/
|
|
323
|
-
amount: number;
|
|
324
|
-
/**
|
|
325
|
-
* Compare At Amount
|
|
326
|
-
* @description Original/strike-through price
|
|
327
|
-
*/
|
|
328
|
-
compare_at_amount?: number | null;
|
|
329
|
-
/**
|
|
330
|
-
* Interval
|
|
331
|
-
* @description day, week, month, year (for subscription)
|
|
332
|
-
*/
|
|
333
|
-
interval?: string | null;
|
|
334
|
-
/**
|
|
335
|
-
* Interval Count
|
|
336
|
-
* @description Number of intervals
|
|
337
|
-
*/
|
|
338
|
-
interval_count?: number | null;
|
|
339
|
-
/**
|
|
340
|
-
* Trial Period Days
|
|
341
|
-
* @description Free trial days
|
|
342
|
-
*/
|
|
343
|
-
trial_period_days?: number | null;
|
|
371
|
+
VariantItem: {
|
|
344
372
|
/**
|
|
345
|
-
*
|
|
346
|
-
* @description
|
|
373
|
+
* Name
|
|
374
|
+
* @description Variant display name
|
|
347
375
|
*/
|
|
348
|
-
|
|
376
|
+
name: string;
|
|
349
377
|
/**
|
|
350
|
-
*
|
|
351
|
-
* @description
|
|
378
|
+
* Sku
|
|
379
|
+
* @description Stock Keeping Unit
|
|
352
380
|
*/
|
|
353
|
-
|
|
381
|
+
sku?: string | null;
|
|
354
382
|
/**
|
|
355
|
-
*
|
|
356
|
-
* @description
|
|
357
|
-
* @default true
|
|
383
|
+
* Attributes
|
|
384
|
+
* @description Custom attributes
|
|
358
385
|
*/
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
* MediaSection
|
|
363
|
-
* @description Product media files - direct media data
|
|
364
|
-
*/
|
|
365
|
-
MediaSection: {
|
|
386
|
+
attributes?: {
|
|
387
|
+
[key: string]: unknown;
|
|
388
|
+
} | null;
|
|
366
389
|
/**
|
|
367
|
-
*
|
|
368
|
-
* @description
|
|
390
|
+
* Is Default
|
|
391
|
+
* @description Set as default variant
|
|
392
|
+
* @default false
|
|
369
393
|
*/
|
|
370
|
-
|
|
371
|
-
};
|
|
372
|
-
InvalidParam: {
|
|
373
|
-
/** @example items[0].quantity */
|
|
374
|
-
field?: string;
|
|
375
|
-
/** @example Input should be greater than or equal to 1 */
|
|
376
|
-
error?: string;
|
|
377
|
-
};
|
|
378
|
-
/**
|
|
379
|
-
* MediaItem
|
|
380
|
-
* @description Single media file item
|
|
381
|
-
*/
|
|
382
|
-
MediaItem: {
|
|
394
|
+
is_default: boolean;
|
|
383
395
|
/**
|
|
384
|
-
*
|
|
385
|
-
* @description
|
|
396
|
+
* Track Inventory
|
|
397
|
+
* @description Track stock for this variant
|
|
398
|
+
* @default false
|
|
386
399
|
*/
|
|
387
|
-
|
|
400
|
+
track_inventory: boolean;
|
|
388
401
|
/**
|
|
389
|
-
*
|
|
390
|
-
* @description
|
|
402
|
+
* Stock Quantity
|
|
403
|
+
* @description Initial stock
|
|
391
404
|
*/
|
|
392
|
-
|
|
405
|
+
stock_quantity?: number | null;
|
|
393
406
|
/**
|
|
394
|
-
*
|
|
395
|
-
* @description
|
|
407
|
+
* Allow Backorder
|
|
408
|
+
* @description Allow orders when out of stock
|
|
409
|
+
* @default false
|
|
396
410
|
*/
|
|
397
|
-
|
|
411
|
+
allow_backorder: boolean;
|
|
398
412
|
/**
|
|
399
|
-
*
|
|
400
|
-
* @description
|
|
413
|
+
* Weight
|
|
414
|
+
* @description Weight in kg
|
|
401
415
|
*/
|
|
402
|
-
|
|
416
|
+
weight?: number | null;
|
|
403
417
|
/**
|
|
404
|
-
*
|
|
405
|
-
* @description
|
|
418
|
+
* Length
|
|
419
|
+
* @description Length in cm
|
|
406
420
|
*/
|
|
407
|
-
|
|
421
|
+
length?: number | null;
|
|
408
422
|
/**
|
|
409
423
|
* Width
|
|
410
|
-
* @description Width in
|
|
424
|
+
* @description Width in cm
|
|
411
425
|
*/
|
|
412
426
|
width?: number | null;
|
|
413
427
|
/**
|
|
414
428
|
* Height
|
|
415
|
-
* @description Height in
|
|
429
|
+
* @description Height in cm
|
|
416
430
|
*/
|
|
417
431
|
height?: number | null;
|
|
418
432
|
/**
|
|
419
|
-
*
|
|
420
|
-
* @description
|
|
421
|
-
|
|
422
|
-
responsive_versions?: {
|
|
423
|
-
[key: string]: string;
|
|
424
|
-
} | null;
|
|
425
|
-
/**
|
|
426
|
-
* Alt Text
|
|
427
|
-
* @description Alt text for SEO/accessibility
|
|
428
|
-
*/
|
|
429
|
-
alt_text?: string | null;
|
|
430
|
-
/**
|
|
431
|
-
* Locale
|
|
432
|
-
* @description Media locale (en-US, es-PR, etc.)
|
|
433
|
-
* @default en-US
|
|
434
|
-
*/
|
|
435
|
-
locale: string;
|
|
436
|
-
/**
|
|
437
|
-
* Display Order
|
|
438
|
-
* @description Display order
|
|
439
|
-
* @default 0
|
|
433
|
+
* Display Order
|
|
434
|
+
* @description Display order
|
|
435
|
+
* @default 100
|
|
440
436
|
*/
|
|
441
437
|
display_order: number;
|
|
442
438
|
/**
|
|
443
|
-
*
|
|
444
|
-
* @description
|
|
445
|
-
* @default false
|
|
439
|
+
* Metadata
|
|
440
|
+
* @description Flexible metadata
|
|
446
441
|
*/
|
|
447
|
-
|
|
442
|
+
metadata?: {
|
|
443
|
+
[key: string]: unknown;
|
|
444
|
+
} | null;
|
|
448
445
|
};
|
|
449
446
|
Extensions: {
|
|
450
447
|
/** @example GENERIC_ERROR */
|
|
@@ -455,83 +452,6 @@ export interface components {
|
|
|
455
452
|
/** @example Detailed debug information */
|
|
456
453
|
debug?: string | null;
|
|
457
454
|
};
|
|
458
|
-
/**
|
|
459
|
-
* VariantPrice
|
|
460
|
-
* @description Variant-specific pricing (maps to product_pricings_tbl with variant_id set)
|
|
461
|
-
*/
|
|
462
|
-
VariantPrice: {
|
|
463
|
-
/**
|
|
464
|
-
* Variant Index
|
|
465
|
-
* @description Index in variants array (0-based)
|
|
466
|
-
*/
|
|
467
|
-
variant_index: number;
|
|
468
|
-
/**
|
|
469
|
-
* Price Type
|
|
470
|
-
* @description free, one_time, subscription, monthly_plan
|
|
471
|
-
*/
|
|
472
|
-
price_type: string;
|
|
473
|
-
/**
|
|
474
|
-
* Currency
|
|
475
|
-
* @description Currency code
|
|
476
|
-
*/
|
|
477
|
-
currency: string;
|
|
478
|
-
/**
|
|
479
|
-
* Amount
|
|
480
|
-
* @description Price amount
|
|
481
|
-
*/
|
|
482
|
-
amount: number;
|
|
483
|
-
/**
|
|
484
|
-
* Compare At Amount
|
|
485
|
-
* @description Original/strike-through price
|
|
486
|
-
*/
|
|
487
|
-
compare_at_amount?: number | null;
|
|
488
|
-
/**
|
|
489
|
-
* Interval
|
|
490
|
-
* @description day, week, month, year
|
|
491
|
-
*/
|
|
492
|
-
interval?: string | null;
|
|
493
|
-
/**
|
|
494
|
-
* Interval Count
|
|
495
|
-
* @description Number of intervals
|
|
496
|
-
*/
|
|
497
|
-
interval_count?: number | null;
|
|
498
|
-
/**
|
|
499
|
-
* Trial Period Days
|
|
500
|
-
* @description Free trial days
|
|
501
|
-
*/
|
|
502
|
-
trial_period_days?: number | null;
|
|
503
|
-
/**
|
|
504
|
-
* Initial Amount
|
|
505
|
-
* @description First payment amount
|
|
506
|
-
*/
|
|
507
|
-
initial_amount?: number | null;
|
|
508
|
-
/**
|
|
509
|
-
* Gateway
|
|
510
|
-
* @description stripe, razorpay, paypal, etc.
|
|
511
|
-
*/
|
|
512
|
-
gateway?: string | null;
|
|
513
|
-
/**
|
|
514
|
-
* Requires Payment Method Upfront
|
|
515
|
-
* @description Require payment method before trial
|
|
516
|
-
* @default true
|
|
517
|
-
*/
|
|
518
|
-
requires_payment_method_upfront: boolean;
|
|
519
|
-
};
|
|
520
|
-
ErrorResponse: {
|
|
521
|
-
/** @example about:blank */
|
|
522
|
-
type?: string;
|
|
523
|
-
/** @example GENERIC_ERROR */
|
|
524
|
-
code?: string;
|
|
525
|
-
/** @example Client Error */
|
|
526
|
-
title?: string;
|
|
527
|
-
/** @example 400 */
|
|
528
|
-
status?: number;
|
|
529
|
-
/** @example An error occurred */
|
|
530
|
-
detail?: string;
|
|
531
|
-
/** @example /v1/cart/items */
|
|
532
|
-
instance?: string;
|
|
533
|
-
extensions?: components["schemas"]["Extensions"];
|
|
534
|
-
};
|
|
535
455
|
/**
|
|
536
456
|
* SessionCreateRequest
|
|
537
457
|
* @description Session creation request - inherits common fields, adds session-specific section
|
|
@@ -595,131 +515,61 @@ export interface components {
|
|
|
595
515
|
session: components["schemas"]["SessionSection"];
|
|
596
516
|
};
|
|
597
517
|
/**
|
|
598
|
-
*
|
|
599
|
-
* @description
|
|
518
|
+
* ProductPrice
|
|
519
|
+
* @description Base product pricing (maps to product_pricings_tbl with variant_id=NULL)
|
|
600
520
|
*/
|
|
601
|
-
|
|
602
|
-
/**
|
|
603
|
-
* Instructor Id
|
|
604
|
-
* @description External user ID of session instructor (usr_xxx)
|
|
605
|
-
*/
|
|
606
|
-
instructor_id?: string | null;
|
|
607
|
-
/**
|
|
608
|
-
* Starts At
|
|
609
|
-
* Format: date-time
|
|
610
|
-
* @description Session start time (UTC)
|
|
611
|
-
*/
|
|
612
|
-
starts_at: string;
|
|
613
|
-
/**
|
|
614
|
-
* Ends At
|
|
615
|
-
* Format: date-time
|
|
616
|
-
* @description Session end time (UTC)
|
|
617
|
-
*/
|
|
618
|
-
ends_at: string;
|
|
521
|
+
ProductPrice: {
|
|
619
522
|
/**
|
|
620
|
-
*
|
|
621
|
-
* @description
|
|
523
|
+
* Price Type
|
|
524
|
+
* @description free, one_time, subscription, monthly_plan
|
|
622
525
|
*/
|
|
623
|
-
|
|
526
|
+
price_type: string;
|
|
624
527
|
/**
|
|
625
|
-
*
|
|
626
|
-
* @description
|
|
627
|
-
* @default false
|
|
528
|
+
* Currency
|
|
529
|
+
* @description Currency code: INR, USD, EUR, etc.
|
|
628
530
|
*/
|
|
629
|
-
|
|
531
|
+
currency: string;
|
|
630
532
|
/**
|
|
631
|
-
*
|
|
632
|
-
* @description
|
|
533
|
+
* Amount
|
|
534
|
+
* @description Price amount
|
|
633
535
|
*/
|
|
634
|
-
|
|
536
|
+
amount: number;
|
|
635
537
|
/**
|
|
636
|
-
*
|
|
637
|
-
* @description
|
|
538
|
+
* Compare At Amount
|
|
539
|
+
* @description Original/strike-through price
|
|
638
540
|
*/
|
|
639
|
-
|
|
541
|
+
compare_at_amount?: number | null;
|
|
640
542
|
/**
|
|
641
|
-
*
|
|
642
|
-
* @description
|
|
543
|
+
* Interval
|
|
544
|
+
* @description day, week, month, year (for subscription)
|
|
643
545
|
*/
|
|
644
|
-
|
|
546
|
+
interval?: string | null;
|
|
645
547
|
/**
|
|
646
|
-
*
|
|
647
|
-
* @description
|
|
548
|
+
* Interval Count
|
|
549
|
+
* @description Number of intervals
|
|
648
550
|
*/
|
|
649
|
-
|
|
551
|
+
interval_count?: number | null;
|
|
650
552
|
/**
|
|
651
|
-
*
|
|
652
|
-
* @description
|
|
553
|
+
* Trial Period Days
|
|
554
|
+
* @description Free trial days
|
|
653
555
|
*/
|
|
654
|
-
|
|
556
|
+
trial_period_days?: number | null;
|
|
655
557
|
/**
|
|
656
|
-
*
|
|
657
|
-
* @description
|
|
558
|
+
* Initial Amount
|
|
559
|
+
* @description First payment amount
|
|
658
560
|
*/
|
|
659
|
-
|
|
561
|
+
initial_amount?: number | null;
|
|
660
562
|
/**
|
|
661
|
-
*
|
|
662
|
-
* @description
|
|
563
|
+
* Gateway
|
|
564
|
+
* @description stripe, razorpay, paypal, etc.
|
|
663
565
|
*/
|
|
664
|
-
|
|
566
|
+
gateway?: string | null;
|
|
665
567
|
/**
|
|
666
|
-
*
|
|
667
|
-
* @description
|
|
568
|
+
* Requires Payment Method Upfront
|
|
569
|
+
* @description Require payment method before trial
|
|
668
570
|
* @default true
|
|
669
571
|
*/
|
|
670
|
-
|
|
671
|
-
/**
|
|
672
|
-
* Requires Camera
|
|
673
|
-
* @description Require participants to turn on camera
|
|
674
|
-
* @default false
|
|
675
|
-
*/
|
|
676
|
-
requires_camera: boolean;
|
|
677
|
-
/**
|
|
678
|
-
* Interactive Mode
|
|
679
|
-
* @description full_interactive, semi_interactive, lecture_only
|
|
680
|
-
*/
|
|
681
|
-
interactive_mode?: string | null;
|
|
682
|
-
/**
|
|
683
|
-
* Status
|
|
684
|
-
* @description scheduled, in_progress, completed, cancelled
|
|
685
|
-
* @default scheduled
|
|
686
|
-
*/
|
|
687
|
-
status: string;
|
|
688
|
-
/**
|
|
689
|
-
* Locale
|
|
690
|
-
* @description Defaults to identity.locale if not provided
|
|
691
|
-
*/
|
|
692
|
-
locale?: string | null;
|
|
693
|
-
};
|
|
694
|
-
/**
|
|
695
|
-
* PricingSection
|
|
696
|
-
* @description Pricing configuration (optional - can have product price, variant prices, or both)
|
|
697
|
-
*/
|
|
698
|
-
PricingSection: {
|
|
699
|
-
/** @description Base product price (no variant) */
|
|
700
|
-
product_price?: components["schemas"]["ProductPrice"] | null;
|
|
701
|
-
/**
|
|
702
|
-
* Variant Prices
|
|
703
|
-
* @description Variant-specific prices
|
|
704
|
-
*/
|
|
705
|
-
variant_prices?: components["schemas"]["VariantPrice"][] | null;
|
|
706
|
-
};
|
|
707
|
-
/** Body_updateSession */
|
|
708
|
-
Body_updateSession: {
|
|
709
|
-
/** Starts At */
|
|
710
|
-
starts_at?: string | null;
|
|
711
|
-
/** Ends At */
|
|
712
|
-
ends_at?: string | null;
|
|
713
|
-
/** Duration Minutes */
|
|
714
|
-
duration_minutes?: number | null;
|
|
715
|
-
/** Max Participants */
|
|
716
|
-
max_participants?: number | null;
|
|
717
|
-
/** Status */
|
|
718
|
-
status?: string | null;
|
|
719
|
-
/** Allows Questions */
|
|
720
|
-
allows_questions?: boolean | null;
|
|
721
|
-
/** Requires Camera */
|
|
722
|
-
requires_camera?: boolean | null;
|
|
572
|
+
requires_payment_method_upfront: boolean;
|
|
723
573
|
};
|
|
724
574
|
/**
|
|
725
575
|
* IdentitySection
|
|
@@ -754,83 +604,233 @@ export interface components {
|
|
|
754
604
|
short_description?: string | null;
|
|
755
605
|
};
|
|
756
606
|
/**
|
|
757
|
-
*
|
|
758
|
-
* @description
|
|
607
|
+
* MediaItem
|
|
608
|
+
* @description Single media file item
|
|
759
609
|
*/
|
|
760
|
-
|
|
610
|
+
MediaItem: {
|
|
761
611
|
/**
|
|
762
|
-
*
|
|
763
|
-
* @description
|
|
612
|
+
* Media Type
|
|
613
|
+
* @description logo, banner, promo_video, gallery_image, gallery_video, swatch
|
|
764
614
|
*/
|
|
765
|
-
|
|
615
|
+
media_type: string;
|
|
766
616
|
/**
|
|
767
|
-
*
|
|
768
|
-
* @description
|
|
617
|
+
* File Path
|
|
618
|
+
* @description Path to media file on storage (S3, CDN, local)
|
|
769
619
|
*/
|
|
770
|
-
|
|
620
|
+
file_path: string;
|
|
771
621
|
/**
|
|
772
|
-
*
|
|
773
|
-
* @description
|
|
622
|
+
* File Name
|
|
623
|
+
* @description Original filename
|
|
774
624
|
*/
|
|
775
|
-
|
|
776
|
-
|
|
625
|
+
file_name: string;
|
|
626
|
+
/**
|
|
627
|
+
* File Size
|
|
628
|
+
* @description File size in bytes
|
|
629
|
+
*/
|
|
630
|
+
file_size?: number | null;
|
|
631
|
+
/**
|
|
632
|
+
* Mime Type
|
|
633
|
+
* @description MIME type (image/png, video/mp4, etc.)
|
|
634
|
+
*/
|
|
635
|
+
mime_type?: string | null;
|
|
636
|
+
/**
|
|
637
|
+
* Width
|
|
638
|
+
* @description Width in pixels (for images/videos)
|
|
639
|
+
*/
|
|
640
|
+
width?: number | null;
|
|
641
|
+
/**
|
|
642
|
+
* Height
|
|
643
|
+
* @description Height in pixels (for images/videos)
|
|
644
|
+
*/
|
|
645
|
+
height?: number | null;
|
|
646
|
+
/**
|
|
647
|
+
* Responsive Versions
|
|
648
|
+
* @description JSON with thumbnail, small, medium, large, xlarge, original paths
|
|
649
|
+
*/
|
|
650
|
+
responsive_versions?: {
|
|
651
|
+
[key: string]: string;
|
|
777
652
|
} | null;
|
|
778
653
|
/**
|
|
779
|
-
*
|
|
780
|
-
* @description
|
|
781
|
-
* @default false
|
|
654
|
+
* Alt Text
|
|
655
|
+
* @description Alt text for SEO/accessibility
|
|
782
656
|
*/
|
|
783
|
-
|
|
657
|
+
alt_text?: string | null;
|
|
784
658
|
/**
|
|
785
|
-
*
|
|
786
|
-
* @description
|
|
787
|
-
* @default
|
|
659
|
+
* Locale
|
|
660
|
+
* @description Media locale (en-US, es-PR, etc.)
|
|
661
|
+
* @default en-US
|
|
788
662
|
*/
|
|
789
|
-
|
|
663
|
+
locale: string;
|
|
790
664
|
/**
|
|
791
|
-
*
|
|
792
|
-
* @description
|
|
665
|
+
* Display Order
|
|
666
|
+
* @description Display order
|
|
667
|
+
* @default 0
|
|
793
668
|
*/
|
|
794
|
-
|
|
669
|
+
display_order: number;
|
|
795
670
|
/**
|
|
796
|
-
*
|
|
797
|
-
* @description
|
|
671
|
+
* Is Primary
|
|
672
|
+
* @description Mark as primary media
|
|
798
673
|
* @default false
|
|
799
674
|
*/
|
|
800
|
-
|
|
675
|
+
is_primary: boolean;
|
|
676
|
+
};
|
|
677
|
+
InvalidParam: {
|
|
678
|
+
/** @example items[0].quantity */
|
|
679
|
+
field?: string;
|
|
680
|
+
/** @example Input should be greater than or equal to 1 */
|
|
681
|
+
error?: string;
|
|
682
|
+
};
|
|
683
|
+
/**
|
|
684
|
+
* VariantPrice
|
|
685
|
+
* @description Variant-specific pricing (maps to product_pricings_tbl with variant_id set)
|
|
686
|
+
*/
|
|
687
|
+
VariantPrice: {
|
|
801
688
|
/**
|
|
802
|
-
*
|
|
803
|
-
* @description
|
|
689
|
+
* Variant Index
|
|
690
|
+
* @description Index in variants array (0-based)
|
|
804
691
|
*/
|
|
805
|
-
|
|
692
|
+
variant_index: number;
|
|
806
693
|
/**
|
|
807
|
-
*
|
|
808
|
-
* @description
|
|
694
|
+
* Price Type
|
|
695
|
+
* @description free, one_time, subscription, monthly_plan
|
|
809
696
|
*/
|
|
810
|
-
|
|
697
|
+
price_type: string;
|
|
811
698
|
/**
|
|
812
|
-
*
|
|
813
|
-
* @description
|
|
699
|
+
* Currency
|
|
700
|
+
* @description Currency code
|
|
814
701
|
*/
|
|
815
|
-
|
|
702
|
+
currency: string;
|
|
816
703
|
/**
|
|
817
|
-
*
|
|
818
|
-
* @description
|
|
704
|
+
* Amount
|
|
705
|
+
* @description Price amount
|
|
819
706
|
*/
|
|
820
|
-
|
|
707
|
+
amount: number;
|
|
821
708
|
/**
|
|
822
|
-
*
|
|
823
|
-
* @description
|
|
824
|
-
* @default 100
|
|
709
|
+
* Compare At Amount
|
|
710
|
+
* @description Original/strike-through price
|
|
825
711
|
*/
|
|
826
|
-
|
|
712
|
+
compare_at_amount?: number | null;
|
|
827
713
|
/**
|
|
828
|
-
*
|
|
829
|
-
* @description
|
|
714
|
+
* Interval
|
|
715
|
+
* @description day, week, month, year
|
|
830
716
|
*/
|
|
831
|
-
|
|
832
|
-
|
|
833
|
-
|
|
717
|
+
interval?: string | null;
|
|
718
|
+
/**
|
|
719
|
+
* Interval Count
|
|
720
|
+
* @description Number of intervals
|
|
721
|
+
*/
|
|
722
|
+
interval_count?: number | null;
|
|
723
|
+
/**
|
|
724
|
+
* Trial Period Days
|
|
725
|
+
* @description Free trial days
|
|
726
|
+
*/
|
|
727
|
+
trial_period_days?: number | null;
|
|
728
|
+
/**
|
|
729
|
+
* Initial Amount
|
|
730
|
+
* @description First payment amount
|
|
731
|
+
*/
|
|
732
|
+
initial_amount?: number | null;
|
|
733
|
+
/**
|
|
734
|
+
* Gateway
|
|
735
|
+
* @description stripe, razorpay, paypal, etc.
|
|
736
|
+
*/
|
|
737
|
+
gateway?: string | null;
|
|
738
|
+
/**
|
|
739
|
+
* Requires Payment Method Upfront
|
|
740
|
+
* @description Require payment method before trial
|
|
741
|
+
* @default true
|
|
742
|
+
*/
|
|
743
|
+
requires_payment_method_upfront: boolean;
|
|
744
|
+
};
|
|
745
|
+
/**
|
|
746
|
+
* ProductSection
|
|
747
|
+
* @description Base product fields (maps to product_tbl)
|
|
748
|
+
*/
|
|
749
|
+
ProductSection: {
|
|
750
|
+
/**
|
|
751
|
+
* Visibility
|
|
752
|
+
* @description public, private, hidden, unlisted
|
|
753
|
+
* @default public
|
|
754
|
+
*/
|
|
755
|
+
visibility: string;
|
|
756
|
+
/**
|
|
757
|
+
* Is Digital
|
|
758
|
+
* @description Digital product flag
|
|
759
|
+
* @default true
|
|
760
|
+
*/
|
|
761
|
+
is_digital: boolean;
|
|
762
|
+
/**
|
|
763
|
+
* Company Id
|
|
764
|
+
* @description Multi-company support
|
|
765
|
+
*/
|
|
766
|
+
company_id?: number | null;
|
|
767
|
+
/**
|
|
768
|
+
* Status
|
|
769
|
+
* @description draft, published, archived, review_required, deleted
|
|
770
|
+
* @default draft
|
|
771
|
+
*/
|
|
772
|
+
status: string;
|
|
773
|
+
/**
|
|
774
|
+
* Is Org Level
|
|
775
|
+
* @description Org-level vs user-created product
|
|
776
|
+
* @default true
|
|
777
|
+
*/
|
|
778
|
+
is_org_level: boolean;
|
|
779
|
+
/**
|
|
780
|
+
* Staff Id
|
|
781
|
+
* @description Staff/instructor delivering product
|
|
782
|
+
*/
|
|
783
|
+
staff_id?: number | null;
|
|
784
|
+
/**
|
|
785
|
+
* Owner Id
|
|
786
|
+
* @description Owner of the product
|
|
787
|
+
*/
|
|
788
|
+
owner_id?: number | null;
|
|
789
|
+
/**
|
|
790
|
+
* Featured
|
|
791
|
+
* @description Featured product flag
|
|
792
|
+
* @default false
|
|
793
|
+
*/
|
|
794
|
+
featured: boolean;
|
|
795
|
+
};
|
|
796
|
+
ErrorResponse: {
|
|
797
|
+
/** @example about:blank */
|
|
798
|
+
type?: string;
|
|
799
|
+
/** @example GENERIC_ERROR */
|
|
800
|
+
code?: string;
|
|
801
|
+
/** @example Client Error */
|
|
802
|
+
title?: string;
|
|
803
|
+
/** @example 400 */
|
|
804
|
+
status?: number;
|
|
805
|
+
/** @example An error occurred */
|
|
806
|
+
detail?: string;
|
|
807
|
+
/** @example /v1/cart/items */
|
|
808
|
+
instance?: string;
|
|
809
|
+
extensions?: components["schemas"]["Extensions"];
|
|
810
|
+
};
|
|
811
|
+
/**
|
|
812
|
+
* MediaSection
|
|
813
|
+
* @description Product media files - direct media data
|
|
814
|
+
*/
|
|
815
|
+
MediaSection: {
|
|
816
|
+
/**
|
|
817
|
+
* Media Items
|
|
818
|
+
* @description List of media files to attach to product
|
|
819
|
+
*/
|
|
820
|
+
media_items?: components["schemas"]["MediaItem"][] | null;
|
|
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;
|
|
829
|
+
/**
|
|
830
|
+
* Variant Prices
|
|
831
|
+
* @description Variant-specific prices
|
|
832
|
+
*/
|
|
833
|
+
variant_prices?: components["schemas"]["VariantPrice"][] | null;
|
|
834
834
|
};
|
|
835
835
|
};
|
|
836
836
|
responses: never;
|