@easyedu/js-lsm-api 1.118.0 → 1.119.0

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

@@ -9,6 +9,8 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { HostedScormRollupPolicy } from './HostedScormRollupPolicy';
+import type { HostedScormAccessPolicy } from './HostedScormAccessPolicy';
 /**
  * Request to create a new export for a course
  * @export
@@ -33,6 +35,24 @@ export interface PostCourseExport {
      * @memberof PostCourseExport
      */
     sectionIds: Array<string>;
+    /**
+     * Hosted course mode is an additive backend preview until its player is deployed.
+     * @type {PostCourseExportDeliveryModeEnum}
+     * @memberof PostCourseExport
+     */
+    deliveryMode?: PostCourseExportDeliveryModeEnum;
+    /**
+     *
+     * @type {HostedScormRollupPolicy}
+     * @memberof PostCourseExport
+     */
+    rollupPolicy?: HostedScormRollupPolicy;
+    /**
+     *
+     * @type {HostedScormAccessPolicy}
+     * @memberof PostCourseExport
+     */
+    accessPolicy?: HostedScormAccessPolicy;
 }
 /**
  * @export
@@ -43,6 +63,14 @@ export declare const PostCourseExportExportTypeEnum: {
     readonly Scorm20044ThEdition: "SCORM_2004_4TH_EDITION";
 };
 export type PostCourseExportExportTypeEnum = typeof PostCourseExportExportTypeEnum[keyof typeof PostCourseExportExportTypeEnum];
+/**
+ * @export
+ */
+export declare const PostCourseExportDeliveryModeEnum: {
+    readonly LegacyMultiSco: "LEGACY_MULTI_SCO";
+    readonly HostedCourseV1: "HOSTED_COURSE_V1";
+};
+export type PostCourseExportDeliveryModeEnum = typeof PostCourseExportDeliveryModeEnum[keyof typeof PostCourseExportDeliveryModeEnum];
 /**
  * Check if a given object implements the PostCourseExport interface.
  */

package/dist/esm/models/PostCourseExport.js

@@ -11,6 +11,8 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { HostedScormRollupPolicyFromJSON, HostedScormRollupPolicyToJSON, } from './HostedScormRollupPolicy';
+import { HostedScormAccessPolicyFromJSON, HostedScormAccessPolicyToJSON, } from './HostedScormAccessPolicy';
 /**
  * @export
  */
@@ -19,6 +21,13 @@ export const PostCourseExportExportTypeEnum = {
     Scorm20043RdEdition: 'SCORM_2004_3RD_EDITION',
     Scorm20044ThEdition: 'SCORM_2004_4TH_EDITION'
 };
+/**
+ * @export
+ */
+export const PostCourseExportDeliveryModeEnum = {
+    LegacyMultiSco: 'LEGACY_MULTI_SCO',
+    HostedCourseV1: 'HOSTED_COURSE_V1'
+};
 /**
  * Check if a given object implements the PostCourseExport interface.
  */
@@ -42,6 +51,9 @@ export function PostCourseExportFromJSONTyped(json, ignoreDiscriminator) {
         'courseVersionId': json['course_version_id'],
         'exportType': json['export_type'],
         'sectionIds': json['section_ids'],
+        'deliveryMode': json['delivery_mode'] == null ? undefined : json['delivery_mode'],
+        'rollupPolicy': json['rollup_policy'] == null ? undefined : HostedScormRollupPolicyFromJSON(json['rollup_policy']),
+        'accessPolicy': json['access_policy'] == null ? undefined : HostedScormAccessPolicyFromJSON(json['access_policy']),
     };
 }
 export function PostCourseExportToJSON(json) {
@@ -55,5 +67,8 @@ export function PostCourseExportToJSONTyped(value, ignoreDiscriminator = false)
         'course_version_id': value['courseVersionId'],
         'export_type': value['exportType'],
         'section_ids': value['sectionIds'],
+        'delivery_mode': value['deliveryMode'],
+        'rollup_policy': HostedScormRollupPolicyToJSON(value['rollupPolicy']),
+        'access_policy': HostedScormAccessPolicyToJSON(value['accessPolicy']),
     };
 }

