@easyedu/js-lsm-api 1.118.0 → 1.120.0

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

@@ -0,0 +1,44 @@
+/**
+ * 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.
+ */
+/**
+ * Typed result of a SCORM runtime API operation
+ * @export
+ * @interface ScormRuntimeResponse
+ */
+export interface ScormRuntimeResponse {
+    /**
+     *
+     * @type {boolean}
+     * @memberof ScormRuntimeResponse
+     */
+    success: boolean;
+    /**
+     * Exact SCORM runtime error code for this API call
+     * @type {string}
+     * @memberof ScormRuntimeResponse
+     */
+    errorCode: string;
+    /**
+     * Diagnostic detail for the error code, empty on success
+     * @type {string}
+     * @memberof ScormRuntimeResponse
+     */
+    diagnostic: string;
+}
+/**
+ * Check if a given object implements the ScormRuntimeResponse interface.
+ */
+export declare function instanceOfScormRuntimeResponse(value: object): value is ScormRuntimeResponse;
+export declare function ScormRuntimeResponseFromJSON(json: any): ScormRuntimeResponse;
+export declare function ScormRuntimeResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScormRuntimeResponse;
+export declare function ScormRuntimeResponseToJSON(json: any): ScormRuntimeResponse;
+export declare function ScormRuntimeResponseToJSONTyped(value?: ScormRuntimeResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ScormRuntimeResponse.js

@@ -0,0 +1,51 @@
+/* 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 ScormRuntimeResponse interface.
+ */
+export function instanceOfScormRuntimeResponse(value) {
+    if (!('success' in value) || value['success'] === undefined)
+        return false;
+    if (!('errorCode' in value) || value['errorCode'] === undefined)
+        return false;
+    if (!('diagnostic' in value) || value['diagnostic'] === undefined)
+        return false;
+    return true;
+}
+export function ScormRuntimeResponseFromJSON(json) {
+    return ScormRuntimeResponseFromJSONTyped(json, false);
+}
+export function ScormRuntimeResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'success': json['success'],
+        'errorCode': json['error_code'],
+        'diagnostic': json['diagnostic'],
+    };
+}
+export function ScormRuntimeResponseToJSON(json) {
+    return ScormRuntimeResponseToJSONTyped(json, false);
+}
+export function ScormRuntimeResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'success': value['success'],
+        'error_code': value['errorCode'],
+        'diagnostic': value['diagnostic'],
+    };
+}

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

