@iblai/iblai-api 1.0.0-add-mcp-server-test-mount-core

package/dist/types/models/Program.d.ts

@@ -0,0 +1,24 @@
+import type { Institution } from './Institution';
+import type { ProgramTypeEnum } from './ProgramTypeEnum';
+export type Program = {
+    readonly id: number;
+    readonly institution: Institution;
+    institution_id: number;
+    name: string;
+    program_type: ProgramTypeEnum;
+    /**
+     * Duration in months
+     */
+    duration: number;
+    description?: string | null;
+    /**
+     * Metadata
+     */
+    data?: any;
+    /**
+     * Metadata
+     */
+    metadata?: any;
+    created_at?: string;
+    readonly updated_at: string;
+};

package/dist/types/models/ProgramTypeEnum.d.ts

@@ -0,0 +1,18 @@
+/**
+ * * `bachelors` - Bachelor's Degree
+ * * `masters` - Master's Degree
+ * * `phd` - PhD
+ * * `diploma` - Diploma
+ * * `certificate` - Certificate
+ * * `ungraded` - Ungraded
+ * * `other` - Other
+ */
+export declare enum ProgramTypeEnum {
+    BACHELORS = "bachelors",
+    MASTERS = "masters",
+    PHD = "phd",
+    DIPLOMA = "diploma",
+    CERTIFICATE = "certificate",
+    UNGRADED = "ungraded",
+    OTHER = "other"
+}

package/dist/types/models/Recipient.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Serializer for recipient data
+ */
+export type Recipient = {
+    username: string;
+    email: string;
+    status?: string;
+};

package/dist/types/models/RecommendationSearchAPI.d.ts

@@ -0,0 +1,3 @@
+export type RecommendationSearchAPI = {
+    search_api_url: string;
+};

package/dist/types/models/RedirectTokenRequest.d.ts

@@ -0,0 +1,3 @@
+export type RedirectTokenRequest = {
+    url: string;
+};

package/dist/types/models/RedirectTokenResponse.d.ts

@@ -0,0 +1,5 @@
+export type RedirectTokenResponse = {
+    readonly platform_key: string;
+    url: string;
+    readonly token: string;
+};

package/dist/types/models/ReportCreate.d.ts

@@ -0,0 +1,7 @@
+import type { ReportStatus } from './ReportStatus';
+/**
+ * Returns this a report is successfully created
+ */
+export type ReportCreate = {
+    data: ReportStatus;
+};

package/dist/types/models/ReportData.d.ts

@@ -0,0 +1,28 @@
+import type { ReportStatus } from './ReportStatus';
+export type ReportData = {
+    /**
+     * Report Name
+     */
+    display_name?: string;
+    /**
+     * Report Description
+     */
+    description?: string;
+    /**
+     * Report slug
+     */
+    report_name?: string;
+    icon?: string;
+    /**
+     * Extra parameters to be passed to the report create view, e.g learner_id
+     */
+    extra_query_params?: Array<any>;
+    /**
+     * Columns to be available in the report
+     */
+    result_columns?: Array<any>;
+    /**
+     * Report Status if any available
+     */
+    status?: ReportStatus;
+};

package/dist/types/models/ReportDetail.d.ts

@@ -0,0 +1,4 @@
+import type { ReportData } from './ReportData';
+export type ReportDetail = {
+    data: ReportData;
+};

package/dist/types/models/ReportList.d.ts

@@ -0,0 +1,4 @@
+import type { ReportData } from './ReportData';
+export type ReportList = {
+    data: Array<ReportData>;
+};

package/dist/types/models/ReportRequest.d.ts

@@ -0,0 +1,21 @@
+export type ReportRequest = {
+    /**
+     * Report slug, this is passed when calling the create report endpoint
+     */
+    report_name?: string;
+    /**
+     * Advanced report filtering. e,g: {'username': 'username1, username2' }
+     */
+    params?: Record<string, any>;
+    /**
+     *
+     * Advanced Query to run the report, supports SQL Like queries.
+     *
+     * e.g For date type filtering
+     * date_joined > '2021-01-01'
+     *
+     * See https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.query.html#pandas.DataFrame.query
+     *
+     */
+    query?: string;
+};

package/dist/types/models/ReportStatus.d.ts

