@easyedu/js-lsm-api 1.65.0 → 1.67.0

package/dist/models/PostCourseEnrollment.js

@@ -13,7 +13,7 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PostCourseEnrollmentUserTypeEnum = void 0;
+exports.PostCourseEnrollmentReEnrollmentModeEnum = exports.PostCourseEnrollmentUserTypeEnum = void 0;
 exports.instanceOfPostCourseEnrollment = instanceOfPostCourseEnrollment;
 exports.PostCourseEnrollmentFromJSON = PostCourseEnrollmentFromJSON;
 exports.PostCourseEnrollmentFromJSONTyped = PostCourseEnrollmentFromJSONTyped;
@@ -26,14 +26,19 @@ exports.PostCourseEnrollmentUserTypeEnum = {
     Student: 'Student',
     Instructor: 'Instructor'
 };
+/**
+ * @export
+ */
+exports.PostCourseEnrollmentReEnrollmentModeEnum = {
+    Restart: 'restart',
+    Resume: 'resume'
+};
 /**
  * Check if a given object implements the PostCourseEnrollment interface.
  */
 function instanceOfPostCourseEnrollment(value) {
     if (!('userId' in value) || value['userId'] === undefined)
         return false;
-    if (!('enrollmentDateStart' in value) || value['enrollmentDateStart'] === undefined)
-        return false;
     return true;
 }
 function PostCourseEnrollmentFromJSON(json) {
@@ -45,10 +50,11 @@ function PostCourseEnrollmentFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'userId': json['user_id'],
-        'enrollmentDateStart': json['enrollment_date_start'],
+        'enrollmentDateStart': json['enrollment_date_start'] == null ? undefined : json['enrollment_date_start'],
         'enrollmentDateEnd': json['enrollment_date_end'] == null ? undefined : json['enrollment_date_end'],
         'notes': json['notes'] == null ? undefined : json['notes'],
         'userType': json['user_type'] == null ? undefined : json['user_type'],
+        'reEnrollmentMode': json['re_enrollment_mode'] == null ? undefined : json['re_enrollment_mode'],
     };
 }
 function PostCourseEnrollmentToJSON(json) {
@@ -64,5 +70,6 @@ function PostCourseEnrollmentToJSONTyped(value, ignoreDiscriminator = false) {
         'enrollment_date_end': value['enrollmentDateEnd'],
         'notes': value['notes'],
         'user_type': value['userType'],
+        're_enrollment_mode': value['reEnrollmentMode'],
     };
 }

package/dist/models/PutContent.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { ContentLaunchMode } from './ContentLaunchMode';
 /**
  *
  * @export
@@ -27,6 +28,12 @@ export interface PutContent {
      * @memberof PutContent
      */
     published?: boolean;
+    /**
+     *
+     * @type {ContentLaunchMode}
+     * @memberof PutContent
+     */
+    launchMode?: ContentLaunchMode;
 }
 /**
  * Check if a given object implements the PutContent interface.

package/dist/models/PutContent.js

@@ -18,6 +18,7 @@ exports.PutContentFromJSON = PutContentFromJSON;
 exports.PutContentFromJSONTyped = PutContentFromJSONTyped;
 exports.PutContentToJSON = PutContentToJSON;
 exports.PutContentToJSONTyped = PutContentToJSONTyped;
+const ContentLaunchMode_1 = require("./ContentLaunchMode");
 /**
  * Check if a given object implements the PutContent interface.
  */
@@ -34,6 +35,7 @@ function PutContentFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'name': json['name'] == null ? undefined : json['name'],
         'published': json['published'] == null ? undefined : json['published'],