@@ -21,6 +21,18 @@ export interface ScormSetValueResponse {
      * @memberof ScormSetValueResponse
      */
     success: boolean;
+    /**
+     * Exact SCORM runtime error code for this API call
+     * @type {string}
+     * @memberof ScormSetValueResponse
+     */
+    errorCode: string;
+    /**
+     * Diagnostic detail for the error code, empty on success
+     * @type {string}
+     * @memberof ScormSetValueResponse
+     */
+    diagnostic: string;
 }
 /**
  * Check if a given object implements the ScormSetValueResponse interface.

package/dist/esm/models/ScormSetValueResponse.js

@@ -17,6 +17,10 @@
 export function instanceOfScormSetValueResponse(value) {
     if (!('success' in value) || value['success'] === undefined)
         return false;
+    if (!('errorCode' in value) || value['errorCode'] === undefined)
+        return false;
+    if (!('diagnostic' in value) || value['diagnostic'] === undefined)
+        return false;
     return true;
 }
 export function ScormSetValueResponseFromJSON(json) {
@@ -28,6 +32,8 @@ export function ScormSetValueResponseFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'success': json['success'],
+        'errorCode': json['error_code'],
+        'diagnostic': json['diagnostic'],
     };
 }
 export function ScormSetValueResponseToJSON(json) {
@@ -39,5 +45,7 @@ export function ScormSetValueResponseToJSONTyped(value, ignoreDiscriminator = fa
     }
     return {
         'success': value['success'],
+        'error_code': value['errorCode'],
+        'diagnostic': value['diagnostic'],
     };
 }

package/dist/esm/models/ScormTerminateResponse.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 { ScormNavigationDelivery } from './ScormNavigationDelivery';
+/**
+ *
+ * @export
+ * @interface ScormTerminateResponse
+ */
+export interface ScormTerminateResponse {
+    /**
+     *
+     * @type {boolean}
+     * @memberof ScormTerminateResponse
+     */
+    success: boolean;
+    /**
+     * Exact SCORM runtime error code for this API call
+     * @type {string}
+     * @memberof ScormTerminateResponse
+     */
+    errorCode: string;
+    /**
+     * Diagnostic detail for the error code, empty on success
+     * @type {string}
+     * @memberof ScormTerminateResponse
+     */
+    diagnostic: string;
+    /**
+     *
+     * @type {ScormNavigationDelivery}
+     * @memberof ScormTerminateResponse
+     */
+    delivery?: ScormNavigationDelivery;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ScormTerminateResponse
+     */
+    sequencingEnded: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ScormTerminateResponse
+     */
+    suspended: boolean;
+}
+/**
+ * Check if a given object implements the ScormTerminateResponse interface.
+ */
+export declare function instanceOfScormTerminateResponse(value: object): value is ScormTerminateResponse;
+export declare function ScormTerminateResponseFromJSON(json: any): ScormTerminateResponse;
+export declare function ScormTerminateResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScormTerminateResponse;
+export declare function ScormTerminateResponseToJSON(json: any): ScormTerminateResponse;
+export declare function ScormTerminateResponseToJSONTyped(value?: ScormTerminateResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ScormTerminateResponse.js

@@ -0,0 +1,62 @@
+/* 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 { ScormNavigationDeliveryFromJSON, ScormNavigationDeliveryToJSON, } from './ScormNavigationDelivery';
+/**
+ * Check if a given object implements the ScormTerminateResponse interface.
+ */
+export function instanceOfScormTerminateResponse(value) {
+    if (!('success' in value) || value['success'] === undefined)
+        return false;
+    if (!('errorCode' in value) || value['errorCode'] === undefined)
+        return false;
+    if (!('diagnostic' in value) || value['diagnostic'] === undefined)
+        return false;
+    if (!('sequencingEnded' in value) || value['sequencingEnded'] === undefined)
+        return false;
+    if (!('suspended' in value) || value['suspended'] === undefined)
+        return false;
+    return true;
+}
+export function ScormTerminateResponseFromJSON(json) {
+    return ScormTerminateResponseFromJSONTyped(json, false);
+}
+export function ScormTerminateResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'success': json['success'],
+        'errorCode': json['error_code'],
+        'diagnostic': json['diagnostic'],
+        'delivery': json['delivery'] == null ? undefined : ScormNavigationDeliveryFromJSON(json['delivery']),
+        'sequencingEnded': json['sequencing_ended'],
+        'suspended': json['suspended'],
+    };
+}
+export function ScormTerminateResponseToJSON(json) {
+    return ScormTerminateResponseToJSONTyped(json, false);
+}
+export function ScormTerminateResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'success': value['success'],
+        'error_code': value['errorCode'],
+        'diagnostic': value['diagnostic'],
+        'delivery': ScormNavigationDeliveryToJSON(value['delivery']),
+        'sequencing_ended': value['sequencingEnded'],
+        'suspended': value['suspended'],
+    };
+}

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

@@ -41,6 +41,7 @@ export * from './CourseProgressionMode';
 export * from './CourseShare';
 export * from './CourseShareAcceptError';
 export * from './CustomWebhookIntegration';
+export * from './DispatchTokenResponse';
 export * from './EffectiveCertificateConfig';
 export * from './EmailTemplateDefinition';
 export * from './EmailTemplateScope';
@@ -85,6 +86,8 @@ export * from './GetCourseVersionSection';
 export * from './GetCourseVersionSectionChild';
 export * from './GetCourseVersionSectionProgression';
 export * from './GetCourseVersionSectionReporting';
+export * from './GetDispatchCourse';
+export * from './GetDispatchRollup';
 export * from './GetEffectiveLearnerExperience';
 export * from './GetEmailAssetUpload';
 export * from './GetEmailDelivery';
@@ -92,6 +95,8 @@ export * from './GetEmailDeliveryList';
 export * from './GetEmailTemplate';
 export * from './GetEmailTemplateList';
 export * from './GetEmailTemplatePreview';
+export * from './GetHostedScormRegistration';
+export * from './GetHostedScormRegistrationList';
 export * from './GetLearnerDashboard';
 export * from './GetLearnerDashboardCourseList';
 export * from './GetLearnerDashboardSummary';
@@ -165,6 +170,10 @@ export * from './GetZapierMe';
 export * from './GetZapierSetup';
 export * from './GetZapierShopifyCourseMappings';
 export * from './GetZapierUsers';
+export * from './HostedScormAccessPolicy';
+export * from './HostedScormOutlineEntry';
+export * from './HostedScormRollupPolicy';
+export * from './HostedScormScoreItem';
 export * from './IntegrationEvent';
 export * from './IntegrationEventCertificate';
 export * from './IntegrationEventCourse';