package/dist/esm/models/PostDispatchItemLaunch.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 PostDispatchItemLaunch
+ */
+export interface PostDispatchItemLaunch {
+    /**
+     *
+     * @type {boolean}
+     * @memberof PostDispatchItemLaunch
+     */
+    retake?: boolean;
+}
+/**
+ * Check if a given object implements the PostDispatchItemLaunch interface.
+ */
+export declare function instanceOfPostDispatchItemLaunch(value: object): value is PostDispatchItemLaunch;
+export declare function PostDispatchItemLaunchFromJSON(json: any): PostDispatchItemLaunch;
+export declare function PostDispatchItemLaunchFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostDispatchItemLaunch;
+export declare function PostDispatchItemLaunchToJSON(json: any): PostDispatchItemLaunch;
+export declare function PostDispatchItemLaunchToJSONTyped(value?: PostDispatchItemLaunch | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PostDispatchItemLaunch.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 PostDispatchItemLaunch interface.
+ */
+export function instanceOfPostDispatchItemLaunch(value) {
+    return true;
+}
+export function PostDispatchItemLaunchFromJSON(json) {
+    return PostDispatchItemLaunchFromJSONTyped(json, false);
+}
+export function PostDispatchItemLaunchFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'retake': json['retake'] == null ? undefined : json['retake'],
+    };
+}
+export function PostDispatchItemLaunchToJSON(json) {
+    return PostDispatchItemLaunchToJSONTyped(json, false);
+}
+export function PostDispatchItemLaunchToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'retake': value['retake'],
+    };
+}

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

@@ -0,0 +1,64 @@
+/**
+ * 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 PostDispatchItemLaunchResponse
+ */
+export interface PostDispatchItemLaunchResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof PostDispatchItemLaunchResponse
+     */
+    itemId: string;
+    /**
+     *
+     * @type {PostDispatchItemLaunchResponseKindEnum}
+     * @memberof PostDispatchItemLaunchResponse
+     */
+    kind: PostDispatchItemLaunchResponseKindEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof PostDispatchItemLaunchResponse
+     */
+    sessionId: string;
+    /**
+     *
+     * @type {number}
+     * @memberof PostDispatchItemLaunchResponse
+     */
+    attemptNumber: number;
+    /**
+     *
+     * @type {string}
+     * @memberof PostDispatchItemLaunchResponse
+     */
+    launchUrl: string | null;
+}
+/**
+ * @export
+ */
+export declare const PostDispatchItemLaunchResponseKindEnum: {
+    readonly Resource: "RESOURCE";
+    readonly Quiz: "QUIZ";
+};
+export type PostDispatchItemLaunchResponseKindEnum = typeof PostDispatchItemLaunchResponseKindEnum[keyof typeof PostDispatchItemLaunchResponseKindEnum];
+/**
+ * Check if a given object implements the PostDispatchItemLaunchResponse interface.
+ */
+export declare function instanceOfPostDispatchItemLaunchResponse(value: object): value is PostDispatchItemLaunchResponse;
+export declare function PostDispatchItemLaunchResponseFromJSON(json: any): PostDispatchItemLaunchResponse;
+export declare function PostDispatchItemLaunchResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostDispatchItemLaunchResponse;
+export declare function PostDispatchItemLaunchResponseToJSON(json: any): PostDispatchItemLaunchResponse;
+export declare function PostDispatchItemLaunchResponseToJSONTyped(value?: PostDispatchItemLaunchResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PostDispatchItemLaunchResponse.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 PostDispatchItemLaunchResponseKindEnum = {
+    Resource: 'RESOURCE',
+    Quiz: 'QUIZ'
+};
+/**
+ * Check if a given object implements the PostDispatchItemLaunchResponse interface.
+ */
+export function instanceOfPostDispatchItemLaunchResponse(value) {
+    if (!('itemId' in value) || value['itemId'] === undefined)
+        return false;
+    if (!('kind' in value) || value['kind'] === undefined)
+        return false;
+    if (!('sessionId' in value) || value['sessionId'] === undefined)
+        return false;
+    if (!('attemptNumber' in value) || value['attemptNumber'] === undefined)
+        return false;
+    if (!('launchUrl' in value) || value['launchUrl'] === undefined)
+        return false;
+    return true;
+}
+export function PostDispatchItemLaunchResponseFromJSON(json) {
+    return PostDispatchItemLaunchResponseFromJSONTyped(json, false);
+}
+export function PostDispatchItemLaunchResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'itemId': json['item_id'],
+        'kind': json['kind'],
+        'sessionId': json['session_id'],
+        'attemptNumber': json['attempt_number'],
+        'launchUrl': json['launch_url'],
+    };
+}
+export function PostDispatchItemLaunchResponseToJSON(json) {
+    return PostDispatchItemLaunchResponseToJSONTyped(json, false);
+}
+export function PostDispatchItemLaunchResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'item_id': value['itemId'],
+        'kind': value['kind'],
+        'session_id': value['sessionId'],
+        'attempt_number': value['attemptNumber'],
+        'launch_url': value['launchUrl'],
+    };
+}

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

