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