@easyedu/js-lsm-api 1.118.0 → 1.120.0

package/src/models/GetHostedScormRegistrationList.ts

@@ -0,0 +1,110 @@
+/* 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 { GetHostedScormRegistration } from './GetHostedScormRegistration';
+import {
+    GetHostedScormRegistrationFromJSON,
+    GetHostedScormRegistrationFromJSONTyped,
+    GetHostedScormRegistrationToJSON,
+    GetHostedScormRegistrationToJSONTyped,
+} from './GetHostedScormRegistration';
+
+/**
+ * 
+ * @export
+ * @interface GetHostedScormRegistrationList
+ */
+export interface GetHostedScormRegistrationList {
+    /**
+     * 
+     * @type {number}
+     * @memberof GetHostedScormRegistrationList
+     */
+    page: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetHostedScormRegistrationList
+     */
+    pageSize: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetHostedScormRegistrationList
+     */
+    totalPages: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetHostedScormRegistrationList
+     */
+    totalItems: number;
+    /**
+     * 
+     * @type {Array<GetHostedScormRegistration>}
+     * @memberof GetHostedScormRegistrationList
+     */
+    items: Array<GetHostedScormRegistration>;
+}
+
+/**
+ * Check if a given object implements the GetHostedScormRegistrationList interface.
+ */
+export function instanceOfGetHostedScormRegistrationList(value: object): value is GetHostedScormRegistrationList {
+    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 GetHostedScormRegistrationListFromJSON(json: any): GetHostedScormRegistrationList {
+    return GetHostedScormRegistrationListFromJSONTyped(json, false);
+}
+
+export function GetHostedScormRegistrationListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetHostedScormRegistrationList {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'page': json['page'],
+        'pageSize': json['page_size'],
+        'totalPages': json['total_pages'],
+        'totalItems': json['total_items'],
+        'items': ((json['items'] as Array<any>).map(GetHostedScormRegistrationFromJSON)),
+    };
+}
+
+export function GetHostedScormRegistrationListToJSON(json: any): GetHostedScormRegistrationList {
+    return GetHostedScormRegistrationListToJSONTyped(json, false);
+}
+
+export function GetHostedScormRegistrationListToJSONTyped(value?: GetHostedScormRegistrationList | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'page': value['page'],
+        'page_size': value['pageSize'],
+        'total_pages': value['totalPages'],
+        'total_items': value['totalItems'],
+        'items': ((value['items'] as Array<any>).map(GetHostedScormRegistrationToJSON)),
+    };
+}
+

package/src/models/GetResourceSessionDiagnostics.ts

@@ -104,6 +104,12 @@ export interface GetResourceSessionDiagnostics {
      * @memberof GetResourceSessionDiagnostics
      */
     scormSummary?: GetResourceSessionDiagnosticsScormSummary | null;
+    /**
+     * Read-only sanitized SCORM 2004 sequencing diagnostics; never the mutable engine snapshot.
+     * @type {{ [key: string]: any; }}
+     * @memberof GetResourceSessionDiagnostics
+     */
+    sequencing?: { [key: string]: any; } | null;
 }
 
 /**
@@ -135,6 +141,7 @@ export function GetResourceSessionDiagnosticsFromJSONTyped(json: any, ignoreDisc
         'version': GetResourceSessionDiagnosticsVersionFromJSON(json['version']),
         'courseContext': json['course_context'] == null ? undefined : GetResourceSessionDiagnosticsCourseContextFromJSON(json['course_context']),
         'scormSummary': json['scorm_summary'] == null ? undefined : GetResourceSessionDiagnosticsScormSummaryFromJSON(json['scorm_summary']),
+        'sequencing': json['sequencing'] == null ? undefined : json['sequencing'],
     };
 }
 
@@ -156,6 +163,7 @@ export function GetResourceSessionDiagnosticsToJSONTyped(value?: GetResourceSess
         'version': GetResourceSessionDiagnosticsVersionToJSON(value['version']),
         'course_context': GetResourceSessionDiagnosticsCourseContextToJSON(value['courseContext']),
         'scorm_summary': GetResourceSessionDiagnosticsScormSummaryToJSON(value['scormSummary']),
+        'sequencing': value['sequencing'],
     };
 }
 

package/src/models/HostedScormAccessPolicy.ts

@@ -0,0 +1,93 @@
+/* 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';
+/**
+ * Mutable reseller access controls for a hosted SCORM export.
+ * @export
+ * @interface HostedScormAccessPolicy
+ */
+export interface HostedScormAccessPolicy {
+    /**
+     * 
+     * @type {number}
+     * @memberof HostedScormAccessPolicy
+     */
+    learnerCap: number | null;
+    /**
+     * Optional Unix timestamp before which launches are rejected.
+     * @type {number}
+     * @memberof HostedScormAccessPolicy
+     */
+    validFrom: number | null;
+    /**
+     * Optional Unix timestamp at or after which launches are rejected.
+     * @type {number}
+     * @memberof HostedScormAccessPolicy
+     */
+    validUntil: number | null;
+    /**
+     * Exact HTTP(S) origins. Empty permits any origin.
+     * @type {Array<string>}
+     * @memberof HostedScormAccessPolicy
+     */
+    allowedLmsOrigins: Array<string>;
+}
+
+/**
+ * Check if a given object implements the HostedScormAccessPolicy interface.
+ */
+export function instanceOfHostedScormAccessPolicy(value: object): value is HostedScormAccessPolicy {
+    if (!('learnerCap' in value) || value['learnerCap'] === undefined) return false;
+    if (!('validFrom' in value) || value['validFrom'] === undefined) return false;
+    if (!('validUntil' in value) || value['validUntil'] === undefined) return false;
+    if (!('allowedLmsOrigins' in value) || value['allowedLmsOrigins'] === undefined) return false;
+    return true;
+}
+
+export function HostedScormAccessPolicyFromJSON(json: any): HostedScormAccessPolicy {
+    return HostedScormAccessPolicyFromJSONTyped(json, false);
+}
+
+export function HostedScormAccessPolicyFromJSONTyped(json: any, ignoreDiscriminator: boolean): HostedScormAccessPolicy {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'learnerCap': json['learner_cap'],
+        'validFrom': json['valid_from'],
+        'validUntil': json['valid_until'],
+        'allowedLmsOrigins': json['allowed_lms_origins'],
+    };
+}
+
+export function HostedScormAccessPolicyToJSON(json: any): HostedScormAccessPolicy {
+    return HostedScormAccessPolicyToJSONTyped(json, false);
+}
+
+export function HostedScormAccessPolicyToJSONTyped(value?: HostedScormAccessPolicy | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'learner_cap': value['learnerCap'],
+        'valid_from': value['validFrom'],
+        'valid_until': value['validUntil'],
+        'allowed_lms_origins': value['allowedLmsOrigins'],
+    };
+}
+

