@easyedu/js-lsm-api 1.83.0 → 1.84.0

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

@@ -0,0 +1,57 @@
+/**
+ * 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 { GetResource } from './GetResource';
+/**
+ *
+ * @export
+ * @interface GetResourceList
+ */
+export interface GetResourceList {
+    /**
+     * The current page number
+     * @type {number}
+     * @memberof GetResourceList
+     */
+    page: number;
+    /**
+     * The number of items per page
+     * @type {number}
+     * @memberof GetResourceList
+     */
+    pageSize: number;
+    /**
+     * The total number of pages
+     * @type {number}
+     * @memberof GetResourceList
+     */
+    totalPages: number;
+    /**
+     * The total number of items
+     * @type {number}
+     * @memberof GetResourceList
+     */
+    totalItems: number;
+    /**
+     *
+     * @type {Array<GetResource>}
+     * @memberof GetResourceList
+     */
+    items: Array<GetResource>;
+}
+/**
+ * Check if a given object implements the GetResourceList interface.
+ */
+export declare function instanceOfGetResourceList(value: object): value is GetResourceList;
+export declare function GetResourceListFromJSON(json: any): GetResourceList;
+export declare function GetResourceListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetResourceList;
+export declare function GetResourceListToJSON(json: any): GetResourceList;
+export declare function GetResourceListToJSONTyped(value?: GetResourceList | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetResourceList.js

@@ -0,0 +1,60 @@
+/* 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 { GetResourceFromJSON, GetResourceToJSON, } from './GetResource';
+/**
+ * Check if a given object implements the GetResourceList interface.
+ */
+export function instanceOfGetResourceList(value) {
+    if (!('page' in value) || value['page'] === undefined)
+        return false;
+    if (!('pageSize' in value) || value['pageSize'] === undefined)
+        return false;
+    if (!('totalPages' in value) || value['totalPages'] === undefined)
+        return false;
+    if (!('totalItems' in value) || value['totalItems'] === undefined)
+        return false;
+    if (!('items' in value) || value['items'] === undefined)
+        return false;
+    return true;
+}
+export function GetResourceListFromJSON(json) {
+    return GetResourceListFromJSONTyped(json, false);
+}
+export function GetResourceListFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'page': json['page'],
+        'pageSize': json['pageSize'],
+        'totalPages': json['totalPages'],
+        'totalItems': json['totalItems'],
+        'items': (json['items'].map(GetResourceFromJSON)),
+    };
+}
+export function GetResourceListToJSON(json) {
+    return GetResourceListToJSONTyped(json, false);
+}
+export function GetResourceListToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'page': value['page'],
+        'pageSize': value['pageSize'],
+        'totalPages': value['totalPages'],
+        'totalItems': value['totalItems'],
+        'items': (value['items'].map(GetResourceToJSON)),
+    };
+}

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