@@ -0,0 +1,41 @@
+import type { StateEnum } from './StateEnum';
+export type ReportStatus = {
+    /**
+     * Used to download the report
+     */
+    report_id?: string;
+    /**
+     * Report slug, this is passed when calling the create report endpoint
+     */
+    report_name?: string;
+    /**
+     * Report States
+     *
+     * * `pending` - Pending
+     * * `running` - Running
+     * * `accumulating` - Accumulating
+     * * `processing` - Processing
+     * * `storing` - Storing
+     * * `completed` - Completed
+     * * `cancelled` - Cancelled
+     * * `error` - Error
+     * * `expired` - Expired
+     */
+    state?: StateEnum;
+    /**
+     * Report request timestamp (ISO 8601)
+     */
+    started_on?: string;
+    /**
+     * Report Owner
+     */
+    owner?: string;
+    /**
+     * When report would expire and not available for download anymore
+     */
+    expires?: string;
+    /**
+     * Download link for report when available
+     */
+    url?: string;
+};

package/dist/types/models/ReportedRole.d.ts

@@ -0,0 +1,4 @@
+import type { Role } from './Role';
+export type ReportedRole = {
+    roles: Array<Role>;
+};

package/dist/types/models/ReportedSkill.d.ts

@@ -0,0 +1,4 @@
+import type { Skill } from './Skill';
+export type ReportedSkill = {
+    skills: Array<Skill>;
+};

package/dist/types/models/Resource.d.ts

@@ -0,0 +1,22 @@
+export type Resource = {
+    item_id?: string;
+    readonly id: number;
+    /**
+     * The display name of the resource.
+     */
+    readonly name: string | null;
+    /**
+     * Resource URL.
+     */
+    readonly url: string | null;
+    /**
+     * Resource type.
+     */
+    readonly resource_type: string | null;
+    /**
+     * Metadata
+     */
+    readonly data: any;
+    image?: string | null;
+    description?: string | null;
+};

package/dist/types/models/ResourceCreateUpdate.d.ts

@@ -0,0 +1,42 @@
+export type ResourceCreateUpdate = {
+    /**
+     * Resource ID for updates
+     */
+    id?: number;
+    /**
+     * User ID of the resource owner
+     */
+    user_id?: number;
+    /**
+     * Username of the resource owner
+     */
+    username?: string;
+    /**
+     * Type of resource (e.g., video, document)
+     */
+    resource_type: string;
+    /**
+     * URL of the resource
+     */
+    url: string;
+    /**
+     * Name of the resource
+     */
+    name: string;
+    /**
+     * Description of the resource
+     */
+    description?: string;
+    /**
+     * List of skill names associated with the resource
+     */
+    skills?: Array<string>;
+    /**
+     * Image file
+     */
+    image?: string;
+    /**
+     * Additional metadata for the resource
+     */
+    data?: any;
+};

package/dist/types/models/ResourcePoint.d.ts

@@ -0,0 +1,7 @@
+export type ResourcePoint = {
+    /**
+     * The display name of the resource.
+     */
+    name?: string | null;
+    readonly points: number;
+};

package/dist/types/models/RevenueByProduct.d.ts

@@ -0,0 +1,6 @@
+import type { ProductTable } from './ProductTable';
+import type { Summary } from './Summary';
+export type RevenueByProduct = {
+    product_table?: Array<ProductTable>;
+    summary?: Summary;
+};

package/dist/types/models/Role.d.ts

@@ -0,0 +1,7 @@
+export type Role = {
+    readonly id: number;
+    /**
+     * The display name of the role.
+     */
+    name?: string | null;
+};

package/dist/types/models/SendNotification.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Request serializer for sending notification
+ */
+export type SendNotification = {
+    build_id: string;
+};

package/dist/types/models/SendResponse.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Response serializer for send notification
+ */
+export type SendResponse = {
+    status: string;
+    notifications_sent: number;
+    build_id: string;
+    message: string;
+};

package/dist/types/models/Skill.d.ts

@@ -0,0 +1,7 @@
+export type Skill = {
+    readonly id: number;
+    /**
+     * Display name
+     */
+    name?: string | null;
+};

package/dist/types/models/SkillDetail.d.ts

@@ -0,0 +1,9 @@
+import type { CourseSkill } from './CourseSkill';
+export type SkillDetail = {
+    /**
+     * Display name
+     */
+    name?: string | null;
+    courses: Array<CourseSkill>;
+    readonly related_skills: number;
+};

