@easyedu/js-lsm-api 1.117.0 → 1.119.0

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/IntegrationEvent.ts

@@ -92,7 +92,9 @@ export type IntegrationEventSpecversionEnum = typeof IntegrationEventSpecversion
 export const IntegrationEventTypeEnum = {
     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 IntegrationEventTypeEnum = typeof IntegrationEventTypeEnum[keyof typeof IntegrationEventTypeEnum];
 

package/src/models/IntegrationEventData.ts

@@ -13,6 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
+import type { IntegrationEventUser } from './IntegrationEventUser';
+import {
+    IntegrationEventUserFromJSON,
+    IntegrationEventUserFromJSONTyped,
+    IntegrationEventUserToJSON,
+    IntegrationEventUserToJSONTyped,
+} from './IntegrationEventUser';
 import type { IntegrationEventLearner } from './IntegrationEventLearner';
 import {
     IntegrationEventLearnerFromJSON,
@@ -48,6 +55,13 @@ import {
     IntegrationEventCourseToJSON,
     IntegrationEventCourseToJSONTyped,
 } from './IntegrationEventCourse';
+import type { IntegrationEventInvitation } from './IntegrationEventInvitation';
+import {
+    IntegrationEventInvitationFromJSON,
+    IntegrationEventInvitationFromJSONTyped,
+    IntegrationEventInvitationToJSON,
+    IntegrationEventInvitationToJSONTyped,
+} from './IntegrationEventInvitation';
 
 /**
  * 
@@ -66,13 +80,19 @@ export interface IntegrationEventData {
      * @type {IntegrationEventLearner}
      * @memberof IntegrationEventData
      */
-    learner: IntegrationEventLearner;
+    learner: IntegrationEventLearner | null;
+    /**
+     * 
+     * @type {IntegrationEventUser}
+     * @memberof IntegrationEventData
+     */
+    user: IntegrationEventUser | null;
     /**
      * 
      * @type {IntegrationEventCourse}
      * @memberof IntegrationEventData
      */
-    course: IntegrationEventCourse;
+    course: IntegrationEventCourse | null;
     /**
      * 
      * @type {IntegrationEventEnrollment}
@@ -85,6 +105,12 @@ export interface IntegrationEventData {
      * @memberof IntegrationEventData
      */
     certificate: IntegrationEventCertificate | null;
+    /**
+     * 
+     * @type {IntegrationEventInvitation}
+     * @memberof IntegrationEventData
+     */
+    invitation: IntegrationEventInvitation | null;
 }
 
 /**
@@ -93,9 +119,11 @@ export interface IntegrationEventData {
 export function instanceOfIntegrationEventData(value: object): value is IntegrationEventData {
     if (!('portal' in value) || value['portal'] === undefined) return false;
     if (!('learner' in value) || value['learner'] === undefined) return false;
+    if (!('user' in value) || value['user'] === undefined) return false;
     if (!('course' in value) || value['course'] === undefined) return false;
     if (!('enrollment' in value) || value['enrollment'] === undefined) return false;
     if (!('certificate' in value) || value['certificate'] === undefined) return false;
+    if (!('invitation' in value) || value['invitation'] === undefined) return false;
     return true;
 }
 
@@ -111,9 +139,11 @@ export function IntegrationEventDataFromJSONTyped(json: any, ignoreDiscriminator
         
         'portal': IntegrationEventPortalFromJSON(json['portal']),
         'learner': IntegrationEventLearnerFromJSON(json['learner']),
+        'user': IntegrationEventUserFromJSON(json['user']),
         'course': IntegrationEventCourseFromJSON(json['course']),
         'enrollment': IntegrationEventEnrollmentFromJSON(json['enrollment']),
         'certificate': IntegrationEventCertificateFromJSON(json['certificate']),
+        'invitation': IntegrationEventInvitationFromJSON(json['invitation']),
     };
 }
 
@@ -130,9 +160,11 @@ export function IntegrationEventDataToJSONTyped(value?: IntegrationEventData | n
         
         'portal': IntegrationEventPortalToJSON(value['portal']),
         'learner': IntegrationEventLearnerToJSON(value['learner']),
+        'user': IntegrationEventUserToJSON(value['user']),
         'course': IntegrationEventCourseToJSON(value['course']),
         'enrollment': IntegrationEventEnrollmentToJSON(value['enrollment']),
         'certificate': IntegrationEventCertificateToJSON(value['certificate']),
+        'invitation': IntegrationEventInvitationToJSON(value['invitation']),
     };
 }
 

package/src/models/IntegrationEventInvitation.ts

@@ -0,0 +1,130 @@
+/* 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 { IntegrationEventUser } from './IntegrationEventUser';
+import {
+    IntegrationEventUserFromJSON,
+    IntegrationEventUserFromJSONTyped,
+    IntegrationEventUserToJSON,
+    IntegrationEventUserToJSONTyped,
+} from './IntegrationEventUser';
+
+/**
+ * Portal invitation lifecycle details for the affected user.
+ * @export
+ * @interface IntegrationEventInvitation
+ */
+export interface IntegrationEventInvitation {
+    /**
+     * Stable invitation ID.
+     * @type {string}
+     * @memberof IntegrationEventInvitation
+     */
+    id: string;
+    /**
+     * 
+     * @type {IntegrationEventInvitationStatusEnum}
+     * @memberof IntegrationEventInvitation
+     */
+    status: IntegrationEventInvitationStatusEnum;
+    /**
+     * 
+     * @type {Date}
+     * @memberof IntegrationEventInvitation
+     */
+    invitedAt: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof IntegrationEventInvitation
+     */
+    expiresAt: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof IntegrationEventInvitation
+     */
+    acceptedAt: Date | null;
+    /**
+     * 
+     * @type {IntegrationEventUser}
+     * @memberof IntegrationEventInvitation
+     */
+    invitedBy: IntegrationEventUser | null;
+}
+
+
+/**
+ * @export
+ */
+export const IntegrationEventInvitationStatusEnum = {
+    Pending: 'pending',
+    Accepted: 'accepted'
+} as const;
+export type IntegrationEventInvitationStatusEnum = typeof IntegrationEventInvitationStatusEnum[keyof typeof IntegrationEventInvitationStatusEnum];
+
+
+/**
+ * Check if a given object implements the IntegrationEventInvitation interface.
+ */
+export function instanceOfIntegrationEventInvitation(value: object): value is IntegrationEventInvitation {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('invitedAt' in value) || value['invitedAt'] === undefined) return false;
+    if (!('expiresAt' in value) || value['expiresAt'] === undefined) return false;
+    if (!('acceptedAt' in value) || value['acceptedAt'] === undefined) return false;
+    if (!('invitedBy' in value) || value['invitedBy'] === undefined) return false;
+    return true;
+}
+
+export function IntegrationEventInvitationFromJSON(json: any): IntegrationEventInvitation {
+    return IntegrationEventInvitationFromJSONTyped(json, false);
+}
+
+export function IntegrationEventInvitationFromJSONTyped(json: any, ignoreDiscriminator: boolean): IntegrationEventInvitation {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'status': json['status'],
+        'invitedAt': (new Date(json['invited_at'])),
+        'expiresAt': (new Date(json['expires_at'])),
+        'acceptedAt': (json['accepted_at'] == null ? null : new Date(json['accepted_at'])),
+        'invitedBy': IntegrationEventUserFromJSON(json['invited_by']),
+    };
+}
+
+export function IntegrationEventInvitationToJSON(json: any): IntegrationEventInvitation {
+    return IntegrationEventInvitationToJSONTyped(json, false);
+}
+
+export function IntegrationEventInvitationToJSONTyped(value?: IntegrationEventInvitation | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'status': value['status'],
+        'invited_at': value['invitedAt'].toISOString(),
+        'expires_at': value['expiresAt'].toISOString(),
+        'accepted_at': value['acceptedAt'] == null ? value['acceptedAt'] : value['acceptedAt'].toISOString(),
+        'invited_by': IntegrationEventUserToJSON(value['invitedBy']),
+    };
+}
+

