@blezgo/api-sdk 0.1.2 → 0.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/account/generated.d.ts +183 -183
- package/dist/account/generated.d.ts.map +1 -1
- package/dist/activity/generated.d.ts +82 -82
- package/dist/activity/generated.d.ts.map +1 -1
- package/dist/addon/generated.d.ts +88 -88
- package/dist/addon/generated.d.ts.map +1 -1
- package/dist/admin/generated.d.ts +42 -42
- package/dist/admin/generated.d.ts.map +1 -1
- package/dist/affiliate/generated.d.ts +97 -98
- package/dist/affiliate/generated.d.ts.map +1 -1
- package/dist/analytics/generated.d.ts +27 -27
- package/dist/analytics/generated.d.ts.map +1 -1
- package/dist/announcements/generated.d.ts +118 -118
- package/dist/announcements/generated.d.ts.map +1 -1
- package/dist/apikeys/generated.d.ts +46 -46
- package/dist/apikeys/generated.d.ts.map +1 -1
- package/dist/assistance/generated.d.ts +24 -24
- package/dist/assistance/generated.d.ts.map +1 -1
- package/dist/authentication/generated.d.ts +73 -73
- package/dist/authentication/generated.d.ts.map +1 -1
- package/dist/blog/generated.d.ts +142 -142
- package/dist/blog/generated.d.ts.map +1 -1
- package/dist/bundle/generated.d.ts +124 -124
- package/dist/bundle/generated.d.ts.map +1 -1
- package/dist/cache/generated.d.ts +32 -32
- package/dist/cache/generated.d.ts.map +1 -1
- package/dist/calendar/generated.d.ts +59 -59
- package/dist/calendar/generated.d.ts.map +1 -1
- package/dist/campaigns/generated.d.ts +151 -151
- package/dist/campaigns/generated.d.ts.map +1 -1
- package/dist/cart/generated.d.ts +41 -41
- package/dist/cart/generated.d.ts.map +1 -1
- package/dist/changelog/generated.d.ts +90 -90
- package/dist/changelog/generated.d.ts.map +1 -1
- package/dist/channel/generated.d.ts +256 -256
- package/dist/channel/generated.d.ts.map +1 -1
- package/dist/company/generated.d.ts +73 -73
- package/dist/company/generated.d.ts.map +1 -1
- package/dist/conference/generated.d.ts +160 -160
- package/dist/conference/generated.d.ts.map +1 -1
- package/dist/config/generated.d.ts +57 -57
- package/dist/config/generated.d.ts.map +1 -1
- package/dist/content/generated.d.ts +620 -620
- package/dist/content/generated.d.ts.map +1 -1
- package/dist/cookies/generated.d.ts +85 -85
- package/dist/cookies/generated.d.ts.map +1 -1
- package/dist/courses/generated.d.ts +381 -381
- package/dist/courses/generated.d.ts.map +1 -1
- package/dist/custom/generated.d.ts +103 -103
- package/dist/custom/generated.d.ts.map +1 -1
- package/dist/dashboard/generated.d.ts +148 -148
- package/dist/dashboard/generated.d.ts.map +1 -1
- package/dist/elasticsearch/generated.d.ts +37 -37
- package/dist/elasticsearch/generated.d.ts.map +1 -1
- package/dist/enrollments/generated.d.ts +21 -21
- package/dist/enrollments/generated.d.ts.map +1 -1
- package/dist/errors/generated.d.ts +21 -21
- package/dist/errors/generated.d.ts.map +1 -1
- package/dist/eventconfig/generated.d.ts +88 -88
- package/dist/eventconfig/generated.d.ts.map +1 -1
- package/dist/funnels/generated.d.ts +124 -125
- package/dist/funnels/generated.d.ts.map +1 -1
- package/dist/gamification/generated.d.ts +151 -151
- package/dist/gamification/generated.d.ts.map +1 -1
- package/dist/impersonation/generated.d.ts +33 -33
- package/dist/impersonation/generated.d.ts.map +1 -1
- package/dist/inbox/generated.d.ts +154 -154
- package/dist/inbox/generated.d.ts.map +1 -1
- package/dist/internal/generated.d.ts +21 -21
- package/dist/internal/generated.d.ts.map +1 -1
- package/dist/internationalization/generated.d.ts +23 -23
- package/dist/internationalization/generated.d.ts.map +1 -1
- package/dist/invitations/generated.d.ts +107 -107
- package/dist/invitations/generated.d.ts.map +1 -1
- package/dist/meetings/generated.d.ts +332 -332
- package/dist/meetings/generated.d.ts.map +1 -1
- package/dist/metas/generated.d.ts +200 -200
- package/dist/metas/generated.d.ts.map +1 -1
- package/dist/notification/generated.d.ts +279 -279
- package/dist/notification/generated.d.ts.map +1 -1
- package/dist/notifications/generated.d.ts +21 -21
- package/dist/notifications/generated.d.ts.map +1 -1
- package/dist/onboarding/generated.d.ts +95 -95
- package/dist/onboarding/generated.d.ts.map +1 -1
- package/dist/packages/generated.d.ts +77 -77
- package/dist/packages/generated.d.ts.map +1 -1
- package/dist/payments/generated.d.ts +628 -631
- package/dist/payments/generated.d.ts.map +1 -1
- package/dist/payouts/generated.d.ts +21 -21
- package/dist/payouts/generated.d.ts.map +1 -1
- package/dist/plans/generated.d.ts +405 -405
- package/dist/plans/generated.d.ts.map +1 -1
- package/dist/pricing/generated.d.ts +75 -75
- package/dist/pricing/generated.d.ts.map +1 -1
- package/dist/products/generated.d.ts +420 -420
- package/dist/products/generated.d.ts.map +1 -1
- package/dist/profile/generated.d.ts +310 -310
- package/dist/profile/generated.d.ts.map +1 -1
- package/dist/reasons/generated.d.ts +64 -64
- package/dist/reasons/generated.d.ts.map +1 -1
- package/dist/registration/generated.d.ts +163 -163
- 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 +944 -446
- package/dist/role/generated.d.ts.map +1 -1
- package/dist/scheduling/generated.d.ts +76 -76
- package/dist/scheduling/generated.d.ts.map +1 -1
- package/dist/services/generated.d.ts +1119 -1119
- package/dist/services/generated.d.ts.map +1 -1
- package/dist/sessions/generated.d.ts +313 -313
- package/dist/sessions/generated.d.ts.map +1 -1
- package/dist/spaces/generated.d.ts +340 -340
- package/dist/spaces/generated.d.ts.map +1 -1
- package/dist/storefront/generated.d.ts +21 -21
- package/dist/storefront/generated.d.ts.map +1 -1
- package/dist/support/generated.d.ts +1624 -1624
- package/dist/support/generated.d.ts.map +1 -1
- package/dist/sync/generated.d.ts +176 -176
- package/dist/sync/generated.d.ts.map +1 -1
- package/dist/tenant/generated.d.ts +487 -487
- package/dist/tenant/generated.d.ts.map +1 -1
- package/dist/testimonials/generated.d.ts +86 -86
- package/dist/testimonials/generated.d.ts.map +1 -1
- package/dist/tests/generated.d.ts +456 -456
- package/dist/tests/generated.d.ts.map +1 -1
- package/dist/tokens/generated.d.ts +54 -54
- 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 +105 -105
- package/dist/upsell/generated.d.ts.map +1 -1
- package/dist/user/generated.d.ts +272 -527
- package/dist/user/generated.d.ts.map +1 -1
- package/dist/webinars/generated.d.ts +260 -260
- package/dist/webinars/generated.d.ts.map +1 -1
- package/package.json +1 -1
- package/test-commit.txt +1 -0
|
@@ -572,95 +572,135 @@ export type webhooks = Record<string, never>;
|
|
|
572
572
|
export interface components {
|
|
573
573
|
schemas: {
|
|
574
574
|
/**
|
|
575
|
-
*
|
|
576
|
-
* @description
|
|
577
|
-
* @example {
|
|
578
|
-
* "course": {
|
|
579
|
-
* "course_type": "instructor_led",
|
|
580
|
-
* "primary_instructor_id": 456
|
|
581
|
-
* },
|
|
582
|
-
* "identity": {
|
|
583
|
-
* "locale": "en-US",
|
|
584
|
-
* "title": "Advanced Python Programming"
|
|
585
|
-
* },
|
|
586
|
-
* "pricing": {
|
|
587
|
-
* "product_price": {
|
|
588
|
-
* "amount": 5000,
|
|
589
|
-
* "currency": "INR",
|
|
590
|
-
* "price_type": "one_time"
|
|
591
|
-
* }
|
|
592
|
-
* },
|
|
593
|
-
* "product": {
|
|
594
|
-
* "is_digital": true,
|
|
595
|
-
* "status": "draft",
|
|
596
|
-
* "visibility": "public"
|
|
597
|
-
* }
|
|
598
|
-
* }
|
|
575
|
+
* VariantItem
|
|
576
|
+
* @description Product variant (maps to product_variants_tbl)
|
|
599
577
|
*/
|
|
600
|
-
|
|
601
|
-
/** @description Base product configuration */
|
|
602
|
-
product: components["schemas"]["ProductSection"];
|
|
603
|
-
/** @description Localized content (title, description) */
|
|
604
|
-
identity: components["schemas"]["IdentitySection"];
|
|
605
|
-
/** @description Pre-uploaded image IDs */
|
|
606
|
-
media?: components["schemas"]["MediaSection"] | null;
|
|
578
|
+
VariantItem: {
|
|
607
579
|
/**
|
|
608
|
-
*
|
|
609
|
-
* @description
|
|
580
|
+
* Name
|
|
581
|
+
* @description Variant display name
|
|
610
582
|
*/
|
|
611
|
-
|
|
583
|
+
name: string;
|
|
612
584
|
/**
|
|
613
|
-
*
|
|
614
|
-
* @description
|
|
585
|
+
* Sku
|
|
586
|
+
* @description Stock Keeping Unit
|
|
615
587
|
*/
|
|
616
|
-
|
|
617
|
-
/**
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
588
|
+
sku?: string | null;
|
|
589
|
+
/**
|
|
590
|
+
* Attributes
|
|
591
|
+
* @description Custom attributes
|
|
592
|
+
*/
|
|
593
|
+
attributes?: {
|
|
594
|
+
[key: string]: unknown;
|
|
595
|
+
} | null;
|
|
596
|
+
/**
|
|
597
|
+
* Is Default
|
|
598
|
+
* @description Set as default variant
|
|
599
|
+
* @default false
|
|
600
|
+
*/
|
|
601
|
+
is_default: boolean;
|
|
602
|
+
/**
|
|
603
|
+
* Track Inventory
|
|
604
|
+
* @description Track stock for this variant
|
|
605
|
+
* @default false
|
|
606
|
+
*/
|
|
607
|
+
track_inventory: boolean;
|
|
608
|
+
/**
|
|
609
|
+
* Stock Quantity
|
|
610
|
+
* @description Initial stock
|
|
611
|
+
*/
|
|
612
|
+
stock_quantity?: number | null;
|
|
613
|
+
/**
|
|
614
|
+
* Allow Backorder
|
|
615
|
+
* @description Allow orders when out of stock
|
|
616
|
+
* @default false
|
|
617
|
+
*/
|
|
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;
|
|
621
652
|
};
|
|
622
|
-
/**
|
|
623
|
-
|
|
624
|
-
/** Batch Name */
|
|
625
|
-
batch_name: string;
|
|
626
|
-
/** Instructor Id */
|
|
627
|
-
instructor_id: number;
|
|
653
|
+
/** Body_validateBatchSchedule */
|
|
654
|
+
Body_validateBatchSchedule: {
|
|
628
655
|
/** Starts At */
|
|
629
656
|
starts_at: string;
|
|
630
657
|
/** Ends At */
|
|
631
|
-
ends_at
|
|
632
|
-
/** Class Duration Minutes */
|
|
633
|
-
class_duration_minutes: number;
|
|
634
|
-
/** Class Time */
|
|
635
|
-
class_time: string;
|
|
658
|
+
ends_at: string;
|
|
636
659
|
/** Weekdays */
|
|
637
660
|
weekdays: string[];
|
|
638
|
-
/**
|
|
639
|
-
|
|
640
|
-
* @default 25
|
|
641
|
-
*/
|
|
642
|
-
max_students: number;
|
|
643
|
-
/** Batch Code */
|
|
644
|
-
batch_code?: string | null;
|
|
645
|
-
/**
|
|
646
|
-
* Is Private
|
|
647
|
-
* @default false
|
|
648
|
-
*/
|
|
649
|
-
is_private: boolean;
|
|
661
|
+
/** Duration Minutes */
|
|
662
|
+
duration_minutes: number;
|
|
650
663
|
/**
|
|
651
664
|
* Timezone
|
|
652
665
|
* @default UTC
|
|
653
666
|
*/
|
|
654
667
|
timezone: string;
|
|
655
|
-
/** Meeting Platform */
|
|
656
|
-
meeting_platform?: string | null;
|
|
657
|
-
/** Meeting Credentials */
|
|
658
|
-
meeting_credentials?: {
|
|
659
|
-
[key: string]: unknown;
|
|
660
|
-
} | null;
|
|
661
668
|
};
|
|
662
|
-
|
|
663
|
-
|
|
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
|
+
/**
|
|
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
|
+
* }
|
|
690
|
+
*/
|
|
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: {
|
|
664
704
|
/** Title */
|
|
665
705
|
title: string;
|
|
666
706
|
/** Content Type */
|
|
@@ -683,116 +723,12 @@ export interface components {
|
|
|
683
723
|
description?: string | null;
|
|
684
724
|
/** Content Id */
|
|
685
725
|
content_id?: number | null;
|
|
686
|
-
/**
|
|
687
|
-
* Drip Days
|
|
688
|
-
* @default 0
|
|
689
|
-
*/
|
|
690
|
-
drip_days: number;
|
|
691
|
-
/**
|
|
692
|
-
* Is Locked
|
|
693
|
-
* @default false
|
|
694
|
-
*/
|
|
695
|
-
is_locked: boolean;
|
|
696
|
-
};
|
|
697
|
-
/**
|
|
698
|
-
* ProductPrice
|
|
699
|
-
* @description Base product pricing (maps to product_pricings_tbl with variant_id=NULL)
|
|
700
|
-
*/
|
|
701
|
-
ProductPrice: {
|
|
702
|
-
/**
|
|
703
|
-
* Price Type
|
|
704
|
-
* @description free, one_time, subscription, monthly_plan
|
|
705
|
-
*/
|
|
706
|
-
price_type: string;
|
|
707
|
-
/**
|
|
708
|
-
* Currency
|
|
709
|
-
* @description Currency code: INR, USD, EUR, etc.
|
|
710
|
-
*/
|
|
711
|
-
currency: string;
|
|
712
|
-
/**
|
|
713
|
-
* Amount
|
|
714
|
-
* @description Price amount
|
|
715
|
-
*/
|
|
716
|
-
amount: number;
|
|
717
|
-
/**
|
|
718
|
-
* Compare At Amount
|
|
719
|
-
* @description Original/strike-through price
|
|
720
|
-
*/
|
|
721
|
-
compare_at_amount?: number | null;
|
|
722
|
-
/**
|
|
723
|
-
* Interval
|
|
724
|
-
* @description day, week, month, year (for subscription)
|
|
725
|
-
*/
|
|
726
|
-
interval?: string | null;
|
|
727
|
-
/**
|
|
728
|
-
* Interval Count
|
|
729
|
-
* @description Number of intervals
|
|
730
|
-
*/
|
|
731
|
-
interval_count?: number | null;
|
|
732
|
-
/**
|
|
733
|
-
* Trial Period Days
|
|
734
|
-
* @description Free trial days
|
|
735
|
-
*/
|
|
736
|
-
trial_period_days?: number | null;
|
|
737
|
-
/**
|
|
738
|
-
* Initial Amount
|
|
739
|
-
* @description First payment amount
|
|
740
|
-
*/
|
|
741
|
-
initial_amount?: number | null;
|
|
742
|
-
/**
|
|
743
|
-
* Gateway
|
|
744
|
-
* @description stripe, razorpay, paypal, etc.
|
|
745
|
-
*/
|
|
746
|
-
gateway?: string | null;
|
|
747
|
-
/**
|
|
748
|
-
* Requires Payment Method Upfront
|
|
749
|
-
* @description Require payment method before trial
|
|
750
|
-
* @default true
|
|
751
|
-
*/
|
|
752
|
-
requires_payment_method_upfront: boolean;
|
|
753
|
-
};
|
|
754
|
-
ErrorResponse: {
|
|
755
|
-
/** @example about:blank */
|
|
756
|
-
type?: string;
|
|
757
|
-
/** @example GENERIC_ERROR */
|
|
758
|
-
code?: string;
|
|
759
|
-
/** @example Client Error */
|
|
760
|
-
title?: string;
|
|
761
|
-
/** @example 400 */
|
|
762
|
-
status?: number;
|
|
763
|
-
/** @example An error occurred */
|
|
764
|
-
detail?: string;
|
|
765
|
-
/** @example /v1/cart/items */
|
|
766
|
-
instance?: string;
|
|
767
|
-
extensions?: components["schemas"]["Extensions"];
|
|
768
|
-
};
|
|
769
|
-
/** Body_createBatchFromCSV */
|
|
770
|
-
Body_createBatchFromCSV: {
|
|
771
|
-
/**
|
|
772
|
-
* Csv File
|
|
773
|
-
* Format: binary
|
|
774
|
-
*/
|
|
775
|
-
csv_file: string;
|
|
776
|
-
/** Batch Name */
|
|
777
|
-
batch_name: string;
|
|
778
726
|
/** Instructor Id */
|
|
779
|
-
instructor_id
|
|
780
|
-
/**
|
|
781
|
-
|
|
782
|
-
/**
|
|
783
|
-
|
|
784
|
-
* @default 25
|
|
785
|
-
*/
|
|
786
|
-
max_students: number;
|
|
787
|
-
/** Batch Code */
|
|
788
|
-
batch_code?: string | null;
|
|
789
|
-
/**
|
|
790
|
-
* Is Private
|
|
791
|
-
* @default false
|
|
792
|
-
*/
|
|
793
|
-
is_private: boolean;
|
|
794
|
-
/** Meeting Platform */
|
|
795
|
-
meeting_platform?: string | null;
|
|
727
|
+
instructor_id?: number | null;
|
|
728
|
+
/** Scheduled At */
|
|
729
|
+
scheduled_at?: string | null;
|
|
730
|
+
/** Duration Minutes */
|
|
731
|
+
duration_minutes?: number | null;
|
|
796
732
|
};
|
|
797
733
|
/**
|
|
798
734
|
* MediaItem
|
|
@@ -912,150 +848,185 @@ export interface components {
|
|
|
912
848
|
*/
|
|
913
849
|
media_items?: components["schemas"]["MediaItem"][] | null;
|
|
914
850
|
};
|
|
915
|
-
|
|
916
|
-
|
|
917
|
-
|
|
918
|
-
|
|
919
|
-
|
|
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: {
|
|
920
862
|
/**
|
|
921
|
-
*
|
|
922
|
-
*
|
|
923
|
-
* @default public
|
|
863
|
+
* Csv File
|
|
864
|
+
* Format: binary
|
|
924
865
|
*/
|
|
925
|
-
|
|
866
|
+
csv_file: string;
|
|
867
|
+
/** Batch Name */
|
|
868
|
+
batch_name: string;
|
|
869
|
+
/** Instructor Id */
|
|
870
|
+
instructor_id: number;
|
|
871
|
+
/** Timezone */
|
|
872
|
+
timezone: string;
|
|
926
873
|
/**
|
|
927
|
-
*
|
|
928
|
-
* @
|
|
929
|
-
* @default true
|
|
874
|
+
* Max Students
|
|
875
|
+
* @default 25
|
|
930
876
|
*/
|
|
931
|
-
|
|
877
|
+
max_students: number;
|
|
878
|
+
/** Batch Code */
|
|
879
|
+
batch_code?: string | null;
|
|
932
880
|
/**
|
|
933
|
-
*
|
|
934
|
-
* @
|
|
881
|
+
* Is Private
|
|
882
|
+
* @default false
|
|
935
883
|
*/
|
|
936
|
-
|
|
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: {
|
|
937
893
|
/**
|
|
938
|
-
*
|
|
939
|
-
* @description
|
|
940
|
-
* @default
|
|
894
|
+
* Locale
|
|
895
|
+
* @description Locale: en-US, es-PR, fr-FR, pt-BR, etc.
|
|
896
|
+
* @default en-US
|
|
941
897
|
*/
|
|
942
|
-
|
|
898
|
+
locale: string;
|
|
943
899
|
/**
|
|
944
|
-
*
|
|
945
|
-
* @description
|
|
946
|
-
* @default true
|
|
900
|
+
* Title
|
|
901
|
+
* @description Product title
|
|
947
902
|
*/
|
|
948
|
-
|
|
903
|
+
title: string;
|
|
949
904
|
/**
|
|
950
|
-
*
|
|
951
|
-
* @description
|
|
905
|
+
* Subtitle
|
|
906
|
+
* @description Product subtitle
|
|
952
907
|
*/
|
|
953
|
-
|
|
908
|
+
subtitle?: string | null;
|
|
954
909
|
/**
|
|
955
|
-
*
|
|
956
|
-
* @description
|
|
910
|
+
* Description
|
|
911
|
+
* @description Full product description
|
|
957
912
|
*/
|
|
958
|
-
|
|
913
|
+
description?: string | null;
|
|
959
914
|
/**
|
|
960
|
-
*
|
|
961
|
-
* @description
|
|
962
|
-
* @default false
|
|
915
|
+
* Short Description
|
|
916
|
+
* @description Short description for listings/previews
|
|
963
917
|
*/
|
|
964
|
-
|
|
918
|
+
short_description?: string | null;
|
|
965
919
|
};
|
|
966
|
-
/**
|
|
967
|
-
|
|
920
|
+
/** Body_createCourseBatch */
|
|
921
|
+
Body_createCourseBatch: {
|
|
922
|
+
/** Batch Name */
|
|
923
|
+
batch_name: string;
|
|
924
|
+
/** Instructor Id */
|
|
925
|
+
instructor_id: number;
|
|
968
926
|
/** Starts At */
|
|
969
927
|
starts_at: string;
|
|
970
928
|
/** Ends At */
|
|
971
|
-
ends_at
|
|
929
|
+
ends_at?: string | null;
|
|
930
|
+
/** Class Duration Minutes */
|
|
931
|
+
class_duration_minutes: number;
|
|
932
|
+
/** Class Time */
|
|
933
|
+
class_time: string;
|
|
972
934
|
/** Weekdays */
|
|
973
935
|
weekdays: string[];
|
|
974
|
-
/** Duration Minutes */
|
|
975
|
-
duration_minutes: number;
|
|
976
936
|
/**
|
|
977
|
-
*
|
|
978
|
-
* @default
|
|
937
|
+
* Max Students
|
|
938
|
+
* @default 25
|
|
979
939
|
*/
|
|
980
|
-
|
|
981
|
-
|
|
982
|
-
|
|
983
|
-
Body_createBatchCurriculumItem: {
|
|
984
|
-
/** Title */
|
|
985
|
-
title: string;
|
|
986
|
-
/** Content Type */
|
|
987
|
-
content_type: string;
|
|
988
|
-
/** Is Section */
|
|
989
|
-
is_section: number;
|
|
990
|
-
/** Parent Id */
|
|
991
|
-
parent_id?: number | null;
|
|
940
|
+
max_students: number;
|
|
941
|
+
/** Batch Code */
|
|
942
|
+
batch_code?: string | null;
|
|
992
943
|
/**
|
|
993
|
-
*
|
|
994
|
-
* @default
|
|
944
|
+
* Is Private
|
|
945
|
+
* @default false
|
|
995
946
|
*/
|
|
996
|
-
|
|
947
|
+
is_private: boolean;
|
|
997
948
|
/**
|
|
998
|
-
*
|
|
999
|
-
* @default
|
|
949
|
+
* Timezone
|
|
950
|
+
* @default UTC
|
|
1000
951
|
*/
|
|
1001
|
-
|
|
1002
|
-
/**
|
|
1003
|
-
|
|
1004
|
-
/**
|
|
1005
|
-
|
|
1006
|
-
|
|
1007
|
-
|
|
1008
|
-
/** Scheduled At */
|
|
1009
|
-
scheduled_at?: string | null;
|
|
1010
|
-
/** Duration Minutes */
|
|
1011
|
-
duration_minutes?: number | null;
|
|
1012
|
-
};
|
|
1013
|
-
Extensions: {
|
|
1014
|
-
/** @example GENERIC_ERROR */
|
|
1015
|
-
message_code?: string;
|
|
1016
|
-
/** @example [] */
|
|
1017
|
-
invalid_params?: components["schemas"]["InvalidParam"][];
|
|
1018
|
-
extra_data?: Record<string, never> | null;
|
|
1019
|
-
/** @example Detailed debug information */
|
|
1020
|
-
debug?: string | null;
|
|
952
|
+
timezone: string;
|
|
953
|
+
/** Meeting Platform */
|
|
954
|
+
meeting_platform?: string | null;
|
|
955
|
+
/** Meeting Credentials */
|
|
956
|
+
meeting_credentials?: {
|
|
957
|
+
[key: string]: unknown;
|
|
958
|
+
} | null;
|
|
1021
959
|
};
|
|
1022
960
|
/**
|
|
961
|
+
* CourseCreateRequest
|
|
962
|
+
* @description Course creation request - inherits common fields, adds course-specific section
|
|
1023
963
|
* @example {
|
|
1024
|
-
* "
|
|
1025
|
-
*
|
|
1026
|
-
*
|
|
1027
|
-
*
|
|
1028
|
-
* "
|
|
1029
|
-
* "
|
|
1030
|
-
* "
|
|
1031
|
-
*
|
|
1032
|
-
*
|
|
1033
|
-
* "
|
|
1034
|
-
*
|
|
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"
|
|
1035
983
|
* }
|
|
1036
984
|
* }
|
|
1037
985
|
*/
|
|
1038
|
-
|
|
1039
|
-
/** @
|
|
1040
|
-
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
|
|
1044
|
-
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
|
|
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;
|
|
993
|
+
/**
|
|
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;
|
|
1048
1024
|
};
|
|
1049
1025
|
/**
|
|
1050
|
-
*
|
|
1051
|
-
* @description
|
|
1026
|
+
* ProductPrice
|
|
1027
|
+
* @description Base product pricing (maps to product_pricings_tbl with variant_id=NULL)
|
|
1052
1028
|
*/
|
|
1053
|
-
|
|
1054
|
-
/**
|
|
1055
|
-
* Variant Index
|
|
1056
|
-
* @description Index in variants array (0-based)
|
|
1057
|
-
*/
|
|
1058
|
-
variant_index: number;
|
|
1029
|
+
ProductPrice: {
|
|
1059
1030
|
/**
|
|
1060
1031
|
* Price Type
|
|
1061
1032
|
* @description free, one_time, subscription, monthly_plan
|
|
@@ -1063,7 +1034,7 @@ export interface components {
|
|
|
1063
1034
|
price_type: string;
|
|
1064
1035
|
/**
|
|
1065
1036
|
* Currency
|
|
1066
|
-
* @description Currency code
|
|
1037
|
+
* @description Currency code: INR, USD, EUR, etc.
|
|
1067
1038
|
*/
|
|
1068
1039
|
currency: string;
|
|
1069
1040
|
/**
|
|
@@ -1078,7 +1049,7 @@ export interface components {
|
|
|
1078
1049
|
compare_at_amount?: number | null;
|
|
1079
1050
|
/**
|
|
1080
1051
|
* Interval
|
|
1081
|
-
* @description day, week, month, year
|
|
1052
|
+
* @description day, week, month, year (for subscription)
|
|
1082
1053
|
*/
|
|
1083
1054
|
interval?: string | null;
|
|
1084
1055
|
/**
|
|
@@ -1109,115 +1080,132 @@ export interface components {
|
|
|
1109
1080
|
requires_payment_method_upfront: boolean;
|
|
1110
1081
|
};
|
|
1111
1082
|
/**
|
|
1112
|
-
*
|
|
1113
|
-
* @description
|
|
1083
|
+
* VariantPrice
|
|
1084
|
+
* @description Variant-specific pricing (maps to product_pricings_tbl with variant_id set)
|
|
1114
1085
|
*/
|
|
1115
|
-
|
|
1086
|
+
VariantPrice: {
|
|
1116
1087
|
/**
|
|
1117
|
-
*
|
|
1118
|
-
* @description
|
|
1119
|
-
* @default en-US
|
|
1088
|
+
* Variant Index
|
|
1089
|
+
* @description Index in variants array (0-based)
|
|
1120
1090
|
*/
|
|
1121
|
-
|
|
1091
|
+
variant_index: number;
|
|
1122
1092
|
/**
|
|
1123
|
-
*
|
|
1124
|
-
* @description
|
|
1093
|
+
* Price Type
|
|
1094
|
+
* @description free, one_time, subscription, monthly_plan
|
|
1125
1095
|
*/
|
|
1126
|
-
|
|
1096
|
+
price_type: string;
|
|
1127
1097
|
/**
|
|
1128
|
-
*
|
|
1129
|
-
* @description
|
|
1098
|
+
* Currency
|
|
1099
|
+
* @description Currency code
|
|
1130
1100
|
*/
|
|
1131
|
-
|
|
1101
|
+
currency: string;
|
|
1132
1102
|
/**
|
|
1133
|
-
*
|
|
1134
|
-
* @description
|
|
1103
|
+
* Amount
|
|
1104
|
+
* @description Price amount
|
|
1135
1105
|
*/
|
|
1136
|
-
|
|
1106
|
+
amount: number;
|
|
1137
1107
|
/**
|
|
1138
|
-
*
|
|
1139
|
-
* @description
|
|
1108
|
+
* Compare At Amount
|
|
1109
|
+
* @description Original/strike-through price
|
|
1140
1110
|
*/
|
|
1141
|
-
|
|
1142
|
-
};
|
|
1143
|
-
/**
|
|
1144
|
-
* VariantItem
|
|
1145
|
-
* @description Product variant (maps to product_variants_tbl)
|
|
1146
|
-
*/
|
|
1147
|
-
VariantItem: {
|
|
1111
|
+
compare_at_amount?: number | null;
|
|
1148
1112
|
/**
|
|
1149
|
-
*
|
|
1150
|
-
* @description
|
|
1113
|
+
* Interval
|
|
1114
|
+
* @description day, week, month, year
|
|
1151
1115
|
*/
|
|
1152
|
-
|
|
1116
|
+
interval?: string | null;
|
|
1153
1117
|
/**
|
|
1154
|
-
*
|
|
1155
|
-
* @description
|
|
1118
|
+
* Interval Count
|
|
1119
|
+
* @description Number of intervals
|
|
1156
1120
|
*/
|
|
1157
|
-
|
|
1121
|
+
interval_count?: number | null;
|
|
1158
1122
|
/**
|
|
1159
|
-
*
|
|
1160
|
-
* @description
|
|
1123
|
+
* Trial Period Days
|
|
1124
|
+
* @description Free trial days
|
|
1161
1125
|
*/
|
|
1162
|
-
|
|
1163
|
-
[key: string]: unknown;
|
|
1164
|
-
} | null;
|
|
1126
|
+
trial_period_days?: number | null;
|
|
1165
1127
|
/**
|
|
1166
|
-
*
|
|
1167
|
-
* @description
|
|
1168
|
-
* @default false
|
|
1128
|
+
* Initial Amount
|
|
1129
|
+
* @description First payment amount
|
|
1169
1130
|
*/
|
|
1170
|
-
|
|
1131
|
+
initial_amount?: number | null;
|
|
1171
1132
|
/**
|
|
1172
|
-
*
|
|
1173
|
-
* @description
|
|
1174
|
-
* @default false
|
|
1133
|
+
* Gateway
|
|
1134
|
+
* @description stripe, razorpay, paypal, etc.
|
|
1175
1135
|
*/
|
|
1176
|
-
|
|
1136
|
+
gateway?: string | null;
|
|
1177
1137
|
/**
|
|
1178
|
-
*
|
|
1179
|
-
* @description
|
|
1138
|
+
* Requires Payment Method Upfront
|
|
1139
|
+
* @description Require payment method before trial
|
|
1140
|
+
* @default true
|
|
1180
1141
|
*/
|
|
1181
|
-
|
|
1142
|
+
requires_payment_method_upfront: boolean;
|
|
1143
|
+
};
|
|
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"];
|
|
1158
|
+
};
|
|
1159
|
+
/**
|
|
1160
|
+
* ProductSection
|
|
1161
|
+
* @description Base product fields (maps to product_tbl)
|
|
1162
|
+
*/
|
|
1163
|
+
ProductSection: {
|
|
1182
1164
|
/**
|
|
1183
|
-
*
|
|
1184
|
-
* @description
|
|
1185
|
-
* @default
|
|
1165
|
+
* Visibility
|
|
1166
|
+
* @description public, private, hidden, unlisted
|
|
1167
|
+
* @default public
|
|
1186
1168
|
*/
|
|
1187
|
-
|
|
1169
|
+
visibility: string;
|
|
1188
1170
|
/**
|
|
1189
|
-
*
|
|
1190
|
-
* @description
|
|
1171
|
+
* Is Digital
|
|
1172
|
+
* @description Digital product flag
|
|
1173
|
+
* @default true
|
|
1191
1174
|
*/
|
|
1192
|
-
|
|
1175
|
+
is_digital: boolean;
|
|
1193
1176
|
/**
|
|
1194
|
-
*
|
|
1195
|
-
* @description
|
|
1177
|
+
* Company Id
|
|
1178
|
+
* @description Multi-company support
|
|
1196
1179
|
*/
|
|
1197
|
-
|
|
1180
|
+
company_id?: number | null;
|
|
1198
1181
|
/**
|
|
1199
|
-
*
|
|
1200
|
-
* @description
|
|
1182
|
+
* Status
|
|
1183
|
+
* @description draft, published, archived, review_required, deleted
|
|
1184
|
+
* @default draft
|
|
1201
1185
|
*/
|
|
1202
|
-
|
|
1186
|
+
status: string;
|
|
1203
1187
|
/**
|
|
1204
|
-
*
|
|
1205
|
-
* @description
|
|
1188
|
+
* Is Org Level
|
|
1189
|
+
* @description Org-level vs user-created product
|
|
1190
|
+
* @default true
|
|
1206
1191
|
*/
|
|
1207
|
-
|
|
1192
|
+
is_org_level: boolean;
|
|
1208
1193
|
/**
|
|
1209
|
-
*
|
|
1210
|
-
* @description
|
|
1211
|
-
* @default 100
|
|
1194
|
+
* Staff Id
|
|
1195
|
+
* @description Staff/instructor delivering product
|
|
1212
1196
|
*/
|
|
1213
|
-
|
|
1197
|
+
staff_id?: number | null;
|
|
1214
1198
|
/**
|
|
1215
|
-
*
|
|
1216
|
-
* @description
|
|
1199
|
+
* Owner Id
|
|
1200
|
+
* @description Owner of the product
|
|
1217
1201
|
*/
|
|
1218
|
-
|
|
1219
|
-
|
|
1220
|
-
|
|
1202
|
+
owner_id?: number | null;
|
|
1203
|
+
/**
|
|
1204
|
+
* Featured
|
|
1205
|
+
* @description Featured product flag
|
|
1206
|
+
* @default false
|
|
1207
|
+
*/
|
|
1208
|
+
featured: boolean;
|
|
1221
1209
|
};
|
|
1222
1210
|
/**
|
|
1223
1211
|
* PricingSection
|
|
@@ -1232,28 +1220,40 @@ export interface components {
|
|
|
1232
1220
|
*/
|
|
1233
1221
|
variant_prices?: components["schemas"]["VariantPrice"][] | null;
|
|
1234
1222
|
};
|
|
1235
|
-
|
|
1236
|
-
|
|
1237
|
-
field?: string;
|
|
1238
|
-
/** @example Input should be greater than or equal to 1 */
|
|
1239
|
-
error?: string;
|
|
1240
|
-
};
|
|
1241
|
-
/** Body_updateCourse */
|
|
1242
|
-
Body_updateCourse: {
|
|
1223
|
+
/** Body_createCourseCurriculumItem */
|
|
1224
|
+
Body_createCourseCurriculumItem: {
|
|
1243
1225
|
/** Title */
|
|
1244
|
-
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;
|
|
1233
|
+
/**
|
|
1234
|
+
* Section Order
|
|
1235
|
+
* @default 0
|
|
1236
|
+
*/
|
|
1237
|
+
section_order: number;
|
|
1238
|
+
/**
|
|
1239
|
+
* Chapter Order
|
|
1240
|
+
* @default 0
|
|
1241
|
+
*/
|
|
1242
|
+
chapter_order: number;
|
|
1245
1243
|
/** Description */
|
|
1246
1244
|
description?: string | null;
|
|
1247
|
-
/**
|
|
1248
|
-
|
|
1249
|
-
/**
|
|
1250
|
-
|
|
1251
|
-
|
|
1252
|
-
|
|
1253
|
-
|
|
1254
|
-
|
|
1255
|
-
|
|
1256
|
-
|
|
1245
|
+
/** Content Id */
|
|
1246
|
+
content_id?: number | null;
|
|
1247
|
+
/**
|
|
1248
|
+
* Drip Days
|
|
1249
|
+
* @default 0
|
|
1250
|
+
*/
|
|
1251
|
+
drip_days: number;
|
|
1252
|
+
/**
|
|
1253
|
+
* Is Locked
|
|
1254
|
+
* @default false
|
|
1255
|
+
*/
|
|
1256
|
+
is_locked: boolean;
|
|
1257
1257
|
};
|
|
1258
1258
|
};
|
|
1259
1259
|
responses: never;
|