@@ -0,0 +1,50 @@
+/**
+ * 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 PostDispatchLaunch
+ */
+export interface PostDispatchLaunch {
+    /**
+     *
+     * @type {string}
+     * @memberof PostDispatchLaunch
+     */
+    dispatchId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PostDispatchLaunch
+     */
+    learnerId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PostDispatchLaunch
+     */
+    learnerName: string;
+    /**
+     * Legacy multi-SCO placement identifier.
+     * @type {string}
+     * @memberof PostDispatchLaunch
+     */
+    itemId?: string | null;
+}
+/**
+ * Check if a given object implements the PostDispatchLaunch interface.
+ */
+export declare function instanceOfPostDispatchLaunch(value: object): value is PostDispatchLaunch;
+export declare function PostDispatchLaunchFromJSON(json: any): PostDispatchLaunch;
+export declare function PostDispatchLaunchFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostDispatchLaunch;
+export declare function PostDispatchLaunchToJSON(json: any): PostDispatchLaunch;
+export declare function PostDispatchLaunchToJSONTyped(value?: PostDispatchLaunch | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PostDispatchLaunch.js

@@ -0,0 +1,53 @@
+/* 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 PostDispatchLaunch interface.
+ */
+export function instanceOfPostDispatchLaunch(value) {
+    if (!('dispatchId' in value) || value['dispatchId'] === undefined)
+        return false;
+    if (!('learnerId' in value) || value['learnerId'] === undefined)
+        return false;
+    if (!('learnerName' in value) || value['learnerName'] === undefined)
+        return false;
+    return true;
+}
+export function PostDispatchLaunchFromJSON(json) {
+    return PostDispatchLaunchFromJSONTyped(json, false);
+}
+export function PostDispatchLaunchFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'dispatchId': json['dispatch_id'],
+        'learnerId': json['learner_id'],
+        'learnerName': json['learner_name'],
+        'itemId': json['item_id'] == null ? undefined : json['item_id'],
+    };
+}
+export function PostDispatchLaunchToJSON(json) {
+    return PostDispatchLaunchToJSONTyped(json, false);
+}
+export function PostDispatchLaunchToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'dispatch_id': value['dispatchId'],
+        'learner_id': value['learnerId'],
+        'learner_name': value['learnerName'],
+        'item_id': value['itemId'],
+    };
+}

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

