@easyedu/js-lsm-api 1.78.0 → 1.80.0

package/dist/esm/models/ContentLaunchMode.d.ts

@@ -0,0 +1,26 @@
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * How the learner player should present the launched content.
+ * @export
+ */
+export declare const ContentLaunchMode: {
+    readonly Embedded: "embedded";
+    readonly Fullscreen: "fullscreen";
+    readonly NewWindow: "new_window";
+};
+export type ContentLaunchMode = typeof ContentLaunchMode[keyof typeof ContentLaunchMode];
+export declare function instanceOfContentLaunchMode(value: any): boolean;
+export declare function ContentLaunchModeFromJSON(json: any): ContentLaunchMode;
+export declare function ContentLaunchModeFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContentLaunchMode;
+export declare function ContentLaunchModeToJSON(value?: ContentLaunchMode | null): any;
+export declare function ContentLaunchModeToJSONTyped(value: any, ignoreDiscriminator: boolean): ContentLaunchMode;

package/dist/esm/models/ContentLaunchMode.js

@@ -0,0 +1,44 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * How the learner player should present the launched content.
+ * @export
+ */
+export const ContentLaunchMode = {
+    Embedded: 'embedded',
+    Fullscreen: 'fullscreen',
+    NewWindow: 'new_window'
+};
+export function instanceOfContentLaunchMode(value) {
+    for (const key in ContentLaunchMode) {
+        if (Object.prototype.hasOwnProperty.call(ContentLaunchMode, key)) {
+            if (ContentLaunchMode[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function ContentLaunchModeFromJSON(json) {
+    return ContentLaunchModeFromJSONTyped(json, false);
+}
+export function ContentLaunchModeFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function ContentLaunchModeToJSON(value) {
+    return value;
+}
+export function ContentLaunchModeToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/esm/models/CourseCatalog.d.ts

@@ -0,0 +1,44 @@
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CourseCatalog
+ */
+export interface CourseCatalog {
+    /**
+     * External ID (UUID) of the catalog
+     * @type {string}
+     * @memberof CourseCatalog
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CourseCatalog
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CourseCatalog
+     */
+    description: string;
+}
+/**
+ * Check if a given object implements the CourseCatalog interface.
+ */
+export declare function instanceOfCourseCatalog(value: object): value is CourseCatalog;
+export declare function CourseCatalogFromJSON(json: any): CourseCatalog;
+export declare function CourseCatalogFromJSONTyped(json: any, ignoreDiscriminator: boolean): CourseCatalog;
+export declare function CourseCatalogToJSON(json: any): CourseCatalog;
+export declare function CourseCatalogToJSONTyped(value?: CourseCatalog | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CourseCatalog.js

@@ -0,0 +1,51 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the CourseCatalog interface.
+ */
+export function instanceOfCourseCatalog(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('description' in value) || value['description'] === undefined)
+        return false;
+    return true;
+}
+export function CourseCatalogFromJSON(json) {
+    return CourseCatalogFromJSONTyped(json, false);
+}
+export function CourseCatalogFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+    };
+}
+export function CourseCatalogToJSON(json) {
+    return CourseCatalogToJSONTyped(json, false);
+}
+export function CourseCatalogToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'description': value['description'],
+    };
+}

package/dist/esm/models/CourseShare.d.ts

@@ -0,0 +1,97 @@
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Shape returned by `GET /course-shares/offered-to-me`. Includes joined source
+ * portal name and course name so the child portal can render an inbox without
+ * follow-up requests.
+ *
+ * @export
+ * @interface CourseShare
+ */
+export interface CourseShare {
+    /**
+     * External ID (UUID) of the share
+     * @type {string}
+     * @memberof CourseShare
+     */
+    id: string;
+    /**
+     * Internal ID of the offering portal
+     * @type {number}
+     * @memberof CourseShare
+     */
+    sourcePortalId: number;
+    /**
+     * Display name of the offering portal
+     * @type {string}
+     * @memberof CourseShare
+     */
+    sourcePortalName: string;
+    /**
+     * Internal ID of the offered course
+     * @type {number}
+     * @memberof CourseShare
+     */
+    courseId: number;
+    /**
+     * Display name of the offered course
+     * @type {string}
+     * @memberof CourseShare
+     */
+    courseName: string;
+    /**
+     *
+     * @type {CourseShareAllowedModeEnum}
+     * @memberof CourseShare
+     */
+    allowedMode: CourseShareAllowedModeEnum;
+    /**
+     *
+     * @type {CourseShareStateEnum}
+     * @memberof CourseShare
+     */
+    state: CourseShareStateEnum;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CourseShare
+     */
+    allowResharing: boolean;
+}
+/**
+ * @export
+ */
+export declare const CourseShareAllowedModeEnum: {
+    readonly Mirror: "Mirror";
+    readonly Clone: "Clone";
+    readonly Either: "Either";
+};
+export type CourseShareAllowedModeEnum = typeof CourseShareAllowedModeEnum[keyof typeof CourseShareAllowedModeEnum];
+/**
+ * @export
+ */
+export declare const CourseShareStateEnum: {
+    readonly Offered: "Offered";
+    readonly AcceptedMirror: "AcceptedMirror";
+    readonly AcceptedClone: "AcceptedClone";
+    readonly Declined: "Declined";
+    readonly Revoked: "Revoked";
+};
+export type CourseShareStateEnum = typeof CourseShareStateEnum[keyof typeof CourseShareStateEnum];
+/**
+ * Check if a given object implements the CourseShare interface.
+ */
+export declare function instanceOfCourseShare(value: object): value is CourseShare;
+export declare function CourseShareFromJSON(json: any): CourseShare;
+export declare function CourseShareFromJSONTyped(json: any, ignoreDiscriminator: boolean): CourseShare;
+export declare function CourseShareToJSON(json: any): CourseShare;
+export declare function CourseShareToJSONTyped(value?: CourseShare | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CourseShare.js

@@ -0,0 +1,89 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * @export
+ */
+export const CourseShareAllowedModeEnum = {
+    Mirror: 'Mirror',
+    Clone: 'Clone',
+    Either: 'Either'
+};
+/**
+ * @export
+ */
+export const CourseShareStateEnum = {
+    Offered: 'Offered',
+    AcceptedMirror: 'AcceptedMirror',
+    AcceptedClone: 'AcceptedClone',
+    Declined: 'Declined',
+    Revoked: 'Revoked'
+};
+/**
+ * Check if a given object implements the CourseShare interface.
+ */
+export function instanceOfCourseShare(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('sourcePortalId' in value) || value['sourcePortalId'] === undefined)
+        return false;
+    if (!('sourcePortalName' in value) || value['sourcePortalName'] === undefined)
+        return false;
+    if (!('courseId' in value) || value['courseId'] === undefined)
+        return false;
+    if (!('courseName' in value) || value['courseName'] === undefined)
+        return false;
+    if (!('allowedMode' in value) || value['allowedMode'] === undefined)
+        return false;
+    if (!('state' in value) || value['state'] === undefined)
+        return false;
+    if (!('allowResharing' in value) || value['allowResharing'] === undefined)
+        return false;
+    return true;
+}
+export function CourseShareFromJSON(json) {
+    return CourseShareFromJSONTyped(json, false);
+}
+export function CourseShareFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'sourcePortalId': json['source_portal_id'],
+        'sourcePortalName': json['source_portal_name'],
+        'courseId': json['course_id'],
+        'courseName': json['course_name'],
+        'allowedMode': json['allowed_mode'],
+        'state': json['state'],
+        'allowResharing': json['allow_resharing'],
+    };
+}
+export function CourseShareToJSON(json) {
+    return CourseShareToJSONTyped(json, false);
+}
+export function CourseShareToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'source_portal_id': value['sourcePortalId'],
+        'source_portal_name': value['sourcePortalName'],
+        'course_id': value['courseId'],
+        'course_name': value['courseName'],
+        'allowed_mode': value['allowedMode'],
+        'state': value['state'],
+        'allow_resharing': value['allowResharing'],
+    };
+}

