@easyedu/js-lsm-api 1.118.0 → 1.119.0

package/src/models/ScormNavigationRequest.ts

@@ -0,0 +1,94 @@
+/* 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';
+/**
+ * A SCORM 2004 navigation request
+ * @export
+ * @interface ScormNavigationRequest
+ */
+export interface ScormNavigationRequest {
+    /**
+     * 
+     * @type {ScormNavigationRequestRequestEnum}
+     * @memberof ScormNavigationRequest
+     */
+    request: ScormNavigationRequestRequestEnum;
+    /**
+     * Required for choice and jump; forbidden for other requests
+     * @type {string}
+     * @memberof ScormNavigationRequest
+     */
+    targetIdentifier?: string;
+}
+
+
+/**
+ * @export
+ */
+export const ScormNavigationRequestRequestEnum = {
+    Start: 'start',
+    ResumeAll: 'resume_all',
+    Continue: 'continue',
+    Previous: 'previous',
+    Choice: 'choice',
+    Jump: 'jump',
+    Exit: 'exit',
+    ExitAll: 'exit_all',
+    Abandon: 'abandon',
+    AbandonAll: 'abandon_all',
+    SuspendAll: 'suspend_all'
+} as const;
+export type ScormNavigationRequestRequestEnum = typeof ScormNavigationRequestRequestEnum[keyof typeof ScormNavigationRequestRequestEnum];
+
+
+/**
+ * Check if a given object implements the ScormNavigationRequest interface.
+ */
+export function instanceOfScormNavigationRequest(value: object): value is ScormNavigationRequest {
+    if (!('request' in value) || value['request'] === undefined) return false;
+    return true;
+}
+
+export function ScormNavigationRequestFromJSON(json: any): ScormNavigationRequest {
+    return ScormNavigationRequestFromJSONTyped(json, false);
+}
+
+export function ScormNavigationRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScormNavigationRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'request': json['request'],
+        'targetIdentifier': json['target_identifier'] == null ? undefined : json['target_identifier'],
+    };
+}
+
+export function ScormNavigationRequestToJSON(json: any): ScormNavigationRequest {
+    return ScormNavigationRequestToJSONTyped(json, false);
+}
+
+export function ScormNavigationRequestToJSONTyped(value?: ScormNavigationRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'request': value['request'],
+        'target_identifier': value['targetIdentifier'],
+    };
+}
+

package/src/models/ScormNavigationResponse.ts