@@ -0,0 +1,70 @@
+/**
+ * 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 PostDispatchLaunchResponse
+ */
+export interface PostDispatchLaunchResponse {
+    /**
+     *
+     * @type {PostDispatchLaunchResponseRuntimeModeEnum}
+     * @memberof PostDispatchLaunchResponse
+     */
+    runtimeMode: PostDispatchLaunchResponseRuntimeModeEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof PostDispatchLaunchResponse
+     */
+    launchUrl: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PostDispatchLaunchResponse
+     */
+    token: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PostDispatchLaunchResponse
+     */
+    launchCode: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PostDispatchLaunchResponse
+     */
+    registrationId: string | null;
+    /**
+     *
+     * @type {number}
+     * @memberof PostDispatchLaunchResponse
+     */
+    expiresAt: number;
+}
+/**
+ * @export
+ */
+export declare const PostDispatchLaunchResponseRuntimeModeEnum: {
+    readonly LegacyMultiSco: "LEGACY_MULTI_SCO";
+    readonly HostedCourseV1: "HOSTED_COURSE_V1";
+};
+export type PostDispatchLaunchResponseRuntimeModeEnum = typeof PostDispatchLaunchResponseRuntimeModeEnum[keyof typeof PostDispatchLaunchResponseRuntimeModeEnum];
+/**
+ * Check if a given object implements the PostDispatchLaunchResponse interface.
+ */
+export declare function instanceOfPostDispatchLaunchResponse(value: object): value is PostDispatchLaunchResponse;
+export declare function PostDispatchLaunchResponseFromJSON(json: any): PostDispatchLaunchResponse;
+export declare function PostDispatchLaunchResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostDispatchLaunchResponse;
+export declare function PostDispatchLaunchResponseToJSON(json: any): PostDispatchLaunchResponse;
+export declare function PostDispatchLaunchResponseToJSONTyped(value?: PostDispatchLaunchResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PostDispatchLaunchResponse.js

@@ -0,0 +1,70 @@
+/* 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 PostDispatchLaunchResponseRuntimeModeEnum = {
+    LegacyMultiSco: 'LEGACY_MULTI_SCO',
+    HostedCourseV1: 'HOSTED_COURSE_V1'
+};
+/**
+ * Check if a given object implements the PostDispatchLaunchResponse interface.
+ */
+export function instanceOfPostDispatchLaunchResponse(value) {
+    if (!('runtimeMode' in value) || value['runtimeMode'] === undefined)
+        return false;
+    if (!('launchUrl' in value) || value['launchUrl'] === undefined)
+        return false;
+    if (!('token' in value) || value['token'] === undefined)
+        return false;
+    if (!('launchCode' in value) || value['launchCode'] === undefined)
+        return false;
+    if (!('registrationId' in value) || value['registrationId'] === undefined)
+        return false;
+    if (!('expiresAt' in value) || value['expiresAt'] === undefined)
+        return false;
+    return true;
+}
+export function PostDispatchLaunchResponseFromJSON(json) {
+    return PostDispatchLaunchResponseFromJSONTyped(json, false);
+}
+export function PostDispatchLaunchResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'runtimeMode': json['runtime_mode'],
+        'launchUrl': json['launch_url'],
+        'token': json['token'],
+        'launchCode': json['launch_code'],
+        'registrationId': json['registration_id'],
+        'expiresAt': json['expires_at'],
+    };
+}
+export function PostDispatchLaunchResponseToJSON(json) {
+    return PostDispatchLaunchResponseToJSONTyped(json, false);
+}
+export function PostDispatchLaunchResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'runtime_mode': value['runtimeMode'],
+        'launch_url': value['launchUrl'],
+        'token': value['token'],
+        'launch_code': value['launchCode'],
+        'registration_id': value['registrationId'],
+        'expires_at': value['expiresAt'],
+    };
+}

package/dist/esm/models/PostDispatchTokenExchange.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 PostDispatchTokenExchange
+ */
+export interface PostDispatchTokenExchange {
+    /**
+     *
+     * @type {string}
+     * @memberof PostDispatchTokenExchange
+     */
+    code: string;
+}
+/**
+ * Check if a given object implements the PostDispatchTokenExchange interface.
+ */
+export declare function instanceOfPostDispatchTokenExchange(value: object): value is PostDispatchTokenExchange;
+export declare function PostDispatchTokenExchangeFromJSON(json: any): PostDispatchTokenExchange;
+export declare function PostDispatchTokenExchangeFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostDispatchTokenExchange;
+export declare function PostDispatchTokenExchangeToJSON(json: any): PostDispatchTokenExchange;
+export declare function PostDispatchTokenExchangeToJSONTyped(value?: PostDispatchTokenExchange | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PostDispatchTokenExchange.js

@@ -0,0 +1,43 @@
+/* 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 PostDispatchTokenExchange interface.
+ */
+export function instanceOfPostDispatchTokenExchange(value) {
+    if (!('code' in value) || value['code'] === undefined)
+        return false;
+    return true;
+}
+export function PostDispatchTokenExchangeFromJSON(json) {
+    return PostDispatchTokenExchangeFromJSONTyped(json, false);
+}
+export function PostDispatchTokenExchangeFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'code': json['code'],
+    };
+}
+export function PostDispatchTokenExchangeToJSON(json) {
+    return PostDispatchTokenExchangeToJSONTyped(json, false);
+}
+export function PostDispatchTokenExchangeToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'code': value['code'],
+    };
+}

package/dist/esm/models/PutHostedScormStatus.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 PutHostedScormStatus
+ */
+export interface PutHostedScormStatus {
+    /**
+     *
+     * @type {boolean}
+     * @memberof PutHostedScormStatus
+     */
+    active: boolean;
+}
+/**
+ * Check if a given object implements the PutHostedScormStatus interface.
+ */
+export declare function instanceOfPutHostedScormStatus(value: object): value is PutHostedScormStatus;
+export declare function PutHostedScormStatusFromJSON(json: any): PutHostedScormStatus;
+export declare function PutHostedScormStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutHostedScormStatus;
+export declare function PutHostedScormStatusToJSON(json: any): PutHostedScormStatus;
+export declare function PutHostedScormStatusToJSONTyped(value?: PutHostedScormStatus | null, ignoreDiscriminator?: boolean): any;