@blezgo/api-sdk 0.1.2 → 0.1.4

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.
Files changed (138) hide show
  1. package/dist/account/generated.d.ts +183 -183
  2. package/dist/account/generated.d.ts.map +1 -1
  3. package/dist/activity/generated.d.ts +82 -82
  4. package/dist/activity/generated.d.ts.map +1 -1
  5. package/dist/addon/generated.d.ts +88 -88
  6. package/dist/addon/generated.d.ts.map +1 -1
  7. package/dist/admin/generated.d.ts +42 -42
  8. package/dist/admin/generated.d.ts.map +1 -1
  9. package/dist/affiliate/generated.d.ts +97 -98
  10. package/dist/affiliate/generated.d.ts.map +1 -1
  11. package/dist/analytics/generated.d.ts +27 -27
  12. package/dist/analytics/generated.d.ts.map +1 -1
  13. package/dist/announcements/generated.d.ts +118 -118
  14. package/dist/announcements/generated.d.ts.map +1 -1
  15. package/dist/apikeys/generated.d.ts +46 -46
  16. package/dist/apikeys/generated.d.ts.map +1 -1
  17. package/dist/assistance/generated.d.ts +24 -24
  18. package/dist/assistance/generated.d.ts.map +1 -1
  19. package/dist/authentication/generated.d.ts +73 -73
  20. package/dist/authentication/generated.d.ts.map +1 -1
  21. package/dist/blog/generated.d.ts +142 -142
  22. package/dist/blog/generated.d.ts.map +1 -1
  23. package/dist/bundle/generated.d.ts +124 -124
  24. package/dist/bundle/generated.d.ts.map +1 -1
  25. package/dist/cache/generated.d.ts +32 -32
  26. package/dist/cache/generated.d.ts.map +1 -1
  27. package/dist/calendar/generated.d.ts +59 -59
  28. package/dist/calendar/generated.d.ts.map +1 -1
  29. package/dist/campaigns/generated.d.ts +151 -151
  30. package/dist/campaigns/generated.d.ts.map +1 -1
  31. package/dist/cart/generated.d.ts +41 -41
  32. package/dist/cart/generated.d.ts.map +1 -1
  33. package/dist/changelog/generated.d.ts +90 -90
  34. package/dist/changelog/generated.d.ts.map +1 -1
  35. package/dist/channel/generated.d.ts +256 -256
  36. package/dist/channel/generated.d.ts.map +1 -1
  37. package/dist/company/generated.d.ts +73 -73
  38. package/dist/company/generated.d.ts.map +1 -1
  39. package/dist/conference/generated.d.ts +160 -160
  40. package/dist/conference/generated.d.ts.map +1 -1
  41. package/dist/config/generated.d.ts +57 -57
  42. package/dist/config/generated.d.ts.map +1 -1
  43. package/dist/content/generated.d.ts +620 -620
  44. package/dist/content/generated.d.ts.map +1 -1
  45. package/dist/cookies/generated.d.ts +85 -85
  46. package/dist/cookies/generated.d.ts.map +1 -1
  47. package/dist/courses/generated.d.ts +381 -381
  48. package/dist/courses/generated.d.ts.map +1 -1
  49. package/dist/custom/generated.d.ts +103 -103
  50. package/dist/custom/generated.d.ts.map +1 -1
  51. package/dist/dashboard/generated.d.ts +148 -148
  52. package/dist/dashboard/generated.d.ts.map +1 -1
  53. package/dist/elasticsearch/generated.d.ts +37 -37
  54. package/dist/elasticsearch/generated.d.ts.map +1 -1
  55. package/dist/enrollments/generated.d.ts +21 -21
  56. package/dist/enrollments/generated.d.ts.map +1 -1
  57. package/dist/errors/generated.d.ts +21 -21
  58. package/dist/errors/generated.d.ts.map +1 -1
  59. package/dist/eventconfig/generated.d.ts +88 -88
  60. package/dist/eventconfig/generated.d.ts.map +1 -1
  61. package/dist/funnels/generated.d.ts +124 -125
  62. package/dist/funnels/generated.d.ts.map +1 -1
  63. package/dist/gamification/generated.d.ts +151 -151
  64. package/dist/gamification/generated.d.ts.map +1 -1
  65. package/dist/impersonation/generated.d.ts +33 -33
  66. package/dist/impersonation/generated.d.ts.map +1 -1
  67. package/dist/inbox/generated.d.ts +154 -154
  68. package/dist/inbox/generated.d.ts.map +1 -1
  69. package/dist/internal/generated.d.ts +21 -21
  70. package/dist/internal/generated.d.ts.map +1 -1
  71. package/dist/internationalization/generated.d.ts +23 -23
  72. package/dist/internationalization/generated.d.ts.map +1 -1
  73. package/dist/invitations/generated.d.ts +107 -107
  74. package/dist/invitations/generated.d.ts.map +1 -1
  75. package/dist/meetings/generated.d.ts +332 -332
  76. package/dist/meetings/generated.d.ts.map +1 -1
  77. package/dist/metas/generated.d.ts +200 -200
  78. package/dist/metas/generated.d.ts.map +1 -1
  79. package/dist/notification/generated.d.ts +279 -279
  80. package/dist/notification/generated.d.ts.map +1 -1
  81. package/dist/notifications/generated.d.ts +21 -21
  82. package/dist/notifications/generated.d.ts.map +1 -1
  83. package/dist/onboarding/generated.d.ts +95 -95
  84. package/dist/onboarding/generated.d.ts.map +1 -1
  85. package/dist/packages/generated.d.ts +77 -77
  86. package/dist/packages/generated.d.ts.map +1 -1
  87. package/dist/payments/generated.d.ts +628 -631
  88. package/dist/payments/generated.d.ts.map +1 -1
  89. package/dist/payouts/generated.d.ts +21 -21
  90. package/dist/payouts/generated.d.ts.map +1 -1
  91. package/dist/plans/generated.d.ts +405 -405
  92. package/dist/plans/generated.d.ts.map +1 -1
  93. package/dist/pricing/generated.d.ts +75 -75
  94. package/dist/pricing/generated.d.ts.map +1 -1
  95. package/dist/products/generated.d.ts +420 -420
  96. package/dist/products/generated.d.ts.map +1 -1
  97. package/dist/profile/generated.d.ts +310 -310
  98. package/dist/profile/generated.d.ts.map +1 -1
  99. package/dist/reasons/generated.d.ts +64 -64
  100. package/dist/reasons/generated.d.ts.map +1 -1
  101. package/dist/registration/generated.d.ts +163 -163
  102. package/dist/registration/generated.d.ts.map +1 -1
  103. package/dist/reviews/generated.d.ts +47 -47
  104. package/dist/reviews/generated.d.ts.map +1 -1
  105. package/dist/role/generated.d.ts +944 -446
  106. package/dist/role/generated.d.ts.map +1 -1
  107. package/dist/scheduling/generated.d.ts +76 -76
  108. package/dist/scheduling/generated.d.ts.map +1 -1
  109. package/dist/services/generated.d.ts +1119 -1119
  110. package/dist/services/generated.d.ts.map +1 -1
  111. package/dist/sessions/generated.d.ts +313 -313
  112. package/dist/sessions/generated.d.ts.map +1 -1
  113. package/dist/spaces/generated.d.ts +340 -340
  114. package/dist/spaces/generated.d.ts.map +1 -1
  115. package/dist/storefront/generated.d.ts +21 -21
  116. package/dist/storefront/generated.d.ts.map +1 -1
  117. package/dist/support/generated.d.ts +1624 -1624
  118. package/dist/support/generated.d.ts.map +1 -1
  119. package/dist/sync/generated.d.ts +176 -176
  120. package/dist/sync/generated.d.ts.map +1 -1
  121. package/dist/tenant/generated.d.ts +487 -487
  122. package/dist/tenant/generated.d.ts.map +1 -1
  123. package/dist/testimonials/generated.d.ts +86 -86
  124. package/dist/testimonials/generated.d.ts.map +1 -1
  125. package/dist/tests/generated.d.ts +456 -456
  126. package/dist/tests/generated.d.ts.map +1 -1
  127. package/dist/tokens/generated.d.ts +54 -54
  128. package/dist/tokens/generated.d.ts.map +1 -1
  129. package/dist/uploads/generated.d.ts +65 -65
  130. package/dist/uploads/generated.d.ts.map +1 -1
  131. package/dist/upsell/generated.d.ts +105 -105
  132. package/dist/upsell/generated.d.ts.map +1 -1
  133. package/dist/user/generated.d.ts +272 -527
  134. package/dist/user/generated.d.ts.map +1 -1
  135. package/dist/webinars/generated.d.ts +260 -260
  136. package/dist/webinars/generated.d.ts.map +1 -1
  137. package/package.json +1 -1
  138. package/test-commit.txt +1 -0