@@ -0,0 +1,134 @@
+/* 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 { ScormNavigationDelivery } from './ScormNavigationDelivery';
+import {
+    ScormNavigationDeliveryFromJSON,
+    ScormNavigationDeliveryFromJSONTyped,
+    ScormNavigationDeliveryToJSON,
+    ScormNavigationDeliveryToJSONTyped,
+} from './ScormNavigationDelivery';
+import type { ScormNavigationValidity } from './ScormNavigationValidity';
+import {
+    ScormNavigationValidityFromJSON,
+    ScormNavigationValidityFromJSONTyped,
+    ScormNavigationValidityToJSON,
+    ScormNavigationValidityToJSONTyped,
+} from './ScormNavigationValidity';
+
+/**
+ * Result of a SCORM 2004 sequencing transition
+ * @export
+ * @interface ScormNavigationResponse
+ */
+export interface ScormNavigationResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ScormNavigationResponse
+     */
+    success: boolean;
+    /**
+     * 
+     * @type {ScormNavigationDelivery}
+     * @memberof ScormNavigationResponse
+     */
+    delivery?: ScormNavigationDelivery;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ScormNavigationResponse
+     */
+    sequencingEnded: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ScormNavigationResponse
+     */
+    suspended: boolean;
+    /**
+     * 
+     * @type {ScormNavigationValidity}
+     * @memberof ScormNavigationResponse
+     */
+    valid: ScormNavigationValidity;
+    /**
+     * 
+     * @type {string}
+     * @memberof ScormNavigationResponse
+     */
+    errorCode: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ScormNavigationResponse
+     */
+    diagnostic: string;
+}
+
+/**
+ * Check if a given object implements the ScormNavigationResponse interface.
+ */
+export function instanceOfScormNavigationResponse(value: object): value is ScormNavigationResponse {
+    if (!('success' in value) || value['success'] === undefined) return false;
+    if (!('sequencingEnded' in value) || value['sequencingEnded'] === undefined) return false;
+    if (!('suspended' in value) || value['suspended'] === undefined) return false;
+    if (!('valid' in value) || value['valid'] === 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 ScormNavigationResponseFromJSON(json: any): ScormNavigationResponse {
+    return ScormNavigationResponseFromJSONTyped(json, false);
+}
+
+export function ScormNavigationResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScormNavigationResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'success': json['success'],
+        'delivery': json['delivery'] == null ? undefined : ScormNavigationDeliveryFromJSON(json['delivery']),
+        'sequencingEnded': json['sequencing_ended'],
+        'suspended': json['suspended'],
+        'valid': ScormNavigationValidityFromJSON(json['valid']),
+        'errorCode': json['error_code'],
+        'diagnostic': json['diagnostic'],
+    };
+}
+
+export function ScormNavigationResponseToJSON(json: any): ScormNavigationResponse {
+    return ScormNavigationResponseToJSONTyped(json, false);
+}
+
+export function ScormNavigationResponseToJSONTyped(value?: ScormNavigationResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'success': value['success'],
+        'delivery': ScormNavigationDeliveryToJSON(value['delivery']),
+        'sequencing_ended': value['sequencingEnded'],
+        'suspended': value['suspended'],
+        'valid': ScormNavigationValidityToJSON(value['valid']),
+        'error_code': value['errorCode'],
+        'diagnostic': value['diagnostic'],
+    };
+}
+

package/src/models/ScormNavigationValidity.ts

@@ -0,0 +1,156 @@
+/* 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';
+/**
+ * Navigation requests valid in the resulting sequencing state
+ * @export
+ * @interface ScormNavigationValidity
+ */
+export interface ScormNavigationValidity {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ScormNavigationValidity
+     */
+    start: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ScormNavigationValidity
+     */
+    resumeAll: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ScormNavigationValidity
+     */
+    _continue: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ScormNavigationValidity
+     */
+    previous: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ScormNavigationValidity
+     */
+    exit: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ScormNavigationValidity
+     */
+    exitAll: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ScormNavigationValidity
+     */
+    abandon: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ScormNavigationValidity
+     */
+    abandonAll: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ScormNavigationValidity
+     */
+    suspendAll: boolean;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof ScormNavigationValidity
+     */
+    choiceTargets: Array<string>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof ScormNavigationValidity
+     */
+    jumpTargets: Array<string>;
+}
+
+/**
+ * Check if a given object implements the ScormNavigationValidity interface.
+ */
+export function instanceOfScormNavigationValidity(value: object): value is ScormNavigationValidity {
+    if (!('start' in value) || value['start'] === undefined) return false;
+    if (!('resumeAll' in value) || value['resumeAll'] === undefined) return false;
+    if (!('_continue' in value) || value['_continue'] === undefined) return false;
+    if (!('previous' in value) || value['previous'] === undefined) return false;
+    if (!('exit' in value) || value['exit'] === undefined) return false;
+    if (!('exitAll' in value) || value['exitAll'] === undefined) return false;
+    if (!('abandon' in value) || value['abandon'] === undefined) return false;
+    if (!('abandonAll' in value) || value['abandonAll'] === undefined) return false;
+    if (!('suspendAll' in value) || value['suspendAll'] === undefined) return false;
+    if (!('choiceTargets' in value) || value['choiceTargets'] === undefined) return false;
+    if (!('jumpTargets' in value) || value['jumpTargets'] === undefined) return false;
+    return true;
+}
+
+export function ScormNavigationValidityFromJSON(json: any): ScormNavigationValidity {
+    return ScormNavigationValidityFromJSONTyped(json, false);
+}
+
+export function ScormNavigationValidityFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScormNavigationValidity {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'start': json['start'],
+        'resumeAll': json['resume_all'],
+        '_continue': json['continue'],
+        'previous': json['previous'],
+        'exit': json['exit'],
+        'exitAll': json['exit_all'],
+        'abandon': json['abandon'],
+        'abandonAll': json['abandon_all'],
+        'suspendAll': json['suspend_all'],
+        'choiceTargets': json['choice_targets'],
+        'jumpTargets': json['jump_targets'],
+    };
+}
+
+export function ScormNavigationValidityToJSON(json: any): ScormNavigationValidity {
+    return ScormNavigationValidityToJSONTyped(json, false);
+}
+
+export function ScormNavigationValidityToJSONTyped(value?: ScormNavigationValidity | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'start': value['start'],
+        'resume_all': value['resumeAll'],
+        'continue': value['_continue'],
+        'previous': value['previous'],
+        'exit': value['exit'],
+        'exit_all': value['exitAll'],
+        'abandon': value['abandon'],
+        'abandon_all': value['abandonAll'],
+        'suspend_all': value['suspendAll'],
+        'choice_targets': value['choiceTargets'],
+        'jump_targets': value['jumpTargets'],
+    };
+}
+

