@easyedu/js-lsm-api 1.83.0 → 1.85.0

package/src/models/GetResourceUsageCoursesInner.ts

@@ -0,0 +1,121 @@
+/* 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 { mapValues } from '../runtime';
+import type { ContentLibraryVersionStatus } from './ContentLibraryVersionStatus';
+import {
+    ContentLibraryVersionStatusFromJSON,
+    ContentLibraryVersionStatusFromJSONTyped,
+    ContentLibraryVersionStatusToJSON,
+    ContentLibraryVersionStatusToJSONTyped,
+} 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 function instanceOfGetResourceUsageCoursesInner(value: object): value is GetResourceUsageCoursesInner {
+    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: any): GetResourceUsageCoursesInner {
+    return GetResourceUsageCoursesInnerFromJSONTyped(json, false);
+}
+
+export function GetResourceUsageCoursesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetResourceUsageCoursesInner {
+    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: any): GetResourceUsageCoursesInner {
+    return GetResourceUsageCoursesInnerToJSONTyped(json, false);
+}
+
+export function GetResourceUsageCoursesInnerToJSONTyped(value?: GetResourceUsageCoursesInner | null, ignoreDiscriminator: boolean = false): any {
+    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/src/models/GetResourceVersionUpload.ts

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

package/src/models/PostCourseDraft.ts

@@ -0,0 +1,65 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface PostCourseDraft
+ */
+export interface PostCourseDraft {
+    /**
+     * 
+     * @type {string}
+     * @memberof PostCourseDraft
+     */
+    changeNotes?: string;
+}
+
+/**
+ * Check if a given object implements the PostCourseDraft interface.
+ */
+export function instanceOfPostCourseDraft(value: object): value is PostCourseDraft {
+    return true;
+}
+
+export function PostCourseDraftFromJSON(json: any): PostCourseDraft {
+    return PostCourseDraftFromJSONTyped(json, false);
+}
+
+export function PostCourseDraftFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostCourseDraft {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'changeNotes': json['change_notes'] == null ? undefined : json['change_notes'],
+    };
+}
+
+export function PostCourseDraftToJSON(json: any): PostCourseDraft {
+    return PostCourseDraftToJSONTyped(json, false);
+}
+
+export function PostCourseDraftToJSONTyped(value?: PostCourseDraft | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'change_notes': value['changeNotes'],
+    };
+}
+

package/src/models/PostCourseVersionItem.ts

@@ -0,0 +1,158 @@
+/* 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 { mapValues } from '../runtime';
+import type { ContentLaunchMode } from './ContentLaunchMode';
+import {
+    ContentLaunchModeFromJSON,
+    ContentLaunchModeFromJSONTyped,
+    ContentLaunchModeToJSON,
+    ContentLaunchModeToJSONTyped,
+} 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 const PostCourseVersionItemScoreRollupStrategyEnum = {
+    Latest: 'Latest',
+    Best: 'Best'
+} as const;
+export type PostCourseVersionItemScoreRollupStrategyEnum = typeof PostCourseVersionItemScoreRollupStrategyEnum[keyof typeof PostCourseVersionItemScoreRollupStrategyEnum];
+
+
+/**
+ * Check if a given object implements the PostCourseVersionItem interface.
+ */
+export function instanceOfPostCourseVersionItem(value: object): value is PostCourseVersionItem {
+    if (!('contentLibraryItemId' in value) || value['contentLibraryItemId'] === undefined) return false;
+    if (!('moduleId' in value) || value['moduleId'] === undefined) return false;
+    return true;
+}
+
+export function PostCourseVersionItemFromJSON(json: any): PostCourseVersionItem {
+    return PostCourseVersionItemFromJSONTyped(json, false);
+}
+
+export function PostCourseVersionItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostCourseVersionItem {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'contentLibraryItemId': json['content_library_item_id'],
+        'contentLibraryVersionId': json['content_library_version_id'] == null ? undefined : json['content_library_version_id'],
+        'moduleId': json['module_id'],
+        'displayName': json['display_name'] == null ? undefined : json['display_name'],
+        'displayOrder': json['display_order'] == null ? undefined : json['display_order'],
+        'isVisible': json['is_visible'] == null ? undefined : json['is_visible'],
+        'launchMode': json['launch_mode'] == null ? undefined : ContentLaunchModeFromJSON(json['launch_mode']),
+        'maxAttempts': json['max_attempts'] == null ? undefined : json['max_attempts'],
+        'scoreRollupStrategy': json['score_rollup_strategy'] == null ? undefined : json['score_rollup_strategy'],
+        'settings': json['settings'] == null ? undefined : json['settings'],
+    };
+}
+
+export function PostCourseVersionItemToJSON(json: any): PostCourseVersionItem {
+    return PostCourseVersionItemToJSONTyped(json, false);
+}
+
+export function PostCourseVersionItemToJSONTyped(value?: PostCourseVersionItem | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'content_library_item_id': value['contentLibraryItemId'],
+        'content_library_version_id': value['contentLibraryVersionId'],
+        'module_id': value['moduleId'],
+        'display_name': value['displayName'],
+        'display_order': value['displayOrder'],
+        'is_visible': value['isVisible'],
+        'launch_mode': ContentLaunchModeToJSON(value['launchMode']),
+        'max_attempts': value['maxAttempts'],
+        'score_rollup_strategy': value['scoreRollupStrategy'],
+        'settings': value['settings'],
+    };
+}
+

