@easyedu/js-lsm-api 1.117.0 → 1.119.0

package/dist/models/ScormTerminateResponse.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.instanceOfScormTerminateResponse = instanceOfScormTerminateResponse;
+exports.ScormTerminateResponseFromJSON = ScormTerminateResponseFromJSON;
+exports.ScormTerminateResponseFromJSONTyped = ScormTerminateResponseFromJSONTyped;
+exports.ScormTerminateResponseToJSON = ScormTerminateResponseToJSON;
+exports.ScormTerminateResponseToJSONTyped = ScormTerminateResponseToJSONTyped;
+const ScormNavigationDelivery_1 = require("./ScormNavigationDelivery");
+/**
+ * Check if a given object implements the ScormTerminateResponse interface.
+ */
+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;
+}
+function ScormTerminateResponseFromJSON(json) {
+    return ScormTerminateResponseFromJSONTyped(json, false);
+}
+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 : (0, ScormNavigationDelivery_1.ScormNavigationDeliveryFromJSON)(json['delivery']),
+        'sequencingEnded': json['sequencing_ended'],
+        'suspended': json['suspended'],
+    };
+}
+function ScormTerminateResponseToJSON(json) {
+    return ScormTerminateResponseToJSONTyped(json, false);
+}
+function ScormTerminateResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'success': value['success'],
+        'error_code': value['errorCode'],
+        'diagnostic': value['diagnostic'],
+        'delivery': (0, ScormNavigationDelivery_1.ScormNavigationDeliveryToJSON)(value['delivery']),
+        'sequencing_ended': value['sequencingEnded'],
+        'suspended': value['suspended'],
+    };
+}

package/dist/models/ZapierSubscription.d.ts

