@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.
Files changed (137) hide show
  1. package/dist/account/generated.d.ts +238 -238
  2. package/dist/account/generated.d.ts.map +1 -1
  3. package/dist/activity/generated.d.ts +57 -57
  4. package/dist/activity/generated.d.ts.map +1 -1
  5. package/dist/addon/generated.d.ts +82 -82
  6. package/dist/addon/generated.d.ts.map +1 -1
  7. package/dist/admin/generated.d.ts +102 -102
  8. package/dist/admin/generated.d.ts.map +1 -1
  9. package/dist/affiliate/generated.d.ts +81 -81
  10. package/dist/affiliate/generated.d.ts.map +1 -1
  11. package/dist/analytics/generated.d.ts +22 -22
  12. package/dist/analytics/generated.d.ts.map +1 -1
  13. package/dist/announcements/generated.d.ts +134 -134
  14. package/dist/announcements/generated.d.ts.map +1 -1
  15. package/dist/apikeys/generated.d.ts +69 -69
  16. package/dist/apikeys/generated.d.ts.map +1 -1
  17. package/dist/assistance/generated.d.ts +22 -22
  18. package/dist/assistance/generated.d.ts.map +1 -1
  19. package/dist/authentication/generated.d.ts +61 -61
  20. package/dist/authentication/generated.d.ts.map +1 -1
  21. package/dist/blog/generated.d.ts +206 -206
  22. package/dist/blog/generated.d.ts.map +1 -1
  23. package/dist/bundle/generated.d.ts +84 -84
  24. package/dist/bundle/generated.d.ts.map +1 -1
  25. package/dist/cache/generated.d.ts +38 -38
  26. package/dist/cache/generated.d.ts.map +1 -1
  27. package/dist/calendar/generated.d.ts +28 -28
  28. package/dist/calendar/generated.d.ts.map +1 -1
  29. package/dist/campaigns/generated.d.ts +174 -174
  30. package/dist/campaigns/generated.d.ts.map +1 -1
  31. package/dist/cart/generated.d.ts +28 -28
  32. package/dist/cart/generated.d.ts.map +1 -1
  33. package/dist/changelog/generated.d.ts +107 -107
  34. package/dist/changelog/generated.d.ts.map +1 -1
  35. package/dist/channel/generated.d.ts +224 -224
  36. package/dist/channel/generated.d.ts.map +1 -1
  37. package/dist/company/generated.d.ts +43 -43
  38. package/dist/company/generated.d.ts.map +1 -1
  39. package/dist/conference/generated.d.ts +74 -74
  40. package/dist/conference/generated.d.ts.map +1 -1
  41. package/dist/config/generated.d.ts +68 -68
  42. package/dist/config/generated.d.ts.map +1 -1
  43. package/dist/content/generated.d.ts +541 -541
  44. package/dist/content/generated.d.ts.map +1 -1
  45. package/dist/cookies/generated.d.ts +36 -36
  46. package/dist/cookies/generated.d.ts.map +1 -1
  47. package/dist/courses/generated.d.ts +436 -436
  48. package/dist/courses/generated.d.ts.map +1 -1
  49. package/dist/custom/generated.d.ts +83 -83
  50. package/dist/custom/generated.d.ts.map +1 -1
  51. package/dist/dashboard/generated.d.ts +214 -214
  52. package/dist/dashboard/generated.d.ts.map +1 -1
  53. package/dist/elasticsearch/generated.d.ts +22 -22
  54. package/dist/elasticsearch/generated.d.ts.map +1 -1
  55. package/dist/enrollments/generated.d.ts +22 -22
  56. package/dist/enrollments/generated.d.ts.map +1 -1
  57. package/dist/errors/generated.d.ts +51 -51
  58. package/dist/errors/generated.d.ts.map +1 -1
  59. package/dist/eventconfig/generated.d.ts +113 -113
  60. package/dist/eventconfig/generated.d.ts.map +1 -1
  61. package/dist/funnels/generated.d.ts +124 -124
  62. package/dist/funnels/generated.d.ts.map +1 -1
  63. package/dist/gamification/generated.d.ts +194 -194
  64. package/dist/gamification/generated.d.ts.map +1 -1
  65. package/dist/impersonation/generated.d.ts +35 -35
  66. package/dist/impersonation/generated.d.ts.map +1 -1
  67. package/dist/inbox/generated.d.ts +138 -138
  68. package/dist/inbox/generated.d.ts.map +1 -1
  69. package/dist/internal/generated.d.ts +22 -22
  70. package/dist/internal/generated.d.ts.map +1 -1
  71. package/dist/internationalization/generated.d.ts +22 -22
  72. package/dist/internationalization/generated.d.ts.map +1 -1
  73. package/dist/invitations/generated.d.ts +111 -111
  74. package/dist/invitations/generated.d.ts.map +1 -1
  75. package/dist/meetings/generated.d.ts +323 -323
  76. package/dist/meetings/generated.d.ts.map +1 -1
  77. package/dist/metas/generated.d.ts +160 -160
  78. package/dist/metas/generated.d.ts.map +1 -1
  79. package/dist/notification/generated.d.ts +246 -246
  80. package/dist/notification/generated.d.ts.map +1 -1
  81. package/dist/notifications/generated.d.ts +22 -22
  82. package/dist/notifications/generated.d.ts.map +1 -1
  83. package/dist/onboarding/generated.d.ts +118 -118
  84. package/dist/onboarding/generated.d.ts.map +1 -1
  85. package/dist/packages/generated.d.ts +80 -80
  86. package/dist/packages/generated.d.ts.map +1 -1
  87. package/dist/payments/generated.d.ts +557 -557
  88. package/dist/payments/generated.d.ts.map +1 -1
  89. package/dist/payouts/generated.d.ts +22 -22
  90. package/dist/payouts/generated.d.ts.map +1 -1
  91. package/dist/plans/generated.d.ts +472 -472
  92. package/dist/plans/generated.d.ts.map +1 -1
  93. package/dist/pricing/generated.d.ts +100 -100
  94. package/dist/pricing/generated.d.ts.map +1 -1
  95. package/dist/products/generated.d.ts +617 -617
  96. package/dist/products/generated.d.ts.map +1 -1
  97. package/dist/profile/generated.d.ts +328 -328
  98. package/dist/profile/generated.d.ts.map +1 -1
  99. package/dist/reasons/generated.d.ts +97 -97
  100. package/dist/reasons/generated.d.ts.map +1 -1
  101. package/dist/registration/generated.d.ts +184 -184
  102. package/dist/registration/generated.d.ts.map +1 -1
  103. package/dist/reviews/generated.d.ts +69 -69
  104. package/dist/reviews/generated.d.ts.map +1 -1
  105. package/dist/role/generated.d.ts +210 -210
  106. package/dist/role/generated.d.ts.map +1 -1
  107. package/dist/scheduling/generated.d.ts +80 -80
  108. package/dist/scheduling/generated.d.ts.map +1 -1
  109. package/dist/services/generated.d.ts +937 -937
  110. package/dist/services/generated.d.ts.map +1 -1
  111. package/dist/sessions/generated.d.ts +363 -363
  112. package/dist/sessions/generated.d.ts.map +1 -1
  113. package/dist/spaces/generated.d.ts +403 -403
  114. package/dist/spaces/generated.d.ts.map +1 -1
  115. package/dist/storefront/generated.d.ts +22 -22
  116. package/dist/storefront/generated.d.ts.map +1 -1
  117. package/dist/support/generated.d.ts +1440 -1440
  118. package/dist/support/generated.d.ts.map +1 -1
  119. package/dist/sync/generated.d.ts +193 -193
  120. package/dist/sync/generated.d.ts.map +1 -1
  121. package/dist/tenant/generated.d.ts +482 -482
  122. package/dist/tenant/generated.d.ts.map +1 -1
  123. package/dist/testimonials/generated.d.ts +65 -65
  124. package/dist/testimonials/generated.d.ts.map +1 -1
  125. package/dist/tests/generated.d.ts +445 -445
  126. package/dist/tests/generated.d.ts.map +1 -1
  127. package/dist/tokens/generated.d.ts +39 -39
  128. package/dist/tokens/generated.d.ts.map +1 -1
  129. package/dist/uploads/generated.d.ts +20 -20
  130. package/dist/uploads/generated.d.ts.map +1 -1
  131. package/dist/upsell/generated.d.ts +108 -108
  132. package/dist/upsell/generated.d.ts.map +1 -1
  133. package/dist/user/generated.d.ts +107 -107
  134. package/dist/user/generated.d.ts.map +1 -1
  135. package/dist/webinars/generated.d.ts +308 -308
  136. package/dist/webinars/generated.d.ts.map +1 -1
  137. package/package.json +1 -1