package/src/models/HostedScormOutlineEntry.ts

@@ -0,0 +1,176 @@
+/* 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 HostedScormOutlineEntry
+ */
+export interface HostedScormOutlineEntry {
+    /**
+     * 
+     * @type {HostedScormOutlineEntryEntryTypeEnum}
+     * @memberof HostedScormOutlineEntry
+     */
+    entryType: HostedScormOutlineEntryEntryTypeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof HostedScormOutlineEntry
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof HostedScormOutlineEntry
+     */
+    parentSectionId: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof HostedScormOutlineEntry
+     */
+    title: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof HostedScormOutlineEntry
+     */
+    displayOrder: number;
+    /**
+     * 
+     * @type {HostedScormOutlineEntryKindEnum}
+     * @memberof HostedScormOutlineEntry
+     */
+    kind: HostedScormOutlineEntryKindEnum | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof HostedScormOutlineEntry
+     */
+    required: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof HostedScormOutlineEntry
+     */
+    completed: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof HostedScormOutlineEntry
+     */
+    locked: boolean;
+    /**
+     * 
+     * @type {number}
+     * @memberof HostedScormOutlineEntry
+     */
+    attemptNumber: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof HostedScormOutlineEntry
+     */
+    maxAttempts: number | null;
+}
+
+
+/**
+ * @export
+ */
+export const HostedScormOutlineEntryEntryTypeEnum = {
+    Section: 'SECTION',
+    Item: 'ITEM'
+} as const;
+export type HostedScormOutlineEntryEntryTypeEnum = typeof HostedScormOutlineEntryEntryTypeEnum[keyof typeof HostedScormOutlineEntryEntryTypeEnum];
+
+/**
+ * @export
+ */
+export const HostedScormOutlineEntryKindEnum = {
+    Resource: 'RESOURCE',
+    Quiz: 'QUIZ'
+} as const;
+export type HostedScormOutlineEntryKindEnum = typeof HostedScormOutlineEntryKindEnum[keyof typeof HostedScormOutlineEntryKindEnum];
+
+
+/**
+ * Check if a given object implements the HostedScormOutlineEntry interface.
+ */
+export function instanceOfHostedScormOutlineEntry(value: object): value is HostedScormOutlineEntry {
+    if (!('entryType' in value) || value['entryType'] === undefined) return false;
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('parentSectionId' in value) || value['parentSectionId'] === undefined) return false;
+    if (!('title' in value) || value['title'] === undefined) return false;
+    if (!('displayOrder' in value) || value['displayOrder'] === undefined) return false;
+    if (!('kind' in value) || value['kind'] === undefined) return false;
+    if (!('required' in value) || value['required'] === undefined) return false;
+    if (!('completed' in value) || value['completed'] === undefined) return false;
+    if (!('locked' in value) || value['locked'] === undefined) return false;
+    if (!('attemptNumber' in value) || value['attemptNumber'] === undefined) return false;
+    if (!('maxAttempts' in value) || value['maxAttempts'] === undefined) return false;
+    return true;
+}
+
+export function HostedScormOutlineEntryFromJSON(json: any): HostedScormOutlineEntry {
+    return HostedScormOutlineEntryFromJSONTyped(json, false);
+}
+
+export function HostedScormOutlineEntryFromJSONTyped(json: any, ignoreDiscriminator: boolean): HostedScormOutlineEntry {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'entryType': json['entry_type'],
+        'id': json['id'],
+        'parentSectionId': json['parent_section_id'],
+        'title': json['title'],
+        'displayOrder': json['display_order'],
+        'kind': json['kind'],
+        'required': json['required'],
+        'completed': json['completed'],
+        'locked': json['locked'],
+        'attemptNumber': json['attempt_number'],
+        'maxAttempts': json['max_attempts'],
+    };
+}
+
+export function HostedScormOutlineEntryToJSON(json: any): HostedScormOutlineEntry {
+    return HostedScormOutlineEntryToJSONTyped(json, false);
+}
+
+export function HostedScormOutlineEntryToJSONTyped(value?: HostedScormOutlineEntry | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'entry_type': value['entryType'],
+        'id': value['id'],
+        'parent_section_id': value['parentSectionId'],
+        'title': value['title'],
+        'display_order': value['displayOrder'],
+        'kind': value['kind'],
+        'required': value['required'],
+        'completed': value['completed'],
+        'locked': value['locked'],
+        'attempt_number': value['attemptNumber'],
+        'max_attempts': value['maxAttempts'],
+    };
+}
+

