@easyedu/js-lsm-api 1.117.0 → 1.119.0

package/src/models/PostDispatchLaunch.ts

@@ -0,0 +1,92 @@
+/* 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 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 function instanceOfPostDispatchLaunch(value: object): value is PostDispatchLaunch {
+    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: any): PostDispatchLaunch {
+    return PostDispatchLaunchFromJSONTyped(json, false);
+}
+
+export function PostDispatchLaunchFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostDispatchLaunch {
+    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: any): PostDispatchLaunch {
+    return PostDispatchLaunchToJSONTyped(json, false);
+}
+
+export function PostDispatchLaunchToJSONTyped(value?: PostDispatchLaunch | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'dispatch_id': value['dispatchId'],
+        'learner_id': value['learnerId'],
+        'learner_name': value['learnerName'],
+        'item_id': value['itemId'],
+    };
+}
+

package/src/models/PostDispatchLaunchResponse.ts

@@ -0,0 +1,122 @@
+/* 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 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 const PostDispatchLaunchResponseRuntimeModeEnum = {
+    LegacyMultiSco: 'LEGACY_MULTI_SCO',
+    HostedCourseV1: 'HOSTED_COURSE_V1'
+} as const;
+export type PostDispatchLaunchResponseRuntimeModeEnum = typeof PostDispatchLaunchResponseRuntimeModeEnum[keyof typeof PostDispatchLaunchResponseRuntimeModeEnum];
+
+
+/**
+ * Check if a given object implements the PostDispatchLaunchResponse interface.
+ */
+export function instanceOfPostDispatchLaunchResponse(value: object): value is PostDispatchLaunchResponse {
+    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: any): PostDispatchLaunchResponse {
+    return PostDispatchLaunchResponseFromJSONTyped(json, false);
+}
+
+export function PostDispatchLaunchResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostDispatchLaunchResponse {
+    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: any): PostDispatchLaunchResponse {
+    return PostDispatchLaunchResponseToJSONTyped(json, false);
+}
+
+export function PostDispatchLaunchResponseToJSONTyped(value?: PostDispatchLaunchResponse | null, ignoreDiscriminator: boolean = false): any {
+    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/src/models/PostDispatchTokenExchange.ts

@@ -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.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface PostDispatchTokenExchange
+ */
+export interface PostDispatchTokenExchange {
+    /**
+     * 
+     * @type {string}
+     * @memberof PostDispatchTokenExchange
+     */
+    code: string;
+}
+
+/**
+ * Check if a given object implements the PostDispatchTokenExchange interface.
+ */
+export function instanceOfPostDispatchTokenExchange(value: object): value is PostDispatchTokenExchange {
+    if (!('code' in value) || value['code'] === undefined) return false;
+    return true;
+}
+
+export function PostDispatchTokenExchangeFromJSON(json: any): PostDispatchTokenExchange {
+    return PostDispatchTokenExchangeFromJSONTyped(json, false);
+}
+
+export function PostDispatchTokenExchangeFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostDispatchTokenExchange {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'code': json['code'],
+    };
+}
+
+export function PostDispatchTokenExchangeToJSON(json: any): PostDispatchTokenExchange {
+    return PostDispatchTokenExchangeToJSONTyped(json, false);
+}
+
+export function PostDispatchTokenExchangeToJSONTyped(value?: PostDispatchTokenExchange | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'code': value['code'],
+    };
+}
+

package/src/models/PostZapierSubscription.ts

