@blezgo/api-sdk 0.1.3 → 0.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/account/generated.d.ts +180 -180
- package/dist/account/generated.d.ts.map +1 -1
- package/dist/activity/generated.d.ts +60 -60
- package/dist/activity/generated.d.ts.map +1 -1
- package/dist/addon/generated.d.ts +83 -83
- package/dist/addon/generated.d.ts.map +1 -1
- package/dist/admin/generated.d.ts +126 -126
- package/dist/admin/generated.d.ts.map +1 -1
- package/dist/affiliate/generated.d.ts +83 -83
- package/dist/affiliate/generated.d.ts.map +1 -1
- package/dist/analytics/generated.d.ts +30 -30
- package/dist/analytics/generated.d.ts.map +1 -1
- package/dist/announcements/generated.d.ts +64 -64
- package/dist/announcements/generated.d.ts.map +1 -1
- package/dist/apikeys/generated.d.ts +79 -79
- package/dist/apikeys/generated.d.ts.map +1 -1
- package/dist/assistance/generated.d.ts +30 -30
- package/dist/assistance/generated.d.ts.map +1 -1
- package/dist/authentication/generated.d.ts +83 -83
- package/dist/authentication/generated.d.ts.map +1 -1
- package/dist/blog/generated.d.ts +204 -204
- package/dist/blog/generated.d.ts.map +1 -1
- package/dist/bundle/generated.d.ts +147 -147
- package/dist/bundle/generated.d.ts.map +1 -1
- package/dist/cache/generated.d.ts +33 -33
- package/dist/cache/generated.d.ts.map +1 -1
- package/dist/calendar/generated.d.ts +80 -80
- package/dist/calendar/generated.d.ts.map +1 -1
- package/dist/campaigns/generated.d.ts +198 -198
- package/dist/campaigns/generated.d.ts.map +1 -1
- package/dist/cart/generated.d.ts +40 -40
- package/dist/cart/generated.d.ts.map +1 -1
- package/dist/changelog/generated.d.ts +95 -95
- package/dist/changelog/generated.d.ts.map +1 -1
- package/dist/channel/generated.d.ts +251 -251
- package/dist/channel/generated.d.ts.map +1 -1
- package/dist/company/generated.d.ts +69 -69
- package/dist/company/generated.d.ts.map +1 -1
- package/dist/conference/generated.d.ts +166 -166
- package/dist/conference/generated.d.ts.map +1 -1
- package/dist/config/generated.d.ts +54 -54
- package/dist/config/generated.d.ts.map +1 -1
- package/dist/content/generated.d.ts +477 -477
- package/dist/content/generated.d.ts.map +1 -1
- package/dist/cookies/generated.d.ts +77 -77
- package/dist/cookies/generated.d.ts.map +1 -1
- package/dist/courses/generated.d.ts +397 -397
- package/dist/courses/generated.d.ts.map +1 -1
- package/dist/custom/generated.d.ts +99 -99
- package/dist/custom/generated.d.ts.map +1 -1
- package/dist/dashboard/generated.d.ts +177 -177
- package/dist/dashboard/generated.d.ts.map +1 -1
- package/dist/elasticsearch/generated.d.ts +30 -30
- package/dist/elasticsearch/generated.d.ts.map +1 -1
- package/dist/enrollments/generated.d.ts +30 -30
- package/dist/enrollments/generated.d.ts.map +1 -1
- package/dist/errors/generated.d.ts +30 -30
- package/dist/errors/generated.d.ts.map +1 -1
- package/dist/eventconfig/generated.d.ts +94 -94
- package/dist/eventconfig/generated.d.ts.map +1 -1
- package/dist/funnels/generated.d.ts +146 -146
- package/dist/funnels/generated.d.ts.map +1 -1
- package/dist/gamification/generated.d.ts +154 -154
- package/dist/gamification/generated.d.ts.map +1 -1
- package/dist/impersonation/generated.d.ts +71 -71
- package/dist/impersonation/generated.d.ts.map +1 -1
- package/dist/inbox/generated.d.ts +140 -140
- package/dist/inbox/generated.d.ts.map +1 -1
- package/dist/internal/generated.d.ts +30 -30
- package/dist/internal/generated.d.ts.map +1 -1
- package/dist/internationalization/generated.d.ts +30 -30
- package/dist/internationalization/generated.d.ts.map +1 -1
- package/dist/invitations/generated.d.ts +123 -123
- package/dist/invitations/generated.d.ts.map +1 -1
- package/dist/meetings/generated.d.ts +337 -337
- package/dist/meetings/generated.d.ts.map +1 -1
- package/dist/metas/generated.d.ts +170 -170
- package/dist/metas/generated.d.ts.map +1 -1
- package/dist/notification/generated.d.ts +382 -382
- package/dist/notification/generated.d.ts.map +1 -1
- package/dist/notifications/generated.d.ts +30 -30
- package/dist/notifications/generated.d.ts.map +1 -1
- package/dist/onboarding/generated.d.ts +106 -106
- package/dist/onboarding/generated.d.ts.map +1 -1
- package/dist/packages/generated.d.ts +83 -83
- package/dist/packages/generated.d.ts.map +1 -1
- package/dist/payments/generated.d.ts +502 -502
- package/dist/payments/generated.d.ts.map +1 -1
- package/dist/payouts/generated.d.ts +30 -30
- package/dist/payouts/generated.d.ts.map +1 -1
- package/dist/plans/generated.d.ts +470 -470
- package/dist/plans/generated.d.ts.map +1 -1
- package/dist/pricing/generated.d.ts +87 -87
- package/dist/pricing/generated.d.ts.map +1 -1
- package/dist/products/generated.d.ts +552 -552
- package/dist/products/generated.d.ts.map +1 -1
- package/dist/profile/generated.d.ts +272 -272
- package/dist/profile/generated.d.ts.map +1 -1
- package/dist/reasons/generated.d.ts +78 -78
- package/dist/reasons/generated.d.ts.map +1 -1
- package/dist/registration/generated.d.ts +145 -145
- package/dist/registration/generated.d.ts.map +1 -1
- package/dist/reviews/generated.d.ts +47 -47
- package/dist/reviews/generated.d.ts.map +1 -1
- package/dist/role/generated.d.ts +217 -217
- package/dist/role/generated.d.ts.map +1 -1
- package/dist/scheduling/generated.d.ts +139 -139
- package/dist/scheduling/generated.d.ts.map +1 -1
- package/dist/services/generated.d.ts +989 -989
- package/dist/services/generated.d.ts.map +1 -1
- package/dist/sessions/generated.d.ts +334 -334
- package/dist/sessions/generated.d.ts.map +1 -1
- package/dist/spaces/generated.d.ts +390 -390
- package/dist/spaces/generated.d.ts.map +1 -1
- package/dist/storefront/generated.d.ts +30 -30
- package/dist/storefront/generated.d.ts.map +1 -1
- package/dist/support/generated.d.ts +1465 -1465
- package/dist/support/generated.d.ts.map +1 -1
- package/dist/sync/generated.d.ts +157 -157
- package/dist/sync/generated.d.ts.map +1 -1
- package/dist/tenant/generated.d.ts +562 -562
- package/dist/tenant/generated.d.ts.map +1 -1
- package/dist/testimonials/generated.d.ts +67 -67
- package/dist/testimonials/generated.d.ts.map +1 -1
- package/dist/tests/generated.d.ts +619 -619
- package/dist/tests/generated.d.ts.map +1 -1
- package/dist/tokens/generated.d.ts +59 -59
- package/dist/tokens/generated.d.ts.map +1 -1
- package/dist/uploads/generated.d.ts +65 -65
- package/dist/uploads/generated.d.ts.map +1 -1
- package/dist/upsell/generated.d.ts +130 -130
- package/dist/upsell/generated.d.ts.map +1 -1
- package/dist/user/generated.d.ts +123 -117
- package/dist/user/generated.d.ts.map +1 -1
- package/dist/webinars/generated.d.ts +298 -298
- package/dist/webinars/generated.d.ts.map +1 -1
- package/package.json +1 -1
- package/test-commit.txt +1 -0
|
@@ -571,176 +571,106 @@ 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: {
|
|
576
|
-
/** Batch Name */
|
|
577
|
-
batch_name: string;
|
|
578
|
-
/** Instructor Id */
|
|
579
|
-
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[];
|
|
590
|
-
/**
|
|
591
|
-
* Max Students
|
|
592
|
-
* @default 25
|
|
593
|
-
*/
|
|
594
|
-
max_students: number;
|
|
595
|
-
/** Batch Code */
|
|
596
|
-
batch_code?: string | null;
|
|
597
|
-
/**
|
|
598
|
-
* Is Private
|
|
599
|
-
* @default false
|
|
600
|
-
*/
|
|
601
|
-
is_private: boolean;
|
|
602
|
-
/**
|
|
603
|
-
* Timezone
|
|
604
|
-
* @default UTC
|
|
605
|
-
*/
|
|
606
|
-
timezone: string;
|
|
607
|
-
/** Meeting Platform */
|
|
608
|
-
meeting_platform?: string | null;
|
|
609
|
-
/** Meeting Credentials */
|
|
610
|
-
meeting_credentials?: {
|
|
611
|
-
[key: string]: unknown;
|
|
612
|
-
} | null;
|
|
613
|
-
};
|
|
614
574
|
/**
|
|
615
|
-
*
|
|
616
|
-
* @description
|
|
575
|
+
* VariantItem
|
|
576
|
+
* @description Product variant (maps to product_variants_tbl)
|
|
617
577
|
*/
|
|
618
|
-
|
|
619
|
-
/**
|
|
620
|
-
* Visibility
|
|
621
|
-
* @description public, private, hidden, unlisted
|
|
622
|
-
* @default public
|
|
623
|
-
*/
|
|
624
|
-
visibility: string;
|
|
578
|
+
VariantItem: {
|
|
625
579
|
/**
|
|
626
|
-
*
|
|
627
|
-
* @description
|
|
628
|
-
* @default true
|
|
580
|
+
* Name
|
|
581
|
+
* @description Variant display name
|
|
629
582
|
*/
|
|
630
|
-
|
|
583
|
+
name: string;
|
|
631
584
|
/**
|
|
632
|
-
*
|
|
633
|
-
* @description
|
|
585
|
+
* Sku
|
|
586
|
+
* @description Stock Keeping Unit
|
|
634
587
|
*/
|
|
635
|
-
|
|
588
|
+
sku?: string | null;
|
|
636
589
|
/**
|
|
637
|
-
*
|
|
638
|
-
* @description
|
|
639
|
-
* @default draft
|
|
590
|
+
* Attributes
|
|
591
|
+
* @description Custom attributes
|
|
640
592
|
*/
|
|
641
|
-
|
|
593
|
+
attributes?: {
|
|
594
|
+
[key: string]: unknown;
|
|
595
|
+
} | null;
|
|
642
596
|
/**
|
|
643
|
-
* Is
|
|
644
|
-
* @description
|
|
645
|
-
* @default
|
|
597
|
+
* Is Default
|
|
598
|
+
* @description Set as default variant
|
|
599
|
+
* @default false
|
|
646
600
|
*/
|
|
647
|
-
|
|
601
|
+
is_default: boolean;
|
|
648
602
|
/**
|
|
649
|
-
*
|
|
650
|
-
* @description
|
|
603
|
+
* Track Inventory
|
|
604
|
+
* @description Track stock for this variant
|
|
605
|
+
* @default false
|
|
651
606
|
*/
|
|
652
|
-
|
|
607
|
+
track_inventory: boolean;
|
|
653
608
|
/**
|
|
654
|
-
*
|
|
655
|
-
* @description
|
|
609
|
+
* Stock Quantity
|
|
610
|
+
* @description Initial stock
|
|
656
611
|
*/
|
|
657
|
-
|
|
612
|
+
stock_quantity?: number | null;
|
|
658
613
|
/**
|
|
659
|
-
*
|
|
660
|
-
* @description
|
|
614
|
+
* Allow Backorder
|
|
615
|
+
* @description Allow orders when out of stock
|
|
661
616
|
* @default false
|
|
662
617
|
*/
|
|
663
|
-
|
|
664
|
-
};
|
|
665
|
-
/** Body_createBatchFromCSV */
|
|
666
|
-
Body_createBatchFromCSV: {
|
|
618
|
+
allow_backorder: boolean;
|
|
667
619
|
/**
|
|
668
|
-
*
|
|
669
|
-
*
|
|
620
|
+
* Weight
|
|
621
|
+
* @description Weight in kg
|
|
670
622
|
*/
|
|
671
|
-
|
|
672
|
-
/** Batch Name */
|
|
673
|
-
batch_name: string;
|
|
674
|
-
/** Instructor Id */
|
|
675
|
-
instructor_id: number;
|
|
676
|
-
/** Timezone */
|
|
677
|
-
timezone: string;
|
|
623
|
+
weight?: number | null;
|
|
678
624
|
/**
|
|
679
|
-
*
|
|
680
|
-
* @
|
|
625
|
+
* Length
|
|
626
|
+
* @description Length in cm
|
|
681
627
|
*/
|
|
682
|
-
|
|
683
|
-
/** Batch Code */
|
|
684
|
-
batch_code?: string | null;
|
|
628
|
+
length?: number | null;
|
|
685
629
|
/**
|
|
686
|
-
*
|
|
687
|
-
* @
|
|
630
|
+
* Width
|
|
631
|
+
* @description Width in cm
|
|
688
632
|
*/
|
|
689
|
-
|
|
690
|
-
/** Meeting Platform */
|
|
691
|
-
meeting_platform?: string | null;
|
|
692
|
-
};
|
|
693
|
-
/** Body_updateCourse */
|
|
694
|
-
Body_updateCourse: {
|
|
695
|
-
/** Title */
|
|
696
|
-
title?: string | null;
|
|
697
|
-
/** Description */
|
|
698
|
-
description?: string | null;
|
|
699
|
-
/** Learning Outcomes */
|
|
700
|
-
learning_outcomes?: string | null;
|
|
701
|
-
/** Prerequisites */
|
|
702
|
-
prerequisites?: string | null;
|
|
703
|
-
/** Target Audience */
|
|
704
|
-
target_audience?: string | null;
|
|
705
|
-
/** Difficulty Level */
|
|
706
|
-
difficulty_level?: string | null;
|
|
707
|
-
/** Co Instructors */
|
|
708
|
-
co_instructors?: number[] | null;
|
|
709
|
-
};
|
|
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;
|
|
633
|
+
width?: number | null;
|
|
720
634
|
/**
|
|
721
|
-
*
|
|
722
|
-
* @
|
|
635
|
+
* Height
|
|
636
|
+
* @description Height in cm
|
|
723
637
|
*/
|
|
724
|
-
|
|
638
|
+
height?: number | null;
|
|
725
639
|
/**
|
|
726
|
-
*
|
|
727
|
-
* @
|
|
640
|
+
* Display Order
|
|
641
|
+
* @description Display order
|
|
642
|
+
* @default 100
|
|
728
643
|
*/
|
|
729
|
-
|
|
730
|
-
/** Description */
|
|
731
|
-
description?: string | null;
|
|
732
|
-
/** Content Id */
|
|
733
|
-
content_id?: number | null;
|
|
644
|
+
display_order: number;
|
|
734
645
|
/**
|
|
735
|
-
*
|
|
736
|
-
* @
|
|
646
|
+
* Metadata
|
|
647
|
+
* @description Flexible metadata
|
|
737
648
|
*/
|
|
738
|
-
|
|
649
|
+
metadata?: {
|
|
650
|
+
[key: string]: unknown;
|
|
651
|
+
} | null;
|
|
652
|
+
};
|
|
653
|
+
/** Body_validateBatchSchedule */
|
|
654
|
+
Body_validateBatchSchedule: {
|
|
655
|
+
/** Starts At */
|
|
656
|
+
starts_at: string;
|
|
657
|
+
/** Ends At */
|
|
658
|
+
ends_at: string;
|
|
659
|
+
/** Weekdays */
|
|
660
|
+
weekdays: string[];
|
|
661
|
+
/** Duration Minutes */
|
|
662
|
+
duration_minutes: number;
|
|
739
663
|
/**
|
|
740
|
-
*
|
|
741
|
-
* @default
|
|
664
|
+
* Timezone
|
|
665
|
+
* @default UTC
|
|
742
666
|
*/
|
|
743
|
-
|
|
667
|
+
timezone: string;
|
|
668
|
+
};
|
|
669
|
+
InvalidParam: {
|
|
670
|
+
/** @example items[0].quantity */
|
|
671
|
+
field?: string;
|
|
672
|
+
/** @example Input should be greater than or equal to 1 */
|
|
673
|
+
error?: string;
|
|
744
674
|
};
|
|
745
675
|
/**
|
|
746
676
|
* @example {
|
|
@@ -769,95 +699,36 @@ export interface components {
|
|
|
769
699
|
metadata?: Record<string, never> | null;
|
|
770
700
|
error?: components["schemas"]["ErrorResponse"];
|
|
771
701
|
};
|
|
772
|
-
/**
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
|
|
777
|
-
|
|
778
|
-
|
|
779
|
-
|
|
780
|
-
|
|
781
|
-
|
|
782
|
-
/**
|
|
783
|
-
* Currency
|
|
784
|
-
* @description Currency code: INR, USD, EUR, etc.
|
|
785
|
-
*/
|
|
786
|
-
currency: string;
|
|
787
|
-
/**
|
|
788
|
-
* Amount
|
|
789
|
-
* @description Price amount
|
|
790
|
-
*/
|
|
791
|
-
amount: number;
|
|
792
|
-
/**
|
|
793
|
-
* Compare At Amount
|
|
794
|
-
* @description Original/strike-through price
|
|
795
|
-
*/
|
|
796
|
-
compare_at_amount?: number | null;
|
|
797
|
-
/**
|
|
798
|
-
* Interval
|
|
799
|
-
* @description day, week, month, year (for subscription)
|
|
800
|
-
*/
|
|
801
|
-
interval?: string | null;
|
|
802
|
-
/**
|
|
803
|
-
* Interval Count
|
|
804
|
-
* @description Number of intervals
|
|
805
|
-
*/
|
|
806
|
-
interval_count?: number | null;
|
|
807
|
-
/**
|
|
808
|
-
* Trial Period Days
|
|
809
|
-
* @description Free trial days
|
|
810
|
-
*/
|
|
811
|
-
trial_period_days?: number | null;
|
|
812
|
-
/**
|
|
813
|
-
* Initial Amount
|
|
814
|
-
* @description First payment amount
|
|
815
|
-
*/
|
|
816
|
-
initial_amount?: number | null;
|
|
817
|
-
/**
|
|
818
|
-
* Gateway
|
|
819
|
-
* @description stripe, razorpay, paypal, etc.
|
|
820
|
-
*/
|
|
821
|
-
gateway?: string | null;
|
|
822
|
-
/**
|
|
823
|
-
* Requires Payment Method Upfront
|
|
824
|
-
* @description Require payment method before trial
|
|
825
|
-
* @default true
|
|
826
|
-
*/
|
|
827
|
-
requires_payment_method_upfront: boolean;
|
|
828
|
-
};
|
|
829
|
-
/**
|
|
830
|
-
* MediaSection
|
|
831
|
-
* @description Product media files - direct media data
|
|
832
|
-
*/
|
|
833
|
-
MediaSection: {
|
|
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;
|
|
834
712
|
/**
|
|
835
|
-
*
|
|
836
|
-
* @
|
|
713
|
+
* Section Order
|
|
714
|
+
* @default 0
|
|
837
715
|
*/
|
|
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;
|
|
716
|
+
section_order: number;
|
|
850
717
|
/**
|
|
851
|
-
*
|
|
852
|
-
* @default
|
|
718
|
+
* Chapter Order
|
|
719
|
+
* @default 0
|
|
853
720
|
*/
|
|
854
|
-
|
|
855
|
-
|
|
856
|
-
|
|
857
|
-
/**
|
|
858
|
-
|
|
859
|
-
/**
|
|
860
|
-
|
|
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;
|
|
861
732
|
};
|
|
862
733
|
/**
|
|
863
734
|
* MediaItem
|
|
@@ -930,6 +801,162 @@ export interface components {
|
|
|
930
801
|
*/
|
|
931
802
|
is_primary: boolean;
|
|
932
803
|
};
|
|
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;
|
|
839
|
+
};
|
|
840
|
+
/**
|
|
841
|
+
* MediaSection
|
|
842
|
+
* @description Product media files - direct media data
|
|
843
|
+
*/
|
|
844
|
+
MediaSection: {
|
|
845
|
+
/**
|
|
846
|
+
* Media Items
|
|
847
|
+
* @description List of media files to attach to product
|
|
848
|
+
*/
|
|
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: {
|
|
862
|
+
/**
|
|
863
|
+
* Csv File
|
|
864
|
+
* Format: binary
|
|
865
|
+
*/
|
|
866
|
+
csv_file: string;
|
|
867
|
+
/** Batch Name */
|
|
868
|
+
batch_name: string;
|
|
869
|
+
/** Instructor Id */
|
|
870
|
+
instructor_id: number;
|
|
871
|
+
/** Timezone */
|
|
872
|
+
timezone: string;
|
|
873
|
+
/**
|
|
874
|
+
* Max Students
|
|
875
|
+
* @default 25
|
|
876
|
+
*/
|
|
877
|
+
max_students: number;
|
|
878
|
+
/** Batch Code */
|
|
879
|
+
batch_code?: string | null;
|
|
880
|
+
/**
|
|
881
|
+
* Is Private
|
|
882
|
+
* @default false
|
|
883
|
+
*/
|
|
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: {
|
|
893
|
+
/**
|
|
894
|
+
* Locale
|
|
895
|
+
* @description Locale: en-US, es-PR, fr-FR, pt-BR, etc.
|
|
896
|
+
* @default en-US
|
|
897
|
+
*/
|
|
898
|
+
locale: string;
|
|
899
|
+
/**
|
|
900
|
+
* Title
|
|
901
|
+
* @description Product title
|
|
902
|
+
*/
|
|
903
|
+
title: string;
|
|
904
|
+
/**
|
|
905
|
+
* Subtitle
|
|
906
|
+
* @description Product subtitle
|
|
907
|
+
*/
|
|
908
|
+
subtitle?: string | null;
|
|
909
|
+
/**
|
|
910
|
+
* Description
|
|
911
|
+
* @description Full product description
|
|
912
|
+
*/
|
|
913
|
+
description?: string | null;
|
|
914
|
+
/**
|
|
915
|
+
* Short Description
|
|
916
|
+
* @description Short description for listings/previews
|
|
917
|
+
*/
|
|
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[];
|
|
936
|
+
/**
|
|
937
|
+
* Max Students
|
|
938
|
+
* @default 25
|
|
939
|
+
*/
|
|
940
|
+
max_students: number;
|
|
941
|
+
/** Batch Code */
|
|
942
|
+
batch_code?: string | null;
|
|
943
|
+
/**
|
|
944
|
+
* Is Private
|
|
945
|
+
* @default false
|
|
946
|
+
*/
|
|
947
|
+
is_private: boolean;
|
|
948
|
+
/**
|
|
949
|
+
* Timezone
|
|
950
|
+
* @default UTC
|
|
951
|
+
*/
|
|
952
|
+
timezone: string;
|
|
953
|
+
/** Meeting Platform */
|
|
954
|
+
meeting_platform?: string | null;
|
|
955
|
+
/** Meeting Credentials */
|
|
956
|
+
meeting_credentials?: {
|
|
957
|
+
[key: string]: unknown;
|
|
958
|
+
} | null;
|
|
959
|
+
};
|
|
933
960
|
/**
|
|
934
961
|
* CourseCreateRequest
|
|
935
962
|
* @description Course creation request - inherits common fields, adds course-specific section
|
|
@@ -964,59 +991,93 @@ export interface components {
|
|
|
964
991
|
/** @description Pre-uploaded image IDs */
|
|
965
992
|
media?: components["schemas"]["MediaSection"] | null;
|
|
966
993
|
/**
|
|
967
|
-
* Tags
|
|
968
|
-
* @description Tag IDs to associate with product
|
|
994
|
+
* Tags
|
|
995
|
+
* @description Tag IDs to associate with product
|
|
996
|
+
*/
|
|
997
|
+
tags?: number[] | null;
|
|
998
|
+
/**
|
|
999
|
+
* Variants
|
|
1000
|
+
* @description Product variants (optional)
|
|
1001
|
+
*/
|
|
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;
|
|
1012
|
+
/** Description */
|
|
1013
|
+
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;
|
|
1024
|
+
};
|
|
1025
|
+
/**
|
|
1026
|
+
* ProductPrice
|
|
1027
|
+
* @description Base product pricing (maps to product_pricings_tbl with variant_id=NULL)
|
|
1028
|
+
*/
|
|
1029
|
+
ProductPrice: {
|
|
1030
|
+
/**
|
|
1031
|
+
* Price Type
|
|
1032
|
+
* @description free, one_time, subscription, monthly_plan
|
|
1033
|
+
*/
|
|
1034
|
+
price_type: string;
|
|
1035
|
+
/**
|
|
1036
|
+
* Currency
|
|
1037
|
+
* @description Currency code: INR, USD, EUR, etc.
|
|
1038
|
+
*/
|
|
1039
|
+
currency: string;
|
|
1040
|
+
/**
|
|
1041
|
+
* Amount
|
|
1042
|
+
* @description Price amount
|
|
1043
|
+
*/
|
|
1044
|
+
amount: number;
|
|
1045
|
+
/**
|
|
1046
|
+
* Compare At Amount
|
|
1047
|
+
* @description Original/strike-through price
|
|
1048
|
+
*/
|
|
1049
|
+
compare_at_amount?: number | null;
|
|
1050
|
+
/**
|
|
1051
|
+
* Interval
|
|
1052
|
+
* @description day, week, month, year (for subscription)
|
|
1053
|
+
*/
|
|
1054
|
+
interval?: string | null;
|
|
1055
|
+
/**
|
|
1056
|
+
* Interval Count
|
|
1057
|
+
* @description Number of intervals
|
|
1058
|
+
*/
|
|
1059
|
+
interval_count?: number | null;
|
|
1060
|
+
/**
|
|
1061
|
+
* Trial Period Days
|
|
1062
|
+
* @description Free trial days
|
|
969
1063
|
*/
|
|
970
|
-
|
|
1064
|
+
trial_period_days?: number | null;
|
|
971
1065
|
/**
|
|
972
|
-
*
|
|
973
|
-
* @description
|
|
1066
|
+
* Initial Amount
|
|
1067
|
+
* @description First payment amount
|
|
974
1068
|
*/
|
|
975
|
-
|
|
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;
|
|
1069
|
+
initial_amount?: number | null;
|
|
991
1070
|
/**
|
|
992
|
-
*
|
|
993
|
-
* @
|
|
1071
|
+
* Gateway
|
|
1072
|
+
* @description stripe, razorpay, paypal, etc.
|
|
994
1073
|
*/
|
|
995
|
-
|
|
1074
|
+
gateway?: string | null;
|
|
996
1075
|
/**
|
|
997
|
-
*
|
|
998
|
-
* @
|
|
1076
|
+
* Requires Payment Method Upfront
|
|
1077
|
+
* @description Require payment method before trial
|
|
1078
|
+
* @default true
|
|
999
1079
|
*/
|
|
1000
|
-
|
|
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;
|
|
1080
|
+
requires_payment_method_upfront: boolean;
|
|
1020
1081
|
};
|
|
1021
1082
|
/**
|
|
1022
1083
|
* VariantPrice
|
|
@@ -1096,164 +1157,103 @@ export interface components {
|
|
|
1096
1157
|
extensions?: components["schemas"]["Extensions"];
|
|
1097
1158
|
};
|
|
1098
1159
|
/**
|
|
1099
|
-
*
|
|
1100
|
-
* @description
|
|
1101
|
-
*/
|
|
1102
|
-
PricingSection: {
|
|
1103
|
-
/** @description Base product price (no variant) */
|
|
1104
|
-
product_price?: components["schemas"]["ProductPrice"] | null;
|
|
1105
|
-
/**
|
|
1106
|
-
* Variant Prices
|
|
1107
|
-
* @description Variant-specific prices
|
|
1108
|
-
*/
|
|
1109
|
-
variant_prices?: components["schemas"]["VariantPrice"][] | null;
|
|
1110
|
-
};
|
|
1111
|
-
/**
|
|
1112
|
-
* IdentitySection
|
|
1113
|
-
* @description Localized product content (maps to product_identity_tbl)
|
|
1160
|
+
* ProductSection
|
|
1161
|
+
* @description Base product fields (maps to product_tbl)
|
|
1114
1162
|
*/
|
|
1115
|
-
|
|
1116
|
-
/**
|
|
1117
|
-
* Locale
|
|
1118
|
-
* @description Locale: en-US, es-PR, fr-FR, pt-BR, etc.
|
|
1119
|
-
* @default en-US
|
|
1120
|
-
*/
|
|
1121
|
-
locale: string;
|
|
1122
|
-
/**
|
|
1123
|
-
* Title
|
|
1124
|
-
* @description Product title
|
|
1125
|
-
*/
|
|
1126
|
-
title: string;
|
|
1127
|
-
/**
|
|
1128
|
-
* Subtitle
|
|
1129
|
-
* @description Product subtitle
|
|
1130
|
-
*/
|
|
1131
|
-
subtitle?: string | null;
|
|
1132
|
-
/**
|
|
1133
|
-
* Description
|
|
1134
|
-
* @description Full product description
|
|
1135
|
-
*/
|
|
1136
|
-
description?: string | null;
|
|
1163
|
+
ProductSection: {
|
|
1137
1164
|
/**
|
|
1138
|
-
*
|
|
1139
|
-
* @description
|
|
1165
|
+
* Visibility
|
|
1166
|
+
* @description public, private, hidden, unlisted
|
|
1167
|
+
* @default public
|
|
1140
1168
|
*/
|
|
1141
|
-
|
|
1142
|
-
};
|
|
1143
|
-
/**
|
|
1144
|
-
* VariantItem
|
|
1145
|
-
* @description Product variant (maps to product_variants_tbl)
|
|
1146
|
-
*/
|
|
1147
|
-
VariantItem: {
|
|
1169
|
+
visibility: string;
|
|
1148
1170
|
/**
|
|
1149
|
-
*
|
|
1150
|
-
* @description
|
|
1171
|
+
* Is Digital
|
|
1172
|
+
* @description Digital product flag
|
|
1173
|
+
* @default true
|
|
1151
1174
|
*/
|
|
1152
|
-
|
|
1175
|
+
is_digital: boolean;
|
|
1153
1176
|
/**
|
|
1154
|
-
*
|
|
1155
|
-
* @description
|
|
1177
|
+
* Company Id
|
|
1178
|
+
* @description Multi-company support
|
|
1156
1179
|
*/
|
|
1157
|
-
|
|
1180
|
+
company_id?: number | null;
|
|
1158
1181
|
/**
|
|
1159
|
-
*
|
|
1160
|
-
* @description
|
|
1182
|
+
* Status
|
|
1183
|
+
* @description draft, published, archived, review_required, deleted
|
|
1184
|
+
* @default draft
|
|
1161
1185
|
*/
|
|
1162
|
-
|
|
1163
|
-
[key: string]: unknown;
|
|
1164
|
-
} | null;
|
|
1186
|
+
status: string;
|
|
1165
1187
|
/**
|
|
1166
|
-
* Is
|
|
1167
|
-
* @description
|
|
1168
|
-
* @default
|
|
1188
|
+
* Is Org Level
|
|
1189
|
+
* @description Org-level vs user-created product
|
|
1190
|
+
* @default true
|
|
1169
1191
|
*/
|
|
1170
|
-
|
|
1192
|
+
is_org_level: boolean;
|
|
1171
1193
|
/**
|
|
1172
|
-
*
|
|
1173
|
-
* @description
|
|
1174
|
-
* @default false
|
|
1194
|
+
* Staff Id
|
|
1195
|
+
* @description Staff/instructor delivering product
|
|
1175
1196
|
*/
|
|
1176
|
-
|
|
1197
|
+
staff_id?: number | null;
|
|
1177
1198
|
/**
|
|
1178
|
-
*
|
|
1179
|
-
* @description
|
|
1199
|
+
* Owner Id
|
|
1200
|
+
* @description Owner of the product
|
|
1180
1201
|
*/
|
|
1181
|
-
|
|
1202
|
+
owner_id?: number | null;
|
|
1182
1203
|
/**
|
|
1183
|
-
*
|
|
1184
|
-
* @description
|
|
1204
|
+
* Featured
|
|
1205
|
+
* @description Featured product flag
|
|
1185
1206
|
* @default false
|
|
1186
1207
|
*/
|
|
1187
|
-
|
|
1188
|
-
/**
|
|
1189
|
-
* Weight
|
|
1190
|
-
* @description Weight in kg
|
|
1191
|
-
*/
|
|
1192
|
-
weight?: number | null;
|
|
1193
|
-
/**
|
|
1194
|
-
* Length
|
|
1195
|
-
* @description Length in cm
|
|
1196
|
-
*/
|
|
1197
|
-
length?: number | null;
|
|
1198
|
-
/**
|
|
1199
|
-
* Width
|
|
1200
|
-
* @description Width in cm
|
|
1201
|
-
*/
|
|
1202
|
-
width?: number | null;
|
|
1203
|
-
/**
|
|
1204
|
-
* Height
|
|
1205
|
-
* @description Height in cm
|
|
1206
|
-
*/
|
|
1207
|
-
height?: number | null;
|
|
1208
|
-
/**
|
|
1209
|
-
* Display Order
|
|
1210
|
-
* @description Display order
|
|
1211
|
-
* @default 100
|
|
1212
|
-
*/
|
|
1213
|
-
display_order: number;
|
|
1214
|
-
/**
|
|
1215
|
-
* Metadata
|
|
1216
|
-
* @description Flexible metadata
|
|
1217
|
-
*/
|
|
1218
|
-
metadata?: {
|
|
1219
|
-
[key: string]: unknown;
|
|
1220
|
-
} | null;
|
|
1208
|
+
featured: boolean;
|
|
1221
1209
|
};
|
|
1222
1210
|
/**
|
|
1223
|
-
*
|
|
1224
|
-
* @description
|
|
1211
|
+
* PricingSection
|
|
1212
|
+
* @description Pricing configuration (optional - can have product price, variant prices, or both)
|
|
1225
1213
|
*/
|
|
1226
|
-
|
|
1227
|
-
/**
|
|
1228
|
-
|
|
1229
|
-
* @description instructor_led, self_paced, hybrid
|
|
1230
|
-
*/
|
|
1231
|
-
course_type: string;
|
|
1214
|
+
PricingSection: {
|
|
1215
|
+
/** @description Base product price (no variant) */
|
|
1216
|
+
product_price?: components["schemas"]["ProductPrice"] | null;
|
|
1232
1217
|
/**
|
|
1233
|
-
*
|
|
1234
|
-
* @description
|
|
1218
|
+
* Variant Prices
|
|
1219
|
+
* @description Variant-specific prices
|
|
1235
1220
|
*/
|
|
1236
|
-
|
|
1221
|
+
variant_prices?: components["schemas"]["VariantPrice"][] | null;
|
|
1222
|
+
};
|
|
1223
|
+
/** Body_createCourseCurriculumItem */
|
|
1224
|
+
Body_createCourseCurriculumItem: {
|
|
1225
|
+
/** Title */
|
|
1226
|
+
title: string;
|
|
1227
|
+
/** Content Type */
|
|
1228
|
+
content_type: string;
|
|
1229
|
+
/** Is Section */
|
|
1230
|
+
is_section: number;
|
|
1231
|
+
/** Parent Id */
|
|
1232
|
+
parent_id?: number | null;
|
|
1237
1233
|
/**
|
|
1238
|
-
*
|
|
1239
|
-
* @
|
|
1234
|
+
* Section Order
|
|
1235
|
+
* @default 0
|
|
1240
1236
|
*/
|
|
1241
|
-
|
|
1237
|
+
section_order: number;
|
|
1242
1238
|
/**
|
|
1243
|
-
*
|
|
1244
|
-
* @
|
|
1239
|
+
* Chapter Order
|
|
1240
|
+
* @default 0
|
|
1245
1241
|
*/
|
|
1246
|
-
|
|
1242
|
+
chapter_order: number;
|
|
1243
|
+
/** Description */
|
|
1244
|
+
description?: string | null;
|
|
1245
|
+
/** Content Id */
|
|
1246
|
+
content_id?: number | null;
|
|
1247
1247
|
/**
|
|
1248
|
-
*
|
|
1249
|
-
* @
|
|
1248
|
+
* Drip Days
|
|
1249
|
+
* @default 0
|
|
1250
1250
|
*/
|
|
1251
|
-
|
|
1251
|
+
drip_days: number;
|
|
1252
1252
|
/**
|
|
1253
|
-
*
|
|
1254
|
-
* @
|
|
1253
|
+
* Is Locked
|
|
1254
|
+
* @default false
|
|
1255
1255
|
*/
|
|
1256
|
-
|
|
1256
|
+
is_locked: boolean;
|
|
1257
1257
|
};
|
|
1258
1258
|
};
|
|
1259
1259
|
responses: never;
|