@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
|
@@ -224,57 +224,6 @@ export interface paths {
|
|
|
224
224
|
export type webhooks = Record<string, never>;
|
|
225
225
|
export interface components {
|
|
226
226
|
schemas: {
|
|
227
|
-
/**
|
|
228
|
-
* ProductSection
|
|
229
|
-
* @description Base product fields (maps to product_tbl)
|
|
230
|
-
*/
|
|
231
|
-
ProductSection: {
|
|
232
|
-
/**
|
|
233
|
-
* Visibility
|
|
234
|
-
* @description public, private, hidden, unlisted
|
|
235
|
-
* @default public
|
|
236
|
-
*/
|
|
237
|
-
visibility: string;
|
|
238
|
-
/**
|
|
239
|
-
* Is Digital
|
|
240
|
-
* @description Digital product flag
|
|
241
|
-
* @default true
|
|
242
|
-
*/
|
|
243
|
-
is_digital: boolean;
|
|
244
|
-
/**
|
|
245
|
-
* Company Id
|
|
246
|
-
* @description Multi-company support
|
|
247
|
-
*/
|
|
248
|
-
company_id?: number | null;
|
|
249
|
-
/**
|
|
250
|
-
* Status
|
|
251
|
-
* @description draft, published, archived, review_required, deleted
|
|
252
|
-
* @default draft
|
|
253
|
-
*/
|
|
254
|
-
status: string;
|
|
255
|
-
/**
|
|
256
|
-
* Is Org Level
|
|
257
|
-
* @description Org-level vs user-created product
|
|
258
|
-
* @default true
|
|
259
|
-
*/
|
|
260
|
-
is_org_level: boolean;
|
|
261
|
-
/**
|
|
262
|
-
* Staff Id
|
|
263
|
-
* @description Staff/instructor delivering product
|
|
264
|
-
*/
|
|
265
|
-
staff_id?: number | null;
|
|
266
|
-
/**
|
|
267
|
-
* Owner Id
|
|
268
|
-
* @description Owner of the product
|
|
269
|
-
*/
|
|
270
|
-
owner_id?: number | null;
|
|
271
|
-
/**
|
|
272
|
-
* Featured
|
|
273
|
-
* @description Featured product flag
|
|
274
|
-
* @default false
|
|
275
|
-
*/
|
|
276
|
-
featured: boolean;
|
|
277
|
-
};
|
|
278
227
|
/**
|
|
279
228
|
* @example {
|
|
280
229
|
* "status": "success",
|
|
@@ -302,63 +251,6 @@ export interface components {
|
|
|
302
251
|
metadata?: Record<string, never> | null;
|
|
303
252
|
error?: components["schemas"]["ErrorResponse"];
|
|
304
253
|
};
|
|
305
|
-
/**
|
|
306
|
-
* ProductPrice
|
|
307
|
-
* @description Base product pricing (maps to product_pricings_tbl with variant_id=NULL)
|
|
308
|
-
*/
|
|
309
|
-
ProductPrice: {
|
|
310
|
-
/**
|
|
311
|
-
* Price Type
|
|
312
|
-
* @description free, one_time, subscription, monthly_plan
|
|
313
|
-
*/
|
|
314
|
-
price_type: string;
|
|
315
|
-
/**
|
|
316
|
-
* Currency
|
|
317
|
-
* @description Currency code: INR, USD, EUR, etc.
|
|
318
|
-
*/
|
|
319
|
-
currency: string;
|
|
320
|
-
/**
|
|
321
|
-
* Amount
|
|
322
|
-
* @description Price amount
|
|
323
|
-
*/
|
|
324
|
-
amount: number;
|
|
325
|
-
/**
|
|
326
|
-
* Compare At Amount
|
|
327
|
-
* @description Original/strike-through price
|
|
328
|
-
*/
|
|
329
|
-
compare_at_amount?: number | null;
|
|
330
|
-
/**
|
|
331
|
-
* Interval
|
|
332
|
-
* @description day, week, month, year (for subscription)
|
|
333
|
-
*/
|
|
334
|
-
interval?: string | null;
|
|
335
|
-
/**
|
|
336
|
-
* Interval Count
|
|
337
|
-
* @description Number of intervals
|
|
338
|
-
*/
|
|
339
|
-
interval_count?: number | null;
|
|
340
|
-
/**
|
|
341
|
-
* Trial Period Days
|
|
342
|
-
* @description Free trial days
|
|
343
|
-
*/
|
|
344
|
-
trial_period_days?: number | null;
|
|
345
|
-
/**
|
|
346
|
-
* Initial Amount
|
|
347
|
-
* @description First payment amount
|
|
348
|
-
*/
|
|
349
|
-
initial_amount?: number | null;
|
|
350
|
-
/**
|
|
351
|
-
* Gateway
|
|
352
|
-
* @description stripe, razorpay, paypal, etc.
|
|
353
|
-
*/
|
|
354
|
-
gateway?: string | null;
|
|
355
|
-
/**
|
|
356
|
-
* Requires Payment Method Upfront
|
|
357
|
-
* @description Require payment method before trial
|
|
358
|
-
* @default true
|
|
359
|
-
*/
|
|
360
|
-
requires_payment_method_upfront: boolean;
|
|
361
|
-
};
|
|
362
254
|
/**
|
|
363
255
|
* TenantPlanCreateRequest
|
|
364
256
|
* @description Tenant Plan creation request - inherits common fields, adds plan-specific sections
|
|
@@ -497,156 +389,136 @@ export interface components {
|
|
|
497
389
|
features?: components["schemas"]["TenantPlanFeaturesSection"] | null;
|
|
498
390
|
};
|
|
499
391
|
/**
|
|
500
|
-
*
|
|
501
|
-
* @description Product
|
|
392
|
+
* VariantItem
|
|
393
|
+
* @description Product variant (maps to product_variants_tbl)
|
|
502
394
|
*/
|
|
503
|
-
|
|
395
|
+
VariantItem: {
|
|
504
396
|
/**
|
|
505
|
-
*
|
|
506
|
-
* @description
|
|
397
|
+
* Name
|
|
398
|
+
* @description Variant display name
|
|
507
399
|
*/
|
|
508
|
-
|
|
509
|
-
};
|
|
510
|
-
InvalidParam: {
|
|
511
|
-
/** @example items[0].quantity */
|
|
512
|
-
field?: string;
|
|
513
|
-
/** @example Input should be greater than or equal to 1 */
|
|
514
|
-
error?: string;
|
|
515
|
-
};
|
|
516
|
-
/**
|
|
517
|
-
* MediaItem
|
|
518
|
-
* @description Single media file item
|
|
519
|
-
*/
|
|
520
|
-
MediaItem: {
|
|
400
|
+
name: string;
|
|
521
401
|
/**
|
|
522
|
-
*
|
|
523
|
-
* @description
|
|
402
|
+
* Sku
|
|
403
|
+
* @description Stock Keeping Unit
|
|
524
404
|
*/
|
|
525
|
-
|
|
405
|
+
sku?: string | null;
|
|
526
406
|
/**
|
|
527
|
-
*
|
|
528
|
-
* @description
|
|
407
|
+
* Attributes
|
|
408
|
+
* @description Custom attributes
|
|
529
409
|
*/
|
|
530
|
-
|
|
410
|
+
attributes?: {
|
|
411
|
+
[key: string]: unknown;
|
|
412
|
+
} | null;
|
|
531
413
|
/**
|
|
532
|
-
*
|
|
533
|
-
* @description
|
|
414
|
+
* Is Default
|
|
415
|
+
* @description Set as default variant
|
|
416
|
+
* @default false
|
|
534
417
|
*/
|
|
535
|
-
|
|
418
|
+
is_default: boolean;
|
|
536
419
|
/**
|
|
537
|
-
*
|
|
538
|
-
* @description
|
|
420
|
+
* Track Inventory
|
|
421
|
+
* @description Track stock for this variant
|
|
422
|
+
* @default false
|
|
539
423
|
*/
|
|
540
|
-
|
|
424
|
+
track_inventory: boolean;
|
|
541
425
|
/**
|
|
542
|
-
*
|
|
543
|
-
* @description
|
|
426
|
+
* Stock Quantity
|
|
427
|
+
* @description Initial stock
|
|
544
428
|
*/
|
|
545
|
-
|
|
429
|
+
stock_quantity?: number | null;
|
|
546
430
|
/**
|
|
547
|
-
*
|
|
548
|
-
* @description
|
|
431
|
+
* Allow Backorder
|
|
432
|
+
* @description Allow orders when out of stock
|
|
433
|
+
* @default false
|
|
549
434
|
*/
|
|
550
|
-
|
|
435
|
+
allow_backorder: boolean;
|
|
551
436
|
/**
|
|
552
|
-
*
|
|
553
|
-
* @description
|
|
437
|
+
* Weight
|
|
438
|
+
* @description Weight in kg
|
|
554
439
|
*/
|
|
555
|
-
|
|
440
|
+
weight?: number | null;
|
|
556
441
|
/**
|
|
557
|
-
*
|
|
558
|
-
* @description
|
|
442
|
+
* Length
|
|
443
|
+
* @description Length in cm
|
|
559
444
|
*/
|
|
560
|
-
|
|
561
|
-
[key: string]: string;
|
|
562
|
-
} | null;
|
|
445
|
+
length?: number | null;
|
|
563
446
|
/**
|
|
564
|
-
*
|
|
565
|
-
* @description
|
|
447
|
+
* Width
|
|
448
|
+
* @description Width in cm
|
|
566
449
|
*/
|
|
567
|
-
|
|
450
|
+
width?: number | null;
|
|
568
451
|
/**
|
|
569
|
-
*
|
|
570
|
-
* @description
|
|
571
|
-
* @default en-US
|
|
452
|
+
* Height
|
|
453
|
+
* @description Height in cm
|
|
572
454
|
*/
|
|
573
|
-
|
|
455
|
+
height?: number | null;
|
|
574
456
|
/**
|
|
575
457
|
* Display Order
|
|
576
458
|
* @description Display order
|
|
577
|
-
* @default
|
|
459
|
+
* @default 100
|
|
578
460
|
*/
|
|
579
461
|
display_order: number;
|
|
580
462
|
/**
|
|
581
|
-
*
|
|
582
|
-
* @description
|
|
583
|
-
* @default false
|
|
463
|
+
* Metadata
|
|
464
|
+
* @description Flexible metadata
|
|
584
465
|
*/
|
|
585
|
-
|
|
466
|
+
metadata?: {
|
|
467
|
+
[key: string]: unknown;
|
|
468
|
+
} | null;
|
|
586
469
|
};
|
|
587
470
|
/**
|
|
588
|
-
*
|
|
589
|
-
* @description Tenant Plan-
|
|
471
|
+
* TenantPlanFeaturesSection
|
|
472
|
+
* @description Tenant Plan Features - Optional add-ons (maps to tenant_plan_features_tbl)
|
|
590
473
|
*/
|
|
591
|
-
|
|
474
|
+
TenantPlanFeaturesSection: {
|
|
592
475
|
/**
|
|
593
|
-
*
|
|
594
|
-
* @description
|
|
595
|
-
* @default false
|
|
476
|
+
* Products
|
|
477
|
+
* @description Enabled product types: ["session", "webinar", "meeting"]
|
|
596
478
|
*/
|
|
597
|
-
|
|
479
|
+
products?: string[] | null;
|
|
598
480
|
/**
|
|
599
|
-
*
|
|
600
|
-
* @description
|
|
481
|
+
* Corporate Products
|
|
482
|
+
* @description Corporate product settings
|
|
601
483
|
*/
|
|
602
|
-
|
|
484
|
+
corporate_products?: {
|
|
485
|
+
[key: string]: unknown;
|
|
486
|
+
} | null;
|
|
603
487
|
/**
|
|
604
|
-
*
|
|
605
|
-
* @description
|
|
488
|
+
* Collections
|
|
489
|
+
* @description Enabled collection features
|
|
606
490
|
*/
|
|
607
|
-
|
|
491
|
+
collections?: {
|
|
492
|
+
[key: string]: unknown;
|
|
493
|
+
} | null;
|
|
608
494
|
/**
|
|
609
|
-
*
|
|
610
|
-
* @description
|
|
495
|
+
* Corporate Collections
|
|
496
|
+
* @description Corporate collection settings
|
|
611
497
|
*/
|
|
612
|
-
|
|
498
|
+
corporate_collections?: {
|
|
499
|
+
[key: string]: unknown;
|
|
500
|
+
} | null;
|
|
613
501
|
/**
|
|
614
|
-
*
|
|
615
|
-
* @description
|
|
502
|
+
* Multilingual
|
|
503
|
+
* @description Multilingual settings: {"enabled": true, "languages": ["en-US", "es-ES"]}
|
|
616
504
|
*/
|
|
617
|
-
|
|
505
|
+
multilingual?: {
|
|
506
|
+
[key: string]: unknown;
|
|
507
|
+
} | null;
|
|
618
508
|
/**
|
|
619
|
-
*
|
|
620
|
-
* @description
|
|
621
|
-
*/
|
|
622
|
-
attendee_limit?: number | null;
|
|
623
|
-
/**
|
|
624
|
-
* Virtual Classroom Enabled
|
|
625
|
-
* @description Enable virtual classroom features
|
|
626
|
-
* @default true
|
|
627
|
-
*/
|
|
628
|
-
virtual_classroom_enabled: boolean;
|
|
629
|
-
/**
|
|
630
|
-
* Active User Limit
|
|
631
|
-
* @description Max active users allowed
|
|
632
|
-
*/
|
|
633
|
-
active_user_limit?: number | null;
|
|
634
|
-
/**
|
|
635
|
-
* Storage Limit Gb
|
|
636
|
-
* @description Storage limit in GB
|
|
637
|
-
*/
|
|
638
|
-
storage_limit_gb?: number | null;
|
|
639
|
-
/**
|
|
640
|
-
* Bandwidth Gb Per Month
|
|
641
|
-
* @description Monthly bandwidth limit in GB
|
|
509
|
+
* Corporate Multilingual
|
|
510
|
+
* @description Corporate multilingual settings
|
|
642
511
|
*/
|
|
643
|
-
|
|
512
|
+
corporate_multilingual?: {
|
|
513
|
+
[key: string]: unknown;
|
|
514
|
+
} | null;
|
|
644
515
|
/**
|
|
645
|
-
*
|
|
646
|
-
* @description
|
|
647
|
-
* @default active
|
|
516
|
+
* Custom Features
|
|
517
|
+
* @description Additional custom features
|
|
648
518
|
*/
|
|
649
|
-
|
|
519
|
+
custom_features?: {
|
|
520
|
+
[key: string]: unknown;
|
|
521
|
+
} | null;
|
|
650
522
|
};
|
|
651
523
|
Extensions: {
|
|
652
524
|
/** @example GENERIC_ERROR */
|
|
@@ -658,15 +530,10 @@ export interface components {
|
|
|
658
530
|
debug?: string | null;
|
|
659
531
|
};
|
|
660
532
|
/**
|
|
661
|
-
*
|
|
662
|
-
* @description
|
|
533
|
+
* ProductPrice
|
|
534
|
+
* @description Base product pricing (maps to product_pricings_tbl with variant_id=NULL)
|
|
663
535
|
*/
|
|
664
|
-
|
|
665
|
-
/**
|
|
666
|
-
* Variant Index
|
|
667
|
-
* @description Index in variants array (0-based)
|
|
668
|
-
*/
|
|
669
|
-
variant_index: number;
|
|
536
|
+
ProductPrice: {
|
|
670
537
|
/**
|
|
671
538
|
* Price Type
|
|
672
539
|
* @description free, one_time, subscription, monthly_plan
|
|
@@ -674,7 +541,7 @@ export interface components {
|
|
|
674
541
|
price_type: string;
|
|
675
542
|
/**
|
|
676
543
|
* Currency
|
|
677
|
-
* @description Currency code
|
|
544
|
+
* @description Currency code: INR, USD, EUR, etc.
|
|
678
545
|
*/
|
|
679
546
|
currency: string;
|
|
680
547
|
/**
|
|
@@ -689,7 +556,7 @@ export interface components {
|
|
|
689
556
|
compare_at_amount?: number | null;
|
|
690
557
|
/**
|
|
691
558
|
* Interval
|
|
692
|
-
* @description day, week, month, year
|
|
559
|
+
* @description day, week, month, year (for subscription)
|
|
693
560
|
*/
|
|
694
561
|
interval?: string | null;
|
|
695
562
|
/**
|
|
@@ -719,87 +586,6 @@ export interface components {
|
|
|
719
586
|
*/
|
|
720
587
|
requires_payment_method_upfront: boolean;
|
|
721
588
|
};
|
|
722
|
-
ErrorResponse: {
|
|
723
|
-
/** @example about:blank */
|
|
724
|
-
type?: string;
|
|
725
|
-
/** @example GENERIC_ERROR */
|
|
726
|
-
code?: string;
|
|
727
|
-
/** @example Client Error */
|
|
728
|
-
title?: string;
|
|
729
|
-
/** @example 400 */
|
|
730
|
-
status?: number;
|
|
731
|
-
/** @example An error occurred */
|
|
732
|
-
detail?: string;
|
|
733
|
-
/** @example /v1/cart/items */
|
|
734
|
-
instance?: string;
|
|
735
|
-
extensions?: components["schemas"]["Extensions"];
|
|
736
|
-
};
|
|
737
|
-
/**
|
|
738
|
-
* TenantPlanFeaturesSection
|
|
739
|
-
* @description Tenant Plan Features - Optional add-ons (maps to tenant_plan_features_tbl)
|
|
740
|
-
*/
|
|
741
|
-
TenantPlanFeaturesSection: {
|
|
742
|
-
/**
|
|
743
|
-
* Products
|
|
744
|
-
* @description Enabled product types: ["session", "webinar", "meeting"]
|
|
745
|
-
*/
|
|
746
|
-
products?: string[] | null;
|
|
747
|
-
/**
|
|
748
|
-
* Corporate Products
|
|
749
|
-
* @description Corporate product settings
|
|
750
|
-
*/
|
|
751
|
-
corporate_products?: {
|
|
752
|
-
[key: string]: unknown;
|
|
753
|
-
} | null;
|
|
754
|
-
/**
|
|
755
|
-
* Collections
|
|
756
|
-
* @description Enabled collection features
|
|
757
|
-
*/
|
|
758
|
-
collections?: {
|
|
759
|
-
[key: string]: unknown;
|
|
760
|
-
} | null;
|
|
761
|
-
/**
|
|
762
|
-
* Corporate Collections
|
|
763
|
-
* @description Corporate collection settings
|
|
764
|
-
*/
|
|
765
|
-
corporate_collections?: {
|
|
766
|
-
[key: string]: unknown;
|
|
767
|
-
} | null;
|
|
768
|
-
/**
|
|
769
|
-
* Multilingual
|
|
770
|
-
* @description Multilingual settings: {"enabled": true, "languages": ["en-US", "es-ES"]}
|
|
771
|
-
*/
|
|
772
|
-
multilingual?: {
|
|
773
|
-
[key: string]: unknown;
|
|
774
|
-
} | null;
|
|
775
|
-
/**
|
|
776
|
-
* Corporate Multilingual
|
|
777
|
-
* @description Corporate multilingual settings
|
|
778
|
-
*/
|
|
779
|
-
corporate_multilingual?: {
|
|
780
|
-
[key: string]: unknown;
|
|
781
|
-
} | null;
|
|
782
|
-
/**
|
|
783
|
-
* Custom Features
|
|
784
|
-
* @description Additional custom features
|
|
785
|
-
*/
|
|
786
|
-
custom_features?: {
|
|
787
|
-
[key: string]: unknown;
|
|
788
|
-
} | null;
|
|
789
|
-
};
|
|
790
|
-
/**
|
|
791
|
-
* PricingSection
|
|
792
|
-
* @description Pricing configuration (optional - can have product price, variant prices, or both)
|
|
793
|
-
*/
|
|
794
|
-
PricingSection: {
|
|
795
|
-
/** @description Base product price (no variant) */
|
|
796
|
-
product_price?: components["schemas"]["ProductPrice"] | null;
|
|
797
|
-
/**
|
|
798
|
-
* Variant Prices
|
|
799
|
-
* @description Variant-specific prices
|
|
800
|
-
*/
|
|
801
|
-
variant_prices?: components["schemas"]["VariantPrice"][] | null;
|
|
802
|
-
};
|
|
803
589
|
/**
|
|
804
590
|
* IdentitySection
|
|
805
591
|
* @description Localized product content (maps to product_identity_tbl)
|
|
@@ -833,83 +619,297 @@ export interface components {
|
|
|
833
619
|
short_description?: string | null;
|
|
834
620
|
};
|
|
835
621
|
/**
|
|
836
|
-
*
|
|
837
|
-
* @description
|
|
622
|
+
* MediaItem
|
|
623
|
+
* @description Single media file item
|
|
838
624
|
*/
|
|
839
|
-
|
|
625
|
+
MediaItem: {
|
|
840
626
|
/**
|
|
841
|
-
*
|
|
842
|
-
* @description
|
|
627
|
+
* Media Type
|
|
628
|
+
* @description logo, banner, promo_video, gallery_image, gallery_video, swatch
|
|
843
629
|
*/
|
|
844
|
-
|
|
630
|
+
media_type: string;
|
|
845
631
|
/**
|
|
846
|
-
*
|
|
847
|
-
* @description
|
|
632
|
+
* File Path
|
|
633
|
+
* @description Path to media file on storage (S3, CDN, local)
|
|
848
634
|
*/
|
|
849
|
-
|
|
635
|
+
file_path: string;
|
|
850
636
|
/**
|
|
851
|
-
*
|
|
852
|
-
* @description
|
|
637
|
+
* File Name
|
|
638
|
+
* @description Original filename
|
|
853
639
|
*/
|
|
854
|
-
|
|
855
|
-
|
|
640
|
+
file_name: string;
|
|
641
|
+
/**
|
|
642
|
+
* File Size
|
|
643
|
+
* @description File size in bytes
|
|
644
|
+
*/
|
|
645
|
+
file_size?: number | null;
|
|
646
|
+
/**
|
|
647
|
+
* Mime Type
|
|
648
|
+
* @description MIME type (image/png, video/mp4, etc.)
|
|
649
|
+
*/
|
|
650
|
+
mime_type?: string | null;
|
|
651
|
+
/**
|
|
652
|
+
* Width
|
|
653
|
+
* @description Width in pixels (for images/videos)
|
|
654
|
+
*/
|
|
655
|
+
width?: number | null;
|
|
656
|
+
/**
|
|
657
|
+
* Height
|
|
658
|
+
* @description Height in pixels (for images/videos)
|
|
659
|
+
*/
|
|
660
|
+
height?: number | null;
|
|
661
|
+
/**
|
|
662
|
+
* Responsive Versions
|
|
663
|
+
* @description JSON with thumbnail, small, medium, large, xlarge, original paths
|
|
664
|
+
*/
|
|
665
|
+
responsive_versions?: {
|
|
666
|
+
[key: string]: string;
|
|
856
667
|
} | null;
|
|
857
668
|
/**
|
|
858
|
-
*
|
|
859
|
-
* @description
|
|
860
|
-
* @default false
|
|
669
|
+
* Alt Text
|
|
670
|
+
* @description Alt text for SEO/accessibility
|
|
861
671
|
*/
|
|
862
|
-
|
|
672
|
+
alt_text?: string | null;
|
|
863
673
|
/**
|
|
864
|
-
*
|
|
865
|
-
* @description
|
|
674
|
+
* Locale
|
|
675
|
+
* @description Media locale (en-US, es-PR, etc.)
|
|
676
|
+
* @default en-US
|
|
677
|
+
*/
|
|
678
|
+
locale: string;
|
|
679
|
+
/**
|
|
680
|
+
* Display Order
|
|
681
|
+
* @description Display order
|
|
682
|
+
* @default 0
|
|
683
|
+
*/
|
|
684
|
+
display_order: number;
|
|
685
|
+
/**
|
|
686
|
+
* Is Primary
|
|
687
|
+
* @description Mark as primary media
|
|
866
688
|
* @default false
|
|
867
689
|
*/
|
|
868
|
-
|
|
690
|
+
is_primary: boolean;
|
|
691
|
+
};
|
|
692
|
+
InvalidParam: {
|
|
693
|
+
/** @example items[0].quantity */
|
|
694
|
+
field?: string;
|
|
695
|
+
/** @example Input should be greater than or equal to 1 */
|
|
696
|
+
error?: string;
|
|
697
|
+
};
|
|
698
|
+
/**
|
|
699
|
+
* VariantPrice
|
|
700
|
+
* @description Variant-specific pricing (maps to product_pricings_tbl with variant_id set)
|
|
701
|
+
*/
|
|
702
|
+
VariantPrice: {
|
|
869
703
|
/**
|
|
870
|
-
*
|
|
871
|
-
* @description
|
|
704
|
+
* Variant Index
|
|
705
|
+
* @description Index in variants array (0-based)
|
|
872
706
|
*/
|
|
873
|
-
|
|
707
|
+
variant_index: number;
|
|
874
708
|
/**
|
|
875
|
-
*
|
|
876
|
-
* @description
|
|
709
|
+
* Price Type
|
|
710
|
+
* @description free, one_time, subscription, monthly_plan
|
|
711
|
+
*/
|
|
712
|
+
price_type: string;
|
|
713
|
+
/**
|
|
714
|
+
* Currency
|
|
715
|
+
* @description Currency code
|
|
716
|
+
*/
|
|
717
|
+
currency: string;
|
|
718
|
+
/**
|
|
719
|
+
* Amount
|
|
720
|
+
* @description Price amount
|
|
721
|
+
*/
|
|
722
|
+
amount: number;
|
|
723
|
+
/**
|
|
724
|
+
* Compare At Amount
|
|
725
|
+
* @description Original/strike-through price
|
|
726
|
+
*/
|
|
727
|
+
compare_at_amount?: number | null;
|
|
728
|
+
/**
|
|
729
|
+
* Interval
|
|
730
|
+
* @description day, week, month, year
|
|
731
|
+
*/
|
|
732
|
+
interval?: string | null;
|
|
733
|
+
/**
|
|
734
|
+
* Interval Count
|
|
735
|
+
* @description Number of intervals
|
|
736
|
+
*/
|
|
737
|
+
interval_count?: number | null;
|
|
738
|
+
/**
|
|
739
|
+
* Trial Period Days
|
|
740
|
+
* @description Free trial days
|
|
741
|
+
*/
|
|
742
|
+
trial_period_days?: number | null;
|
|
743
|
+
/**
|
|
744
|
+
* Initial Amount
|
|
745
|
+
* @description First payment amount
|
|
746
|
+
*/
|
|
747
|
+
initial_amount?: number | null;
|
|
748
|
+
/**
|
|
749
|
+
* Gateway
|
|
750
|
+
* @description stripe, razorpay, paypal, etc.
|
|
751
|
+
*/
|
|
752
|
+
gateway?: string | null;
|
|
753
|
+
/**
|
|
754
|
+
* Requires Payment Method Upfront
|
|
755
|
+
* @description Require payment method before trial
|
|
756
|
+
* @default true
|
|
757
|
+
*/
|
|
758
|
+
requires_payment_method_upfront: boolean;
|
|
759
|
+
};
|
|
760
|
+
/**
|
|
761
|
+
* TenantPlanSection
|
|
762
|
+
* @description Tenant Plan-specific fields (maps to tenant_plans_tbl)
|
|
763
|
+
*/
|
|
764
|
+
TenantPlanSection: {
|
|
765
|
+
/**
|
|
766
|
+
* Is Standard
|
|
767
|
+
* @description Is this a standard/free plan
|
|
877
768
|
* @default false
|
|
878
769
|
*/
|
|
879
|
-
|
|
770
|
+
is_standard: boolean;
|
|
880
771
|
/**
|
|
881
|
-
*
|
|
882
|
-
* @description
|
|
772
|
+
* Premium Plan Id
|
|
773
|
+
* @description Reference to premium upgrade plan (internal ID)
|
|
883
774
|
*/
|
|
884
|
-
|
|
775
|
+
premium_plan_id?: number | null;
|
|
885
776
|
/**
|
|
886
|
-
*
|
|
887
|
-
* @description
|
|
777
|
+
* For Org Id
|
|
778
|
+
* @description Specific org this plan is for (NULL = available to all)
|
|
888
779
|
*/
|
|
889
|
-
|
|
780
|
+
for_org_id?: number | null;
|
|
890
781
|
/**
|
|
891
|
-
*
|
|
892
|
-
* @description
|
|
782
|
+
* Concurrent Rooms
|
|
783
|
+
* @description Max concurrent virtual rooms allowed
|
|
893
784
|
*/
|
|
894
|
-
|
|
785
|
+
concurrent_rooms?: number | null;
|
|
895
786
|
/**
|
|
896
|
-
*
|
|
897
|
-
* @description
|
|
787
|
+
* Class Duration Minutes
|
|
788
|
+
* @description Max class duration in minutes
|
|
898
789
|
*/
|
|
899
|
-
|
|
790
|
+
class_duration_minutes?: number | null;
|
|
900
791
|
/**
|
|
901
|
-
*
|
|
902
|
-
* @description
|
|
903
|
-
* @default 100
|
|
792
|
+
* Attendee Limit
|
|
793
|
+
* @description Max attendees per session
|
|
904
794
|
*/
|
|
905
|
-
|
|
795
|
+
attendee_limit?: number | null;
|
|
906
796
|
/**
|
|
907
|
-
*
|
|
908
|
-
* @description
|
|
797
|
+
* Virtual Classroom Enabled
|
|
798
|
+
* @description Enable virtual classroom features
|
|
799
|
+
* @default true
|
|
909
800
|
*/
|
|
910
|
-
|
|
911
|
-
|
|
912
|
-
|
|
801
|
+
virtual_classroom_enabled: boolean;
|
|
802
|
+
/**
|
|
803
|
+
* Active User Limit
|
|
804
|
+
* @description Max active users allowed
|
|
805
|
+
*/
|
|
806
|
+
active_user_limit?: number | null;
|
|
807
|
+
/**
|
|
808
|
+
* Storage Limit Gb
|
|
809
|
+
* @description Storage limit in GB
|
|
810
|
+
*/
|
|
811
|
+
storage_limit_gb?: number | null;
|
|
812
|
+
/**
|
|
813
|
+
* Bandwidth Gb Per Month
|
|
814
|
+
* @description Monthly bandwidth limit in GB
|
|
815
|
+
*/
|
|
816
|
+
bandwidth_gb_per_month?: number | null;
|
|
817
|
+
/**
|
|
818
|
+
* Status
|
|
819
|
+
* @description active, inactive, archived, deleted
|
|
820
|
+
* @default active
|
|
821
|
+
*/
|
|
822
|
+
status: string;
|
|
823
|
+
};
|
|
824
|
+
/**
|
|
825
|
+
* ProductSection
|
|
826
|
+
* @description Base product fields (maps to product_tbl)
|
|
827
|
+
*/
|
|
828
|
+
ProductSection: {
|
|
829
|
+
/**
|
|
830
|
+
* Visibility
|
|
831
|
+
* @description public, private, hidden, unlisted
|
|
832
|
+
* @default public
|
|
833
|
+
*/
|
|
834
|
+
visibility: string;
|
|
835
|
+
/**
|
|
836
|
+
* Is Digital
|
|
837
|
+
* @description Digital product flag
|
|
838
|
+
* @default true
|
|
839
|
+
*/
|
|
840
|
+
is_digital: boolean;
|
|
841
|
+
/**
|
|
842
|
+
* Company Id
|
|
843
|
+
* @description Multi-company support
|
|
844
|
+
*/
|
|
845
|
+
company_id?: number | null;
|
|
846
|
+
/**
|
|
847
|
+
* Status
|
|
848
|
+
* @description draft, published, archived, review_required, deleted
|
|
849
|
+
* @default draft
|
|
850
|
+
*/
|
|
851
|
+
status: string;
|
|
852
|
+
/**
|
|
853
|
+
* Is Org Level
|
|
854
|
+
* @description Org-level vs user-created product
|
|
855
|
+
* @default true
|
|
856
|
+
*/
|
|
857
|
+
is_org_level: boolean;
|
|
858
|
+
/**
|
|
859
|
+
* Staff Id
|
|
860
|
+
* @description Staff/instructor delivering product
|
|
861
|
+
*/
|
|
862
|
+
staff_id?: number | null;
|
|
863
|
+
/**
|
|
864
|
+
* Owner Id
|
|
865
|
+
* @description Owner of the product
|
|
866
|
+
*/
|
|
867
|
+
owner_id?: number | null;
|
|
868
|
+
/**
|
|
869
|
+
* Featured
|
|
870
|
+
* @description Featured product flag
|
|
871
|
+
* @default false
|
|
872
|
+
*/
|
|
873
|
+
featured: boolean;
|
|
874
|
+
};
|
|
875
|
+
ErrorResponse: {
|
|
876
|
+
/** @example about:blank */
|
|
877
|
+
type?: string;
|
|
878
|
+
/** @example GENERIC_ERROR */
|
|
879
|
+
code?: string;
|
|
880
|
+
/** @example Client Error */
|
|
881
|
+
title?: string;
|
|
882
|
+
/** @example 400 */
|
|
883
|
+
status?: number;
|
|
884
|
+
/** @example An error occurred */
|
|
885
|
+
detail?: string;
|
|
886
|
+
/** @example /v1/cart/items */
|
|
887
|
+
instance?: string;
|
|
888
|
+
extensions?: components["schemas"]["Extensions"];
|
|
889
|
+
};
|
|
890
|
+
/**
|
|
891
|
+
* MediaSection
|
|
892
|
+
* @description Product media files - direct media data
|
|
893
|
+
*/
|
|
894
|
+
MediaSection: {
|
|
895
|
+
/**
|
|
896
|
+
* Media Items
|
|
897
|
+
* @description List of media files to attach to product
|
|
898
|
+
*/
|
|
899
|
+
media_items?: components["schemas"]["MediaItem"][] | null;
|
|
900
|
+
};
|
|
901
|
+
/**
|
|
902
|
+
* PricingSection
|
|
903
|
+
* @description Pricing configuration (optional - can have product price, variant prices, or both)
|
|
904
|
+
*/
|
|
905
|
+
PricingSection: {
|
|
906
|
+
/** @description Base product price (no variant) */
|
|
907
|
+
product_price?: components["schemas"]["ProductPrice"] | null;
|
|
908
|
+
/**
|
|
909
|
+
* Variant Prices
|
|
910
|
+
* @description Variant-specific prices
|
|
911
|
+
*/
|
|
912
|
+
variant_prices?: components["schemas"]["VariantPrice"][] | null;
|
|
913
913
|
};
|
|
914
914
|
};
|
|
915
915
|
responses: never;
|