@@ -225,141 +225,89 @@ export type webhooks = Record<string, never>;
225
225
  export interface components {
226
226
  schemas: {
227
227
  /**
228
- * TenantPlanCreateRequest
229
- * @description Tenant Plan creation request - inherits common fields, adds plan-specific sections
230
- * @example {
231
- * "features": {
232
- * "collections": {
233
- * "enabled": true,
234
- * "max_collections": 50
235
- * },
236
- * "corporate_products": {
237
- * "enabled": true
238
- * },
239
- * "multilingual": {
240
- * "enabled": true,
241
- * "languages": [
242
- * "en-US",
243
- * "es-ES",
244
- * "fr-FR"
245
- * ]
246
- * },
247
- * "products": [
248
- * "session",
249
- * "webinar",
250
- * "meeting"
251
- * ]
252
- * },
253
- * "identity": {
254
- * "description": "Comprehensive features for professional use with advanced virtual classroom capabilities...",
255
- * "locale": "en-US",
256
- * "short_description": "Professional tier with advanced features",
257
- * "subtitle": "Perfect for growing teams",
258
- * "title": "Professional Plan"
259
- * },
260
- * "media": {
261
- * "media_items": [
262
- * {
263
- * "alt_text": "Professional Plan Logo",
264
- * "file_name": "logo.png",
265
- * "file_path": "/plans/123/logo.png",
266
- * "is_primary": true,
267
- * "media_type": "logo",
268
- * "mime_type": "image/png"
269
- * }
270
- * ]
271
- * },
272
- * "plan": {
273
- * "active_user_limit": 50,
274
- * "attendee_limit": 100,
275
- * "bandwidth_gb_per_month": 500,
276
- * "class_duration_minutes": 120,
277
- * "concurrent_rooms": 10,
278
- * "is_standard": false,
279
- * "status": "active",
280
- * "storage_limit_gb": 100,
281
- * "virtual_classroom_enabled": true
282
- * },
283
- * "pricing": {
284
- * "product_price": {
285
- * "amount": 99,
286
- * "currency": "USD",
287
- * "interval": "month",
288
- * "price_type": "recurring"
289
- * },
290
- * "variant_prices": [
291
- * {
292
- * "amount": 99,
293
- * "currency": "USD",
294
- * "interval": "month",
295
- * "price_type": "recurring",
296
- * "variant_index": 0
297
- * },
298
- * {
299
- * "amount": 950,
300
- * "currency": "USD",
301
- * "interval": "year",
302
- * "price_type": "recurring",
303
- * "variant_index": 1
304
- * }
305
- * ]
306
- * },
307
- * "product": {
308
- * "company_id": 2,
309
- * "featured": false,
310
- * "is_digital": true,
311
- * "is_org_level": true,
312
- * "status": "active",
313
- * "visibility": "public"
314
- * },
315
- * "tags": [
316
- * 1,
317
- * 5,
318
- * 8
319
- * ],
320
- * "variants": [
321
- * {
322
- * "attributes": {
323
- * "billing_cycle": "monthly"
324
- * },
325
- * "is_default": true,
326
- * "name": "Monthly",
327
- * "sku": "PROF-MONTHLY"
328
- * },
329
- * {
330
- * "attributes": {
331
- * "billing_cycle": "annual",
332
- * "discount": "20%"
333
- * },
334
- * "name": "Annual",
335
- * "sku": "PROF-ANNUAL"
336
- * }
337
- * ]
338
- * }
228
+ * VariantItem
229
+ * @description Product variant (maps to product_variants_tbl)
339
230
  */
340
- TenantPlanCreateRequest: {
341
- /** @description Base product configuration */
342
- product: components["schemas"]["ProductSection"];
343
- /** @description Localized content (title, description) */
344
- identity: components["schemas"]["IdentitySection"];
345
- /** @description Pre-uploaded image IDs */
346
- media?: components["schemas"]["MediaSection"] | null;
231
+ VariantItem: {
347
232
  /**
348
- * Tags
349
- * @description Tag IDs to associate with product
233
+ * Name
234
+ * @description Variant display name
350
235
  */
351
- tags?: number[] | null;
236
+ name: string;
352
237
  /**
353
- * Variants
354
- * @description Product variants (optional)
238
+ * Sku
239
+ * @description Stock Keeping Unit
355
240
  */
356
- variants?: components["schemas"]["VariantItem"][] | null;
357
- /** @description Pricing for product and variants */
358
- pricing?: components["schemas"]["PricingSection"] | null;
359
- /** @description Tenant plan configuration and limits */
360
- plan: components["schemas"]["TenantPlanSection"];
361
- /** @description Optional plan features and add-ons */
362
- features?: components["schemas"]["TenantPlanFeaturesSection"] | null;
241
+ sku?: string | null;
242
+ /**
243
+ * Attributes
244
+ * @description Custom attributes
245
+ */
246
+ attributes?: {
247
+ [key: string]: unknown;
248
+ } | null;
249
+ /**
250
+ * Is Default
251
+ * @description Set as default variant
252
+ * @default false
253
+ */
254
+ is_default: boolean;
255
+ /**
256
+ * Track Inventory
257
+ * @description Track stock for this variant
258
+ * @default false
259
+ */
260
+ track_inventory: boolean;
261
+ /**
262
+ * Stock Quantity
263
+ * @description Initial stock
264
+ */
265
+ stock_quantity?: number | null;
266
+ /**
267
+ * Allow Backorder
268
+ * @description Allow orders when out of stock
269
+ * @default false
270
+ */
271
+ allow_backorder: boolean;
272
+ /**
273
+ * Weight
274
+ * @description Weight in kg
275
+ */
276
+ weight?: number | null;
277
+ /**
278
+ * Length
279
+ * @description Length in cm
280
+ */
281
+ length?: number | null;
282
+ /**
283
+ * Width
284
+ * @description Width in cm
285
+ */
286
+ width?: number | null;
287
+ /**
288
+ * Height
289
+ * @description Height in cm
290
+ */
291
+ height?: number | null;
292
+ /**
293
+ * Display Order
294
+ * @description Display order
295
+ * @default 100
296
+ */
297
+ display_order: number;
298
+ /**
299
+ * Metadata
300
+ * @description Flexible metadata
301
+ */
302
+ metadata?: {
303
+ [key: string]: unknown;
304
+ } | null;
305
+ };
306
+ InvalidParam: {
307
+ /** @example items[0].quantity */
308
+ field?: string;
309
+ /** @example Input should be greater than or equal to 1 */
310
+ error?: string;
363
311
  };
364
312
  /**
365
313
  * TenantPlanFeaturesSection
@@ -415,92 +363,47 @@ export interface components {
415
363
  } | null;
416
364
  };
417
365
  /**
418
- * ProductPrice
419
- * @description Base product pricing (maps to product_pricings_tbl with variant_id=NULL)
366
+ * @example {
367
+ * "status": "success",
368
+ * "message": "Operation successful",
369
+ * "message_code": "api_suc_20001",
370
+ * "data": {},
371
+ * "metadata": {
372
+ * "timestamp": "2026-03-26T10:00:00.000Z",
373
+ * "requestId": "07e22004-cb60-4dfc-bc9c-b6f99664dca1",
374
+ * "traceId": "a9f1204c-bb82-41de-b234-7c3a9e120000",
375
+ * "version": "v1",
376
+ * "executionTime": 42,
377
+ * "language": "en-US"
378
+ * }
379
+ * }
420
380
  */
421
- ProductPrice: {
381
+ StandardResponse: {
382
+ /** @example success */
383
+ status?: string;
384
+ data?: Record<string, never> | null;
385
+ /** @example Operation successful */
386
+ message?: string | null;
387
+ /** @example api_suc_20001 */
388
+ message_code?: string | null;
389
+ metadata?: Record<string, never> | null;
390
+ error?: components["schemas"]["ErrorResponse"];
391
+ };
392
+ /**
393
+ * MediaItem
394
+ * @description Single media file item
395
+ */
396
+ MediaItem: {
422
397
  /**
423
- * Price Type
424
- * @description free, one_time, subscription, monthly_plan
398
+ * Media Type
399
+ * @description logo, banner, promo_video, gallery_image, gallery_video, swatch
425
400
  */
426
- price_type: string;
401
+ media_type: string;
427
402
  /**
428
- * Currency
429
- * @description Currency code: INR, USD, EUR, etc.
403
+ * File Path
404
+ * @description Path to media file on storage (S3, CDN, local)
430
405
  */
431
- currency: string;
432
- /**
433
- * Amount
434
- * @description Price amount
435
- */
436
- amount: number;
437
- /**
438
- * Compare At Amount
439
- * @description Original/strike-through price
440
- */
441
- compare_at_amount?: number | null;
442
- /**
443
- * Interval
444
- * @description day, week, month, year (for subscription)
445
- */
446
- interval?: string | null;
447
- /**
448
- * Interval Count
449
- * @description Number of intervals
450
- */
451
- interval_count?: number | null;
452
- /**
453
- * Trial Period Days
454
- * @description Free trial days
455
- */
456
- trial_period_days?: number | null;
457
- /**
458
- * Initial Amount
459
- * @description First payment amount
460
- */
461
- initial_amount?: number | null;
462
- /**
463
- * Gateway
464
- * @description stripe, razorpay, paypal, etc.
465
- */
466
- gateway?: string | null;
467
- /**
468
- * Requires Payment Method Upfront
469
- * @description Require payment method before trial
470
- * @default true
471
- */
472
- requires_payment_method_upfront: boolean;
473
- };
474
- ErrorResponse: {
475
- /** @example about:blank */
476
- type?: string;
477
- /** @example GENERIC_ERROR */
478
- code?: string;
479
- /** @example Client Error */
480
- title?: string;
481
- /** @example 400 */
482
- status?: number;
483
- /** @example An error occurred */
484
- detail?: string;
485
- /** @example /v1/cart/items */
486
- instance?: string;
487
- extensions?: components["schemas"]["Extensions"];
488
- };
489
- /**
490
- * MediaItem
491
- * @description Single media file item
492
- */
493
- MediaItem: {
494
- /**
495
- * Media Type
496
- * @description logo, banner, promo_video, gallery_image, gallery_video, swatch
497
- */
498
- media_type: string;
499
- /**
500
- * File Path
501
- * @description Path to media file on storage (S3, CDN, local)
502
- */
503
- file_path: string;
406
+ file_path: string;
504
407
  /**
505
408
  * File Name
506
409
  * @description Original filename
@@ -568,156 +471,103 @@ export interface components {
568
471
  */
569
472
  media_items?: components["schemas"]["MediaItem"][] | null;
570
473
  };
474
+ Extensions: {
475
+ /** @example GENERIC_ERROR */
476
+ message_code?: string;
477
+ /** @example [] */
478
+ invalid_params?: components["schemas"]["InvalidParam"][];
479
+ extra_data?: Record<string, never> | null;
480
+ /** @example Detailed debug information */
481
+ debug?: string | null;
482
+ };
571
483
  /**
572
- * ProductSection
573
- * @description Base product fields (maps to product_tbl)
484
+ * IdentitySection
485
+ * @description Localized product content (maps to product_identity_tbl)
574
486
  */
575
- ProductSection: {
576
- /**
577
- * Visibility
578
- * @description public, private, hidden, unlisted
579
- * @default public
580
- */
581
- visibility: string;
582
- /**
583
- * Is Digital
584
- * @description Digital product flag
585
- * @default true
586
- */
587
- is_digital: boolean;
588
- /**
589
- * Company Id
590
- * @description Multi-company support
591
- */
592
- company_id?: number | null;
487
+ IdentitySection: {
593
488
  /**
594
- * Status
595
- * @description draft, published, archived, review_required, deleted
596
- * @default draft
489
+ * Locale
490
+ * @description Locale: en-US, es-PR, fr-FR, pt-BR, etc.
491
+ * @default en-US
597
492
  */
598
- status: string;
493
+ locale: string;
599
494
  /**
600
- * Is Org Level
601
- * @description Org-level vs user-created product
602
- * @default true
495
+ * Title
496
+ * @description Product title
603
497
  */
604
- is_org_level: boolean;
498
+ title: string;
605
499
  /**
606
- * Staff Id
607
- * @description Staff/instructor delivering product
500
+ * Subtitle
501
+ * @description Product subtitle
608
502
  */
609
- staff_id?: number | null;
503
+ subtitle?: string | null;
610
504
  /**
611
- * Owner Id
612
- * @description Owner of the product
505
+ * Description
506
+ * @description Full product description
613
507
  */
614
- owner_id?: number | null;
508
+ description?: string | null;
615
509
  /**
616
- * Featured
617
- * @description Featured product flag
618
- * @default false
510
+ * Short Description
511
+ * @description Short description for listings/previews
619
512
  */
620
- featured: boolean;
513
+ short_description?: string | null;
621
514
  };
622
515
  /**
623
- * TenantPlanSection
624
- * @description Tenant Plan-specific fields (maps to tenant_plans_tbl)
516
+ * ProductPrice
517
+ * @description Base product pricing (maps to product_pricings_tbl with variant_id=NULL)
625
518
  */
626
- TenantPlanSection: {
627
- /**
628
- * Is Standard
629
- * @description Is this a standard/free plan
630
- * @default false
631
- */
632
- is_standard: boolean;
519
+ ProductPrice: {
633
520
  /**
634
- * Premium Plan Id
635
- * @description Reference to premium upgrade plan (internal ID)
521
+ * Price Type
522
+ * @description free, one_time, subscription, monthly_plan
636
523
  */
637
- premium_plan_id?: number | null;
524
+ price_type: string;
638
525
  /**
639
- * For Org Id
640
- * @description Specific org this plan is for (NULL = available to all)
526
+ * Currency
527
+ * @description Currency code: INR, USD, EUR, etc.
641
528
  */
642
- for_org_id?: number | null;
529
+ currency: string;
643
530
  /**
644
- * Concurrent Rooms
645
- * @description Max concurrent virtual rooms allowed
531
+ * Amount
532
+ * @description Price amount
646
533
  */
647
- concurrent_rooms?: number | null;
534
+ amount: number;
648
535
  /**
649
- * Class Duration Minutes
650
- * @description Max class duration in minutes
536
+ * Compare At Amount
537
+ * @description Original/strike-through price
651
538
  */
652
- class_duration_minutes?: number | null;
539
+ compare_at_amount?: number | null;
653
540
  /**
654
- * Attendee Limit
655
- * @description Max attendees per session
541
+ * Interval
542
+ * @description day, week, month, year (for subscription)
656
543
  */
657
- attendee_limit?: number | null;
544
+ interval?: string | null;
658
545
  /**
659
- * Virtual Classroom Enabled
660
- * @description Enable virtual classroom features
661
- * @default true
546
+ * Interval Count
547
+ * @description Number of intervals
662
548
  */
663
- virtual_classroom_enabled: boolean;
549
+ interval_count?: number | null;
664
550
  /**
665
- * Active User Limit
666
- * @description Max active users allowed
551
+ * Trial Period Days
552
+ * @description Free trial days
667
553
  */
668
- active_user_limit?: number | null;
554
+ trial_period_days?: number | null;
669
555
  /**
670
- * Storage Limit Gb
671
- * @description Storage limit in GB
556
+ * Initial Amount
557
+ * @description First payment amount
672
558
  */
673
- storage_limit_gb?: number | null;
559
+ initial_amount?: number | null;
674
560
  /**
675
- * Bandwidth Gb Per Month
676
- * @description Monthly bandwidth limit in GB
561
+ * Gateway
562
+ * @description stripe, razorpay, paypal, etc.
677
563
  */
678
- bandwidth_gb_per_month?: number | null;
564
+ gateway?: string | null;
679
565
  /**
680
- * Status
681
- * @description active, inactive, archived, deleted
682
- * @default active
566
+ * Requires Payment Method Upfront
567
+ * @description Require payment method before trial
568
+ * @default true
683
569
  */
684
- status: string;
685
- };
686
- Extensions: {
687
- /** @example GENERIC_ERROR */
688
- message_code?: string;
689
- /** @example [] */
690
- invalid_params?: components["schemas"]["InvalidParam"][];
691
- extra_data?: Record<string, never> | null;
692
- /** @example Detailed debug information */
693
- debug?: string | null;
694
- };
695
- /**
696
- * @example {
697
- * "status": "success",
698
- * "message": "Operation successful",
699
- * "message_code": "api_suc_20001",
700
- * "data": {},
701
- * "metadata": {
702
- * "timestamp": "2026-03-26T10:00:00.000Z",
703
- * "requestId": "07e22004-cb60-4dfc-bc9c-b6f99664dca1",
704
- * "traceId": "a9f1204c-bb82-41de-b234-7c3a9e120000",
705
- * "version": "v1",
706
- * "executionTime": 42,
707
- * "language": "en-US"
708
- * }
709
- * }
710
- */
711
- StandardResponse: {
712
- /** @example success */
713
- status?: string;
714
- data?: Record<string, never> | null;
715
- /** @example Operation successful */
716
- message?: string | null;
717
- /** @example api_suc_20001 */
718
- message_code?: string | null;
719
- metadata?: Record<string, never> | null;
720
- error?: components["schemas"]["ErrorResponse"];
570
+ requires_payment_method_upfront: boolean;
721
571
  };
722
572
  /**
723
573
  * VariantPrice
@@ -782,115 +632,271 @@ export interface components {
782
632
  requires_payment_method_upfront: boolean;
783
633
  };
784
634
  /**
785
- * IdentitySection
786
- * @description Localized product content (maps to product_identity_tbl)
635
+ * TenantPlanSection
636
+ * @description Tenant Plan-specific fields (maps to tenant_plans_tbl)
787
637
  */
788
- IdentitySection: {
638
+ TenantPlanSection: {
789
639
  /**
790
- * Locale
791
- * @description Locale: en-US, es-PR, fr-FR, pt-BR, etc.
792
- * @default en-US
793
- */
794
- locale: string;
640
+ * Is Standard
641
+ * @description Is this a standard/free plan
642
+ * @default false
643
+ */
644
+ is_standard: boolean;
795
645
  /**
796
- * Title
797
- * @description Product title
646
+ * Premium Plan Id
647
+ * @description Reference to premium upgrade plan (internal ID)
798
648
  */
799
- title: string;
649
+ premium_plan_id?: number | null;
800
650
  /**
801
- * Subtitle
802
- * @description Product subtitle
651
+ * For Org Id
652
+ * @description Specific org this plan is for (NULL = available to all)
803
653
  */
804
- subtitle?: string | null;
654
+ for_org_id?: number | null;
805
655
  /**
806
- * Description
807
- * @description Full product description
656
+ * Concurrent Rooms
657
+ * @description Max concurrent virtual rooms allowed
808
658
  */
809
- description?: string | null;
659
+ concurrent_rooms?: number | null;
810
660
  /**
811
- * Short Description
812
- * @description Short description for listings/previews
661
+ * Class Duration Minutes
662
+ * @description Max class duration in minutes
813
663
  */
814
- short_description?: string | null;
815
- };
816
- /**
817
- * VariantItem
818
- * @description Product variant (maps to product_variants_tbl)
819
- */
820
- VariantItem: {
664
+ class_duration_minutes?: number | null;
821
665
  /**
822
- * Name
823
- * @description Variant display name
666
+ * Attendee Limit
667
+ * @description Max attendees per session
824
668
  */
825
- name: string;
669
+ attendee_limit?: number | null;
826
670
  /**
827
- * Sku
828
- * @description Stock Keeping Unit
671
+ * Virtual Classroom Enabled
672
+ * @description Enable virtual classroom features
673
+ * @default true
829
674
  */
830
- sku?: string | null;
675
+ virtual_classroom_enabled: boolean;
831
676
  /**
832
- * Attributes
833
- * @description Custom attributes
677
+ * Active User Limit
678
+ * @description Max active users allowed
834
679
  */
835
- attributes?: {
836
- [key: string]: unknown;
837
- } | null;
680
+ active_user_limit?: number | null;
838
681
  /**
839
- * Is Default
840
- * @description Set as default variant
841
- * @default false
682
+ * Storage Limit Gb
683
+ * @description Storage limit in GB
842
684
  */
843
- is_default: boolean;
685
+ storage_limit_gb?: number | null;
844
686
  /**
845
- * Track Inventory
846
- * @description Track stock for this variant
847
- * @default false
687
+ * Bandwidth Gb Per Month
688
+ * @description Monthly bandwidth limit in GB
848
689
  */
849
- track_inventory: boolean;
690
+ bandwidth_gb_per_month?: number | null;
850
691
  /**
851
- * Stock Quantity
852
- * @description Initial stock
692
+ * Status
693
+ * @description active, inactive, archived, deleted
694
+ * @default active
853
695
  */
854
- stock_quantity?: number | null;
696
+ status: string;
697
+ };
698
+ ErrorResponse: {
699
+ /** @example about:blank */
700
+ type?: string;
701
+ /** @example GENERIC_ERROR */
702
+ code?: string;
703
+ /** @example Client Error */
704
+ title?: string;
705
+ /** @example 400 */
706
+ status?: number;
707
+ /** @example An error occurred */
708
+ detail?: string;
709
+ /** @example /v1/cart/items */
710
+ instance?: string;
711
+ extensions?: components["schemas"]["Extensions"];
712
+ };
713
+ /**
714
+ * ProductSection
715
+ * @description Base product fields (maps to product_tbl)
716
+ */
717
+ ProductSection: {
855
718
  /**
856
- * Allow Backorder
857
- * @description Allow orders when out of stock
858
- * @default false
719
+ * Visibility
720
+ * @description public, private, hidden, unlisted
721
+ * @default public
859
722
  */
860
- allow_backorder: boolean;
723
+ visibility: string;
861
724
  /**
862
- * Weight
863
- * @description Weight in kg
725
+ * Is Digital
726
+ * @description Digital product flag
727
+ * @default true
864
728
  */
865
- weight?: number | null;
729
+ is_digital: boolean;
866
730
  /**
867
- * Length
868
- * @description Length in cm
731
+ * Company Id
732
+ * @description Multi-company support
869
733
  */
870
- length?: number | null;
734
+ company_id?: number | null;
871
735
  /**
872
- * Width
873
- * @description Width in cm
736
+ * Status
737
+ * @description draft, published, archived, review_required, deleted
738
+ * @default draft
874
739
  */
875
- width?: number | null;
740
+ status: string;
876
741
  /**
877
- * Height
878
- * @description Height in cm
742
+ * Is Org Level
743
+ * @description Org-level vs user-created product
744
+ * @default true
879
745
  */
880
- height?: number | null;
746
+ is_org_level: boolean;
881
747
  /**
882
- * Display Order
883
- * @description Display order
884
- * @default 100
748
+ * Staff Id
749
+ * @description Staff/instructor delivering product
885
750
  */
886
- display_order: number;
751
+ staff_id?: number | null;
887
752
  /**
888
- * Metadata
889
- * @description Flexible metadata
753
+ * Owner Id
754
+ * @description Owner of the product
890
755
  */
891
- metadata?: {
892
- [key: string]: unknown;
893
- } | null;
756
+ owner_id?: number | null;
757
+ /**
758
+ * Featured
759
+ * @description Featured product flag
760
+ * @default false
761
+ */
762
+ featured: boolean;
763
+ };
764
+ /**
765
+ * TenantPlanCreateRequest
766
+ * @description Tenant Plan creation request - inherits common fields, adds plan-specific sections
767
+ * @example {
768
+ * "features": {
769
+ * "collections": {
770
+ * "enabled": true,
771
+ * "max_collections": 50
772
+ * },
773
+ * "corporate_products": {
774
+ * "enabled": true
775
+ * },
776
+ * "multilingual": {
777
+ * "enabled": true,
778
+ * "languages": [
779
+ * "en-US",
780
+ * "es-ES",
781
+ * "fr-FR"
782
+ * ]
783
+ * },
784
+ * "products": [
785
+ * "session",
786
+ * "webinar",
787
+ * "meeting"
788
+ * ]
789
+ * },
790
+ * "identity": {
791
+ * "description": "Comprehensive features for professional use with advanced virtual classroom capabilities...",
792
+ * "locale": "en-US",
793
+ * "short_description": "Professional tier with advanced features",
794
+ * "subtitle": "Perfect for growing teams",
795
+ * "title": "Professional Plan"
796
+ * },
797
+ * "media": {
798
+ * "media_items": [
799
+ * {
800
+ * "alt_text": "Professional Plan Logo",
801
+ * "file_name": "logo.png",
802
+ * "file_path": "/plans/123/logo.png",
803
+ * "is_primary": true,
804
+ * "media_type": "logo",
805
+ * "mime_type": "image/png"
806
+ * }
807
+ * ]
808
+ * },
809
+ * "plan": {
810
+ * "active_user_limit": 50,
811
+ * "attendee_limit": 100,
812
+ * "bandwidth_gb_per_month": 500,
813
+ * "class_duration_minutes": 120,
814
+ * "concurrent_rooms": 10,
815
+ * "is_standard": false,
816
+ * "status": "active",
817
+ * "storage_limit_gb": 100,
818
+ * "virtual_classroom_enabled": true
819
+ * },
820
+ * "pricing": {
821
+ * "product_price": {
822
+ * "amount": 99,
823
+ * "currency": "USD",
824
+ * "interval": "month",
825
+ * "price_type": "recurring"
826
+ * },
827
+ * "variant_prices": [
828
+ * {
829
+ * "amount": 99,
830
+ * "currency": "USD",
831
+ * "interval": "month",
832
+ * "price_type": "recurring",
833
+ * "variant_index": 0
834
+ * },
835
+ * {
836
+ * "amount": 950,
837
+ * "currency": "USD",
838
+ * "interval": "year",
839
+ * "price_type": "recurring",
840
+ * "variant_index": 1
841
+ * }
842
+ * ]
843
+ * },
844
+ * "product": {
845
+ * "company_id": 2,
846
+ * "featured": false,
847
+ * "is_digital": true,
848
+ * "is_org_level": true,
849
+ * "status": "active",
850
+ * "visibility": "public"
851
+ * },
852
+ * "tags": [
853
+ * 1,
854
+ * 5,
855
+ * 8
856
+ * ],
857
+ * "variants": [
858
+ * {
859
+ * "attributes": {
860
+ * "billing_cycle": "monthly"
861
+ * },
862
+ * "is_default": true,
863
+ * "name": "Monthly",
864
+ * "sku": "PROF-MONTHLY"
865
+ * },
866
+ * {
867
+ * "attributes": {
868
+ * "billing_cycle": "annual",
869
+ * "discount": "20%"
870
+ * },
871
+ * "name": "Annual",
872
+ * "sku": "PROF-ANNUAL"
873
+ * }
874
+ * ]
875
+ * }
876
+ */
877
+ TenantPlanCreateRequest: {
878
+ /** @description Base product configuration */
879
+ product: components["schemas"]["ProductSection"];
880
+ /** @description Localized content (title, description) */
881
+ identity: components["schemas"]["IdentitySection"];
882
+ /** @description Pre-uploaded image IDs */
883
+ media?: components["schemas"]["MediaSection"] | null;
884
+ /**
885
+ * Tags
886
+ * @description Tag IDs to associate with product
887
+ */
888
+ tags?: number[] | null;
889
+ /**
890
+ * Variants
891
+ * @description Product variants (optional)
892
+ */
893
+ variants?: components["schemas"]["VariantItem"][] | null;
894
+ /** @description Pricing for product and variants */
895
+ pricing?: components["schemas"]["PricingSection"] | null;
896
+ /** @description Tenant plan configuration and limits */
897
+ plan: components["schemas"]["TenantPlanSection"];
898
+ /** @description Optional plan features and add-ons */
899
+ features?: components["schemas"]["TenantPlanFeaturesSection"] | null;
894
900
  };
895
901
  /**
896
902
  * PricingSection
@@ -905,12 +911,6 @@ export interface components {
905
911
  */
906
912
  variant_prices?: components["schemas"]["VariantPrice"][] | null;
907
913
  };
908
- InvalidParam: {
909
- /** @example items[0].quantity */
910
- field?: string;
911
- /** @example Input should be greater than or equal to 1 */
912
- error?: string;
913
- };
914
914
  };
915
915
  responses: never;
916
916
  parameters: never;