package/src/models/IntegrationEventUser.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';
+/**
+ * User affected by a portal membership lifecycle event.
+ * @export
+ * @interface IntegrationEventUser
+ */
+export interface IntegrationEventUser {
+    /**
+     * Stable external user ID.
+     * @type {string}
+     * @memberof IntegrationEventUser
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IntegrationEventUser
+     */
+    email: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IntegrationEventUser
+     */
+    firstName: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IntegrationEventUser
+     */
+    lastName: string;
+}
+
+/**
+ * Check if a given object implements the IntegrationEventUser interface.
+ */
+export function instanceOfIntegrationEventUser(value: object): value is IntegrationEventUser {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('email' in value) || value['email'] === undefined) return false;
+    if (!('firstName' in value) || value['firstName'] === undefined) return false;
+    if (!('lastName' in value) || value['lastName'] === undefined) return false;
+    return true;
+}
+
+export function IntegrationEventUserFromJSON(json: any): IntegrationEventUser {
+    return IntegrationEventUserFromJSONTyped(json, false);
+}
+
+export function IntegrationEventUserFromJSONTyped(json: any, ignoreDiscriminator: boolean): IntegrationEventUser {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'email': json['email'],
+        'firstName': json['first_name'],
+        'lastName': json['last_name'],
+    };
+}
+
+export function IntegrationEventUserToJSON(json: any): IntegrationEventUser {
+    return IntegrationEventUserToJSONTyped(json, false);
+}
+
+export function IntegrationEventUserToJSONTyped(value?: IntegrationEventUser | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'email': value['email'],
+        'first_name': value['firstName'],
+        'last_name': value['lastName'],
+    };
+}
+

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