+        'launchMode': json['launch_mode'] == null ? undefined : (0, ContentLaunchMode_1.ContentLaunchModeFromJSON)(json['launch_mode']),
     };
 }
 function PutContentToJSON(json) {
@@ -46,5 +48,6 @@ function PutContentToJSONTyped(value, ignoreDiscriminator = false) {
     return {
         'name': value['name'],
         'published': value['published'],
+        'launch_mode': (0, ContentLaunchMode_1.ContentLaunchModeToJSON)(value['launchMode']),
     };
 }

package/dist/models/PutCourse.d.ts

@@ -39,7 +39,34 @@ export interface PutCourse {
      * @memberof PutCourse
      */
     published?: boolean;
+    /**
+     * Course-level learner access policy.
+     * @type {PutCourseAccessPolicyTypeEnum}
+     * @memberof PutCourse
+     */
+    accessPolicyType?: PutCourseAccessPolicyTypeEnum;
+    /**
+     * Number of access days from enrollment start when access_policy_type is duration_days.
+     * @type {number}
+     * @memberof PutCourse
+     */
+    accessDurationDays?: number | null;
+    /**
+     * Fixed Unix timestamp when access expires when access_policy_type is fixed_end_date.
+     * @type {number}
+     * @memberof PutCourse
+     */
+    accessFixedEndAt?: number | null;
 }
+/**
+ * @export
+ */
+export declare const PutCourseAccessPolicyTypeEnum: {
+    readonly DurationDays: "duration_days";
+    readonly FixedEndDate: "fixed_end_date";
+    readonly NeverExpires: "never_expires";
+};
+export type PutCourseAccessPolicyTypeEnum = typeof PutCourseAccessPolicyTypeEnum[keyof typeof PutCourseAccessPolicyTypeEnum];
 /**
  * Check if a given object implements the PutCourse interface.
  */

package/dist/models/PutCourse.js

@@ -13,11 +13,20 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.PutCourseAccessPolicyTypeEnum = void 0;
 exports.instanceOfPutCourse = instanceOfPutCourse;
 exports.PutCourseFromJSON = PutCourseFromJSON;
 exports.PutCourseFromJSONTyped = PutCourseFromJSONTyped;
 exports.PutCourseToJSON = PutCourseToJSON;
 exports.PutCourseToJSONTyped = PutCourseToJSONTyped;
+/**
+ * @export
+ */
+exports.PutCourseAccessPolicyTypeEnum = {
+    DurationDays: 'duration_days',
+    FixedEndDate: 'fixed_end_date',
+    NeverExpires: 'never_expires'
+};
 /**
  * Check if a given object implements the PutCourse interface.
  */
@@ -36,6 +45,9 @@ function PutCourseFromJSONTyped(json, ignoreDiscriminator) {
         'name': json['name'] == null ? undefined : json['name'],
         'description': json['description'] == null ? undefined : json['description'],
         'published': json['published'] == null ? undefined : json['published'],
+        'accessPolicyType': json['access_policy_type'] == null ? undefined : json['access_policy_type'],
+        'accessDurationDays': json['access_duration_days'] == null ? undefined : json['access_duration_days'],
+        'accessFixedEndAt': json['access_fixed_end_at'] == null ? undefined : json['access_fixed_end_at'],
     };
 }
 function PutCourseToJSON(json) {
@@ -49,5 +61,8 @@ function PutCourseToJSONTyped(value, ignoreDiscriminator = false) {
         'name': value['name'],
         'description': value['description'],
         'published': value['published'],
+        'access_policy_type': value['accessPolicyType'],
+        'access_duration_days': value['accessDurationDays'],
+        'access_fixed_end_at': value['accessFixedEndAt'],
     };
 }

package/dist/models/PutCourseEnrollment.d.ts

