@blezgo/api-sdk 0.1.3 → 0.1.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/account/generated.d.ts +153 -153
- package/dist/account/generated.d.ts.map +1 -1
- package/dist/activity/generated.d.ts +57 -57
- package/dist/activity/generated.d.ts.map +1 -1
- package/dist/addon/generated.d.ts +104 -104
- package/dist/addon/generated.d.ts.map +1 -1
- package/dist/admin/generated.d.ts +85 -85
- package/dist/admin/generated.d.ts.map +1 -1
- package/dist/affiliate/generated.d.ts +89 -89
- package/dist/affiliate/generated.d.ts.map +1 -1
- package/dist/analytics/generated.d.ts +15 -15
- package/dist/analytics/generated.d.ts.map +1 -1
- package/dist/announcements/generated.d.ts +52 -52
- package/dist/announcements/generated.d.ts.map +1 -1
- package/dist/apikeys/generated.d.ts +43 -43
- package/dist/apikeys/generated.d.ts.map +1 -1
- package/dist/assistance/generated.d.ts +15 -15
- package/dist/assistance/generated.d.ts.map +1 -1
- package/dist/authentication/generated.d.ts +116 -116
- package/dist/authentication/generated.d.ts.map +1 -1
- package/dist/blog/generated.d.ts +168 -168
- package/dist/blog/generated.d.ts.map +1 -1
- package/dist/bundle/generated.d.ts +116 -116
- package/dist/bundle/generated.d.ts.map +1 -1
- package/dist/cache/generated.d.ts +30 -30
- package/dist/cache/generated.d.ts.map +1 -1
- package/dist/calendar/generated.d.ts +37 -37
- package/dist/calendar/generated.d.ts.map +1 -1
- package/dist/campaigns/generated.d.ts +157 -157
- package/dist/campaigns/generated.d.ts.map +1 -1
- package/dist/cart/generated.d.ts +30 -30
- package/dist/cart/generated.d.ts.map +1 -1
- package/dist/changelog/generated.d.ts +107 -107
- package/dist/changelog/generated.d.ts.map +1 -1
- package/dist/channel/generated.d.ts +231 -231
- package/dist/channel/generated.d.ts.map +1 -1
- package/dist/company/generated.d.ts +44 -44
- package/dist/company/generated.d.ts.map +1 -1
- package/dist/conference/generated.d.ts +14 -14
- package/dist/conference/generated.d.ts.map +1 -1
- package/dist/config/generated.d.ts +60 -60
- package/dist/config/generated.d.ts.map +1 -1
- package/dist/content/generated.d.ts +527 -527
- package/dist/content/generated.d.ts.map +1 -1
- package/dist/cookies/generated.d.ts +60 -60
- package/dist/cookies/generated.d.ts.map +1 -1
- package/dist/courses/generated.d.ts +348 -348
- package/dist/courses/generated.d.ts.map +1 -1
- package/dist/custom/generated.d.ts +96 -96
- package/dist/custom/generated.d.ts.map +1 -1
- package/dist/dashboard/generated.d.ts +124 -124
- package/dist/dashboard/generated.d.ts.map +1 -1
- package/dist/elasticsearch/generated.d.ts +15 -15
- package/dist/elasticsearch/generated.d.ts.map +1 -1
- package/dist/enrollments/generated.d.ts +15 -15
- package/dist/enrollments/generated.d.ts.map +1 -1
- package/dist/errors/generated.d.ts +24 -24
- package/dist/errors/generated.d.ts.map +1 -1
- package/dist/eventconfig/generated.d.ts +103 -103
- package/dist/eventconfig/generated.d.ts.map +1 -1
- package/dist/funnels/generated.d.ts +111 -111
- package/dist/funnels/generated.d.ts.map +1 -1
- package/dist/gamification/generated.d.ts +105 -105
- package/dist/gamification/generated.d.ts.map +1 -1
- package/dist/impersonation/generated.d.ts +27 -27
- package/dist/impersonation/generated.d.ts.map +1 -1
- package/dist/inbox/generated.d.ts +117 -117
- package/dist/inbox/generated.d.ts.map +1 -1
- package/dist/internal/generated.d.ts +15 -15
- package/dist/internal/generated.d.ts.map +1 -1
- package/dist/internationalization/generated.d.ts +15 -15
- package/dist/internationalization/generated.d.ts.map +1 -1
- package/dist/invitations/generated.d.ts +85 -85
- package/dist/invitations/generated.d.ts.map +1 -1
- package/dist/meetings/generated.d.ts +295 -295
- package/dist/meetings/generated.d.ts.map +1 -1
- package/dist/metas/generated.d.ts +191 -191
- package/dist/metas/generated.d.ts.map +1 -1
- package/dist/notification/generated.d.ts +261 -261
- package/dist/notification/generated.d.ts.map +1 -1
- package/dist/notifications/generated.d.ts +15 -15
- package/dist/notifications/generated.d.ts.map +1 -1
- package/dist/onboarding/generated.d.ts +116 -116
- package/dist/onboarding/generated.d.ts.map +1 -1
- package/dist/packages/generated.d.ts +21 -21
- package/dist/packages/generated.d.ts.map +1 -1
- package/dist/payments/generated.d.ts +548 -548
- package/dist/payments/generated.d.ts.map +1 -1
- package/dist/payouts/generated.d.ts +15 -15
- package/dist/payouts/generated.d.ts.map +1 -1
- package/dist/plans/generated.d.ts +349 -349
- package/dist/plans/generated.d.ts.map +1 -1
- package/dist/pricing/generated.d.ts +41 -41
- package/dist/pricing/generated.d.ts.map +1 -1
- package/dist/products/generated.d.ts +398 -398
- package/dist/products/generated.d.ts.map +1 -1
- package/dist/profile/generated.d.ts +333 -333
- package/dist/profile/generated.d.ts.map +1 -1
- package/dist/reasons/generated.d.ts +81 -81
- package/dist/reasons/generated.d.ts.map +1 -1
- package/dist/registration/generated.d.ts +178 -178
- package/dist/registration/generated.d.ts.map +1 -1
- package/dist/reviews/generated.d.ts +63 -63
- package/dist/reviews/generated.d.ts.map +1 -1
- package/dist/role/generated.d.ts +218 -218
- package/dist/role/generated.d.ts.map +1 -1
- package/dist/scheduling/generated.d.ts +96 -96
- package/dist/scheduling/generated.d.ts.map +1 -1
- package/dist/services/generated.d.ts +957 -957
- package/dist/services/generated.d.ts.map +1 -1
- package/dist/sessions/generated.d.ts +370 -370
- package/dist/sessions/generated.d.ts.map +1 -1
- package/dist/spaces/generated.d.ts +533 -533
- package/dist/spaces/generated.d.ts.map +1 -1
- package/dist/storefront/generated.d.ts +15 -15
- package/dist/storefront/generated.d.ts.map +1 -1
- package/dist/support/generated.d.ts +1426 -1426
- package/dist/support/generated.d.ts.map +1 -1
- package/dist/sync/generated.d.ts +127 -127
- package/dist/sync/generated.d.ts.map +1 -1
- package/dist/tenant/generated.d.ts +528 -528
- package/dist/tenant/generated.d.ts.map +1 -1
- package/dist/testimonials/generated.d.ts +56 -56
- package/dist/testimonials/generated.d.ts.map +1 -1
- package/dist/tests/generated.d.ts +509 -509
- package/dist/tests/generated.d.ts.map +1 -1
- package/dist/tokens/generated.d.ts +50 -50
- package/dist/tokens/generated.d.ts.map +1 -1
- package/dist/uploads/generated.d.ts +29 -29
- package/dist/uploads/generated.d.ts.map +1 -1
- package/dist/upsell/generated.d.ts +80 -80
- package/dist/upsell/generated.d.ts.map +1 -1
- package/dist/user/generated.d.ts +76 -70
- package/dist/user/generated.d.ts.map +1 -1
- package/dist/webinars/generated.d.ts +336 -336
- package/dist/webinars/generated.d.ts.map +1 -1
- package/package.json +1 -1
- package/test-commit.txt +1 -0
|
@@ -612,55 +612,155 @@ export interface components {
|
|
|
612
612
|
} | null;
|
|
613
613
|
};
|
|
614
614
|
/**
|
|
615
|
-
*
|
|
616
|
-
*
|
|
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
|
+
* }
|
|
617
629
|
*/
|
|
618
|
-
|
|
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"];
|
|
640
|
+
};
|
|
641
|
+
/**
|
|
642
|
+
* VariantItem
|
|
643
|
+
* @description Product variant (maps to product_variants_tbl)
|
|
644
|
+
*/
|
|
645
|
+
VariantItem: {
|
|
619
646
|
/**
|
|
620
|
-
*
|
|
621
|
-
* @description
|
|
622
|
-
* @default public
|
|
647
|
+
* Name
|
|
648
|
+
* @description Variant display name
|
|
623
649
|
*/
|
|
624
|
-
|
|
650
|
+
name: string;
|
|
625
651
|
/**
|
|
626
|
-
*
|
|
627
|
-
* @description
|
|
628
|
-
* @default true
|
|
652
|
+
* Sku
|
|
653
|
+
* @description Stock Keeping Unit
|
|
629
654
|
*/
|
|
630
|
-
|
|
655
|
+
sku?: string | null;
|
|
631
656
|
/**
|
|
632
|
-
*
|
|
633
|
-
* @description
|
|
657
|
+
* Attributes
|
|
658
|
+
* @description Custom attributes
|
|
634
659
|
*/
|
|
635
|
-
|
|
660
|
+
attributes?: {
|
|
661
|
+
[key: string]: unknown;
|
|
662
|
+
} | null;
|
|
636
663
|
/**
|
|
637
|
-
*
|
|
638
|
-
* @description
|
|
639
|
-
* @default
|
|
664
|
+
* Is Default
|
|
665
|
+
* @description Set as default variant
|
|
666
|
+
* @default false
|
|
640
667
|
*/
|
|
641
|
-
|
|
668
|
+
is_default: boolean;
|
|
642
669
|
/**
|
|
643
|
-
*
|
|
644
|
-
* @description
|
|
645
|
-
* @default
|
|
670
|
+
* Track Inventory
|
|
671
|
+
* @description Track stock for this variant
|
|
672
|
+
* @default false
|
|
646
673
|
*/
|
|
647
|
-
|
|
674
|
+
track_inventory: boolean;
|
|
648
675
|
/**
|
|
649
|
-
*
|
|
650
|
-
* @description
|
|
676
|
+
* Stock Quantity
|
|
677
|
+
* @description Initial stock
|
|
651
678
|
*/
|
|
652
|
-
|
|
679
|
+
stock_quantity?: number | null;
|
|
653
680
|
/**
|
|
654
|
-
*
|
|
655
|
-
* @description
|
|
681
|
+
* Allow Backorder
|
|
682
|
+
* @description Allow orders when out of stock
|
|
683
|
+
* @default false
|
|
656
684
|
*/
|
|
657
|
-
|
|
685
|
+
allow_backorder: boolean;
|
|
658
686
|
/**
|
|
659
|
-
*
|
|
660
|
-
* @description
|
|
661
|
-
* @default false
|
|
687
|
+
* Weight
|
|
688
|
+
* @description Weight in kg
|
|
662
689
|
*/
|
|
663
|
-
|
|
690
|
+
weight?: number | null;
|
|
691
|
+
/**
|
|
692
|
+
* Length
|
|
693
|
+
* @description Length in cm
|
|
694
|
+
*/
|
|
695
|
+
length?: number | null;
|
|
696
|
+
/**
|
|
697
|
+
* Width
|
|
698
|
+
* @description Width in cm
|
|
699
|
+
*/
|
|
700
|
+
width?: number | null;
|
|
701
|
+
/**
|
|
702
|
+
* Height
|
|
703
|
+
* @description Height in cm
|
|
704
|
+
*/
|
|
705
|
+
height?: number | null;
|
|
706
|
+
/**
|
|
707
|
+
* Display Order
|
|
708
|
+
* @description Display order
|
|
709
|
+
* @default 100
|
|
710
|
+
*/
|
|
711
|
+
display_order: number;
|
|
712
|
+
/**
|
|
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
|
|
728
|
+
*/
|
|
729
|
+
course_type: string;
|
|
730
|
+
/**
|
|
731
|
+
* Primary Instructor Id
|
|
732
|
+
* @description User ID of main instructor
|
|
733
|
+
*/
|
|
734
|
+
primary_instructor_id: number;
|
|
735
|
+
/**
|
|
736
|
+
* Co Instructors
|
|
737
|
+
* @description List of co-instructor user IDs
|
|
738
|
+
*/
|
|
739
|
+
co_instructors?: number[] | null;
|
|
740
|
+
/**
|
|
741
|
+
* Difficulty Level
|
|
742
|
+
* @description beginner, intermediate, advanced, expert
|
|
743
|
+
*/
|
|
744
|
+
difficulty_level?: string | null;
|
|
745
|
+
/**
|
|
746
|
+
* Instruction Language
|
|
747
|
+
* @description English, Spanish, French, etc.
|
|
748
|
+
*/
|
|
749
|
+
instruction_language?: string | null;
|
|
750
|
+
/**
|
|
751
|
+
* Locale
|
|
752
|
+
* @description Defaults to identity.locale if not provided
|
|
753
|
+
*/
|
|
754
|
+
locale?: string | null;
|
|
755
|
+
};
|
|
756
|
+
Extensions: {
|
|
757
|
+
/** @example GENERIC_ERROR */
|
|
758
|
+
message_code?: string;
|
|
759
|
+
/** @example [] */
|
|
760
|
+
invalid_params?: components["schemas"]["InvalidParam"][];
|
|
761
|
+
extra_data?: Record<string, never> | null;
|
|
762
|
+
/** @example Detailed debug information */
|
|
763
|
+
debug?: string | null;
|
|
664
764
|
};
|
|
665
765
|
/** Body_createBatchFromCSV */
|
|
666
766
|
Body_createBatchFromCSV: {
|
|
@@ -707,68 +807,6 @@ export interface components {
|
|
|
707
807
|
/** Co Instructors */
|
|
708
808
|
co_instructors?: number[] | null;
|
|
709
809
|
};
|
|
710
|
-
/** Body_createCourseCurriculumItem */
|
|
711
|
-
Body_createCourseCurriculumItem: {
|
|
712
|
-
/** Title */
|
|
713
|
-
title: string;
|
|
714
|
-
/** Content Type */
|
|
715
|
-
content_type: string;
|
|
716
|
-
/** Is Section */
|
|
717
|
-
is_section: number;
|
|
718
|
-
/** Parent Id */
|
|
719
|
-
parent_id?: number | null;
|
|
720
|
-
/**
|
|
721
|
-
* Section Order
|
|
722
|
-
* @default 0
|
|
723
|
-
*/
|
|
724
|
-
section_order: number;
|
|
725
|
-
/**
|
|
726
|
-
* Chapter Order
|
|
727
|
-
* @default 0
|
|
728
|
-
*/
|
|
729
|
-
chapter_order: number;
|
|
730
|
-
/** Description */
|
|
731
|
-
description?: string | null;
|
|
732
|
-
/** Content Id */
|
|
733
|
-
content_id?: number | null;
|
|
734
|
-
/**
|
|
735
|
-
* Drip Days
|
|
736
|
-
* @default 0
|
|
737
|
-
*/
|
|
738
|
-
drip_days: number;
|
|
739
|
-
/**
|
|
740
|
-
* Is Locked
|
|
741
|
-
* @default false
|
|
742
|
-
*/
|
|
743
|
-
is_locked: boolean;
|
|
744
|
-
};
|
|
745
|
-
/**
|
|
746
|
-
* @example {
|
|
747
|
-
* "status": "success",
|
|
748
|
-
* "message": "Operation successful",
|
|
749
|
-
* "message_code": "api_suc_20001",
|
|
750
|
-
* "data": {},
|
|
751
|
-
* "metadata": {
|
|
752
|
-
* "timestamp": "2026-03-26T10:00:00.000Z",
|
|
753
|
-
* "requestId": "07e22004-cb60-4dfc-bc9c-b6f99664dca1",
|
|
754
|
-
* "traceId": "a9f1204c-bb82-41de-b234-7c3a9e120000",
|
|
755
|
-
* "version": "v1",
|
|
756
|
-
* "executionTime": 42,
|
|
757
|
-
* "language": "en-US"
|
|
758
|
-
* }
|
|
759
|
-
* }
|
|
760
|
-
*/
|
|
761
|
-
StandardResponse: {
|
|
762
|
-
/** @example success */
|
|
763
|
-
status?: string;
|
|
764
|
-
data?: Record<string, never> | null;
|
|
765
|
-
/** @example Operation successful */
|
|
766
|
-
message?: string | null;
|
|
767
|
-
/** @example api_suc_20001 */
|
|
768
|
-
message_code?: string | null;
|
|
769
|
-
metadata?: Record<string, never> | null;
|
|
770
|
-
error?: components["schemas"]["ErrorResponse"];
|
|
771
|
-
};
|
|
772
810
|
/**
|
|
773
811
|
* ProductPrice
|
|
774
812
|
* @description Base product pricing (maps to product_pricings_tbl with variant_id=NULL)
|
|
@@ -826,38 +864,103 @@ export interface components {
|
|
|
826
864
|
*/
|
|
827
865
|
requires_payment_method_upfront: boolean;
|
|
828
866
|
};
|
|
829
|
-
/**
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
|
|
833
|
-
|
|
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;
|
|
834
877
|
/**
|
|
835
|
-
*
|
|
836
|
-
* @
|
|
878
|
+
* Section Order
|
|
879
|
+
* @default 0
|
|
837
880
|
*/
|
|
838
|
-
|
|
839
|
-
};
|
|
840
|
-
/** Body_validateBatchSchedule */
|
|
841
|
-
Body_validateBatchSchedule: {
|
|
842
|
-
/** Starts At */
|
|
843
|
-
starts_at: string;
|
|
844
|
-
/** Ends At */
|
|
845
|
-
ends_at: string;
|
|
846
|
-
/** Weekdays */
|
|
847
|
-
weekdays: string[];
|
|
848
|
-
/** Duration Minutes */
|
|
849
|
-
duration_minutes: number;
|
|
881
|
+
section_order: number;
|
|
850
882
|
/**
|
|
851
|
-
*
|
|
852
|
-
* @default
|
|
883
|
+
* Chapter Order
|
|
884
|
+
* @default 0
|
|
853
885
|
*/
|
|
854
|
-
|
|
886
|
+
chapter_order: number;
|
|
887
|
+
/** Description */
|
|
888
|
+
description?: string | null;
|
|
889
|
+
/** Content Id */
|
|
890
|
+
content_id?: number | null;
|
|
891
|
+
/**
|
|
892
|
+
* Drip Days
|
|
893
|
+
* @default 0
|
|
894
|
+
*/
|
|
895
|
+
drip_days: number;
|
|
896
|
+
/**
|
|
897
|
+
* Is Locked
|
|
898
|
+
* @default false
|
|
899
|
+
*/
|
|
900
|
+
is_locked: boolean;
|
|
855
901
|
};
|
|
856
|
-
|
|
857
|
-
|
|
858
|
-
|
|
859
|
-
|
|
860
|
-
|
|
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;
|
|
912
|
+
/**
|
|
913
|
+
* Section Order
|
|
914
|
+
* @default 0
|
|
915
|
+
*/
|
|
916
|
+
section_order: number;
|
|
917
|
+
/**
|
|
918
|
+
* Chapter Order
|
|
919
|
+
* @default 0
|
|
920
|
+
*/
|
|
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: {
|
|
938
|
+
/**
|
|
939
|
+
* Locale
|
|
940
|
+
* @description Locale: en-US, es-PR, fr-FR, pt-BR, etc.
|
|
941
|
+
* @default en-US
|
|
942
|
+
*/
|
|
943
|
+
locale: string;
|
|
944
|
+
/**
|
|
945
|
+
* Title
|
|
946
|
+
* @description Product title
|
|
947
|
+
*/
|
|
948
|
+
title: string;
|
|
949
|
+
/**
|
|
950
|
+
* Subtitle
|
|
951
|
+
* @description Product subtitle
|
|
952
|
+
*/
|
|
953
|
+
subtitle?: string | null;
|
|
954
|
+
/**
|
|
955
|
+
* Description
|
|
956
|
+
* @description Full product description
|
|
957
|
+
*/
|
|
958
|
+
description?: string | null;
|
|
959
|
+
/**
|
|
960
|
+
* Short Description
|
|
961
|
+
* @description Short description for listings/previews
|
|
962
|
+
*/
|
|
963
|
+
short_description?: string | null;
|
|
861
964
|
};
|
|
862
965
|
/**
|
|
863
966
|
* MediaItem
|
|
@@ -930,93 +1033,11 @@ export interface components {
|
|
|
930
1033
|
*/
|
|
931
1034
|
is_primary: boolean;
|
|
932
1035
|
};
|
|
933
|
-
|
|
934
|
-
|
|
935
|
-
|
|
936
|
-
|
|
937
|
-
|
|
938
|
-
* "course_type": "instructor_led",
|
|
939
|
-
* "primary_instructor_id": 456
|
|
940
|
-
* },
|
|
941
|
-
* "identity": {
|
|
942
|
-
* "locale": "en-US",
|
|
943
|
-
* "title": "Advanced Python Programming"
|
|
944
|
-
* },
|
|
945
|
-
* "pricing": {
|
|
946
|
-
* "product_price": {
|
|
947
|
-
* "amount": 5000,
|
|
948
|
-
* "currency": "INR",
|
|
949
|
-
* "price_type": "one_time"
|
|
950
|
-
* }
|
|
951
|
-
* },
|
|
952
|
-
* "product": {
|
|
953
|
-
* "is_digital": true,
|
|
954
|
-
* "status": "draft",
|
|
955
|
-
* "visibility": "public"
|
|
956
|
-
* }
|
|
957
|
-
* }
|
|
958
|
-
*/
|
|
959
|
-
CourseCreateRequest: {
|
|
960
|
-
/** @description Base product configuration */
|
|
961
|
-
product: components["schemas"]["ProductSection"];
|
|
962
|
-
/** @description Localized content (title, description) */
|
|
963
|
-
identity: components["schemas"]["IdentitySection"];
|
|
964
|
-
/** @description Pre-uploaded image IDs */
|
|
965
|
-
media?: components["schemas"]["MediaSection"] | null;
|
|
966
|
-
/**
|
|
967
|
-
* Tags
|
|
968
|
-
* @description Tag IDs to associate with product
|
|
969
|
-
*/
|
|
970
|
-
tags?: number[] | null;
|
|
971
|
-
/**
|
|
972
|
-
* Variants
|
|
973
|
-
* @description Product variants (optional)
|
|
974
|
-
*/
|
|
975
|
-
variants?: components["schemas"]["VariantItem"][] | null;
|
|
976
|
-
/** @description Pricing for product and variants */
|
|
977
|
-
pricing?: components["schemas"]["PricingSection"] | null;
|
|
978
|
-
/** @description Course-specific configuration */
|
|
979
|
-
course: components["schemas"]["CourseSection"];
|
|
980
|
-
};
|
|
981
|
-
/** Body_createBatchCurriculumItem */
|
|
982
|
-
Body_createBatchCurriculumItem: {
|
|
983
|
-
/** Title */
|
|
984
|
-
title: string;
|
|
985
|
-
/** Content Type */
|
|
986
|
-
content_type: string;
|
|
987
|
-
/** Is Section */
|
|
988
|
-
is_section: number;
|
|
989
|
-
/** Parent Id */
|
|
990
|
-
parent_id?: number | null;
|
|
991
|
-
/**
|
|
992
|
-
* Section Order
|
|
993
|
-
* @default 0
|
|
994
|
-
*/
|
|
995
|
-
section_order: number;
|
|
996
|
-
/**
|
|
997
|
-
* Chapter Order
|
|
998
|
-
* @default 0
|
|
999
|
-
*/
|
|
1000
|
-
chapter_order: number;
|
|
1001
|
-
/** Description */
|
|
1002
|
-
description?: string | null;
|
|
1003
|
-
/** Content Id */
|
|
1004
|
-
content_id?: number | null;
|
|
1005
|
-
/** Instructor Id */
|
|
1006
|
-
instructor_id?: number | null;
|
|
1007
|
-
/** Scheduled At */
|
|
1008
|
-
scheduled_at?: string | null;
|
|
1009
|
-
/** Duration Minutes */
|
|
1010
|
-
duration_minutes?: number | null;
|
|
1011
|
-
};
|
|
1012
|
-
Extensions: {
|
|
1013
|
-
/** @example GENERIC_ERROR */
|
|
1014
|
-
message_code?: string;
|
|
1015
|
-
/** @example [] */
|
|
1016
|
-
invalid_params?: components["schemas"]["InvalidParam"][];
|
|
1017
|
-
extra_data?: Record<string, never> | null;
|
|
1018
|
-
/** @example Detailed debug information */
|
|
1019
|
-
debug?: string | null;
|
|
1036
|
+
InvalidParam: {
|
|
1037
|
+
/** @example items[0].quantity */
|
|
1038
|
+
field?: string;
|
|
1039
|
+
/** @example Input should be greater than or equal to 1 */
|
|
1040
|
+
error?: string;
|
|
1020
1041
|
};
|
|
1021
1042
|
/**
|
|
1022
1043
|
* VariantPrice
|
|
@@ -1080,180 +1101,159 @@ export interface components {
|
|
|
1080
1101
|
*/
|
|
1081
1102
|
requires_payment_method_upfront: boolean;
|
|
1082
1103
|
};
|
|
1083
|
-
ErrorResponse: {
|
|
1084
|
-
/** @example about:blank */
|
|
1085
|
-
type?: string;
|
|
1086
|
-
/** @example GENERIC_ERROR */
|
|
1087
|
-
code?: string;
|
|
1088
|
-
/** @example Client Error */
|
|
1089
|
-
title?: string;
|
|
1090
|
-
/** @example 400 */
|
|
1091
|
-
status?: number;
|
|
1092
|
-
/** @example An error occurred */
|
|
1093
|
-
detail?: string;
|
|
1094
|
-
/** @example /v1/cart/items */
|
|
1095
|
-
instance?: string;
|
|
1096
|
-
extensions?: components["schemas"]["Extensions"];
|
|
1097
|
-
};
|
|
1098
1104
|
/**
|
|
1099
|
-
*
|
|
1100
|
-
* @description
|
|
1101
|
-
|
|
1102
|
-
|
|
1103
|
-
|
|
1104
|
-
|
|
1105
|
-
|
|
1106
|
-
|
|
1107
|
-
|
|
1108
|
-
|
|
1109
|
-
|
|
1110
|
-
|
|
1111
|
-
|
|
1112
|
-
*
|
|
1113
|
-
*
|
|
1105
|
+
* CourseCreateRequest
|
|
1106
|
+
* @description Course creation request - inherits common fields, adds course-specific section
|
|
1107
|
+
* @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"
|
|
1127
|
+
* }
|
|
1128
|
+
* }
|
|
1114
1129
|
*/
|
|
1115
|
-
|
|
1116
|
-
/**
|
|
1117
|
-
|
|
1118
|
-
|
|
1119
|
-
|
|
1120
|
-
|
|
1121
|
-
|
|
1122
|
-
/**
|
|
1123
|
-
* Title
|
|
1124
|
-
* @description Product title
|
|
1125
|
-
*/
|
|
1126
|
-
title: string;
|
|
1127
|
-
/**
|
|
1128
|
-
* Subtitle
|
|
1129
|
-
* @description Product subtitle
|
|
1130
|
-
*/
|
|
1131
|
-
subtitle?: string | null;
|
|
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;
|
|
1132
1137
|
/**
|
|
1133
|
-
*
|
|
1134
|
-
* @description
|
|
1138
|
+
* Tags
|
|
1139
|
+
* @description Tag IDs to associate with product
|
|
1135
1140
|
*/
|
|
1136
|
-
|
|
1141
|
+
tags?: number[] | null;
|
|
1137
1142
|
/**
|
|
1138
|
-
*
|
|
1139
|
-
* @description
|
|
1143
|
+
* Variants
|
|
1144
|
+
* @description Product variants (optional)
|
|
1140
1145
|
*/
|
|
1141
|
-
|
|
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"];
|
|
1142
1151
|
};
|
|
1143
1152
|
/**
|
|
1144
|
-
*
|
|
1145
|
-
* @description
|
|
1153
|
+
* ProductSection
|
|
1154
|
+
* @description Base product fields (maps to product_tbl)
|
|
1146
1155
|
*/
|
|
1147
|
-
|
|
1148
|
-
/**
|
|
1149
|
-
* Name
|
|
1150
|
-
* @description Variant display name
|
|
1151
|
-
*/
|
|
1152
|
-
name: string;
|
|
1153
|
-
/**
|
|
1154
|
-
* Sku
|
|
1155
|
-
* @description Stock Keeping Unit
|
|
1156
|
-
*/
|
|
1157
|
-
sku?: string | null;
|
|
1158
|
-
/**
|
|
1159
|
-
* Attributes
|
|
1160
|
-
* @description Custom attributes
|
|
1161
|
-
*/
|
|
1162
|
-
attributes?: {
|
|
1163
|
-
[key: string]: unknown;
|
|
1164
|
-
} | null;
|
|
1165
|
-
/**
|
|
1166
|
-
* Is Default
|
|
1167
|
-
* @description Set as default variant
|
|
1168
|
-
* @default false
|
|
1169
|
-
*/
|
|
1170
|
-
is_default: boolean;
|
|
1171
|
-
/**
|
|
1172
|
-
* Track Inventory
|
|
1173
|
-
* @description Track stock for this variant
|
|
1174
|
-
* @default false
|
|
1175
|
-
*/
|
|
1176
|
-
track_inventory: boolean;
|
|
1156
|
+
ProductSection: {
|
|
1177
1157
|
/**
|
|
1178
|
-
*
|
|
1179
|
-
* @description
|
|
1158
|
+
* Visibility
|
|
1159
|
+
* @description public, private, hidden, unlisted
|
|
1160
|
+
* @default public
|
|
1180
1161
|
*/
|
|
1181
|
-
|
|
1162
|
+
visibility: string;
|
|
1182
1163
|
/**
|
|
1183
|
-
*
|
|
1184
|
-
* @description
|
|
1185
|
-
* @default
|
|
1164
|
+
* Is Digital
|
|
1165
|
+
* @description Digital product flag
|
|
1166
|
+
* @default true
|
|
1186
1167
|
*/
|
|
1187
|
-
|
|
1168
|
+
is_digital: boolean;
|
|
1188
1169
|
/**
|
|
1189
|
-
*
|
|
1190
|
-
* @description
|
|
1170
|
+
* Company Id
|
|
1171
|
+
* @description Multi-company support
|
|
1191
1172
|
*/
|
|
1192
|
-
|
|
1173
|
+
company_id?: number | null;
|
|
1193
1174
|
/**
|
|
1194
|
-
*
|
|
1195
|
-
* @description
|
|
1175
|
+
* Status
|
|
1176
|
+
* @description draft, published, archived, review_required, deleted
|
|
1177
|
+
* @default draft
|
|
1196
1178
|
*/
|
|
1197
|
-
|
|
1179
|
+
status: string;
|
|
1198
1180
|
/**
|
|
1199
|
-
*
|
|
1200
|
-
* @description
|
|
1181
|
+
* Is Org Level
|
|
1182
|
+
* @description Org-level vs user-created product
|
|
1183
|
+
* @default true
|
|
1201
1184
|
*/
|
|
1202
|
-
|
|
1185
|
+
is_org_level: boolean;
|
|
1203
1186
|
/**
|
|
1204
|
-
*
|
|
1205
|
-
* @description
|
|
1187
|
+
* Staff Id
|
|
1188
|
+
* @description Staff/instructor delivering product
|
|
1206
1189
|
*/
|
|
1207
|
-
|
|
1190
|
+
staff_id?: number | null;
|
|
1208
1191
|
/**
|
|
1209
|
-
*
|
|
1210
|
-
* @description
|
|
1211
|
-
* @default 100
|
|
1192
|
+
* Owner Id
|
|
1193
|
+
* @description Owner of the product
|
|
1212
1194
|
*/
|
|
1213
|
-
|
|
1195
|
+
owner_id?: number | null;
|
|
1214
1196
|
/**
|
|
1215
|
-
*
|
|
1216
|
-
* @description
|
|
1197
|
+
* Featured
|
|
1198
|
+
* @description Featured product flag
|
|
1199
|
+
* @default false
|
|
1217
1200
|
*/
|
|
1218
|
-
|
|
1219
|
-
|
|
1220
|
-
|
|
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"];
|
|
1221
1217
|
};
|
|
1222
1218
|
/**
|
|
1223
|
-
*
|
|
1224
|
-
* @description
|
|
1219
|
+
* MediaSection
|
|
1220
|
+
* @description Product media files - direct media data
|
|
1225
1221
|
*/
|
|
1226
|
-
|
|
1227
|
-
/**
|
|
1228
|
-
* Course Type
|
|
1229
|
-
* @description instructor_led, self_paced, hybrid
|
|
1230
|
-
*/
|
|
1231
|
-
course_type: string;
|
|
1232
|
-
/**
|
|
1233
|
-
* Primary Instructor Id
|
|
1234
|
-
* @description User ID of main instructor
|
|
1235
|
-
*/
|
|
1236
|
-
primary_instructor_id: number;
|
|
1237
|
-
/**
|
|
1238
|
-
* Co Instructors
|
|
1239
|
-
* @description List of co-instructor user IDs
|
|
1240
|
-
*/
|
|
1241
|
-
co_instructors?: number[] | null;
|
|
1222
|
+
MediaSection: {
|
|
1242
1223
|
/**
|
|
1243
|
-
*
|
|
1244
|
-
* @description
|
|
1224
|
+
* Media Items
|
|
1225
|
+
* @description List of media files to attach to product
|
|
1245
1226
|
*/
|
|
1246
|
-
|
|
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;
|
|
1247
1236
|
/**
|
|
1248
|
-
*
|
|
1249
|
-
* @description
|
|
1237
|
+
* Variant Prices
|
|
1238
|
+
* @description Variant-specific prices
|
|
1250
1239
|
*/
|
|
1251
|
-
|
|
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;
|
|
1252
1252
|
/**
|
|
1253
|
-
*
|
|
1254
|
-
* @
|
|
1253
|
+
* Timezone
|
|
1254
|
+
* @default UTC
|
|
1255
1255
|
*/
|
|
1256
|
-
|
|
1256
|
+
timezone: string;
|
|
1257
1257
|
};
|
|
1258
1258
|
};
|
|
1259
1259
|
responses: never;
|