@@ -226,6 +235,11 @@ export * from './PostCourseVersionPublish';
 export * from './PostCourseVersionSection';
 export * from './PostCourseVersionSectionDuplicate';
 export * from './PostCustomWebhookIntegration';
+export * from './PostDispatchItemLaunch';
+export * from './PostDispatchItemLaunchResponse';
+export * from './PostDispatchLaunch';
+export * from './PostDispatchLaunchResponse';
+export * from './PostDispatchTokenExchange';
 export * from './PostDuplicate';
 export * from './PostEmailAssetComplete';
 export * from './PostEmailAssetUpload';
@@ -292,6 +306,7 @@ export * from './PutCourseVersionOutlineEntryMove';
 export * from './PutCourseVersionSection';
 export * from './PutCustomWebhookIntegration';
 export * from './PutEmailTemplateDraft';
+export * from './PutHostedScormStatus';
 export * from './PutLearnerExperienceDraft';
 export * from './PutLibraryQuiz';
 export * from './PutLibraryQuizCriteria';
@@ -327,8 +342,14 @@ export * from './RichTextAsset';
 export * from './RichTextDocument';
 export * from './RichTextInput';
 export * from './ScormGetValueResponse';
+export * from './ScormNavigationDelivery';
+export * from './ScormNavigationRequest';
+export * from './ScormNavigationResponse';
+export * from './ScormNavigationValidity';
+export * from './ScormRuntimeResponse';
 export * from './ScormSetValueRequest';
 export * from './ScormSetValueResponse';
+export * from './ScormTerminateResponse';
 export * from './SupportTicketUser';
 export * from './UpdateSelectedPortalResponse';
 export * from './UpdateSelectedPortalResponseHostPortal';

package/dist/esm/models/index.js

@@ -43,6 +43,7 @@ export * from './CourseProgressionMode';
 export * from './CourseShare';
 export * from './CourseShareAcceptError';
 export * from './CustomWebhookIntegration';
+export * from './DispatchTokenResponse';
 export * from './EffectiveCertificateConfig';
 export * from './EmailTemplateDefinition';
 export * from './EmailTemplateScope';
@@ -87,6 +88,8 @@ export * from './GetCourseVersionSection';
 export * from './GetCourseVersionSectionChild';
 export * from './GetCourseVersionSectionProgression';
 export * from './GetCourseVersionSectionReporting';
+export * from './GetDispatchCourse';
+export * from './GetDispatchRollup';
 export * from './GetEffectiveLearnerExperience';
 export * from './GetEmailAssetUpload';
 export * from './GetEmailDelivery';
@@ -94,6 +97,8 @@ export * from './GetEmailDeliveryList';
 export * from './GetEmailTemplate';
 export * from './GetEmailTemplateList';
 export * from './GetEmailTemplatePreview';
+export * from './GetHostedScormRegistration';
+export * from './GetHostedScormRegistrationList';
 export * from './GetLearnerDashboard';
 export * from './GetLearnerDashboardCourseList';
 export * from './GetLearnerDashboardSummary';
@@ -167,6 +172,10 @@ export * from './GetZapierMe';
 export * from './GetZapierSetup';
 export * from './GetZapierShopifyCourseMappings';
 export * from './GetZapierUsers';
+export * from './HostedScormAccessPolicy';
+export * from './HostedScormOutlineEntry';
+export * from './HostedScormRollupPolicy';
+export * from './HostedScormScoreItem';
 export * from './IntegrationEvent';
 export * from './IntegrationEventCertificate';
 export * from './IntegrationEventCourse';
@@ -228,6 +237,11 @@ export * from './PostCourseVersionPublish';
 export * from './PostCourseVersionSection';
 export * from './PostCourseVersionSectionDuplicate';
 export * from './PostCustomWebhookIntegration';
+export * from './PostDispatchItemLaunch';
+export * from './PostDispatchItemLaunchResponse';
+export * from './PostDispatchLaunch';
+export * from './PostDispatchLaunchResponse';
+export * from './PostDispatchTokenExchange';
 export * from './PostDuplicate';
 export * from './PostEmailAssetComplete';
 export * from './PostEmailAssetUpload';
@@ -294,6 +308,7 @@ export * from './PutCourseVersionOutlineEntryMove';
 export * from './PutCourseVersionSection';
 export * from './PutCustomWebhookIntegration';
 export * from './PutEmailTemplateDraft';
+export * from './PutHostedScormStatus';
 export * from './PutLearnerExperienceDraft';
 export * from './PutLibraryQuiz';
 export * from './PutLibraryQuizCriteria';
