@easyedu/js-lsm-api 1.117.0 → 1.119.0

package/src/models/CustomWebhookIntegration.ts

@@ -76,7 +76,9 @@ export interface CustomWebhookIntegration {
 export const CustomWebhookIntegrationEventTypesEnum = {
     ComEdaxuEnrollmentEnrolledV1: 'com.edaxu.enrollment.enrolled.v1',
     ComEdaxuEnrollmentCompletedV1: 'com.edaxu.enrollment.completed.v1',
-    ComEdaxuCertificateIssuedV1: 'com.edaxu.certificate.issued.v1'
+    ComEdaxuCertificateIssuedV1: 'com.edaxu.certificate.issued.v1',
+    ComEdaxuPortalUserInvitedV1: 'com.edaxu.portal.user_invited.v1',
+    ComEdaxuPortalUserJoinedV1: 'com.edaxu.portal.user_joined.v1'
 } as const;
 export type CustomWebhookIntegrationEventTypesEnum = typeof CustomWebhookIntegrationEventTypesEnum[keyof typeof CustomWebhookIntegrationEventTypesEnum];
 

package/src/models/DispatchTokenResponse.ts

@@ -0,0 +1,103 @@
+/* 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 DispatchTokenResponse
+ */
+export interface DispatchTokenResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof DispatchTokenResponse
+     */
+    accessToken: string;
+    /**
+     * 
+     * @type {DispatchTokenResponseTokenTypeEnum}
+     * @memberof DispatchTokenResponse
+     */
+    tokenType: DispatchTokenResponseTokenTypeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof DispatchTokenResponse
+     */
+    registrationId: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof DispatchTokenResponse
+     */
+    expiresAt: number;
+}
+
+
+/**
+ * @export
+ */
+export const DispatchTokenResponseTokenTypeEnum = {
+    Dispatch: 'Dispatch'
+} as const;
+export type DispatchTokenResponseTokenTypeEnum = typeof DispatchTokenResponseTokenTypeEnum[keyof typeof DispatchTokenResponseTokenTypeEnum];
+
+
+/**
+ * Check if a given object implements the DispatchTokenResponse interface.
+ */
+export function instanceOfDispatchTokenResponse(value: object): value is DispatchTokenResponse {
+    if (!('accessToken' in value) || value['accessToken'] === undefined) return false;
+    if (!('tokenType' in value) || value['tokenType'] === 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 DispatchTokenResponseFromJSON(json: any): DispatchTokenResponse {
+    return DispatchTokenResponseFromJSONTyped(json, false);
+}
+
+export function DispatchTokenResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DispatchTokenResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'accessToken': json['access_token'],
+        'tokenType': json['token_type'],
+        'registrationId': json['registration_id'],
+        'expiresAt': json['expires_at'],
+    };
+}
+
+export function DispatchTokenResponseToJSON(json: any): DispatchTokenResponse {
+    return DispatchTokenResponseToJSONTyped(json, false);
+}
+
+export function DispatchTokenResponseToJSONTyped(value?: DispatchTokenResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'access_token': value['accessToken'],
+        'token_type': value['tokenType'],
+        'registration_id': value['registrationId'],
+        'expires_at': value['expiresAt'],
+    };
+}
+

package/src/models/GetCourseExport.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';
+
 /**
  * Details of a course export
  * @export
@@ -91,6 +106,48 @@ export interface GetCourseExport {
      * @memberof GetCourseExport
      */
     createdAt: number;
+    /**
+     * Runtime package shape used by this export.
+     * @type {GetCourseExportDeliveryModeEnum}
+     * @memberof GetCourseExport
+     */
+    deliveryMode: GetCourseExportDeliveryModeEnum;
+    /**
+     * 
+     * @type {HostedScormRollupPolicy}
+     * @memberof GetCourseExport
+     */
+    rollupPolicy: HostedScormRollupPolicy;
+    /**
+     * 
+     * @type {HostedScormAccessPolicy}
+     * @memberof GetCourseExport
+     */
+    accessPolicy: HostedScormAccessPolicy;
+    /**
+     * 
+     * @type {GetCourseExportRuntimeStatusEnum}
+     * @memberof GetCourseExport
+     */
+    runtimeStatus: GetCourseExportRuntimeStatusEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetCourseExport
+     */
+    registeredLearners: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetCourseExport
+     */
+    totalLaunches: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetCourseExport
+     */
+    lastLaunchAt?: number | null;
 }
 
 
