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