@@ -329,8 +344,14 @@ export * from './RichTextAsset';
 export * from './RichTextDocument';
 export * from './RichTextInput';
 export * from './ScormGetValueResponse';
+export * from './ScormNavigationDelivery';
+export * from './ScormNavigationRequest';
+export * from './ScormNavigationResponse';
+export * from './ScormNavigationValidity';
+export * from './ScormRuntimeResponse';
 export * from './ScormSetValueRequest';
 export * from './ScormSetValueResponse';
+export * from './ScormTerminateResponse';
 export * from './SupportTicketUser';
 export * from './UpdateSelectedPortalResponse';
 export * from './UpdateSelectedPortalResponseHostPortal';

package/dist/models/DispatchTokenResponse.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.
+ */
+/**
+ *
+ * @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 declare const DispatchTokenResponseTokenTypeEnum: {
+    readonly Dispatch: "Dispatch";
+};
+export type DispatchTokenResponseTokenTypeEnum = typeof DispatchTokenResponseTokenTypeEnum[keyof typeof DispatchTokenResponseTokenTypeEnum];
+/**
+ * Check if a given object implements the DispatchTokenResponse interface.
+ */
+export declare function instanceOfDispatchTokenResponse(value: object): value is DispatchTokenResponse;
+export declare function DispatchTokenResponseFromJSON(json: any): DispatchTokenResponse;
+export declare function DispatchTokenResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DispatchTokenResponse;
+export declare function DispatchTokenResponseToJSON(json: any): DispatchTokenResponse;
+export declare function DispatchTokenResponseToJSONTyped(value?: DispatchTokenResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/DispatchTokenResponse.js

@@ -0,0 +1,69 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DispatchTokenResponseTokenTypeEnum = void 0;
+exports.instanceOfDispatchTokenResponse = instanceOfDispatchTokenResponse;
+exports.DispatchTokenResponseFromJSON = DispatchTokenResponseFromJSON;
+exports.DispatchTokenResponseFromJSONTyped = DispatchTokenResponseFromJSONTyped;
+exports.DispatchTokenResponseToJSON = DispatchTokenResponseToJSON;
+exports.DispatchTokenResponseToJSONTyped = DispatchTokenResponseToJSONTyped;
+/**
+ * @export
+ */
+exports.DispatchTokenResponseTokenTypeEnum = {
+    Dispatch: 'Dispatch'
+};
+/**
+ * Check if a given object implements the DispatchTokenResponse interface.
+ */
+function instanceOfDispatchTokenResponse(value) {
+    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;
+}
+function DispatchTokenResponseFromJSON(json) {
+    return DispatchTokenResponseFromJSONTyped(json, false);
+}
+function DispatchTokenResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'accessToken': json['access_token'],
+        'tokenType': json['token_type'],
+        'registrationId': json['registration_id'],
+        'expiresAt': json['expires_at'],
+    };
+}
+function DispatchTokenResponseToJSON(json) {
+    return DispatchTokenResponseToJSONTyped(json, false);
+}
+function DispatchTokenResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'access_token': value['accessToken'],
+        'token_type': value['tokenType'],
+        'registration_id': value['registrationId'],
+        'expires_at': value['expiresAt'],
+    };
+}

package/dist/models/GetCourseExport.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';
 /**
  * Details of a course export
  * @export
@@ -87,6 +89,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;
 }
 /**
  * @export
@@ -107,6 +151,24 @@ export declare const GetCourseExportStatusEnum: {
     readonly Failed: "FAILED";
 };
 export type GetCourseExportStatusEnum = typeof GetCourseExportStatusEnum[keyof typeof GetCourseExportStatusEnum];
+/**
+ * @export
+ */
+export declare const GetCourseExportDeliveryModeEnum: {
+    readonly LegacyMultiSco: "LEGACY_MULTI_SCO";
+    readonly HostedCourseV1: "HOSTED_COURSE_V1";
+};
+export type GetCourseExportDeliveryModeEnum = typeof GetCourseExportDeliveryModeEnum[keyof typeof GetCourseExportDeliveryModeEnum];
+/**
+ * @export
+ */
+export declare const GetCourseExportRuntimeStatusEnum: {
+    readonly LegacyActive: "LEGACY_ACTIVE";
+    readonly BackendReady: "BACKEND_READY";
+    readonly PlayerUnavailable: "PLAYER_UNAVAILABLE";
+    readonly Revoked: "REVOKED";
+};
+export type GetCourseExportRuntimeStatusEnum = typeof GetCourseExportRuntimeStatusEnum[keyof typeof GetCourseExportRuntimeStatusEnum];
 /**
  * Check if a given object implements the GetCourseExport interface.
  */