package/dist/types/models/SkillInfo.d.ts

@@ -0,0 +1,23 @@
+export type SkillInfo = {
+    readonly id: number;
+    /**
+     * Display name
+     */
+    name?: string | null;
+    /**
+     * Number of courses with skill
+     */
+    readonly course_count: number;
+    /**
+     * Number of users with skill
+     */
+    readonly user_count: number;
+    /**
+     * Total points for skill
+     */
+    readonly total_points: number;
+    /**
+     * Average points for skill
+     */
+    readonly average_points: number;
+};

package/dist/types/models/SkillThreshold.d.ts

@@ -0,0 +1,14 @@
+export type SkillThreshold = {
+    /**
+     * The name of the threshold e.g Beginner.
+     */
+    name: string;
+    /**
+     * The threshold for the skill.
+     */
+    threshold: number;
+    /**
+     * The platform key
+     */
+    platform: string;
+};

package/dist/types/models/StateEnum.d.ts

@@ -0,0 +1,22 @@
+/**
+ * * `pending` - Pending
+ * * `running` - Running
+ * * `accumulating` - Accumulating
+ * * `processing` - Processing
+ * * `storing` - Storing
+ * * `completed` - Completed
+ * * `cancelled` - Cancelled
+ * * `error` - Error
+ * * `expired` - Expired
+ */
+export declare enum StateEnum {
+    PENDING = "pending",
+    RUNNING = "running",
+    ACCUMULATING = "accumulating",
+    PROCESSING = "processing",
+    STORING = "storing",
+    COMPLETED = "completed",
+    CANCELLED = "cancelled",
+    ERROR = "error",
+    EXPIRED = "expired"
+}

package/dist/types/models/StripeCheckoutSessionRequest.d.ts

@@ -0,0 +1,54 @@
+import type { ModeEnum } from './ModeEnum';
+/**
+ * Serializer for Stripe checkout session creation requests.
+ */
+export type StripeCheckoutSessionRequest = {
+    /**
+     * Product SKU
+     */
+    sku?: string;
+    /**
+     * Alternative to SKU
+     */
+    product?: string;
+    /**
+     * URL to redirect after successful payment
+     */
+    success_url: string;
+    /**
+     * URL to redirect if checkout cancelled
+     */
+    cancel_url: string;
+    /**
+     * Checkout mode
+     *
+     * * `subscription` - subscription
+     * * `payment` - payment
+     * * `setup` - setup
+     */
+    mode?: ModeEnum;
+    /**
+     * Whether to use metered billing
+     */
+    metered?: boolean;
+    /**
+     * Subscription quantity
+     */
+    quantity?: number;
+    /**
+     * Coupon code to apply
+     */
+    coupon?: string;
+    /**
+     * Enable free trial
+     */
+    is_free_trial?: boolean;
+    /**
+     * Trial period in days
+     */
+    trial_days?: number;
+    /**
+     * Skip card collection for trial
+     */
+    skip_card?: boolean;
+};

package/dist/types/models/StripeCheckoutSessionResponse.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Stripe checkout session serialized response
+ */
+export type StripeCheckoutSessionResponse = {
+    redirect_to: string;
+};

package/dist/types/models/StripeCustomerPortalRequest.d.ts

@@ -0,0 +1,3 @@
+export type StripeCustomerPortalRequest = {
+    return_url: string;
+};

package/dist/types/models/StripeCustomerPortalResponse.d.ts

@@ -0,0 +1,3 @@
+export type StripeCustomerPortalResponse = {
+    url: string;
+};

package/dist/types/models/StripeLocalProduct.d.ts

@@ -0,0 +1,8 @@
+export type StripeLocalProduct = {
+    name: string;
+    description?: string | null;
+    readonly price: string;
+    stripe_product_id?: string | null;
+    sku: string;
+    readonly platform: string;
+};

package/dist/types/models/StripeSubscriptionRenewalRequest.d.ts

@@ -0,0 +1,4 @@
+export type StripeSubscriptionRenewalRequest = {
+    checkout_session_uuid: string;
+    return_url: string;
+};

package/dist/types/models/StripeSubscriptionRenewalResponse.d.ts

@@ -0,0 +1,3 @@
+export type StripeSubscriptionRenewalResponse = {
+    subscription_id: string;
+};