package/src/models/HostedScormRollupPolicy.ts

@@ -0,0 +1,123 @@
+/* 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 { HostedScormScoreItem } from './HostedScormScoreItem';
+import {
+    HostedScormScoreItemFromJSON,
+    HostedScormScoreItemFromJSONTyped,
+    HostedScormScoreItemToJSON,
+    HostedScormScoreItemToJSONTyped,
+} from './HostedScormScoreItem';
+
+/**
+ * Immutable course aggregate rules captured by a hosted SCORM export.
+ * @export
+ * @interface HostedScormRollupPolicy
+ */
+export interface HostedScormRollupPolicy {
+    /**
+     * 
+     * @type {HostedScormRollupPolicySuccessRuleEnum}
+     * @memberof HostedScormRollupPolicy
+     */
+    successRule: HostedScormRollupPolicySuccessRuleEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof HostedScormRollupPolicy
+     */
+    passingScorePercent: number | null;
+    /**
+     * 
+     * @type {HostedScormRollupPolicyScoreAggregationEnum}
+     * @memberof HostedScormRollupPolicy
+     */
+    scoreAggregation: HostedScormRollupPolicyScoreAggregationEnum;
+    /**
+     * Empty selects every score-producing resource or quiz in the exported tree.
+     * @type {Array<HostedScormScoreItem>}
+     * @memberof HostedScormRollupPolicy
+     */
+    scoredItems: Array<HostedScormScoreItem>;
+}
+
+
+/**
+ * @export
+ */
+export const HostedScormRollupPolicySuccessRuleEnum = {
+    CompletionOnly: 'COMPLETION_ONLY',
+    AllRequiredGradedPass: 'ALL_REQUIRED_GRADED_PASS',
+    ScoreThreshold: 'SCORE_THRESHOLD',
+    AllRequiredGradedPassAndScoreThreshold: 'ALL_REQUIRED_GRADED_PASS_AND_SCORE_THRESHOLD'
+} as const;
+export type HostedScormRollupPolicySuccessRuleEnum = typeof HostedScormRollupPolicySuccessRuleEnum[keyof typeof HostedScormRollupPolicySuccessRuleEnum];
+
+/**
+ * @export
+ */
+export const HostedScormRollupPolicyScoreAggregationEnum = {
+    Equal: 'EQUAL',
+    Weighted: 'WEIGHTED'
+} as const;
+export type HostedScormRollupPolicyScoreAggregationEnum = typeof HostedScormRollupPolicyScoreAggregationEnum[keyof typeof HostedScormRollupPolicyScoreAggregationEnum];
+
+
+/**
+ * Check if a given object implements the HostedScormRollupPolicy interface.
+ */
+export function instanceOfHostedScormRollupPolicy(value: object): value is HostedScormRollupPolicy {
+    if (!('successRule' in value) || value['successRule'] === undefined) return false;
+    if (!('passingScorePercent' in value) || value['passingScorePercent'] === undefined) return false;
+    if (!('scoreAggregation' in value) || value['scoreAggregation'] === undefined) return false;
+    if (!('scoredItems' in value) || value['scoredItems'] === undefined) return false;
+    return true;
+}
+
+export function HostedScormRollupPolicyFromJSON(json: any): HostedScormRollupPolicy {
+    return HostedScormRollupPolicyFromJSONTyped(json, false);
+}
+
+export function HostedScormRollupPolicyFromJSONTyped(json: any, ignoreDiscriminator: boolean): HostedScormRollupPolicy {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'successRule': json['success_rule'],
+        'passingScorePercent': json['passing_score_percent'],
+        'scoreAggregation': json['score_aggregation'],
+        'scoredItems': ((json['scored_items'] as Array<any>).map(HostedScormScoreItemFromJSON)),
+    };
+}
+
+export function HostedScormRollupPolicyToJSON(json: any): HostedScormRollupPolicy {
+    return HostedScormRollupPolicyToJSONTyped(json, false);
+}
+
+export function HostedScormRollupPolicyToJSONTyped(value?: HostedScormRollupPolicy | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'success_rule': value['successRule'],
+        'passing_score_percent': value['passingScorePercent'],
+        'score_aggregation': value['scoreAggregation'],
+        'scored_items': ((value['scoredItems'] as Array<any>).map(HostedScormScoreItemToJSON)),
+    };
+}
+

