@easyedu/js-lsm-api 1.46.0 → 1.47.0

package/dist/esm/models/PutModule.js

@@ -27,7 +27,6 @@ export function PutModuleFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'name': json['name'] == null ? undefined : json['name'],
         'description': json['description'] == null ? undefined : json['description'],
-        'order': json['order'] == null ? undefined : json['order'],
         'published': json['published'] == null ? undefined : json['published'],
     };
 }
@@ -41,7 +40,6 @@ export function PutModuleToJSONTyped(value, ignoreDiscriminator = false) {
     return {
         'name': value['name'],
         'description': value['description'],
-        'order': value['order'],
         'published': value['published'],
     };
 }

package/dist/esm/models/PutModuleReorder.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface PutModuleReorder
+ */
+export interface PutModuleReorder {
+    /**
+     * Ordered list of module IDs
+     * @type {Array<string>}
+     * @memberof PutModuleReorder
+     */
+    ids: Array<string>;
+}
+/**
+ * Check if a given object implements the PutModuleReorder interface.
+ */
+export declare function instanceOfPutModuleReorder(value: object): value is PutModuleReorder;
+export declare function PutModuleReorderFromJSON(json: any): PutModuleReorder;
+export declare function PutModuleReorderFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutModuleReorder;
+export declare function PutModuleReorderToJSON(json: any): PutModuleReorder;
+export declare function PutModuleReorderToJSONTyped(value?: PutModuleReorder | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PutModuleReorder.js

@@ -0,0 +1,43 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the PutModuleReorder interface.
+ */
+export function instanceOfPutModuleReorder(value) {
+    if (!('ids' in value) || value['ids'] === undefined)
+        return false;
+    return true;
+}
+export function PutModuleReorderFromJSON(json) {
+    return PutModuleReorderFromJSONTyped(json, false);
+}
+export function PutModuleReorderFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'ids': json['ids'],
+    };
+}
+export function PutModuleReorderToJSON(json) {
+    return PutModuleReorderToJSONTyped(json, false);
+}
+export function PutModuleReorderToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'ids': value['ids'],
+    };
+}

package/dist/esm/models/index.d.ts

@@ -193,10 +193,12 @@ export * from './PostVerifyManifest';
 export * from './PostVerifyManifestItemsInner';
 export * from './PostVerifyManifestResourcesInner';
 export * from './PutContent';
+export * from './PutContentReorder';
 export * from './PutContentVersion';
 export * from './PutCourse';
 export * from './PutCourseEnrollment';
 export * from './PutModule';
+export * from './PutModuleReorder';
 export * from './PutPortalBranding';
 export * from './PutQuestion';
 export * from './PutQuestionAnswerChoicesInner';

package/dist/esm/models/index.js

@@ -195,10 +195,12 @@ export * from './PostVerifyManifest';
 export * from './PostVerifyManifestItemsInner';
 export * from './PostVerifyManifestResourcesInner';
 export * from './PutContent';
+export * from './PutContentReorder';
 export * from './PutContentVersion';
 export * from './PutCourse';
 export * from './PutCourseEnrollment';
 export * from './PutModule';
+export * from './PutModuleReorder';
 export * from './PutPortalBranding';
 export * from './PutQuestion';
 export * from './PutQuestionAnswerChoicesInner';

package/dist/models/PostContentQuiz.d.ts