@@ -46,7 +46,9 @@ export interface PostZapierSubscription {
 export const PostZapierSubscriptionEventTypeEnum = {
     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 PostZapierSubscriptionEventTypeEnum = typeof PostZapierSubscriptionEventTypeEnum[keyof typeof PostZapierSubscriptionEventTypeEnum];
 

package/src/models/PutCustomWebhookIntegration.ts

@@ -58,7 +58,9 @@ export interface PutCustomWebhookIntegration {
 export const PutCustomWebhookIntegrationEventTypesEnum = {
     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 PutCustomWebhookIntegrationEventTypesEnum = typeof PutCustomWebhookIntegrationEventTypesEnum[keyof typeof PutCustomWebhookIntegrationEventTypesEnum];
 

package/src/models/PutHostedScormStatus.ts

@@ -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.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface PutHostedScormStatus
+ */
+export interface PutHostedScormStatus {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PutHostedScormStatus
+     */
+    active: boolean;
+}
+
+/**
+ * Check if a given object implements the PutHostedScormStatus interface.
+ */
+export function instanceOfPutHostedScormStatus(value: object): value is PutHostedScormStatus {
+    if (!('active' in value) || value['active'] === undefined) return false;
+    return true;
+}
+
+export function PutHostedScormStatusFromJSON(json: any): PutHostedScormStatus {
+    return PutHostedScormStatusFromJSONTyped(json, false);
+}
+
+export function PutHostedScormStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutHostedScormStatus {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'active': json['active'],
+    };
+}
+
+export function PutHostedScormStatusToJSON(json: any): PutHostedScormStatus {
+    return PutHostedScormStatusToJSONTyped(json, false);
+}
+
+export function PutHostedScormStatusToJSONTyped(value?: PutHostedScormStatus | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'active': value['active'],
+    };
+}
+

package/src/models/ScormGetValueResponse.ts

@@ -31,6 +31,18 @@ export interface ScormGetValueResponse {
      * @memberof ScormGetValueResponse
      */
     value: string;
+    /**
+     * Exact SCORM runtime error code for this API call
+     * @type {string}
+     * @memberof ScormGetValueResponse
+     */
+    errorCode: string;
+    /**
+     * Diagnostic detail for the error code, empty on success
+     * @type {string}
+     * @memberof ScormGetValueResponse
+     */
+    diagnostic: string;
 }
 
 /**
@@ -39,6 +51,8 @@ export interface ScormGetValueResponse {
 export function instanceOfScormGetValueResponse(value: object): value is ScormGetValueResponse {
     if (!('success' in value) || value['success'] === undefined) return false;
     if (!('value' in value) || value['value'] === undefined) return false;
+    if (!('errorCode' in value) || value['errorCode'] === undefined) return false;
+    if (!('diagnostic' in value) || value['diagnostic'] === undefined) return false;
     return true;
 }
 
@@ -54,6 +68,8 @@ export function ScormGetValueResponseFromJSONTyped(json: any, ignoreDiscriminato
         
         'success': json['success'],
         'value': json['value'],
+        'errorCode': json['error_code'],
+        'diagnostic': json['diagnostic'],
     };
 }
 
@@ -70,6 +86,8 @@ export function ScormGetValueResponseToJSONTyped(value?: ScormGetValueResponse |
         
         'success': value['success'],
         'value': value['value'],
+        'error_code': value['errorCode'],
+        'diagnostic': value['diagnostic'],
     };
 }
 

package/src/models/ScormNavigationDelivery.ts

@@ -0,0 +1,113 @@
+/* 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';
+/**
+ * Activity selected exclusively by the sequencing engine
+ * @export
+ * @interface ScormNavigationDelivery
+ */
+export interface ScormNavigationDelivery {
+    /**
+     * 
+     * @type {string}
+     * @memberof ScormNavigationDelivery
+     */
+    activityIdentifier: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ScormNavigationDelivery
+     */
+    trackingUuid: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ScormNavigationDelivery
+     */
+    launchUrl: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ScormNavigationDelivery
+     */
+    title: string;
+    /**
+     * 
+     * @type {ScormNavigationDeliveryActivityTypeEnum}
+     * @memberof ScormNavigationDelivery
+     */
+    activityType: ScormNavigationDeliveryActivityTypeEnum;
+}
+
+
+/**
+ * @export
+ */
+export const ScormNavigationDeliveryActivityTypeEnum = {
+    Sco: 'sco',
+    Asset: 'asset'
+} as const;
+export type ScormNavigationDeliveryActivityTypeEnum = typeof ScormNavigationDeliveryActivityTypeEnum[keyof typeof ScormNavigationDeliveryActivityTypeEnum];
+
+
+/**
+ * Check if a given object implements the ScormNavigationDelivery interface.
+ */
+export function instanceOfScormNavigationDelivery(value: object): value is ScormNavigationDelivery {
+    if (!('activityIdentifier' in value) || value['activityIdentifier'] === undefined) return false;
+    if (!('trackingUuid' in value) || value['trackingUuid'] === undefined) return false;
+    if (!('launchUrl' in value) || value['launchUrl'] === undefined) return false;
+    if (!('title' in value) || value['title'] === undefined) return false;
+    if (!('activityType' in value) || value['activityType'] === undefined) return false;
+    return true;
+}
+
+export function ScormNavigationDeliveryFromJSON(json: any): ScormNavigationDelivery {
+    return ScormNavigationDeliveryFromJSONTyped(json, false);
+}
+
+export function ScormNavigationDeliveryFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScormNavigationDelivery {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'activityIdentifier': json['activity_identifier'],
+        'trackingUuid': json['tracking_uuid'],
+        'launchUrl': json['launch_url'],
+        'title': json['title'],
+        'activityType': json['activity_type'],
+    };
+}
+
+export function ScormNavigationDeliveryToJSON(json: any): ScormNavigationDelivery {
+    return ScormNavigationDeliveryToJSONTyped(json, false);
+}
+
+export function ScormNavigationDeliveryToJSONTyped(value?: ScormNavigationDelivery | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'activity_identifier': value['activityIdentifier'],
+        'tracking_uuid': value['trackingUuid'],
+        'launch_url': value['launchUrl'],
+        'title': value['title'],
+        'activity_type': value['activityType'],
+    };
+}
+

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'],
+    };
+}
+