@@ -0,0 +1,63 @@
+/**
+ * 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 { GetResourceUsageCoursesInner } from './GetResourceUsageCoursesInner';
+/**
+ *
+ * @export
+ * @interface GetResourceUsage
+ */
+export interface GetResourceUsage {
+    /**
+     *
+     * @type {string}
+     * @memberof GetResourceUsage
+     */
+    resourceId: string;
+    /**
+     *
+     * @type {number}
+     * @memberof GetResourceUsage
+     */
+    publishedCourseCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetResourceUsage
+     */
+    draftCourseCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetResourceUsage
+     */
+    historicalCourseCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetResourceUsage
+     */
+    activeLearnerCount: number;
+    /**
+     *
+     * @type {Array<GetResourceUsageCoursesInner>}
+     * @memberof GetResourceUsage
+     */
+    courses: Array<GetResourceUsageCoursesInner>;
+}
+/**
+ * Check if a given object implements the GetResourceUsage interface.
+ */
+export declare function instanceOfGetResourceUsage(value: object): value is GetResourceUsage;
+export declare function GetResourceUsageFromJSON(json: any): GetResourceUsage;
+export declare function GetResourceUsageFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetResourceUsage;
+export declare function GetResourceUsageToJSON(json: any): GetResourceUsage;
+export declare function GetResourceUsageToJSONTyped(value?: GetResourceUsage | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetResourceUsage.js

@@ -0,0 +1,64 @@
+/* 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 { GetResourceUsageCoursesInnerFromJSON, GetResourceUsageCoursesInnerToJSON, } from './GetResourceUsageCoursesInner';
+/**
+ * Check if a given object implements the GetResourceUsage interface.
+ */
+export function instanceOfGetResourceUsage(value) {
+    if (!('resourceId' in value) || value['resourceId'] === undefined)
+        return false;
+    if (!('publishedCourseCount' in value) || value['publishedCourseCount'] === undefined)
+        return false;
+    if (!('draftCourseCount' in value) || value['draftCourseCount'] === undefined)
+        return false;
+    if (!('historicalCourseCount' in value) || value['historicalCourseCount'] === undefined)
+        return false;
+    if (!('activeLearnerCount' in value) || value['activeLearnerCount'] === undefined)
+        return false;
+    if (!('courses' in value) || value['courses'] === undefined)
+        return false;
+    return true;
+}
+export function GetResourceUsageFromJSON(json) {
+    return GetResourceUsageFromJSONTyped(json, false);
+}
+export function GetResourceUsageFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'resourceId': json['resource_id'],
+        'publishedCourseCount': json['published_course_count'],
+        'draftCourseCount': json['draft_course_count'],
+        'historicalCourseCount': json['historical_course_count'],
+        'activeLearnerCount': json['active_learner_count'],
+        'courses': (json['courses'].map(GetResourceUsageCoursesInnerFromJSON)),
+    };
+}
+export function GetResourceUsageToJSON(json) {
+    return GetResourceUsageToJSONTyped(json, false);
+}
+export function GetResourceUsageToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'resource_id': value['resourceId'],
+        'published_course_count': value['publishedCourseCount'],
+        'draft_course_count': value['draftCourseCount'],
+        'historical_course_count': value['historicalCourseCount'],
+        'active_learner_count': value['activeLearnerCount'],
+        'courses': (value['courses'].map(GetResourceUsageCoursesInnerToJSON)),
+    };
+}

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