package/dist/esm/models/CriteriaBasedSelection.d.ts

@@ -0,0 +1,59 @@
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { CriteriaBasedSelectionCriteria } from './CriteriaBasedSelectionCriteria';
+import type { CriteriaBasedSelectionDistribution } from './CriteriaBasedSelectionDistribution';
+/**
+ *
+ * @export
+ * @interface CriteriaBasedSelection
+ */
+export interface CriteriaBasedSelection {
+    /**
+     *
+     * @type {CriteriaBasedSelectionMethodEnum}
+     * @memberof CriteriaBasedSelection
+     */
+    method: CriteriaBasedSelectionMethodEnum;
+    /**
+     *
+     * @type {CriteriaBasedSelectionCriteria}
+     * @memberof CriteriaBasedSelection
+     */
+    criteria: CriteriaBasedSelectionCriteria;
+    /**
+     * Number of questions to randomly select (for randomized_test)
+     * @type {number}
+     * @memberof CriteriaBasedSelection
+     */
+    questionCount?: number;
+    /**
+     *
+     * @type {CriteriaBasedSelectionDistribution}
+     * @memberof CriteriaBasedSelection
+     */
+    distribution?: CriteriaBasedSelectionDistribution;
+}
+/**
+ * @export
+ */
+export declare const CriteriaBasedSelectionMethodEnum: {
+    readonly Criteria: "criteria";
+};
+export type CriteriaBasedSelectionMethodEnum = typeof CriteriaBasedSelectionMethodEnum[keyof typeof CriteriaBasedSelectionMethodEnum];
+/**
+ * Check if a given object implements the CriteriaBasedSelection interface.
+ */
+export declare function instanceOfCriteriaBasedSelection(value: object): value is CriteriaBasedSelection;
+export declare function CriteriaBasedSelectionFromJSON(json: any): CriteriaBasedSelection;
+export declare function CriteriaBasedSelectionFromJSONTyped(json: any, ignoreDiscriminator: boolean): CriteriaBasedSelection;
+export declare function CriteriaBasedSelectionToJSON(json: any): CriteriaBasedSelection;
+export declare function CriteriaBasedSelectionToJSONTyped(value?: CriteriaBasedSelection | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CriteriaBasedSelection.js

@@ -0,0 +1,59 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { CriteriaBasedSelectionCriteriaFromJSON, CriteriaBasedSelectionCriteriaToJSON, } from './CriteriaBasedSelectionCriteria';
+import { CriteriaBasedSelectionDistributionFromJSON, CriteriaBasedSelectionDistributionToJSON, } from './CriteriaBasedSelectionDistribution';
+/**
+ * @export
+ */
+export const CriteriaBasedSelectionMethodEnum = {
+    Criteria: 'criteria'
+};
+/**
+ * Check if a given object implements the CriteriaBasedSelection interface.
+ */
+export function instanceOfCriteriaBasedSelection(value) {
+    if (!('method' in value) || value['method'] === undefined)
+        return false;
+    if (!('criteria' in value) || value['criteria'] === undefined)
+        return false;
+    return true;
+}
+export function CriteriaBasedSelectionFromJSON(json) {
+    return CriteriaBasedSelectionFromJSONTyped(json, false);
+}
+export function CriteriaBasedSelectionFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'method': json['method'],
+        'criteria': CriteriaBasedSelectionCriteriaFromJSON(json['criteria']),
+        'questionCount': json['question_count'] == null ? undefined : json['question_count'],
+        'distribution': json['distribution'] == null ? undefined : CriteriaBasedSelectionDistributionFromJSON(json['distribution']),
+    };
+}
+export function CriteriaBasedSelectionToJSON(json) {
+    return CriteriaBasedSelectionToJSONTyped(json, false);
+}
+export function CriteriaBasedSelectionToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'method': value['method'],
+        'criteria': CriteriaBasedSelectionCriteriaToJSON(value['criteria']),
+        'question_count': value['questionCount'],
+        'distribution': CriteriaBasedSelectionDistributionToJSON(value['distribution']),
+    };
+}