package/src/models/HostedScormScoreItem.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 HostedScormScoreItem
+ */
+export interface HostedScormScoreItem {
+    /**
+     * 
+     * @type {string}
+     * @memberof HostedScormScoreItem
+     */
+    itemId: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof HostedScormScoreItem
+     */
+    weight: number;
+}
+
+/**
+ * Check if a given object implements the HostedScormScoreItem interface.
+ */
+export function instanceOfHostedScormScoreItem(value: object): value is HostedScormScoreItem {
+    if (!('itemId' in value) || value['itemId'] === undefined) return false;
+    if (!('weight' in value) || value['weight'] === undefined) return false;
+    return true;
+}
+
+export function HostedScormScoreItemFromJSON(json: any): HostedScormScoreItem {
+    return HostedScormScoreItemFromJSONTyped(json, false);
+}
+
+export function HostedScormScoreItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): HostedScormScoreItem {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'itemId': json['item_id'],
+        'weight': json['weight'],
+    };
+}
+
+export function HostedScormScoreItemToJSON(json: any): HostedScormScoreItem {
+    return HostedScormScoreItemToJSONTyped(json, false);
+}
+
+export function HostedScormScoreItemToJSONTyped(value?: HostedScormScoreItem | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'item_id': value['itemId'],
+        'weight': value['weight'],
+    };
+}
+

package/src/models/PostCourseExport.ts

@@ -13,6 +13,21 @@
  */
 
 import { mapValues } from '../runtime';
+import type { HostedScormRollupPolicy } from './HostedScormRollupPolicy';
+import {
+    HostedScormRollupPolicyFromJSON,
+    HostedScormRollupPolicyFromJSONTyped,
+    HostedScormRollupPolicyToJSON,
+    HostedScormRollupPolicyToJSONTyped,
+} from './HostedScormRollupPolicy';
+import type { HostedScormAccessPolicy } from './HostedScormAccessPolicy';
+import {
+    HostedScormAccessPolicyFromJSON,
+    HostedScormAccessPolicyFromJSONTyped,
+    HostedScormAccessPolicyToJSON,
+    HostedScormAccessPolicyToJSONTyped,
+} from './HostedScormAccessPolicy';
+
 /**
  * Request to create a new export for a course
  * @export
@@ -37,6 +52,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;
 }
 
 
@@ -50,6 +83,15 @@ export const PostCourseExportExportTypeEnum = {
 } as const;
 export type PostCourseExportExportTypeEnum = typeof PostCourseExportExportTypeEnum[keyof typeof PostCourseExportExportTypeEnum];
 
+/**
+ * @export
+ */
+export const PostCourseExportDeliveryModeEnum = {
+    LegacyMultiSco: 'LEGACY_MULTI_SCO',
+    HostedCourseV1: 'HOSTED_COURSE_V1'
+} as const;
+export type PostCourseExportDeliveryModeEnum = typeof PostCourseExportDeliveryModeEnum[keyof typeof PostCourseExportDeliveryModeEnum];
+
 
 /**
  * Check if a given object implements the PostCourseExport interface.
@@ -74,6 +116,9 @@ export function PostCourseExportFromJSONTyped(json: any, ignoreDiscriminator: bo
         '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']),
     };
 }
 
@@ -91,6 +136,9 @@ export function PostCourseExportToJSONTyped(value?: PostCourseExport | null, ign
         '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']),
     };
 }