@easyedu/js-lsm-api 1.66.0 → 1.67.0

package/dist/esm/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/esm/models/index.js

@@ -3,12 +3,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/ContentLaunchMode.d.ts

@@ -0,0 +1,26 @@
+/**
+ * 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.
+ */
+/**
+ * How the learner player should present the launched content.
+ * @export
+ */
+export declare const ContentLaunchMode: {
+    readonly Embedded: "embedded";
+    readonly Fullscreen: "fullscreen";
+    readonly NewWindow: "new_window";
+};
+export type ContentLaunchMode = typeof ContentLaunchMode[keyof typeof ContentLaunchMode];
+export declare function instanceOfContentLaunchMode(value: any): boolean;
+export declare function ContentLaunchModeFromJSON(json: any): ContentLaunchMode;
+export declare function ContentLaunchModeFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContentLaunchMode;
+export declare function ContentLaunchModeToJSON(value?: ContentLaunchMode | null): any;
+export declare function ContentLaunchModeToJSONTyped(value: any, ignoreDiscriminator: boolean): ContentLaunchMode;

package/dist/models/ContentLaunchMode.js

@@ -0,0 +1,52 @@
+"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.ContentLaunchMode = void 0;
+exports.instanceOfContentLaunchMode = instanceOfContentLaunchMode;
+exports.ContentLaunchModeFromJSON = ContentLaunchModeFromJSON;
+exports.ContentLaunchModeFromJSONTyped = ContentLaunchModeFromJSONTyped;
+exports.ContentLaunchModeToJSON = ContentLaunchModeToJSON;
+exports.ContentLaunchModeToJSONTyped = ContentLaunchModeToJSONTyped;
+/**
+ * How the learner player should present the launched content.
+ * @export
+ */
+exports.ContentLaunchMode = {
+    Embedded: 'embedded',
+    Fullscreen: 'fullscreen',
+    NewWindow: 'new_window'
+};
+function instanceOfContentLaunchMode(value) {
+    for (const key in exports.ContentLaunchMode) {
+        if (Object.prototype.hasOwnProperty.call(exports.ContentLaunchMode, key)) {
+            if (exports.ContentLaunchMode[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+function ContentLaunchModeFromJSON(json) {
+    return ContentLaunchModeFromJSONTyped(json, false);
+}
+function ContentLaunchModeFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+function ContentLaunchModeToJSON(value) {
+    return value;
+}
+function ContentLaunchModeToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/models/GetContent.d.ts

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import type { GetContentContentData } from './GetContentContentData';
+import type { ContentLaunchMode } from './ContentLaunchMode';
 /**
  *
  * @export
@@ -46,6 +47,12 @@ export interface GetContent {
      * @memberof GetContent
      */
     contentType: GetContentContentTypeEnum;
+    /**
+     *
+     * @type {ContentLaunchMode}
+     * @memberof GetContent
+     */
+    launchMode: ContentLaunchMode;
     /**
      *
      * @type {GetContentContentData}

package/dist/models/GetContent.js

@@ -20,6 +20,7 @@ exports.GetContentFromJSONTyped = GetContentFromJSONTyped;
 exports.GetContentToJSON = GetContentToJSON;
 exports.GetContentToJSONTyped = GetContentToJSONTyped;
 const GetContentContentData_1 = require("./GetContentContentData");
+const ContentLaunchMode_1 = require("./ContentLaunchMode");
 /**
  * @export
  */
@@ -44,6 +45,8 @@ function instanceOfGetContent(value) {
         return false;
     if (!('contentType' in value) || value['contentType'] === undefined)
         return false;
+    if (!('launchMode' in value) || value['launchMode'] === undefined)
+        return false;
     if (!('contentData' in value) || value['contentData'] === undefined)
         return false;
     if (!('published' in value) || value['published'] === undefined)
@@ -63,6 +66,7 @@ function GetContentFromJSONTyped(json, ignoreDiscriminator) {
         'name': json['name'],
         'description': json['description'] == null ? undefined : json['description'],
         'contentType': json['content_type'],
+        'launchMode': (0, ContentLaunchMode_1.ContentLaunchModeFromJSON)(json['launch_mode']),
         'contentData': (0, GetContentContentData_1.GetContentContentDataFromJSON)(json['content_data']),
         'order': json['order'] == null ? undefined : json['order'],
         'published': json['published'],
@@ -85,6 +89,7 @@ function GetContentToJSONTyped(value, ignoreDiscriminator = false) {
         'name': value['name'],
         'description': value['description'],
         'content_type': value['contentType'],
+        'launch_mode': (0, ContentLaunchMode_1.ContentLaunchModeToJSON)(value['launchMode']),
         'content_data': (0, GetContentContentData_1.GetContentContentDataToJSON)(value['contentData']),
         'order': value['order'],
         'published': value['published'],

package/dist/models/GetPortal.d.ts

@@ -46,13 +46,13 @@ export interface GetPortal {
      */
     clientDomain?: string | null;
     /**
-     *
+     * API-proxied portal logo URL when a logo is configured.
      * @type {string}
      * @memberof GetPortal
      */
     logoUrl?: string | null;
     /**
-     *
+     * API-proxied portal favicon URL when a favicon is configured.
      * @type {string}
      * @memberof GetPortal
      */

package/dist/models/GetPortalFaviconUpload.d.ts

@@ -16,7 +16,7 @@
  */
 export interface GetPortalFaviconUpload {
     /**
-     * Presigned URL for the uploaded favicon image
+     * API-proxied URL for the uploaded favicon image
      * @type {string}
      * @memberof GetPortalFaviconUpload
      */

package/dist/models/GetPortalLogoUpload.d.ts

@@ -16,7 +16,7 @@
  */
 export interface GetPortalLogoUpload {
     /**
-     * Presigned URL for the uploaded logo image
+     * API-proxied URL for the uploaded logo image
      * @type {string}
      * @memberof GetPortalLogoUpload
      */

package/dist/models/GetPublicPortalBranding.d.ts

@@ -34,13 +34,13 @@ export interface GetPublicPortalBranding {
      */
     slug: string | null;
     /**
-     * Presigned portal logo URL when a logo is configured.
+     * API-proxied portal logo URL when a logo is configured.
      * @type {string}
      * @memberof GetPublicPortalBranding
      */
     logoUrl: string | null;
     /**
-     * Presigned portal favicon URL when a favicon is configured.
+     * API-proxied portal favicon URL when a favicon is configured.
      * @type {string}
      * @memberof GetPublicPortalBranding
      */

package/dist/models/PostContentSession.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { ContentLaunchMode } from './ContentLaunchMode';
 /**
  * A content session
  * @export
@@ -33,6 +34,12 @@ export interface PostContentSession {
      * @memberof PostContentSession
      */
     launchUrl: string;
+    /**
+     *
+     * @type {ContentLaunchMode}
+     * @memberof PostContentSession
+     */
+    launchMode: ContentLaunchMode;
     /**
      * The date and time the content session was created
      * @type {number}

package/dist/models/PostContentSession.js

@@ -18,6 +18,7 @@ exports.PostContentSessionFromJSON = PostContentSessionFromJSON;
 exports.PostContentSessionFromJSONTyped = PostContentSessionFromJSONTyped;
 exports.PostContentSessionToJSON = PostContentSessionToJSON;
 exports.PostContentSessionToJSONTyped = PostContentSessionToJSONTyped;
+const ContentLaunchMode_1 = require("./ContentLaunchMode");
 /**
  * Check if a given object implements the PostContentSession interface.
  */
@@ -28,6 +29,8 @@ function instanceOfPostContentSession(value) {
         return false;
     if (!('launchUrl' in value) || value['launchUrl'] === undefined)
         return false;
+    if (!('launchMode' in value) || value['launchMode'] === undefined)
+        return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined)
         return false;
     return true;
@@ -43,6 +46,7 @@ function PostContentSessionFromJSONTyped(json, ignoreDiscriminator) {
         'contentId': json['content_id'],
         'userId': json['user_id'],
         'launchUrl': json['launch_url'],
+        'launchMode': (0, ContentLaunchMode_1.ContentLaunchModeFromJSON)(json['launch_mode']),
         'createdAt': json['created_at'],
         'playerSessionId': json['player_session_id'] == null ? undefined : json['player_session_id'],
     };
@@ -58,6 +62,7 @@ function PostContentSessionToJSONTyped(value, ignoreDiscriminator = false) {
         'content_id': value['contentId'],
         'user_id': value['userId'],
         'launch_url': value['launchUrl'],
+        'launch_mode': (0, ContentLaunchMode_1.ContentLaunchModeToJSON)(value['launchMode']),
         'created_at': value['createdAt'],
         'player_session_id': value['playerSessionId'],
     };

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/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,