package/dist/esm/models/CriteriaBasedSelectionCriteria.d.ts

@@ -0,0 +1,71 @@
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CriteriaBasedSelectionCriteria
+ */
+export interface CriteriaBasedSelectionCriteria {
+    /**
+     * Topics to include
+     * @type {Array<string>}
+     * @memberof CriteriaBasedSelectionCriteria
+     */
+    topics?: Array<string>;
+    /**
+     * Difficulty levels to include
+     * @type {Array<CriteriaBasedSelectionCriteriaDifficultyLevelsEnum>}
+     * @memberof CriteriaBasedSelectionCriteria
+     */
+    difficultyLevels?: Array<CriteriaBasedSelectionCriteriaDifficultyLevelsEnum>;
+    /**
+     * Question types to include
+     * @type {Array<CriteriaBasedSelectionCriteriaQuestionTypesEnum>}
+     * @memberof CriteriaBasedSelectionCriteria
+     */
+    questionTypes?: Array<CriteriaBasedSelectionCriteriaQuestionTypesEnum>;
+    /**
+     * Tags to match
+     * @type {Array<string>}
+     * @memberof CriteriaBasedSelectionCriteria
+     */
+    tags?: Array<string>;
+}
+/**
+ * @export
+ */
+export declare const CriteriaBasedSelectionCriteriaDifficultyLevelsEnum: {
+    readonly Beginner: "beginner";
+    readonly Intermediate: "intermediate";
+    readonly Advanced: "advanced";
+};
+export type CriteriaBasedSelectionCriteriaDifficultyLevelsEnum = typeof CriteriaBasedSelectionCriteriaDifficultyLevelsEnum[keyof typeof CriteriaBasedSelectionCriteriaDifficultyLevelsEnum];
+/**
+ * @export
+ */
+export declare const CriteriaBasedSelectionCriteriaQuestionTypesEnum: {
+    readonly SingleAnswer: "single_answer";
+    readonly MultipleAnswer: "multiple_answer";
+    readonly FillInBlank: "fill_in_blank";
+    readonly ShortAnswer: "short_answer";
+    readonly Matching: "matching";
+    readonly Essay: "essay";
+};
+export type CriteriaBasedSelectionCriteriaQuestionTypesEnum = typeof CriteriaBasedSelectionCriteriaQuestionTypesEnum[keyof typeof CriteriaBasedSelectionCriteriaQuestionTypesEnum];
+/**
+ * Check if a given object implements the CriteriaBasedSelectionCriteria interface.
+ */
+export declare function instanceOfCriteriaBasedSelectionCriteria(value: object): value is CriteriaBasedSelectionCriteria;
+export declare function CriteriaBasedSelectionCriteriaFromJSON(json: any): CriteriaBasedSelectionCriteria;
+export declare function CriteriaBasedSelectionCriteriaFromJSONTyped(json: any, ignoreDiscriminator: boolean): CriteriaBasedSelectionCriteria;
+export declare function CriteriaBasedSelectionCriteriaToJSON(json: any): CriteriaBasedSelectionCriteria;
+export declare function CriteriaBasedSelectionCriteriaToJSONTyped(value?: CriteriaBasedSelectionCriteria | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CriteriaBasedSelectionCriteria.js

@@ -0,0 +1,66 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * @export
+ */
+export const CriteriaBasedSelectionCriteriaDifficultyLevelsEnum = {
+    Beginner: 'beginner',
+    Intermediate: 'intermediate',
+    Advanced: 'advanced'
+};
+/**
+ * @export
+ */
+export const CriteriaBasedSelectionCriteriaQuestionTypesEnum = {
+    SingleAnswer: 'single_answer',
+    MultipleAnswer: 'multiple_answer',
+    FillInBlank: 'fill_in_blank',
+    ShortAnswer: 'short_answer',
+    Matching: 'matching',
+    Essay: 'essay'
+};
+/**
+ * Check if a given object implements the CriteriaBasedSelectionCriteria interface.
+ */
+export function instanceOfCriteriaBasedSelectionCriteria(value) {
+    return true;
+}
+export function CriteriaBasedSelectionCriteriaFromJSON(json) {
+    return CriteriaBasedSelectionCriteriaFromJSONTyped(json, false);
+}
+export function CriteriaBasedSelectionCriteriaFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'topics': json['topics'] == null ? undefined : json['topics'],
+        'difficultyLevels': json['difficulty_levels'] == null ? undefined : json['difficulty_levels'],
+        'questionTypes': json['question_types'] == null ? undefined : json['question_types'],
+        'tags': json['tags'] == null ? undefined : json['tags'],
+    };
+}
+export function CriteriaBasedSelectionCriteriaToJSON(json) {
+    return CriteriaBasedSelectionCriteriaToJSONTyped(json, false);
+}
+export function CriteriaBasedSelectionCriteriaToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'topics': value['topics'],
+        'difficulty_levels': value['difficultyLevels'],
+        'question_types': value['questionTypes'],
+        'tags': value['tags'],
+    };
+}