package/src/models/PostCustomWebhookIntegration.ts

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

package/src/models/PostDispatchItemLaunch.ts

@@ -0,0 +1,65 @@
+/* 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 PostDispatchItemLaunch
+ */
+export interface PostDispatchItemLaunch {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PostDispatchItemLaunch
+     */
+    retake?: boolean;
+}
+
+/**
+ * Check if a given object implements the PostDispatchItemLaunch interface.
+ */
+export function instanceOfPostDispatchItemLaunch(value: object): value is PostDispatchItemLaunch {
+    return true;
+}
+
+export function PostDispatchItemLaunchFromJSON(json: any): PostDispatchItemLaunch {
+    return PostDispatchItemLaunchFromJSONTyped(json, false);
+}
+
+export function PostDispatchItemLaunchFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostDispatchItemLaunch {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'retake': json['retake'] == null ? undefined : json['retake'],
+    };
+}
+
+export function PostDispatchItemLaunchToJSON(json: any): PostDispatchItemLaunch {
+    return PostDispatchItemLaunchToJSONTyped(json, false);
+}
+
+export function PostDispatchItemLaunchToJSONTyped(value?: PostDispatchItemLaunch | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'retake': value['retake'],
+    };
+}
+

package/src/models/PostDispatchItemLaunchResponse.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';
+/**
+ * 
+ * @export
+ * @interface PostDispatchItemLaunchResponse
+ */
+export interface PostDispatchItemLaunchResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof PostDispatchItemLaunchResponse
+     */
+    itemId: string;
+    /**
+     * 
+     * @type {PostDispatchItemLaunchResponseKindEnum}
+     * @memberof PostDispatchItemLaunchResponse
+     */
+    kind: PostDispatchItemLaunchResponseKindEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostDispatchItemLaunchResponse
+     */
+    sessionId: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof PostDispatchItemLaunchResponse
+     */
+    attemptNumber: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostDispatchItemLaunchResponse
+     */
+    launchUrl: string | null;
+}
+
+
+/**
+ * @export
+ */
+export const PostDispatchItemLaunchResponseKindEnum = {
+    Resource: 'RESOURCE',
+    Quiz: 'QUIZ'
+} as const;
+export type PostDispatchItemLaunchResponseKindEnum = typeof PostDispatchItemLaunchResponseKindEnum[keyof typeof PostDispatchItemLaunchResponseKindEnum];
+
+
+/**
+ * Check if a given object implements the PostDispatchItemLaunchResponse interface.
+ */
+export function instanceOfPostDispatchItemLaunchResponse(value: object): value is PostDispatchItemLaunchResponse {
+    if (!('itemId' in value) || value['itemId'] === undefined) return false;
+    if (!('kind' in value) || value['kind'] === undefined) return false;
+    if (!('sessionId' in value) || value['sessionId'] === undefined) return false;
+    if (!('attemptNumber' in value) || value['attemptNumber'] === undefined) return false;
+    if (!('launchUrl' in value) || value['launchUrl'] === undefined) return false;
+    return true;
+}
+
+export function PostDispatchItemLaunchResponseFromJSON(json: any): PostDispatchItemLaunchResponse {
+    return PostDispatchItemLaunchResponseFromJSONTyped(json, false);
+}
+
+export function PostDispatchItemLaunchResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostDispatchItemLaunchResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'itemId': json['item_id'],
+        'kind': json['kind'],
+        'sessionId': json['session_id'],
+        'attemptNumber': json['attempt_number'],
+        'launchUrl': json['launch_url'],
+    };
+}
+
+export function PostDispatchItemLaunchResponseToJSON(json: any): PostDispatchItemLaunchResponse {
+    return PostDispatchItemLaunchResponseToJSONTyped(json, false);
+}
+
+export function PostDispatchItemLaunchResponseToJSONTyped(value?: PostDispatchItemLaunchResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'item_id': value['itemId'],
+        'kind': value['kind'],
+        'session_id': value['sessionId'],
+        'attempt_number': value['attemptNumber'],
+        'launch_url': value['launchUrl'],
+    };
+}
+