@@ -571,22 +571,80 @@ export interface paths {
571
571
  export type webhooks = Record<string, never>;
572
572
  export interface components {
573
573
  schemas: {
574
- /** Body_createCourseBatch */
575
- Body_createCourseBatch: {
574
+ /**
575
+ * PricingSection
576
+ * @description Pricing configuration (optional - can have product price, variant prices, or both)
577
+ */
578
+ PricingSection: {
579
+ /** @description Base product price (no variant) */
580
+ product_price?: components["schemas"]["ProductPrice"] | null;
581
+ /**
582
+ * Variant Prices
583
+ * @description Variant-specific prices
584
+ */
585
+ variant_prices?: components["schemas"]["VariantPrice"][] | null;
586
+ };
587
+ /**
588
+ * CourseCreateRequest
589
+ * @description Course creation request - inherits common fields, adds course-specific section
590
+ * @example {
591
+ * "course": {
592
+ * "course_type": "instructor_led",
593
+ * "primary_instructor_id": 456
594
+ * },
595
+ * "identity": {
596
+ * "locale": "en-US",
597
+ * "title": "Advanced Python Programming"
598
+ * },
599
+ * "pricing": {
600
+ * "product_price": {
601
+ * "amount": 5000,
602
+ * "currency": "INR",
603
+ * "price_type": "one_time"
604
+ * }
605
+ * },
606
+ * "product": {
607
+ * "is_digital": true,
608
+ * "status": "draft",
609
+ * "visibility": "public"
610
+ * }
611
+ * }
612
+ */
613
+ CourseCreateRequest: {
614
+ /** @description Base product configuration */
615
+ product: components["schemas"]["ProductSection"];
616
+ /** @description Localized content (title, description) */
617
+ identity: components["schemas"]["IdentitySection"];
618
+ /** @description Pre-uploaded image IDs */
619
+ media?: components["schemas"]["MediaSection"] | null;
620
+ /**
621
+ * Tags
622
+ * @description Tag IDs to associate with product
623
+ */
624
+ tags?: number[] | null;
625
+ /**
626
+ * Variants
627
+ * @description Product variants (optional)
628
+ */
629
+ variants?: components["schemas"]["VariantItem"][] | null;
630
+ /** @description Pricing for product and variants */
631
+ pricing?: components["schemas"]["PricingSection"] | null;
632
+ /** @description Course-specific configuration */
633
+ course: components["schemas"]["CourseSection"];
634
+ };
635
+ /** Body_createBatchFromCSV */
636
+ Body_createBatchFromCSV: {
637
+ /**
638
+ * Csv File
639
+ * Format: binary
640
+ */
641
+ csv_file: string;
576
642
  /** Batch Name */
577
643
  batch_name: string;
578
644
  /** Instructor Id */
579
645
  instructor_id: number;
580
- /** Starts At */
581
- starts_at: string;
582
- /** Ends At */
583
- ends_at?: string | null;
584
- /** Class Duration Minutes */
585
- class_duration_minutes: number;
586
- /** Class Time */
587
- class_time: string;
588
- /** Weekdays */
589
- weekdays: string[];
646
+ /** Timezone */
647
+ timezone: string;
590
648
  /**
591
649
  * Max Students
592
650
  * @default 25
@@ -599,159 +657,203 @@ export interface components {
599
657
  * @default false
600
658
  */
601
659
  is_private: boolean;
660
+ /** Meeting Platform */
661
+ meeting_platform?: string | null;
662
+ };
663
+ /** Body_validateBatchSchedule */
664
+ Body_validateBatchSchedule: {
665
+ /** Starts At */
666
+ starts_at: string;
667
+ /** Ends At */
668
+ ends_at: string;
669
+ /** Weekdays */
670
+ weekdays: string[];
671
+ /** Duration Minutes */
672
+ duration_minutes: number;
602
673
  /**
603
674
  * Timezone
604
675
  * @default UTC
605
676
  */
606
677
  timezone: string;
607
- /** Meeting Platform */
608
- meeting_platform?: string | null;
609
- /** Meeting Credentials */
610
- meeting_credentials?: {
611
- [key: string]: unknown;
612
- } | null;
613
678
  };
614
679
  /**
615
- * @example {
616
- * "status": "success",
617
- * "message": "Operation successful",
618
- * "message_code": "api_suc_20001",
619
- * "data": {},
620
- * "metadata": {
621
- * "timestamp": "2026-03-26T10:00:00.000Z",
622
- * "requestId": "07e22004-cb60-4dfc-bc9c-b6f99664dca1",
623
- * "traceId": "a9f1204c-bb82-41de-b234-7c3a9e120000",
624
- * "version": "v1",
625
- * "executionTime": 42,
626
- * "language": "en-US"
627
- * }
628
- * }
680
+ * MediaSection
681
+ * @description Product media files - direct media data
629
682
  */
630
- StandardResponse: {
631
- /** @example success */
632
- status?: string;
633
- data?: Record<string, never> | null;
634
- /** @example Operation successful */
635
- message?: string | null;
636
- /** @example api_suc_20001 */
637
- message_code?: string | null;
638
- metadata?: Record<string, never> | null;
639
- error?: components["schemas"]["ErrorResponse"];
683
+ MediaSection: {
684
+ /**
685
+ * Media Items
686
+ * @description List of media files to attach to product
687
+ */
688
+ media_items?: components["schemas"]["MediaItem"][] | null;
640
689
  };
641
690
  /**
642
- * VariantItem
643
- * @description Product variant (maps to product_variants_tbl)
691
+ * ProductSection
692
+ * @description Base product fields (maps to product_tbl)
644
693
  */
645
- VariantItem: {
694
+ ProductSection: {
646
695
  /**
647
- * Name
648
- * @description Variant display name
696
+ * Visibility
697
+ * @description public, private, hidden, unlisted
698
+ * @default public
649
699
  */
650
- name: string;
700
+ visibility: string;
651
701
  /**
652
- * Sku
653
- * @description Stock Keeping Unit
702
+ * Is Digital
703
+ * @description Digital product flag
704
+ * @default true
654
705
  */
655
- sku?: string | null;
706
+ is_digital: boolean;
656
707
  /**
657
- * Attributes
658
- * @description Custom attributes
708
+ * Company Id
709
+ * @description Multi-company support
659
710
  */
660
- attributes?: {
661
- [key: string]: unknown;
662
- } | null;
711
+ company_id?: number | null;
663
712
  /**
664
- * Is Default
665
- * @description Set as default variant
666
- * @default false
713
+ * Status
714
+ * @description draft, published, archived, review_required, deleted
715
+ * @default draft
667
716
  */
668
- is_default: boolean;
717
+ status: string;
669
718
  /**
670
- * Track Inventory
671
- * @description Track stock for this variant
672
- * @default false
719
+ * Is Org Level
720
+ * @description Org-level vs user-created product
721
+ * @default true
673
722
  */
674
- track_inventory: boolean;
723
+ is_org_level: boolean;
675
724
  /**
676
- * Stock Quantity
677
- * @description Initial stock
725
+ * Staff Id
726
+ * @description Staff/instructor delivering product
678
727
  */
679
- stock_quantity?: number | null;
728
+ staff_id?: number | null;
680
729
  /**
681
- * Allow Backorder
682
- * @description Allow orders when out of stock
730
+ * Owner Id
731
+ * @description Owner of the product
732
+ */
733
+ owner_id?: number | null;
734
+ /**
735
+ * Featured
736
+ * @description Featured product flag
683
737
  * @default false
684
738
  */
685
- allow_backorder: boolean;
739
+ featured: boolean;
740
+ };
741
+ ErrorResponse: {
742
+ /** @example about:blank */
743
+ type?: string;
744
+ /** @example GENERIC_ERROR */
745
+ code?: string;
746
+ /** @example Client Error */
747
+ title?: string;
748
+ /** @example 400 */
749
+ status?: number;
750
+ /** @example An error occurred */
751
+ detail?: string;
752
+ /** @example /v1/cart/items */
753
+ instance?: string;
754
+ extensions?: components["schemas"]["Extensions"];
755
+ };
756
+ /**
757
+ * MediaItem
758
+ * @description Single media file item
759
+ */
760
+ MediaItem: {
686
761
  /**
687
- * Weight
688
- * @description Weight in kg
762
+ * Media Type
763
+ * @description logo, banner, promo_video, gallery_image, gallery_video, swatch
689
764
  */
690
- weight?: number | null;
765
+ media_type: string;
691
766
  /**
692
- * Length
693
- * @description Length in cm
767
+ * File Path
768
+ * @description Path to media file on storage (S3, CDN, local)
694
769
  */
695
- length?: number | null;
770
+ file_path: string;
771
+ /**
772
+ * File Name
773
+ * @description Original filename
774
+ */
775
+ file_name: string;
776
+ /**
777
+ * File Size
778
+ * @description File size in bytes
779
+ */
780
+ file_size?: number | null;
781
+ /**
782
+ * Mime Type
783
+ * @description MIME type (image/png, video/mp4, etc.)
784
+ */
785
+ mime_type?: string | null;
696
786
  /**
697
787
  * Width
698
- * @description Width in cm
788
+ * @description Width in pixels (for images/videos)
699
789
  */
700
790
  width?: number | null;
701
791
  /**
702
792
  * Height
703
- * @description Height in cm
793
+ * @description Height in pixels (for images/videos)
704
794
  */
705
795
  height?: number | null;
706
796
  /**
707
- * Display Order
708
- * @description Display order
709
- * @default 100
797
+ * Responsive Versions
798
+ * @description JSON with thumbnail, small, medium, large, xlarge, original paths
710
799
  */
711
- display_order: number;
800
+ responsive_versions?: {
801
+ [key: string]: string;
802
+ } | null;
712
803
  /**
713
- * Metadata
714
- * @description Flexible metadata
715
- */
716
- metadata?: {
717
- [key: string]: unknown;
718
- } | null;
719
- };
720
- /**
721
- * CourseSection
722
- * @description Course-specific fields (maps to courses_tbl)
723
- */
724
- CourseSection: {
725
- /**
726
- * Course Type
727
- * @description instructor_led, self_paced, hybrid
804
+ * Alt Text
805
+ * @description Alt text for SEO/accessibility
728
806
  */
729
- course_type: string;
807
+ alt_text?: string | null;
730
808
  /**
731
- * Primary Instructor Id
732
- * @description User ID of main instructor
809
+ * Locale
810
+ * @description Media locale (en-US, es-PR, etc.)
811
+ * @default en-US
733
812
  */
734
- primary_instructor_id: number;
813
+ locale: string;
735
814
  /**
736
- * Co Instructors
737
- * @description List of co-instructor user IDs
815
+ * Display Order
816
+ * @description Display order
817
+ * @default 0
738
818
  */
739
- co_instructors?: number[] | null;
819
+ display_order: number;
740
820
  /**
741
- * Difficulty Level
742
- * @description beginner, intermediate, advanced, expert
821
+ * Is Primary
822
+ * @description Mark as primary media
823
+ * @default false
743
824
  */
744
- difficulty_level?: string | null;
825
+ is_primary: boolean;
826
+ };
827
+ /** Body_createBatchCurriculumItem */
828
+ Body_createBatchCurriculumItem: {
829
+ /** Title */
830
+ title: string;
831
+ /** Content Type */
832
+ content_type: string;
833
+ /** Is Section */
834
+ is_section: number;
835
+ /** Parent Id */
836
+ parent_id?: number | null;
745
837
  /**
746
- * Instruction Language
747
- * @description English, Spanish, French, etc.
838
+ * Section Order
839
+ * @default 0
748
840
  */
749
- instruction_language?: string | null;
841
+ section_order: number;
750
842
  /**
751
- * Locale
752
- * @description Defaults to identity.locale if not provided
843
+ * Chapter Order
844
+ * @default 0
753
845
  */
754
- locale?: string | null;
846
+ chapter_order: number;
847
+ /** Description */
848
+ description?: string | null;
849
+ /** Content Id */
850
+ content_id?: number | null;
851
+ /** Instructor Id */
852
+ instructor_id?: number | null;
853
+ /** Scheduled At */
854
+ scheduled_at?: string | null;
855
+ /** Duration Minutes */
856
+ duration_minutes?: number | null;
755
857
  };
756
858
  Extensions: {
757
859
  /** @example GENERIC_ERROR */
@@ -762,56 +864,16 @@ export interface components {
762
864
  /** @example Detailed debug information */
763
865
  debug?: string | null;
764
866
  };
765
- /** Body_createBatchFromCSV */
766
- Body_createBatchFromCSV: {
767
- /**
768
- * Csv File
769
- * Format: binary
770
- */
771
- csv_file: string;
772
- /** Batch Name */
773
- batch_name: string;
774
- /** Instructor Id */
775
- instructor_id: number;
776
- /** Timezone */
777
- timezone: string;
778
- /**
779
- * Max Students
780
- * @default 25
781
- */
782
- max_students: number;
783
- /** Batch Code */
784
- batch_code?: string | null;
785
- /**
786
- * Is Private
787
- * @default false
788
- */
789
- is_private: boolean;
790
- /** Meeting Platform */
791
- meeting_platform?: string | null;
792
- };
793
- /** Body_updateCourse */
794
- Body_updateCourse: {
795
- /** Title */
796
- title?: string | null;
797
- /** Description */
798
- description?: string | null;
799
- /** Learning Outcomes */
800
- learning_outcomes?: string | null;
801
- /** Prerequisites */
802
- prerequisites?: string | null;
803
- /** Target Audience */
804
- target_audience?: string | null;
805
- /** Difficulty Level */
806
- difficulty_level?: string | null;
807
- /** Co Instructors */
808
- co_instructors?: number[] | null;
809
- };
810
867
  /**
811
- * ProductPrice
812
- * @description Base product pricing (maps to product_pricings_tbl with variant_id=NULL)
868
+ * VariantPrice
869
+ * @description Variant-specific pricing (maps to product_pricings_tbl with variant_id set)
813
870
  */
814
- ProductPrice: {
871
+ VariantPrice: {
872
+ /**
873
+ * Variant Index
874
+ * @description Index in variants array (0-based)
875
+ */
876
+ variant_index: number;
815
877
  /**
816
878
  * Price Type
817
879
  * @description free, one_time, subscription, monthly_plan
@@ -819,7 +881,7 @@ export interface components {
819
881
  price_type: string;
820
882
  /**
821
883
  * Currency
822
- * @description Currency code: INR, USD, EUR, etc.
884
+ * @description Currency code
823
885
  */
824
886
  currency: string;
825
887
  /**
@@ -834,7 +896,7 @@ export interface components {
834
896
  compare_at_amount?: number | null;
835
897
  /**
836
898
  * Interval
837
- * @description day, week, month, year (for subscription)
899
+ * @description day, week, month, year
838
900
  */
839
901
  interval?: string | null;
840
902
  /**
@@ -864,191 +926,90 @@ export interface components {
864
926
  */
865
927
  requires_payment_method_upfront: boolean;
866
928
  };
867
- /** Body_createCourseCurriculumItem */
868
- Body_createCourseCurriculumItem: {
869
- /** Title */
870
- title: string;
871
- /** Content Type */
872
- content_type: string;
873
- /** Is Section */
874
- is_section: number;
875
- /** Parent Id */
876
- parent_id?: number | null;
929
+ /**
930
+ * VariantItem
931
+ * @description Product variant (maps to product_variants_tbl)
932
+ */
933
+ VariantItem: {
877
934
  /**
878
- * Section Order
879
- * @default 0
935
+ * Name
936
+ * @description Variant display name
880
937
  */
881
- section_order: number;
938
+ name: string;
882
939
  /**
883
- * Chapter Order
884
- * @default 0
940
+ * Sku
941
+ * @description Stock Keeping Unit
885
942
  */
886
- chapter_order: number;
887
- /** Description */
888
- description?: string | null;
889
- /** Content Id */
890
- content_id?: number | null;
943
+ sku?: string | null;
891
944
  /**
892
- * Drip Days
893
- * @default 0
945
+ * Attributes
946
+ * @description Custom attributes
894
947
  */
895
- drip_days: number;
948
+ attributes?: {
949
+ [key: string]: unknown;
950
+ } | null;
896
951
  /**
897
- * Is Locked
952
+ * Is Default
953
+ * @description Set as default variant
898
954
  * @default false
899
955
  */
900
- is_locked: boolean;
901
- };
902
- /** Body_createBatchCurriculumItem */
903
- Body_createBatchCurriculumItem: {
904
- /** Title */
905
- title: string;
906
- /** Content Type */
907
- content_type: string;
908
- /** Is Section */
909
- is_section: number;
910
- /** Parent Id */
911
- parent_id?: number | null;
956
+ is_default: boolean;
912
957
  /**
913
- * Section Order
914
- * @default 0
958
+ * Track Inventory
959
+ * @description Track stock for this variant
960
+ * @default false
915
961
  */
916
- section_order: number;
962
+ track_inventory: boolean;
917
963
  /**
918
- * Chapter Order
919
- * @default 0
964
+ * Stock Quantity
965
+ * @description Initial stock
920
966
  */
921
- chapter_order: number;
922
- /** Description */
923
- description?: string | null;
924
- /** Content Id */
925
- content_id?: number | null;
926
- /** Instructor Id */
927
- instructor_id?: number | null;
928
- /** Scheduled At */
929
- scheduled_at?: string | null;
930
- /** Duration Minutes */
931
- duration_minutes?: number | null;
932
- };
933
- /**
934
- * IdentitySection
935
- * @description Localized product content (maps to product_identity_tbl)
936
- */
937
- IdentitySection: {
967
+ stock_quantity?: number | null;
938
968
  /**
939
- * Locale
940
- * @description Locale: en-US, es-PR, fr-FR, pt-BR, etc.
941
- * @default en-US
969
+ * Allow Backorder
970
+ * @description Allow orders when out of stock
971
+ * @default false
942
972
  */
943
- locale: string;
973
+ allow_backorder: boolean;
944
974
  /**
945
- * Title
946
- * @description Product title
975
+ * Weight
976
+ * @description Weight in kg
947
977
  */
948
- title: string;
978
+ weight?: number | null;
949
979
  /**
950
- * Subtitle
951
- * @description Product subtitle
980
+ * Length
981
+ * @description Length in cm
952
982
  */
953
- subtitle?: string | null;
983
+ length?: number | null;
954
984
  /**
955
- * Description
956
- * @description Full product description
985
+ * Width
986
+ * @description Width in cm
957
987
  */
958
- description?: string | null;
988
+ width?: number | null;
959
989
  /**
960
- * Short Description
961
- * @description Short description for listings/previews
990
+ * Height
991
+ * @description Height in cm
962
992
  */
963
- short_description?: string | null;
964
- };
965
- /**
966
- * MediaItem
967
- * @description Single media file item
968
- */
969
- MediaItem: {
970
- /**
971
- * Media Type
972
- * @description logo, banner, promo_video, gallery_image, gallery_video, swatch
973
- */
974
- media_type: string;
975
- /**
976
- * File Path
977
- * @description Path to media file on storage (S3, CDN, local)
978
- */
979
- file_path: string;
980
- /**
981
- * File Name
982
- * @description Original filename
983
- */
984
- file_name: string;
985
- /**
986
- * File Size
987
- * @description File size in bytes
988
- */
989
- file_size?: number | null;
990
- /**
991
- * Mime Type
992
- * @description MIME type (image/png, video/mp4, etc.)
993
- */
994
- mime_type?: string | null;
995
- /**
996
- * Width
997
- * @description Width in pixels (for images/videos)
998
- */
999
- width?: number | null;
1000
- /**
1001
- * Height
1002
- * @description Height in pixels (for images/videos)
1003
- */
1004
- height?: number | null;
1005
- /**
1006
- * Responsive Versions
1007
- * @description JSON with thumbnail, small, medium, large, xlarge, original paths
1008
- */
1009
- responsive_versions?: {
1010
- [key: string]: string;
1011
- } | null;
1012
- /**
1013
- * Alt Text
1014
- * @description Alt text for SEO/accessibility
1015
- */
1016
- alt_text?: string | null;
1017
- /**
1018
- * Locale
1019
- * @description Media locale (en-US, es-PR, etc.)
1020
- * @default en-US
1021
- */
1022
- locale: string;
993
+ height?: number | null;
1023
994
  /**
1024
995
  * Display Order
1025
996
  * @description Display order
1026
- * @default 0
997
+ * @default 100
1027
998
  */
1028
999
  display_order: number;
1029
1000
  /**
1030
- * Is Primary
1031
- * @description Mark as primary media
1032
- * @default false
1001
+ * Metadata
1002
+ * @description Flexible metadata
1033
1003
  */
1034
- is_primary: boolean;
1035
- };
1036
- InvalidParam: {
1037
- /** @example items[0].quantity */
1038
- field?: string;
1039
- /** @example Input should be greater than or equal to 1 */
1040
- error?: string;
1004
+ metadata?: {
1005
+ [key: string]: unknown;
1006
+ } | null;
1041
1007
  };
1042
1008
  /**
1043
- * VariantPrice
1044
- * @description Variant-specific pricing (maps to product_pricings_tbl with variant_id set)
1009
+ * ProductPrice
1010
+ * @description Base product pricing (maps to product_pricings_tbl with variant_id=NULL)
1045
1011
  */
1046
- VariantPrice: {
1047
- /**
1048
- * Variant Index
1049
- * @description Index in variants array (0-based)
1050
- */
1051
- variant_index: number;
1012
+ ProductPrice: {
1052
1013
  /**
1053
1014
  * Price Type
1054
1015
  * @description free, one_time, subscription, monthly_plan
@@ -1056,7 +1017,7 @@ export interface components {
1056
1017
  price_type: string;
1057
1018
  /**
1058
1019
  * Currency
1059
- * @description Currency code
1020
+ * @description Currency code: INR, USD, EUR, etc.
1060
1021
  */
1061
1022
  currency: string;
1062
1023
  /**
@@ -1071,7 +1032,7 @@ export interface components {
1071
1032
  compare_at_amount?: number | null;
1072
1033
  /**
1073
1034
  * Interval
1074
- * @description day, week, month, year
1035
+ * @description day, week, month, year (for subscription)
1075
1036
  */
1076
1037
  interval?: string | null;
1077
1038
  /**
@@ -1101,159 +1062,198 @@ export interface components {
1101
1062
  */
1102
1063
  requires_payment_method_upfront: boolean;
1103
1064
  };
1065
+ InvalidParam: {
1066
+ /** @example items[0].quantity */
1067
+ field?: string;
1068
+ /** @example Input should be greater than or equal to 1 */
1069
+ error?: string;
1070
+ };
1071
+ /** Body_createCourseBatch */
1072
+ Body_createCourseBatch: {
1073
+ /** Batch Name */
1074
+ batch_name: string;
1075
+ /** Instructor Id */
1076
+ instructor_id: number;
1077
+ /** Starts At */
1078
+ starts_at: string;
1079
+ /** Ends At */
1080
+ ends_at?: string | null;
1081
+ /** Class Duration Minutes */
1082
+ class_duration_minutes: number;
1083
+ /** Class Time */
1084
+ class_time: string;
1085
+ /** Weekdays */
1086
+ weekdays: string[];
1087
+ /**
1088
+ * Max Students
1089
+ * @default 25
1090
+ */
1091
+ max_students: number;
1092
+ /** Batch Code */
1093
+ batch_code?: string | null;
1094
+ /**
1095
+ * Is Private
1096
+ * @default false
1097
+ */
1098
+ is_private: boolean;
1099
+ /**
1100
+ * Timezone
1101
+ * @default UTC
1102
+ */
1103
+ timezone: string;
1104
+ /** Meeting Platform */
1105
+ meeting_platform?: string | null;
1106
+ /** Meeting Credentials */
1107
+ meeting_credentials?: {
1108
+ [key: string]: unknown;
1109
+ } | null;
1110
+ };
1111
+ /** Body_updateCourse */
1112
+ Body_updateCourse: {
1113
+ /** Title */
1114
+ title?: string | null;
1115
+ /** Description */
1116
+ description?: string | null;
1117
+ /** Learning Outcomes */
1118
+ learning_outcomes?: string | null;
1119
+ /** Prerequisites */
1120
+ prerequisites?: string | null;
1121
+ /** Target Audience */
1122
+ target_audience?: string | null;
1123
+ /** Difficulty Level */
1124
+ difficulty_level?: string | null;
1125
+ /** Co Instructors */
1126
+ co_instructors?: number[] | null;
1127
+ };
1104
1128
  /**
1105
- * CourseCreateRequest
1106
- * @description Course creation request - inherits common fields, adds course-specific section
1107
1129
  * @example {
1108
- * "course": {
1109
- * "course_type": "instructor_led",
1110
- * "primary_instructor_id": 456
1111
- * },
1112
- * "identity": {
1113
- * "locale": "en-US",
1114
- * "title": "Advanced Python Programming"
1115
- * },
1116
- * "pricing": {
1117
- * "product_price": {
1118
- * "amount": 5000,
1119
- * "currency": "INR",
1120
- * "price_type": "one_time"
1121
- * }
1122
- * },
1123
- * "product": {
1124
- * "is_digital": true,
1125
- * "status": "draft",
1126
- * "visibility": "public"
1130
+ * "status": "success",
1131
+ * "message": "Operation successful",
1132
+ * "message_code": "api_suc_20001",
1133
+ * "data": {},
1134
+ * "metadata": {
1135
+ * "timestamp": "2026-03-26T10:00:00.000Z",
1136
+ * "requestId": "07e22004-cb60-4dfc-bc9c-b6f99664dca1",
1137
+ * "traceId": "a9f1204c-bb82-41de-b234-7c3a9e120000",
1138
+ * "version": "v1",
1139
+ * "executionTime": 42,
1140
+ * "language": "en-US"
1127
1141
  * }
1128
1142
  * }
1129
1143
  */
1130
- CourseCreateRequest: {
1131
- /** @description Base product configuration */
1132
- product: components["schemas"]["ProductSection"];
1133
- /** @description Localized content (title, description) */
1134
- identity: components["schemas"]["IdentitySection"];
1135
- /** @description Pre-uploaded image IDs */
1136
- media?: components["schemas"]["MediaSection"] | null;
1144
+ StandardResponse: {
1145
+ /** @example success */
1146
+ status?: string;
1147
+ data?: Record<string, never> | null;
1148
+ /** @example Operation successful */
1149
+ message?: string | null;
1150
+ /** @example api_suc_20001 */
1151
+ message_code?: string | null;
1152
+ metadata?: Record<string, never> | null;
1153
+ error?: components["schemas"]["ErrorResponse"];
1154
+ };
1155
+ /** Body_createCourseCurriculumItem */
1156
+ Body_createCourseCurriculumItem: {
1157
+ /** Title */
1158
+ title: string;
1159
+ /** Content Type */
1160
+ content_type: string;
1161
+ /** Is Section */
1162
+ is_section: number;
1163
+ /** Parent Id */
1164
+ parent_id?: number | null;
1137
1165
  /**
1138
- * Tags
1139
- * @description Tag IDs to associate with product
1166
+ * Section Order
1167
+ * @default 0
1140
1168
  */
1141
- tags?: number[] | null;
1169
+ section_order: number;
1142
1170
  /**
1143
- * Variants
1144
- * @description Product variants (optional)
1171
+ * Chapter Order
1172
+ * @default 0
1145
1173
  */
1146
- variants?: components["schemas"]["VariantItem"][] | null;
1147
- /** @description Pricing for product and variants */
1148
- pricing?: components["schemas"]["PricingSection"] | null;
1149
- /** @description Course-specific configuration */
1150
- course: components["schemas"]["CourseSection"];
1151
- };
1152
- /**
1153
- * ProductSection
1154
- * @description Base product fields (maps to product_tbl)
1155
- */
1156
- ProductSection: {
1174
+ chapter_order: number;
1175
+ /** Description */
1176
+ description?: string | null;
1177
+ /** Content Id */
1178
+ content_id?: number | null;
1157
1179
  /**
1158
- * Visibility
1159
- * @description public, private, hidden, unlisted
1160
- * @default public
1180
+ * Drip Days
1181
+ * @default 0
1161
1182
  */
1162
- visibility: string;
1183
+ drip_days: number;
1163
1184
  /**
1164
- * Is Digital
1165
- * @description Digital product flag
1166
- * @default true
1185
+ * Is Locked
1186
+ * @default false
1167
1187
  */
1168
- is_digital: boolean;
1188
+ is_locked: boolean;
1189
+ };
1190
+ /**
1191
+ * CourseSection
1192
+ * @description Course-specific fields (maps to courses_tbl)
1193
+ */
1194
+ CourseSection: {
1169
1195
  /**
1170
- * Company Id
1171
- * @description Multi-company support
1196
+ * Course Type
1197
+ * @description instructor_led, self_paced, hybrid
1172
1198
  */
1173
- company_id?: number | null;
1199
+ course_type: string;
1174
1200
  /**
1175
- * Status
1176
- * @description draft, published, archived, review_required, deleted
1177
- * @default draft
1201
+ * Primary Instructor Id
1202
+ * @description User ID of main instructor
1178
1203
  */
1179
- status: string;
1204
+ primary_instructor_id: number;
1180
1205
  /**
1181
- * Is Org Level
1182
- * @description Org-level vs user-created product
1183
- * @default true
1206
+ * Co Instructors
1207
+ * @description List of co-instructor user IDs
1184
1208
  */
1185
- is_org_level: boolean;
1209
+ co_instructors?: number[] | null;
1186
1210
  /**
1187
- * Staff Id
1188
- * @description Staff/instructor delivering product
1211
+ * Difficulty Level
1212
+ * @description beginner, intermediate, advanced, expert
1189
1213
  */
1190
- staff_id?: number | null;
1214
+ difficulty_level?: string | null;
1191
1215
  /**
1192
- * Owner Id
1193
- * @description Owner of the product
1216
+ * Instruction Language
1217
+ * @description English, Spanish, French, etc.
1194
1218
  */
1195
- owner_id?: number | null;
1219
+ instruction_language?: string | null;
1196
1220
  /**
1197
- * Featured
1198
- * @description Featured product flag
1199
- * @default false
1221
+ * Locale
1222
+ * @description Defaults to identity.locale if not provided
1200
1223
  */
1201
- featured: boolean;
1202
- };
1203
- ErrorResponse: {
1204
- /** @example about:blank */
1205
- type?: string;
1206
- /** @example GENERIC_ERROR */
1207
- code?: string;
1208
- /** @example Client Error */
1209
- title?: string;
1210
- /** @example 400 */
1211
- status?: number;
1212
- /** @example An error occurred */
1213
- detail?: string;
1214
- /** @example /v1/cart/items */
1215
- instance?: string;
1216
- extensions?: components["schemas"]["Extensions"];
1224
+ locale?: string | null;
1217
1225
  };
1218
1226
  /**
1219
- * MediaSection
1220
- * @description Product media files - direct media data
1227
+ * IdentitySection
1228
+ * @description Localized product content (maps to product_identity_tbl)
1221
1229
  */
1222
- MediaSection: {
1230
+ IdentitySection: {
1223
1231
  /**
1224
- * Media Items
1225
- * @description List of media files to attach to product
1232
+ * Locale
1233
+ * @description Locale: en-US, es-PR, fr-FR, pt-BR, etc.
1234
+ * @default en-US
1226
1235
  */
1227
- media_items?: components["schemas"]["MediaItem"][] | null;
1228
- };
1229
- /**
1230
- * PricingSection
1231
- * @description Pricing configuration (optional - can have product price, variant prices, or both)
1232
- */
1233
- PricingSection: {
1234
- /** @description Base product price (no variant) */
1235
- product_price?: components["schemas"]["ProductPrice"] | null;
1236
+ locale: string;
1236
1237
  /**
1237
- * Variant Prices
1238
- * @description Variant-specific prices
1238
+ * Title
1239
+ * @description Product title
1239
1240
  */
1240
- variant_prices?: components["schemas"]["VariantPrice"][] | null;
1241
- };
1242
- /** Body_validateBatchSchedule */
1243
- Body_validateBatchSchedule: {
1244
- /** Starts At */
1245
- starts_at: string;
1246
- /** Ends At */
1247
- ends_at: string;
1248
- /** Weekdays */
1249
- weekdays: string[];
1250
- /** Duration Minutes */
1251
- duration_minutes: number;
1241
+ title: string;
1252
1242
  /**
1253
- * Timezone
1254
- * @default UTC
1243
+ * Subtitle
1244
+ * @description Product subtitle
1255
1245
  */
1256
- timezone: string;
1246
+ subtitle?: string | null;
1247
+ /**
1248
+ * Description
1249
+ * @description Full product description
1250
+ */
1251
+ description?: string | null;
1252
+ /**
1253
+ * Short Description
1254
+ * @description Short description for listings/previews
1255
+ */
1256
+ short_description?: string | null;
1257
1257
  };
1258
1258
  };
1259
1259
  responses: never;