package/dist/esm/models/CriteriaBasedSelectionDistribution.d.ts

@@ -0,0 +1,42 @@
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * How to distribute selected questions
+ * @export
+ * @interface CriteriaBasedSelectionDistribution
+ */
+export interface CriteriaBasedSelectionDistribution {
+    /**
+     * Number of questions per topic
+     * @type {{ [key: string]: number; }}
+     * @memberof CriteriaBasedSelectionDistribution
+     */
+    byTopic?: {
+        [key: string]: number;
+    };
+    /**
+     * Number of questions per difficulty level
+     * @type {{ [key: string]: number; }}
+     * @memberof CriteriaBasedSelectionDistribution
+     */
+    byDifficulty?: {
+        [key: string]: number;
+    };
+}
+/**
+ * Check if a given object implements the CriteriaBasedSelectionDistribution interface.
+ */
+export declare function instanceOfCriteriaBasedSelectionDistribution(value: object): value is CriteriaBasedSelectionDistribution;
+export declare function CriteriaBasedSelectionDistributionFromJSON(json: any): CriteriaBasedSelectionDistribution;
+export declare function CriteriaBasedSelectionDistributionFromJSONTyped(json: any, ignoreDiscriminator: boolean): CriteriaBasedSelectionDistribution;
+export declare function CriteriaBasedSelectionDistributionToJSON(json: any): CriteriaBasedSelectionDistribution;
+export declare function CriteriaBasedSelectionDistributionToJSONTyped(value?: CriteriaBasedSelectionDistribution | null, ignoreDiscriminator?: boolean): any;