@@ -0,0 +1,63 @@
+/**
+ * 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 { ContentLibraryVersionStatus } from './ContentLibraryVersionStatus';
+/**
+ *
+ * @export
+ * @interface GetResourceUsageCoursesInner
+ */
+export interface GetResourceUsageCoursesInner {
+    /**
+     *
+     * @type {string}
+     * @memberof GetResourceUsageCoursesInner
+     */
+    courseId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetResourceUsageCoursesInner
+     */
+    courseVersionId: string;
+    /**
+     *
+     * @type {number}
+     * @memberof GetResourceUsageCoursesInner
+     */
+    courseVersionNumber: number;
+    /**
+     *
+     * @type {ContentLibraryVersionStatus}
+     * @memberof GetResourceUsageCoursesInner
+     */
+    courseStatus: ContentLibraryVersionStatus;
+    /**
+     *
+     * @type {string}
+     * @memberof GetResourceUsageCoursesInner
+     */
+    resourceVersionId: string;
+    /**
+     *
+     * @type {number}
+     * @memberof GetResourceUsageCoursesInner
+     */
+    resourceVersionNumber: number;
+}
+/**
+ * Check if a given object implements the GetResourceUsageCoursesInner interface.
+ */
+export declare function instanceOfGetResourceUsageCoursesInner(value: object): value is GetResourceUsageCoursesInner;
+export declare function GetResourceUsageCoursesInnerFromJSON(json: any): GetResourceUsageCoursesInner;
+export declare function GetResourceUsageCoursesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetResourceUsageCoursesInner;
+export declare function GetResourceUsageCoursesInnerToJSON(json: any): GetResourceUsageCoursesInner;
+export declare function GetResourceUsageCoursesInnerToJSONTyped(value?: GetResourceUsageCoursesInner | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetResourceUsageCoursesInner.js

@@ -0,0 +1,64 @@
+/* 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 { ContentLibraryVersionStatusFromJSON, ContentLibraryVersionStatusToJSON, } from './ContentLibraryVersionStatus';
+/**
+ * Check if a given object implements the GetResourceUsageCoursesInner interface.
+ */
+export function instanceOfGetResourceUsageCoursesInner(value) {
+    if (!('courseId' in value) || value['courseId'] === undefined)
+        return false;
+    if (!('courseVersionId' in value) || value['courseVersionId'] === undefined)
+        return false;
+    if (!('courseVersionNumber' in value) || value['courseVersionNumber'] === undefined)
+        return false;
+    if (!('courseStatus' in value) || value['courseStatus'] === undefined)
+        return false;
+    if (!('resourceVersionId' in value) || value['resourceVersionId'] === undefined)
+        return false;
+    if (!('resourceVersionNumber' in value) || value['resourceVersionNumber'] === undefined)
+        return false;
+    return true;
+}
+export function GetResourceUsageCoursesInnerFromJSON(json) {
+    return GetResourceUsageCoursesInnerFromJSONTyped(json, false);
+}
+export function GetResourceUsageCoursesInnerFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'courseId': json['course_id'],
+        'courseVersionId': json['course_version_id'],
+        'courseVersionNumber': json['course_version_number'],
+        'courseStatus': ContentLibraryVersionStatusFromJSON(json['course_status']),
+        'resourceVersionId': json['resource_version_id'],
+        'resourceVersionNumber': json['resource_version_number'],
+    };
+}
+export function GetResourceUsageCoursesInnerToJSON(json) {
+    return GetResourceUsageCoursesInnerToJSONTyped(json, false);
+}
+export function GetResourceUsageCoursesInnerToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'course_id': value['courseId'],
+        'course_version_id': value['courseVersionId'],
+        'course_version_number': value['courseVersionNumber'],
+        'course_status': ContentLibraryVersionStatusToJSON(value['courseStatus']),
+        'resource_version_id': value['resourceVersionId'],
+        'resource_version_number': value['resourceVersionNumber'],
+    };
+}

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

@@ -0,0 +1,38 @@
+/**
+ * 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 GetResourceVersionUpload
+ */
+export interface GetResourceVersionUpload {
+    /**
+     *
+     * @type {string}
+     * @memberof GetResourceVersionUpload
+     */
+    uploadUrl: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetResourceVersionUpload
+     */
+    versionId: string;
+}
+/**
+ * Check if a given object implements the GetResourceVersionUpload interface.
+ */
+export declare function instanceOfGetResourceVersionUpload(value: object): value is GetResourceVersionUpload;
+export declare function GetResourceVersionUploadFromJSON(json: any): GetResourceVersionUpload;
+export declare function GetResourceVersionUploadFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetResourceVersionUpload;
+export declare function GetResourceVersionUploadToJSON(json: any): GetResourceVersionUpload;
+export declare function GetResourceVersionUploadToJSONTyped(value?: GetResourceVersionUpload | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetResourceVersionUpload.js

@@ -0,0 +1,47 @@
+/* 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 GetResourceVersionUpload interface.
+ */
+export function instanceOfGetResourceVersionUpload(value) {
+    if (!('uploadUrl' in value) || value['uploadUrl'] === undefined)
+        return false;
+    if (!('versionId' in value) || value['versionId'] === undefined)
+        return false;
+    return true;
+}
+export function GetResourceVersionUploadFromJSON(json) {
+    return GetResourceVersionUploadFromJSONTyped(json, false);
+}
+export function GetResourceVersionUploadFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'uploadUrl': json['upload_url'],
+        'versionId': json['version_id'],
+    };
+}
+export function GetResourceVersionUploadToJSON(json) {
+    return GetResourceVersionUploadToJSONTyped(json, false);
+}
+export function GetResourceVersionUploadToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'upload_url': value['uploadUrl'],
+        'version_id': value['versionId'],
+    };
+}

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