@@ -42,6 +42,12 @@ export interface PostContentQuiz {
      * @memberof PostContentQuiz
      */
     settings: PostContentQuizSettings;
+    /**
+     * Display order within the module. Auto-assigned if not provided.
+     * @type {number}
+     * @memberof PostContentQuiz
+     */
+    order?: number;
     /**
      *
      * @type {PostContentQuizAssignment}

package/dist/models/PostContentQuiz.js

@@ -45,6 +45,7 @@ function PostContentQuizFromJSONTyped(json, ignoreDiscriminator) {
         'description': json['description'] == null ? undefined : json['description'],
         'questionSelection': (0, PostContentQuizQuestionSelection_1.PostContentQuizQuestionSelectionFromJSON)(json['question_selection']),
         'settings': (0, PostContentQuizSettings_1.PostContentQuizSettingsFromJSON)(json['settings']),
+        'order': json['order'] == null ? undefined : json['order'],
         'assignment': json['assignment'] == null ? undefined : (0, PostContentQuizAssignment_1.PostContentQuizAssignmentFromJSON)(json['assignment']),
     };
 }
@@ -60,6 +61,7 @@ function PostContentQuizToJSONTyped(value, ignoreDiscriminator = false) {
         'description': value['description'],
         'question_selection': (0, PostContentQuizQuestionSelection_1.PostContentQuizQuestionSelectionToJSON)(value['questionSelection']),
         'settings': (0, PostContentQuizSettings_1.PostContentQuizSettingsToJSON)(value['settings']),
+        'order': value['order'],
         'assignment': (0, PostContentQuizAssignment_1.PostContentQuizAssignmentToJSON)(value['assignment']),
     };
 }

package/dist/models/PostContentUpload.d.ts

@@ -27,6 +27,12 @@ export interface PostContentUpload {
      * @memberof PostContentUpload
      */
     contentType: PostContentUploadContentTypeEnum;
+    /**
+     * Display order within the module. Auto-assigned if not provided.
+     * @type {number}
+     * @memberof PostContentUpload
+     */
+    order?: number;
 }
 /**
  * @export

package/dist/models/PostContentUpload.js

@@ -55,6 +55,7 @@ function PostContentUploadFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'name': json['name'],
         'contentType': json['content_type'],
+        'order': json['order'] == null ? undefined : json['order'],
     };
 }
 function PostContentUploadToJSON(json) {
@@ -67,5 +68,6 @@ function PostContentUploadToJSONTyped(value, ignoreDiscriminator = false) {
     return {
         'name': value['name'],
         'content_type': value['contentType'],
+        'order': value['order'],
     };
 }

package/dist/models/PostModule.d.ts

@@ -32,7 +32,7 @@ export interface PostModule {
      * @type {number}
      * @memberof PostModule
      */
-    order: number;
+    order?: number;
 }
 /**
  * Check if a given object implements the PostModule interface.

package/dist/models/PostModule.js

@@ -26,8 +26,6 @@ function instanceOfPostModule(value) {
         return false;
     if (!('description' in value) || value['description'] === undefined)
         return false;
-    if (!('order' in value) || value['order'] === undefined)
-        return false;
     return true;
 }
 function PostModuleFromJSON(json) {
@@ -40,7 +38,7 @@ function PostModuleFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'name': json['name'],
         'description': json['description'],
-        'order': json['order'],
+        'order': json['order'] == null ? undefined : json['order'],
     };
 }
 function PostModuleToJSON(json) {

package/dist/models/PutContentReorder.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface PutContentReorder
+ */
+export interface PutContentReorder {
+    /**
+     * Ordered list of content IDs
+     * @type {Array<string>}
+     * @memberof PutContentReorder
+     */
+    ids: Array<string>;
+}
+/**
+ * Check if a given object implements the PutContentReorder interface.
+ */
+export declare function instanceOfPutContentReorder(value: object): value is PutContentReorder;
+export declare function PutContentReorderFromJSON(json: any): PutContentReorder;
+export declare function PutContentReorderFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutContentReorder;
+export declare function PutContentReorderToJSON(json: any): PutContentReorder;
+export declare function PutContentReorderToJSONTyped(value?: PutContentReorder | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PutContentReorder.js

@@ -0,0 +1,50 @@
+"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.instanceOfPutContentReorder = instanceOfPutContentReorder;
+exports.PutContentReorderFromJSON = PutContentReorderFromJSON;
+exports.PutContentReorderFromJSONTyped = PutContentReorderFromJSONTyped;
+exports.PutContentReorderToJSON = PutContentReorderToJSON;
+exports.PutContentReorderToJSONTyped = PutContentReorderToJSONTyped;
+/**
+ * Check if a given object implements the PutContentReorder interface.
+ */
+function instanceOfPutContentReorder(value) {
+    if (!('ids' in value) || value['ids'] === undefined)
+        return false;
+    return true;
+}
+function PutContentReorderFromJSON(json) {
+    return PutContentReorderFromJSONTyped(json, false);
+}
+function PutContentReorderFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'ids': json['ids'],
+    };
+}
+function PutContentReorderToJSON(json) {
+    return PutContentReorderToJSONTyped(json, false);
+}
+function PutContentReorderToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'ids': value['ids'],
+    };
+}

package/dist/models/PutCourse.d.ts