package/src/models/ScormRuntimeResponse.ts

@@ -0,0 +1,84 @@
+/* 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';
+/**
+ * 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 function instanceOfScormRuntimeResponse(value: object): value is ScormRuntimeResponse {
+    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: any): ScormRuntimeResponse {
+    return ScormRuntimeResponseFromJSONTyped(json, false);
+}
+
+export function ScormRuntimeResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScormRuntimeResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'success': json['success'],
+        'errorCode': json['error_code'],
+        'diagnostic': json['diagnostic'],
+    };
+}
+
+export function ScormRuntimeResponseToJSON(json: any): ScormRuntimeResponse {
+    return ScormRuntimeResponseToJSONTyped(json, false);
+}
+
+export function ScormRuntimeResponseToJSONTyped(value?: ScormRuntimeResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'success': value['success'],
+        'error_code': value['errorCode'],
+        'diagnostic': value['diagnostic'],
+    };
+}
+

package/src/models/ScormSetValueResponse.ts

@@ -25,6 +25,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;
 }
 
 /**
@@ -32,6 +44,8 @@ export interface ScormSetValueResponse {
  */
 export function instanceOfScormSetValueResponse(value: object): value is ScormSetValueResponse {
     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;
 }
 
@@ -46,6 +60,8 @@ export function ScormSetValueResponseFromJSONTyped(json: any, ignoreDiscriminato
     return {
         
         'success': json['success'],
+        'errorCode': json['error_code'],
+        'diagnostic': json['diagnostic'],
     };
 }
 
@@ -61,6 +77,8 @@ export function ScormSetValueResponseToJSONTyped(value?: ScormSetValueResponse |
     return {
         
         'success': value['success'],
+        'error_code': value['errorCode'],
+        'diagnostic': value['diagnostic'],
     };
 }
 

package/src/models/ScormTerminateResponse.ts

@@ -0,0 +1,118 @@
+/* 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 { ScormNavigationDelivery } from './ScormNavigationDelivery';
+import {
+    ScormNavigationDeliveryFromJSON,
+    ScormNavigationDeliveryFromJSONTyped,
+    ScormNavigationDeliveryToJSON,
+    ScormNavigationDeliveryToJSONTyped,
+} 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 function instanceOfScormTerminateResponse(value: object): value is ScormTerminateResponse {
+    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: any): ScormTerminateResponse {
+    return ScormTerminateResponseFromJSONTyped(json, false);
+}
+
+export function ScormTerminateResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScormTerminateResponse {
+    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: any): ScormTerminateResponse {
+    return ScormTerminateResponseToJSONTyped(json, false);
+}
+
+export function ScormTerminateResponseToJSONTyped(value?: ScormTerminateResponse | null, ignoreDiscriminator: boolean = false): any {
+    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/src/models/index.ts

@@ -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';