@@ -115,6 +172,26 @@ export const GetCourseExportStatusEnum = {
 } as const;
 export type GetCourseExportStatusEnum = typeof GetCourseExportStatusEnum[keyof typeof GetCourseExportStatusEnum];
 
+/**
+ * @export
+ */
+export const GetCourseExportDeliveryModeEnum = {
+    LegacyMultiSco: 'LEGACY_MULTI_SCO',
+    HostedCourseV1: 'HOSTED_COURSE_V1'
+} as const;
+export type GetCourseExportDeliveryModeEnum = typeof GetCourseExportDeliveryModeEnum[keyof typeof GetCourseExportDeliveryModeEnum];
+
+/**
+ * @export
+ */
+export const GetCourseExportRuntimeStatusEnum = {
+    LegacyActive: 'LEGACY_ACTIVE',
+    BackendReady: 'BACKEND_READY',
+    PlayerUnavailable: 'PLAYER_UNAVAILABLE',
+    Revoked: 'REVOKED'
+} as const;
+export type GetCourseExportRuntimeStatusEnum = typeof GetCourseExportRuntimeStatusEnum[keyof typeof GetCourseExportRuntimeStatusEnum];
+
 
 /**
  * Check if a given object implements the GetCourseExport interface.
@@ -128,6 +205,12 @@ export function instanceOfGetCourseExport(value: object): value is GetCourseExpo
     if (!('createdBy' in value) || value['createdBy'] === undefined) return false;
     if (!('status' in value) || value['status'] === undefined) return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('deliveryMode' in value) || value['deliveryMode'] === undefined) return false;
+    if (!('rollupPolicy' in value) || value['rollupPolicy'] === undefined) return false;
+    if (!('accessPolicy' in value) || value['accessPolicy'] === undefined) return false;
+    if (!('runtimeStatus' in value) || value['runtimeStatus'] === undefined) return false;
+    if (!('registeredLearners' in value) || value['registeredLearners'] === undefined) return false;
+    if (!('totalLaunches' in value) || value['totalLaunches'] === undefined) return false;
     return true;
 }
 
@@ -153,6 +236,13 @@ export function GetCourseExportFromJSONTyped(json: any, ignoreDiscriminator: boo
         'fileSize': json['file_size'] == null ? undefined : json['file_size'],
         'errorMessage': json['error_message'] == null ? undefined : json['error_message'],
         'createdAt': json['created_at'],
+        'deliveryMode': json['delivery_mode'],
+        'rollupPolicy': HostedScormRollupPolicyFromJSON(json['rollup_policy']),
+        'accessPolicy': HostedScormAccessPolicyFromJSON(json['access_policy']),
+        'runtimeStatus': json['runtime_status'],
+        'registeredLearners': json['registered_learners'],
+        'totalLaunches': json['total_launches'],
+        'lastLaunchAt': json['last_launch_at'] == null ? undefined : json['last_launch_at'],
     };
 }
 
@@ -179,6 +269,13 @@ export function GetCourseExportToJSONTyped(value?: GetCourseExport | null, ignor
         'file_size': value['fileSize'],
         'error_message': value['errorMessage'],
         'created_at': value['createdAt'],
+        'delivery_mode': value['deliveryMode'],
+        'rollup_policy': HostedScormRollupPolicyToJSON(value['rollupPolicy']),
+        'access_policy': HostedScormAccessPolicyToJSON(value['accessPolicy']),
+        'runtime_status': value['runtimeStatus'],
+        'registered_learners': value['registeredLearners'],
+        'total_launches': value['totalLaunches'],
+        'last_launch_at': value['lastLaunchAt'],
     };
 }
 

package/src/models/GetDispatchCourse.ts

@@ -0,0 +1,153 @@
+/* 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 { HostedScormOutlineEntry } from './HostedScormOutlineEntry';
+import {
+    HostedScormOutlineEntryFromJSON,
+    HostedScormOutlineEntryFromJSONTyped,
+    HostedScormOutlineEntryToJSON,
+    HostedScormOutlineEntryToJSONTyped,
+} from './HostedScormOutlineEntry';
+import type { GetDispatchRollup } from './GetDispatchRollup';
+import {
+    GetDispatchRollupFromJSON,
+    GetDispatchRollupFromJSONTyped,
+    GetDispatchRollupToJSON,
+    GetDispatchRollupToJSONTyped,
+} from './GetDispatchRollup';
+
+/**
+ * 
+ * @export
+ * @interface GetDispatchCourse
+ */
+export interface GetDispatchCourse {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetDispatchCourse
+     */
+    dispatchId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetDispatchCourse
+     */
+    registrationId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetDispatchCourse
+     */
+    courseId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetDispatchCourse
+     */
+    courseVersionId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetDispatchCourse
+     */
+    title: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetDispatchCourse
+     */
+    progressionMode: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetDispatchCourse
+     */
+    currentItemId: string | null;
+    /**
+     * 
+     * @type {Array<HostedScormOutlineEntry>}
+     * @memberof GetDispatchCourse
+     */
+    outline: Array<HostedScormOutlineEntry>;
+    /**
+     * 
+     * @type {GetDispatchRollup}
+     * @memberof GetDispatchCourse
+     */
+    rollup: GetDispatchRollup;
+}
+
+/**
+ * Check if a given object implements the GetDispatchCourse interface.
+ */
+export function instanceOfGetDispatchCourse(value: object): value is GetDispatchCourse {
+    if (!('dispatchId' in value) || value['dispatchId'] === undefined) return false;
+    if (!('registrationId' in value) || value['registrationId'] === undefined) return false;
+    if (!('courseId' in value) || value['courseId'] === undefined) return false;
+    if (!('courseVersionId' in value) || value['courseVersionId'] === undefined) return false;
+    if (!('title' in value) || value['title'] === undefined) return false;
+    if (!('progressionMode' in value) || value['progressionMode'] === undefined) return false;
+    if (!('currentItemId' in value) || value['currentItemId'] === undefined) return false;
+    if (!('outline' in value) || value['outline'] === undefined) return false;
+    if (!('rollup' in value) || value['rollup'] === undefined) return false;
+    return true;
+}
+
+export function GetDispatchCourseFromJSON(json: any): GetDispatchCourse {
+    return GetDispatchCourseFromJSONTyped(json, false);
+}
+
+export function GetDispatchCourseFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetDispatchCourse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'dispatchId': json['dispatch_id'],
+        'registrationId': json['registration_id'],
+        'courseId': json['course_id'],
+        'courseVersionId': json['course_version_id'],
+        'title': json['title'],
+        'progressionMode': json['progression_mode'],
+        'currentItemId': json['current_item_id'],
+        'outline': ((json['outline'] as Array<any>).map(HostedScormOutlineEntryFromJSON)),
+        'rollup': GetDispatchRollupFromJSON(json['rollup']),
+    };
+}
+
+export function GetDispatchCourseToJSON(json: any): GetDispatchCourse {
+    return GetDispatchCourseToJSONTyped(json, false);
+}
+
+export function GetDispatchCourseToJSONTyped(value?: GetDispatchCourse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'dispatch_id': value['dispatchId'],
+        'registration_id': value['registrationId'],
+        'course_id': value['courseId'],
+        'course_version_id': value['courseVersionId'],
+        'title': value['title'],
+        'progression_mode': value['progressionMode'],
+        'current_item_id': value['currentItemId'],
+        'outline': ((value['outline'] as Array<any>).map(HostedScormOutlineEntryToJSON)),
+        'rollup': GetDispatchRollupToJSON(value['rollup']),
+    };
+}
+