@@ -33,12 +33,6 @@ export interface PutCourse {
      * @memberof PutCourse
      */
     description?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof PutCourse
-     */
-    instructor?: string;
     /**
      * Whether the course is published and visible to students
      * @type {boolean}

package/dist/models/PutCourse.js

@@ -35,7 +35,6 @@ function PutCourseFromJSONTyped(json, ignoreDiscriminator) {
         'id': json['id'] == null ? undefined : json['id'],
         'name': json['name'] == null ? undefined : json['name'],
         'description': json['description'] == null ? undefined : json['description'],
-        'instructor': json['instructor'] == null ? undefined : json['instructor'],
         'published': json['published'] == null ? undefined : json['published'],
     };
 }
@@ -49,7 +48,6 @@ function PutCourseToJSONTyped(value, ignoreDiscriminator = false) {
     return {
         'name': value['name'],
         'description': value['description'],
-        'instructor': value['instructor'],
         'published': value['published'],
     };
 }

package/dist/models/PutModule.d.ts

@@ -27,12 +27,6 @@ export interface PutModule {
      * @memberof PutModule
      */
     description?: string;
-    /**
-     *
-     * @type {number}
-     * @memberof PutModule
-     */
-    order?: number;
     /**
      * Whether the module is published and visible to students
      * @type {boolean}

package/dist/models/PutModule.js

@@ -34,7 +34,6 @@ function PutModuleFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'name': json['name'] == null ? undefined : json['name'],
         'description': json['description'] == null ? undefined : json['description'],
-        'order': json['order'] == null ? undefined : json['order'],
         'published': json['published'] == null ? undefined : json['published'],
     };
 }
@@ -48,7 +47,6 @@ function PutModuleToJSONTyped(value, ignoreDiscriminator = false) {
     return {
         'name': value['name'],
         'description': value['description'],
-        'order': value['order'],
         'published': value['published'],
     };
 }

package/dist/models/PutModuleReorder.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface PutModuleReorder
+ */
+export interface PutModuleReorder {
+    /**
+     * Ordered list of module IDs
+     * @type {Array<string>}
+     * @memberof PutModuleReorder
+     */
+    ids: Array<string>;
+}
+/**
+ * Check if a given object implements the PutModuleReorder interface.
+ */
+export declare function instanceOfPutModuleReorder(value: object): value is PutModuleReorder;
+export declare function PutModuleReorderFromJSON(json: any): PutModuleReorder;
+export declare function PutModuleReorderFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutModuleReorder;
+export declare function PutModuleReorderToJSON(json: any): PutModuleReorder;
+export declare function PutModuleReorderToJSONTyped(value?: PutModuleReorder | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PutModuleReorder.js

@@ -0,0 +1,50 @@
+"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.instanceOfPutModuleReorder = instanceOfPutModuleReorder;
+exports.PutModuleReorderFromJSON = PutModuleReorderFromJSON;
+exports.PutModuleReorderFromJSONTyped = PutModuleReorderFromJSONTyped;
+exports.PutModuleReorderToJSON = PutModuleReorderToJSON;
+exports.PutModuleReorderToJSONTyped = PutModuleReorderToJSONTyped;
+/**
+ * Check if a given object implements the PutModuleReorder interface.
+ */
+function instanceOfPutModuleReorder(value) {
+    if (!('ids' in value) || value['ids'] === undefined)
+        return false;
+    return true;
+}
+function PutModuleReorderFromJSON(json) {
+    return PutModuleReorderFromJSONTyped(json, false);
+}
+function PutModuleReorderFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'ids': json['ids'],
+    };
+}
+function PutModuleReorderToJSON(json) {
+    return PutModuleReorderToJSONTyped(json, false);
+}
+function PutModuleReorderToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'ids': value['ids'],
+    };
+}

package/dist/models/index.d.ts

@@ -193,10 +193,12 @@ export * from './PostVerifyManifest';
 export * from './PostVerifyManifestItemsInner';
 export * from './PostVerifyManifestResourcesInner';
 export * from './PutContent';
+export * from './PutContentReorder';
 export * from './PutContentVersion';
 export * from './PutCourse';
 export * from './PutCourseEnrollment';
 export * from './PutModule';
+export * from './PutModuleReorder';
 export * from './PutPortalBranding';
 export * from './PutQuestion';
 export * from './PutQuestionAnswerChoicesInner';

package/dist/models/index.js