package/dist/types/models/SubTimeChild.d.ts

@@ -0,0 +1,18 @@
+export type SubTimeChild = {
+    /**
+     * Display name
+     */
+    display_name: string;
+    /**
+     * block id
+     */
+    id: string;
+    /**
+     * block id
+     */
+    block_id?: string;
+    /**
+     * Total time spent
+     */
+    total_time?: number;
+};

package/dist/types/models/Summary.d.ts

@@ -0,0 +1,18 @@
+export type Summary = {
+    /**
+     * Total number of products
+     */
+    num_products: number;
+    /**
+     * Total number of items ordered
+     */
+    num_orders: number;
+    /**
+     * Total Net revenue
+     */
+    net_revenue: number;
+    /**
+     * Average Net value per item sold
+     */
+    avg_order_value: number;
+};

package/dist/types/models/TenantLaunchError.d.ts

@@ -0,0 +1,10 @@
+/**
+ * An unexpected error occurred during launch process
+ */
+export type TenantLaunchError = {
+    success?: boolean;
+    message: any;
+    data?: any;
+    id?: string;
+    timestamp?: string;
+};

package/dist/types/models/TenantLaunchFailed.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Launch process started but could not complete
+ */
+export type TenantLaunchFailed = {
+    success?: boolean;
+    message: any;
+    data?: any;
+    id?: string;
+    timestamp?: string;
+    org: string;
+    lms_url: string;
+    cms_url: string;
+    portal_url: string;
+    edx_role: string;
+};

package/dist/types/models/TenantLaunchRequest.d.ts

@@ -0,0 +1,16 @@
+export type TenantLaunchRequest = {
+    username: string;
+    email: string;
+    firstname?: string;
+    lastname?: string;
+    password?: string;
+    /**
+     * Organization name
+     */
+    name: string;
+    /**
+     * Unique key for the organization
+     */
+    key: string;
+    ignore_user_exists?: boolean;
+};

package/dist/types/models/TenantLaunchResponse.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Launch process completed successfully
+ */
+export type TenantLaunchResponse = {
+    success?: boolean;
+    message: any;
+    data?: any;
+    id?: string;
+    timestamp?: string;
+    org: string;
+    lms_url: string;
+    cms_url: string;
+    portal_url: string;
+    edx_role: string;
+};

package/dist/types/models/TimeChildData.d.ts

@@ -0,0 +1,20 @@
+import type { SubTimeChild } from './SubTimeChild';
+export type TimeChildData = {
+    /**
+     * Display name
+     */
+    display_name: string;
+    /**
+     * block id
+     */
+    id: string;
+    /**
+     * block id
+     */
+    block_id?: string;
+    /**
+     * Total time spent
+     */
+    total_time?: number;
+    children: Array<SubTimeChild>;
+};

package/dist/types/models/TimeDetail.d.ts

@@ -0,0 +1,8 @@
+import type { TimeDetailData } from './TimeDetailData';
+export type TimeDetail = {
+    data?: Array<TimeDetailData>;
+    /**
+     * Total time spent
+     */
+    total?: number;
+};

package/dist/types/models/TimeDetailChild.d.ts

@@ -0,0 +1,26 @@
+export type TimeDetailChild = {
+    /**
+     * Average time spent
+     */
+    average_time: number;
+    /**
+     * Subsection Display name
+     */
+    display_name: string;
+    /**
+     * Subsection HTML id
+     */
+    id: string;
+    /**
+     * Subsection block id
+     */
+    block_id: string;
+    /**
+     * Total time spent
+     */
+    total_time?: number;
+    /**
+     * Total users who accessed the subsection
+     */
+    total_users?: number;
+};

package/dist/types/models/TimeDetailData.d.ts

@@ -0,0 +1,24 @@
+import type { TimeDetailChild } from './TimeDetailChild';
+export type TimeDetailData = {
+    /**
+     * Average time spent
+     */
+    average_time: number;
+    /**
+     * Chapter name
+     */
+    display_name: string;
+    /**
+     * Chapter Id
+     */
+    id: string;
+    children?: Array<TimeDetailChild>;
+    /**
+     * Total time spent
+     */
+    total_time?: number;
+    /**
+     * Total users who accessed the chapter
+     */
+    total_users?: number;
+};