package/src/models/PostCourseVersionItemSession.ts

@@ -0,0 +1,65 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * Start or resume a learner attempt for an exact course resource version.
+ * @export
+ * @interface PostCourseVersionItemSession
+ */
+export interface PostCourseVersionItemSession {
+    /**
+     * Create a new attempt instead of returning the current attempt.
+     * @type {boolean}
+     * @memberof PostCourseVersionItemSession
+     */
+    retake?: boolean;
+}
+
+/**
+ * Check if a given object implements the PostCourseVersionItemSession interface.
+ */
+export function instanceOfPostCourseVersionItemSession(value: object): value is PostCourseVersionItemSession {
+    return true;
+}
+
+export function PostCourseVersionItemSessionFromJSON(json: any): PostCourseVersionItemSession {
+    return PostCourseVersionItemSessionFromJSONTyped(json, false);
+}
+
+export function PostCourseVersionItemSessionFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostCourseVersionItemSession {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'retake': json['retake'] == null ? undefined : json['retake'],
+    };
+}
+
+export function PostCourseVersionItemSessionToJSON(json: any): PostCourseVersionItemSession {
+    return PostCourseVersionItemSessionToJSONTyped(json, false);
+}
+
+export function PostCourseVersionItemSessionToJSONTyped(value?: PostCourseVersionItemSession | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'retake': value['retake'],
+    };
+}
+

package/src/models/PostCourseVersionPublish.ts

@@ -0,0 +1,65 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface PostCourseVersionPublish
+ */
+export interface PostCourseVersionPublish {
+    /**
+     * 
+     * @type {string}
+     * @memberof PostCourseVersionPublish
+     */
+    changeNotes?: string;
+}
+
+/**
+ * Check if a given object implements the PostCourseVersionPublish interface.
+ */
+export function instanceOfPostCourseVersionPublish(value: object): value is PostCourseVersionPublish {
+    return true;
+}
+
+export function PostCourseVersionPublishFromJSON(json: any): PostCourseVersionPublish {
+    return PostCourseVersionPublishFromJSONTyped(json, false);
+}
+
+export function PostCourseVersionPublishFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostCourseVersionPublish {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'changeNotes': json['change_notes'] == null ? undefined : json['change_notes'],
+    };
+}
+
+export function PostCourseVersionPublishToJSON(json: any): PostCourseVersionPublish {
+    return PostCourseVersionPublishToJSONTyped(json, false);
+}
+
+export function PostCourseVersionPublishToJSONTyped(value?: PostCourseVersionPublish | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'change_notes': value['changeNotes'],
+    };
+}
+

package/src/models/PostEmailAssetComplete.ts

@@ -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.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface PostEmailAssetComplete
+ */
+export interface PostEmailAssetComplete {
+    /**
+     * 
+     * @type {string}
+     * @memberof PostEmailAssetComplete
+     */
+    checksumSha256: string;
+}
+
+/**
+ * Check if a given object implements the PostEmailAssetComplete interface.
+ */
+export function instanceOfPostEmailAssetComplete(value: object): value is PostEmailAssetComplete {
+    if (!('checksumSha256' in value) || value['checksumSha256'] === undefined) return false;
+    return true;
+}
+
+export function PostEmailAssetCompleteFromJSON(json: any): PostEmailAssetComplete {
+    return PostEmailAssetCompleteFromJSONTyped(json, false);
+}
+
+export function PostEmailAssetCompleteFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostEmailAssetComplete {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'checksumSha256': json['checksum_sha256'],
+    };
+}
+
+export function PostEmailAssetCompleteToJSON(json: any): PostEmailAssetComplete {
+    return PostEmailAssetCompleteToJSONTyped(json, false);
+}
+
+export function PostEmailAssetCompleteToJSONTyped(value?: PostEmailAssetComplete | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'checksum_sha256': value['checksumSha256'],
+    };
+}
+