@@ -211,10 +211,12 @@ __exportStar(require("./PostVerifyManifest"), exports);
 __exportStar(require("./PostVerifyManifestItemsInner"), exports);
 __exportStar(require("./PostVerifyManifestResourcesInner"), exports);
 __exportStar(require("./PutContent"), exports);
+__exportStar(require("./PutContentReorder"), exports);
 __exportStar(require("./PutContentVersion"), exports);
 __exportStar(require("./PutCourse"), exports);
 __exportStar(require("./PutCourseEnrollment"), exports);
 __exportStar(require("./PutModule"), exports);
+__exportStar(require("./PutModuleReorder"), exports);
 __exportStar(require("./PutPortalBranding"), exports);
 __exportStar(require("./PutQuestion"), exports);
 __exportStar(require("./PutQuestionAnswerChoicesInner"), exports);

package/docs/ContentApi.md

@@ -22,6 +22,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**postContentSession**](ContentApi.md#postcontentsession) | **POST** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/session | Post a new content session |
 | [**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 |
 | [**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 |
@@ -1352,6 +1353,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)
 
 
+## putContentReorder
+
+> putContentReorder(moduleId, courseId, putContentReorder)
+
+Reorder content in a module
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ContentApi,
+} from '@easyedu/js-lsm-api';
+import type { PutContentReorderRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ContentApi();
+
+  const body = {
+    // string
+    moduleId: moduleId_example,
+    // string
+    courseId: courseId_example,
+    // PutContentReorder | Ordered list of content IDs
+    putContentReorder: ...,
+  } satisfies PutContentReorderRequest;
+
+  try {
+    const data = await api.putContentReorder(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **moduleId** | `string` |  | [Defaults to `undefined`] |
+| **courseId** | `string` |  | [Defaults to `undefined`] |
+| **putContentReorder** | [PutContentReorder](PutContentReorder.md) | Ordered list of content IDs | |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Content reordered successfully |  -  |
+
+[[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/ModuleApi.md

@@ -8,6 +8,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**getModuleList**](ModuleApi.md#getmodulelist) | **GET** /courses/{courseId}/modules | get module list |
 | [**postModule**](ModuleApi.md#postmodule) | **POST** /courses/{courseId}/modules | Post a new module |
 | [**putModule**](ModuleApi.md#putmodule) | **PUT** /courses/{courseId}/modules/{moduleId} | Update a module by id |
+| [**putModuleReorder**](ModuleApi.md#putmodulereorder) | **PUT** /courses/{courseId}/modules/reorder | Reorder modules in a course |
 
 
 
@@ -282,3 +283,71 @@ 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)
 
+
+## putModuleReorder
+
+> putModuleReorder(courseId, putModuleReorder)
+
+Reorder modules in a course
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ModuleApi,
+} from '@easyedu/js-lsm-api';
+import type { PutModuleReorderRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ModuleApi();
+
+  const body = {
+    // string
+    courseId: courseId_example,
+    // PutModuleReorder | Ordered list of module IDs
+    putModuleReorder: ...,
+  } satisfies PutModuleReorderRequest;
+
+  try {
+    const data = await api.putModuleReorder(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`] |
+| **putModuleReorder** | [PutModuleReorder](PutModuleReorder.md) | Ordered list of module IDs | |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Modules reordered successfully |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/PostContentQuiz.md

@@ -10,6 +10,7 @@ Name | Type
 `description` | string
 `questionSelection` | [PostContentQuizQuestionSelection](PostContentQuizQuestionSelection.md)
 `settings` | [PostContentQuizSettings](PostContentQuizSettings.md)
+`order` | number
 `assignment` | [PostContentQuizAssignment](PostContentQuizAssignment.md)
 
 ## Example
@@ -23,6 +24,7 @@ const example = {
   "description": null,
   "questionSelection": null,
   "settings": null,
+  "order": null,
   "assignment": null,
 } satisfies PostContentQuiz
 

package/docs/PostContentUpload.md

@@ -8,6 +8,7 @@ Name | Type
 ------------ | -------------
 `name` | string
 `contentType` | string
+`order` | number
 
 ## Example
 
@@ -18,6 +19,7 @@ import type { PostContentUpload } from '@easyedu/js-lsm-api'
 const example = {
   "name": null,
   "contentType": null,
+  "order": null,
 } satisfies PostContentUpload
 
 console.log(example)