@@ -35,7 +35,13 @@ export interface PutCourseEnrollment {
      * @type {number}
      * @memberof PutCourseEnrollment
      */
-    enrollmentDateEnd?: number;
+    enrollmentDateEnd?: number | null;
+    /**
+     * Add this many days to the current end date, or to now if the enrollment is already expired.
+     * @type {number}
+     * @memberof PutCourseEnrollment
+     */
+    extensionDays?: number;
     /**
      * Optional notes about the enrollment
      * @type {string}
@@ -53,6 +59,7 @@ export declare const PutCourseEnrollmentStatusEnum: {
     readonly Withdrawn: "Withdrawn";
     readonly Removed: "Removed";
     readonly Archived: "Archived";
+    readonly Suspended: "Suspended";
 };
 export type PutCourseEnrollmentStatusEnum = typeof PutCourseEnrollmentStatusEnum[keyof typeof PutCourseEnrollmentStatusEnum];
 /**

package/dist/models/PutCourseEnrollment.js

@@ -28,7 +28,8 @@ exports.PutCourseEnrollmentStatusEnum = {
     Failed: 'Failed',
     Withdrawn: 'Withdrawn',
     Removed: 'Removed',
-    Archived: 'Archived'
+    Archived: 'Archived',
+    Suspended: 'Suspended'
 };
 /**
  * @export
@@ -54,6 +55,7 @@ function PutCourseEnrollmentFromJSONTyped(json, ignoreDiscriminator) {
         'status': json['status'] == null ? undefined : json['status'],
         'userType': json['user_type'] == null ? undefined : json['user_type'],
         'enrollmentDateEnd': json['enrollment_date_end'] == null ? undefined : json['enrollment_date_end'],
+        'extensionDays': json['extension_days'] == null ? undefined : json['extension_days'],
         'notes': json['notes'] == null ? undefined : json['notes'],
     };
 }
@@ -68,6 +70,7 @@ function PutCourseEnrollmentToJSONTyped(value, ignoreDiscriminator = false) {
         'status': value['status'],
         'user_type': value['userType'],
         'enrollment_date_end': value['enrollmentDateEnd'],
+        'extension_days': value['extensionDays'],
         'notes': value['notes'],
     };
 }

package/dist/models/index.d.ts

@@ -1,12 +1,12 @@
 export * from './Certificate';
 export * from './CertificateConfig';
 export * from './CertificatePublic';
+export * from './ContentLaunchMode';
 export * from './CourseCatalog';
 export * from './CourseShare';
 export * from './CriteriaBasedSelection';
 export * from './CriteriaBasedSelectionCriteria';
 export * from './CriteriaBasedSelectionDistribution';
-export * from './DownloadSupportTicketAttachment200Response';
 export * from './EffectiveCertificateConfig';
 export * from './Essay';
 export * from './Essay1';

package/dist/models/index.js

@@ -19,12 +19,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./Certificate"), exports);
 __exportStar(require("./CertificateConfig"), exports);
 __exportStar(require("./CertificatePublic"), exports);
+__exportStar(require("./ContentLaunchMode"), exports);
 __exportStar(require("./CourseCatalog"), exports);
 __exportStar(require("./CourseShare"), exports);
 __exportStar(require("./CriteriaBasedSelection"), exports);
 __exportStar(require("./CriteriaBasedSelectionCriteria"), exports);
 __exportStar(require("./CriteriaBasedSelectionDistribution"), exports);
-__exportStar(require("./DownloadSupportTicketAttachment200Response"), exports);
 __exportStar(require("./EffectiveCertificateConfig"), exports);
 __exportStar(require("./Essay"), exports);
 __exportStar(require("./Essay1"), exports);

package/docs/ContentApi.md

@@ -26,6 +26,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**postContentUpload**](ContentApi.md#postcontentupload) | **POST** /courses/{courseId}/modules/{moduleId}/contents/upload | Post a new content upload |
 | [**putContent**](ContentApi.md#putcontent) | **PUT** /courses/{courseId}/modules/{moduleId}/contents/{contentId} | Update content by id |
 | [**putContentReorder**](ContentApi.md#putcontentreorder) | **PUT** /courses/{courseId}/modules/{moduleId}/contents/reorder | Reorder content in a module |
+| [**putContentUploadFile**](ContentApi.md#putcontentuploadfile) | **PUT** /courses/{courseId}/modules/{moduleId}/contents/uploads/{uploadId}/file | Upload content file through the API |
 | [**putContentVersion**](ContentApi.md#putcontentversion) | **PUT** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/versions/{versionId} | Update a content version |
 | [**setScormValue**](ContentApi.md#setscormvalue) | **POST** /scorm/sessions/{scormSessionId}/set-value | Set a SCORM CMI data element value |
 | [**terminateScormSession**](ContentApi.md#terminatescormsession) | **POST** /scorm/sessions/{scormSessionId}/terminate | Terminate a SCORM session |
@@ -1657,6 +1658,84 @@ 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)
 
 
+## putContentUploadFile
+
+> putContentUploadFile(courseId, moduleId, uploadId, body)
+
+Upload content file through the API
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ContentApi,
+} from '@easyedu/js-lsm-api';
+import type { PutContentUploadFileRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ContentApi();
+
+  const body = {
+    // string
+    courseId: courseId_example,
+    // string
+    moduleId: moduleId_example,
+    // number
+    uploadId: 56,
+    // Blob
+    body: BINARY_DATA_HERE,
+  } satisfies PutContentUploadFileRequest;
+
+  try {
+    const data = await api.putContentUploadFile(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`] |
+| **moduleId** | `string` |  | [Defaults to `undefined`] |
+| **uploadId** | `number` |  | [Defaults to `undefined`] |
+| **body** | `Blob` |  | |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/octet-stream`
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | File uploaded successfully |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Course, module, or content upload not found |  -  |
+| **413** | File too large |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## putContentVersion
 
 > GetContentVersion putContentVersion(contentId, moduleId, courseId, versionId, putContentVersion)

package/docs/{DownloadSupportTicketAttachment200Response.md → ContentLaunchMode.md}

@@ -1,22 +1,21 @@
 
-# DownloadSupportTicketAttachment200Response
+# ContentLaunchMode
 
+How the learner player should present the launched content.
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`downloadUrl` | string
 
 ## Example
 
 ```typescript
-import type { DownloadSupportTicketAttachment200Response } from '@easyedu/js-lsm-api'
+import type { ContentLaunchMode } from '@easyedu/js-lsm-api'
 
 // TODO: Update the object below with actual values
 const example = {
-  "downloadUrl": null,
-} satisfies DownloadSupportTicketAttachment200Response
+} satisfies ContentLaunchMode
 
 console.log(example)
 
@@ -25,7 +24,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as DownloadSupportTicketAttachment200Response
+const exampleParsed = JSON.parse(exampleJSON) as ContentLaunchMode
 console.log(exampleParsed)
 ```
 

package/docs/CourseApi.md

@@ -8,6 +8,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**deleteCourseEnrollment**](CourseApi.md#deletecourseenrollment) | **DELETE** /courses/{courseId}/enrollments/{enrollmentId} | Remove a course enrollment |
 | [**deleteCourseExport**](CourseApi.md#deletecourseexport) | **DELETE** /courses/{courseId}/exports/{exportId} | Delete a course export |
 | [**deleteCourseImage**](CourseApi.md#deletecourseimage) | **DELETE** /courses/{courseId}/image | Remove the course image |
+| [**downloadCourseExport**](CourseApi.md#downloadcourseexport) | **GET** /courses/{courseId}/exports/{exportId}/download | Download a completed course export |
 | [**getCourse**](CourseApi.md#getcourse) | **GET** /courses/{courseId} | get course |
 | [**getCourseEnrollment**](CourseApi.md#getcourseenrollment) | **GET** /courses/{courseId}/enrollments/{enrollmentId} | Get a specific course enrollment |
 | [**getCourseEnrollments**](CourseApi.md#getcourseenrollments) | **GET** /courses/{courseId}/enrollments | Get course enrollments |
@@ -299,6 +300,77 @@ 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)
 
 
+## downloadCourseExport
+
+> Blob downloadCourseExport(courseId, exportId)
+
+Download a completed course export
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseApi,
+} from '@easyedu/js-lsm-api';
+import type { DownloadCourseExportRequest } 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,
+  } satisfies DownloadCourseExportRequest;
+
+  try {
+    const data = await api.downloadCourseExport(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`] |
+
+### Return type
+
+**Blob**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/zip`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Export ZIP |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Export or course 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)
+
+
 ## getCourse
 
 > GetCourse getCourse(courseId)

package/docs/GetContent.md

@@ -11,6 +11,7 @@ Name | Type
 `name` | string
 `description` | string
 `contentType` | string
+`launchMode` | [ContentLaunchMode](ContentLaunchMode.md)
 `contentData` | [GetContentContentData](GetContentContentData.md)
 `order` | number
 `published` | boolean
@@ -32,6 +33,7 @@ const example = {
   "name": null,
   "description": null,
   "contentType": null,
+  "launchMode": null,
   "contentData": null,
   "order": null,
   "published": null,

package/docs/GetCourse.md

@@ -12,6 +12,9 @@ Name | Type
 `imageUrl` | string
 `published` | boolean
 `createdAt` | number
+`accessPolicyType` | string
+`accessDurationDays` | number
+`accessFixedEndAt` | number
 
 ## Example
 
@@ -26,6 +29,9 @@ const example = {
   "imageUrl": null,
   "published": null,
   "createdAt": null,
+  "accessPolicyType": null,
+  "accessDurationDays": null,
+  "accessFixedEndAt": null,
 } satisfies GetCourse
 
 console.log(example)

package/docs/GetCourseEnrollment.md

@@ -14,6 +14,8 @@ Name | Type
 `enrollmentDateEnd` | number
 `notes` | string
 `status` | string
+`accessState` | string
+`daysUntilExpiry` | number
 `userType` | string
 `completionDate` | number
 
@@ -31,6 +33,8 @@ const example = {
   "enrollmentDateEnd": null,
   "notes": null,
   "status": null,
+  "accessState": null,
+  "daysUntilExpiry": null,
   "userType": null,
   "completionDate": null,
 } satisfies GetCourseEnrollment

package/docs/GetCourseEnrollmentListItem.md

@@ -15,6 +15,8 @@ Name | Type
 `enrollmentDateStart` | number
 `enrollmentDateEnd` | number
 `status` | string
+`accessState` | string
+`daysUntilExpiry` | number
 `userType` | string
 `completionDate` | number
 
@@ -33,6 +35,8 @@ const example = {
   "enrollmentDateStart": null,
   "enrollmentDateEnd": null,
   "status": null,
+  "accessState": null,
+  "daysUntilExpiry": null,
   "userType": null,
   "completionDate": null,
 } satisfies GetCourseEnrollmentListItem