@@ -0,0 +1,32 @@
+/**
+ * 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 PostCourseDraft
+ */
+export interface PostCourseDraft {
+    /**
+     *
+     * @type {string}
+     * @memberof PostCourseDraft
+     */
+    changeNotes?: string;
+}
+/**
+ * Check if a given object implements the PostCourseDraft interface.
+ */
+export declare function instanceOfPostCourseDraft(value: object): value is PostCourseDraft;
+export declare function PostCourseDraftFromJSON(json: any): PostCourseDraft;
+export declare function PostCourseDraftFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostCourseDraft;
+export declare function PostCourseDraftToJSON(json: any): PostCourseDraft;
+export declare function PostCourseDraftToJSONTyped(value?: PostCourseDraft | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PostCourseDraft.js

@@ -0,0 +1,41 @@
+/* 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 PostCourseDraft interface.
+ */
+export function instanceOfPostCourseDraft(value) {
+    return true;
+}
+export function PostCourseDraftFromJSON(json) {
+    return PostCourseDraftFromJSONTyped(json, false);
+}
+export function PostCourseDraftFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'changeNotes': json['change_notes'] == null ? undefined : json['change_notes'],
+    };
+}
+export function PostCourseDraftToJSON(json) {
+    return PostCourseDraftToJSONTyped(json, false);
+}
+export function PostCourseDraftToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'change_notes': value['changeNotes'],
+    };
+}

package/dist/esm/models/PostCourseVersionItem.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.
+ */
+import type { ContentLaunchMode } from './ContentLaunchMode';
+/**
+ *
+ * @export
+ * @interface PostCourseVersionItem
+ */
+export interface PostCourseVersionItem {
+    /**
+     *
+     * @type {string}
+     * @memberof PostCourseVersionItem
+     */
+    contentLibraryItemId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PostCourseVersionItem
+     */
+    contentLibraryVersionId?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PostCourseVersionItem
+     */
+    moduleId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PostCourseVersionItem
+     */
+    displayName?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof PostCourseVersionItem
+     */
+    displayOrder?: number;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PostCourseVersionItem
+     */
+    isVisible?: boolean;
+    /**
+     *
+     * @type {ContentLaunchMode}
+     * @memberof PostCourseVersionItem
+     */
+    launchMode?: ContentLaunchMode;
+    /**
+     *
+     * @type {number}
+     * @memberof PostCourseVersionItem
+     */
+    maxAttempts?: number;
+    /**
+     *
+     * @type {PostCourseVersionItemScoreRollupStrategyEnum}
+     * @memberof PostCourseVersionItem
+     */
+    scoreRollupStrategy?: PostCourseVersionItemScoreRollupStrategyEnum;
+    /**
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof PostCourseVersionItem
+     */
+    settings?: {
+        [key: string]: any;
+    };
+}
+/**
+ * @export
+ */
+export declare const PostCourseVersionItemScoreRollupStrategyEnum: {
+    readonly Latest: "Latest";
+    readonly Best: "Best";
+};
+export type PostCourseVersionItemScoreRollupStrategyEnum = typeof PostCourseVersionItemScoreRollupStrategyEnum[keyof typeof PostCourseVersionItemScoreRollupStrategyEnum];
+/**
+ * Check if a given object implements the PostCourseVersionItem interface.
+ */
+export declare function instanceOfPostCourseVersionItem(value: object): value is PostCourseVersionItem;
+export declare function PostCourseVersionItemFromJSON(json: any): PostCourseVersionItem;
+export declare function PostCourseVersionItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostCourseVersionItem;
+export declare function PostCourseVersionItemToJSON(json: any): PostCourseVersionItem;
+export declare function PostCourseVersionItemToJSONTyped(value?: PostCourseVersionItem | null, ignoreDiscriminator?: boolean): any;