package/src/models/GetDispatchRollup.ts

@@ -0,0 +1,169 @@
+/* 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 GetDispatchRollup
+ */
+export interface GetDispatchRollup {
+    /**
+     * 
+     * @type {GetDispatchRollupCompletionStatusEnum}
+     * @memberof GetDispatchRollup
+     */
+    completionStatus: GetDispatchRollupCompletionStatusEnum;
+    /**
+     * 
+     * @type {GetDispatchRollupSuccessStatusEnum}
+     * @memberof GetDispatchRollup
+     */
+    successStatus: GetDispatchRollupSuccessStatusEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetDispatchRollup
+     */
+    scoreRaw: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetDispatchRollup
+     */
+    scoreScaled: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetDispatchRollup
+     */
+    progressMeasure: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetDispatchRollup
+     */
+    totalItems: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetDispatchRollup
+     */
+    completedItems: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetDispatchRollup
+     */
+    requiredItems: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetDispatchRollup
+     */
+    completedRequiredItems: number;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof GetDispatchRollup
+     */
+    pendingManualGrading: boolean;
+}
+
+
+/**
+ * @export
+ */
+export const GetDispatchRollupCompletionStatusEnum = {
+    NotAttempted: 'not_attempted',
+    Incomplete: 'incomplete',
+    Completed: 'completed'
+} as const;
+export type GetDispatchRollupCompletionStatusEnum = typeof GetDispatchRollupCompletionStatusEnum[keyof typeof GetDispatchRollupCompletionStatusEnum];
+
+/**
+ * @export
+ */
+export const GetDispatchRollupSuccessStatusEnum = {
+    Unknown: 'unknown',
+    Passed: 'passed',
+    Failed: 'failed'
+} as const;
+export type GetDispatchRollupSuccessStatusEnum = typeof GetDispatchRollupSuccessStatusEnum[keyof typeof GetDispatchRollupSuccessStatusEnum];
+
+
+/**
+ * Check if a given object implements the GetDispatchRollup interface.
+ */
+export function instanceOfGetDispatchRollup(value: object): value is GetDispatchRollup {
+    if (!('completionStatus' in value) || value['completionStatus'] === undefined) return false;
+    if (!('successStatus' in value) || value['successStatus'] === undefined) return false;
+    if (!('scoreRaw' in value) || value['scoreRaw'] === undefined) return false;
+    if (!('scoreScaled' in value) || value['scoreScaled'] === undefined) return false;
+    if (!('progressMeasure' in value) || value['progressMeasure'] === undefined) return false;
+    if (!('totalItems' in value) || value['totalItems'] === undefined) return false;
+    if (!('completedItems' in value) || value['completedItems'] === undefined) return false;
+    if (!('requiredItems' in value) || value['requiredItems'] === undefined) return false;
+    if (!('completedRequiredItems' in value) || value['completedRequiredItems'] === undefined) return false;
+    if (!('pendingManualGrading' in value) || value['pendingManualGrading'] === undefined) return false;
+    return true;
+}
+
+export function GetDispatchRollupFromJSON(json: any): GetDispatchRollup {
+    return GetDispatchRollupFromJSONTyped(json, false);
+}
+
+export function GetDispatchRollupFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetDispatchRollup {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'completionStatus': json['completion_status'],
+        'successStatus': json['success_status'],
+        'scoreRaw': json['score_raw'],
+        'scoreScaled': json['score_scaled'],
+        'progressMeasure': json['progress_measure'],
+        'totalItems': json['total_items'],
+        'completedItems': json['completed_items'],
+        'requiredItems': json['required_items'],
+        'completedRequiredItems': json['completed_required_items'],
+        'pendingManualGrading': json['pending_manual_grading'],
+    };
+}
+
+export function GetDispatchRollupToJSON(json: any): GetDispatchRollup {
+    return GetDispatchRollupToJSONTyped(json, false);
+}
+
+export function GetDispatchRollupToJSONTyped(value?: GetDispatchRollup | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'completion_status': value['completionStatus'],
+        'success_status': value['successStatus'],
+        'score_raw': value['scoreRaw'],
+        'score_scaled': value['scoreScaled'],
+        'progress_measure': value['progressMeasure'],
+        'total_items': value['totalItems'],
+        'completed_items': value['completedItems'],
+        'required_items': value['requiredItems'],
+        'completed_required_items': value['completedRequiredItems'],
+        'pending_manual_grading': value['pendingManualGrading'],
+    };
+}
+