@@ -41,6 +41,8 @@ export declare const ZapierSubscriptionEventTypeEnum: {
     readonly ComEdaxuEnrollmentEnrolledV1: "com.edaxu.enrollment.enrolled.v1";
     readonly ComEdaxuEnrollmentCompletedV1: "com.edaxu.enrollment.completed.v1";
     readonly ComEdaxuCertificateIssuedV1: "com.edaxu.certificate.issued.v1";
+    readonly ComEdaxuPortalUserInvitedV1: "com.edaxu.portal.user_invited.v1";
+    readonly ComEdaxuPortalUserJoinedV1: "com.edaxu.portal.user_joined.v1";
 };
 export type ZapierSubscriptionEventTypeEnum = typeof ZapierSubscriptionEventTypeEnum[keyof typeof ZapierSubscriptionEventTypeEnum];
 /**

package/dist/models/ZapierSubscription.js

@@ -25,7 +25,9 @@ exports.ZapierSubscriptionToJSONTyped = ZapierSubscriptionToJSONTyped;
 exports.ZapierSubscriptionEventTypeEnum = {
     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'
 };
 /**
  * Check if a given object implements the ZapierSubscription interface.

package/dist/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,13 +170,19 @@ 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';
 export * from './IntegrationEventData';
 export * from './IntegrationEventEnrollment';
+export * from './IntegrationEventInvitation';
 export * from './IntegrationEventLearner';
 export * from './IntegrationEventPortal';
+export * from './IntegrationEventUser';
 export * from './LearnerExperienceVersion';
 export * from './LibraryQuizCriteriaPreviewQuestion';
 export * from './LibraryQuizCriterion';
@@ -224,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';
@@ -290,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';
@@ -325,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/models/index.js

@@ -59,6 +59,7 @@ __exportStar(require("./CourseProgressionMode"), exports);
 __exportStar(require("./CourseShare"), exports);
 __exportStar(require("./CourseShareAcceptError"), exports);
 __exportStar(require("./CustomWebhookIntegration"), exports);
+__exportStar(require("./DispatchTokenResponse"), exports);
 __exportStar(require("./EffectiveCertificateConfig"), exports);
 __exportStar(require("./EmailTemplateDefinition"), exports);
 __exportStar(require("./EmailTemplateScope"), exports);
@@ -103,6 +104,8 @@ __exportStar(require("./GetCourseVersionSection"), exports);
 __exportStar(require("./GetCourseVersionSectionChild"), exports);
 __exportStar(require("./GetCourseVersionSectionProgression"), exports);
 __exportStar(require("./GetCourseVersionSectionReporting"), exports);
+__exportStar(require("./GetDispatchCourse"), exports);
+__exportStar(require("./GetDispatchRollup"), exports);
 __exportStar(require("./GetEffectiveLearnerExperience"), exports);
 __exportStar(require("./GetEmailAssetUpload"), exports);
 __exportStar(require("./GetEmailDelivery"), exports);
@@ -110,6 +113,8 @@ __exportStar(require("./GetEmailDeliveryList"), exports);
 __exportStar(require("./GetEmailTemplate"), exports);
 __exportStar(require("./GetEmailTemplateList"), exports);
 __exportStar(require("./GetEmailTemplatePreview"), exports);
+__exportStar(require("./GetHostedScormRegistration"), exports);
+__exportStar(require("./GetHostedScormRegistrationList"), exports);
 __exportStar(require("./GetLearnerDashboard"), exports);
 __exportStar(require("./GetLearnerDashboardCourseList"), exports);
 __exportStar(require("./GetLearnerDashboardSummary"), exports);
@@ -183,13 +188,19 @@ __exportStar(require("./GetZapierMe"), exports);
 __exportStar(require("./GetZapierSetup"), exports);
 __exportStar(require("./GetZapierShopifyCourseMappings"), exports);
 __exportStar(require("./GetZapierUsers"), exports);
+__exportStar(require("./HostedScormAccessPolicy"), exports);
+__exportStar(require("./HostedScormOutlineEntry"), exports);
+__exportStar(require("./HostedScormRollupPolicy"), exports);
+__exportStar(require("./HostedScormScoreItem"), exports);
 __exportStar(require("./IntegrationEvent"), exports);
 __exportStar(require("./IntegrationEventCertificate"), exports);
 __exportStar(require("./IntegrationEventCourse"), exports);
 __exportStar(require("./IntegrationEventData"), exports);
 __exportStar(require("./IntegrationEventEnrollment"), exports);
+__exportStar(require("./IntegrationEventInvitation"), exports);
 __exportStar(require("./IntegrationEventLearner"), exports);
 __exportStar(require("./IntegrationEventPortal"), exports);
+__exportStar(require("./IntegrationEventUser"), exports);
 __exportStar(require("./LearnerExperienceVersion"), exports);
 __exportStar(require("./LibraryQuizCriteriaPreviewQuestion"), exports);
 __exportStar(require("./LibraryQuizCriterion"), exports);
@@ -242,6 +253,11 @@ __exportStar(require("./PostCourseVersionPublish"), exports);
 __exportStar(require("./PostCourseVersionSection"), exports);
 __exportStar(require("./PostCourseVersionSectionDuplicate"), exports);
 __exportStar(require("./PostCustomWebhookIntegration"), exports);
+__exportStar(require("./PostDispatchItemLaunch"), exports);
+__exportStar(require("./PostDispatchItemLaunchResponse"), exports);
+__exportStar(require("./PostDispatchLaunch"), exports);
+__exportStar(require("./PostDispatchLaunchResponse"), exports);
+__exportStar(require("./PostDispatchTokenExchange"), exports);
 __exportStar(require("./PostDuplicate"), exports);
 __exportStar(require("./PostEmailAssetComplete"), exports);
 __exportStar(require("./PostEmailAssetUpload"), exports);
@@ -308,6 +324,7 @@ __exportStar(require("./PutCourseVersionOutlineEntryMove"), exports);
 __exportStar(require("./PutCourseVersionSection"), exports);
 __exportStar(require("./PutCustomWebhookIntegration"), exports);
 __exportStar(require("./PutEmailTemplateDraft"), exports);
+__exportStar(require("./PutHostedScormStatus"), exports);
 __exportStar(require("./PutLearnerExperienceDraft"), exports);
 __exportStar(require("./PutLibraryQuiz"), exports);
 __exportStar(require("./PutLibraryQuizCriteria"), exports);
@@ -343,8 +360,14 @@ __exportStar(require("./RichTextAsset"), exports);
 __exportStar(require("./RichTextDocument"), exports);
 __exportStar(require("./RichTextInput"), exports);
 __exportStar(require("./ScormGetValueResponse"), exports);
+__exportStar(require("./ScormNavigationDelivery"), exports);
+__exportStar(require("./ScormNavigationRequest"), exports);
+__exportStar(require("./ScormNavigationResponse"), exports);
+__exportStar(require("./ScormNavigationValidity"), exports);
+__exportStar(require("./ScormRuntimeResponse"), exports);
 __exportStar(require("./ScormSetValueRequest"), exports);
 __exportStar(require("./ScormSetValueResponse"), exports);
+__exportStar(require("./ScormTerminateResponse"), exports);
 __exportStar(require("./SupportTicketUser"), exports);
 __exportStar(require("./UpdateSelectedPortalResponse"), exports);
 __exportStar(require("./UpdateSelectedPortalResponseHostPortal"), exports);

package/docs/CourseApi.md

@@ -23,6 +23,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**getCourseVersionItemLaunch**](CourseApi.md#getcourseversionitemlaunch) | **GET** /courses/{courseId}/versions/{courseVersionId}/items/{itemId}/launch | Resolve the exact immutable resource launch selected by a course version |
 | [**getCourseVersionList**](CourseApi.md#getcourseversionlist) | **GET** /courses/{courseId}/versions | List immutable course versions and the current draft |
 | [**getCourseVersionProgression**](CourseApi.md#getcourseversionprogression) | **GET** /courses/{courseId}/versions/{courseVersionId}/progression | Get learner-specific completion and section lock state |
+| [**getHostedScormExportRegistrations**](CourseApi.md#gethostedscormexportregistrations) | **GET** /courses/{courseId}/exports/{exportId}/registrations | List hosted SCORM learner registrations |
 | [**getPortalCourseExports**](CourseApi.md#getportalcourseexports) | **GET** /course-exports | List SCORM exports owned by the current portal |
 | [**postCourse**](CourseApi.md#postcourse) | **POST** /courses | Post a new course |
 | [**postCourseDraft**](CourseApi.md#postcoursedraft) | **POST** /courses/{courseId}/draft | Create or return the single editable course draft |
@@ -45,6 +46,8 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**putCourseVersionItem**](CourseApi.md#putcourseversionitem) | **PUT** /courses/{courseId}/draft/sections/{sectionId}/items/{itemId} | Update a draft placement; use the outline move endpoint to change its parent or position |
 | [**putCourseVersionOutlineEntryMove**](CourseApi.md#putcourseversionoutlineentrymove) | **PUT** /courses/{courseId}/draft/outline/move | Move a section or item to a new parent and sibling position |
 | [**putCourseVersionSection**](CourseApi.md#putcourseversionsection) | **PUT** /courses/{courseId}/draft/sections/{sectionId} | Update a draft section |
+| [**putHostedScormExportAccess**](CourseApi.md#puthostedscormexportaccess) | **PUT** /courses/{courseId}/exports/{exportId}/access | Update mutable access controls for a hosted SCORM export |
+| [**putHostedScormExportStatus**](CourseApi.md#puthostedscormexportstatus) | **PUT** /courses/{courseId}/exports/{exportId}/status | Revoke or reactivate a hosted SCORM export |
 
 
 
@@ -1392,6 +1395,81 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## getHostedScormExportRegistrations
+
+> GetHostedScormRegistrationList getHostedScormExportRegistrations(courseId, exportId, page, pageSize)
+
+List hosted SCORM learner registrations
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseApi,
+} from '@easyedu/js-lsm-api';
+import type { GetHostedScormExportRegistrationsRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CourseApi();
+
+  const body = {
+    // string
+    courseId: courseId_example,
+    // string
+    exportId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // number (optional)
+    page: 56,
+    // number (optional)
+    pageSize: 56,
+  } satisfies GetHostedScormExportRegistrationsRequest;
+
+  try {
+    const data = await api.getHostedScormExportRegistrations(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **courseId** | `string` |  | [Defaults to `undefined`] |
+| **exportId** | `string` |  | [Defaults to `undefined`] |
+| **page** | `number` |  | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` |  | [Optional] [Defaults to `20`] |
+
+### Return type
+
+[**GetHostedScormRegistrationList**](GetHostedScormRegistrationList.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Registrations |  -  |
+| **404** | Export not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## getPortalCourseExports
 
 > GetCourseExportList getPortalCourseExports(page, pageSize, courseId, status)
@@ -2959,3 +3037,150 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
+
+## putHostedScormExportAccess
+
+> GetCourseExport putHostedScormExportAccess(courseId, exportId, body)
+
+Update mutable access controls for a hosted SCORM export
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseApi,
+} from '@easyedu/js-lsm-api';
+import type { PutHostedScormExportAccessRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CourseApi();
+
+  const body = {
+    // string
+    courseId: courseId_example,
+    // string
+    exportId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // HostedScormAccessPolicy
+    body: ...,
+  } satisfies PutHostedScormExportAccessRequest;
+
+  try {
+    const data = await api.putHostedScormExportAccess(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **courseId** | `string` |  | [Defaults to `undefined`] |
+| **exportId** | `string` |  | [Defaults to `undefined`] |
+| **body** | `HostedScormAccessPolicy` |  | |
+
+### Return type
+
+[**GetCourseExport**](GetCourseExport.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Updated export |  -  |
+| **400** | Invalid access policy |  -  |
+| **404** | Export not found |  -  |
+| **409** | Export is not a hosted course package |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## putHostedScormExportStatus
+
+> GetCourseExport putHostedScormExportStatus(courseId, exportId, putHostedScormStatus)
+
+Revoke or reactivate a hosted SCORM export
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseApi,
+} from '@easyedu/js-lsm-api';
+import type { PutHostedScormExportStatusRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CourseApi();
+
+  const body = {
+    // string
+    courseId: courseId_example,
+    // string
+    exportId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // PutHostedScormStatus
+    putHostedScormStatus: ...,
+  } satisfies PutHostedScormExportStatusRequest;
+
+  try {
+    const data = await api.putHostedScormExportStatus(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **courseId** | `string` |  | [Defaults to `undefined`] |
+| **exportId** | `string` |  | [Defaults to `undefined`] |
+| **putHostedScormStatus** | [PutHostedScormStatus](PutHostedScormStatus.md) |  | |
+
+### Return type
+
+[**GetCourseExport**](GetCourseExport.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Updated export |  -  |
+| **404** | Export not found |  -  |
+| **409** | Export is not a hosted course package |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+