@easyedu/js-lsm-api 1.45.0 → 1.47.0

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)

package/docs/PostCourse.md

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

package/docs/PutContentReorder.md

@@ -0,0 +1,34 @@
+
+# PutContentReorder
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ids` | Array<string>
+
+## Example
+
+```typescript
+import type { PutContentReorder } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ids": null,
+} satisfies PutContentReorder
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PutContentReorder
+console.log(exampleParsed)
+```
+
+[[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/PutCourse.md

@@ -9,7 +9,6 @@ Name | Type
 `id` | string
 `name` | string
 `description` | string
-`instructor` | string
 `published` | boolean
 
 ## Example
@@ -22,7 +21,6 @@ const example = {
   "id": null,
   "name": null,
   "description": null,
-  "instructor": null,
   "published": null,
 } satisfies PutCourse
 

package/docs/PutModule.md

@@ -8,7 +8,6 @@ Name | Type
 ------------ | -------------
 `name` | string
 `description` | string
-`order` | number
 `published` | boolean
 
 ## Example
@@ -20,7 +19,6 @@ import type { PutModule } from '@easyedu/js-lsm-api'
 const example = {
   "name": null,
   "description": null,
-  "order": null,
   "published": null,
 } satisfies PutModule
 

package/docs/PutModuleReorder.md

@@ -0,0 +1,34 @@
+
+# PutModuleReorder
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ids` | Array<string>
+
+## Example
+
+```typescript
+import type { PutModuleReorder } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ids": null,
+} satisfies PutModuleReorder
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PutModuleReorder
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easyedu/js-lsm-api",
-  "version": "1.45.0",
+  "version": "1.47.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/ContentApi.ts

@@ -31,6 +31,7 @@ import type {
   PostContentUpload,
   PostVerifyManifest,
   PutContent,
+  PutContentReorder,
   PutContentVersion,
   ScormGetValueResponse,
   ScormSetValueRequest,
@@ -69,6 +70,8 @@ import {
     PostVerifyManifestToJSON,
     PutContentFromJSON,
     PutContentToJSON,
+    PutContentReorderFromJSON,
+    PutContentReorderToJSON,
     PutContentVersionFromJSON,
     PutContentVersionToJSON,
     ScormGetValueResponseFromJSON,
@@ -187,6 +190,12 @@ export interface PutContentRequest {
     putContent: PutContent;
 }
 
+export interface PutContentReorderRequest {
+    moduleId: string;
+    courseId: string;
+    putContentReorder: PutContentReorder;
+}
+
 export interface PutContentVersionRequest {
     contentId: string;
     moduleId: string;
@@ -1305,6 +1314,68 @@ export class ContentApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for putContentReorder without sending the request
+     */
+    async putContentReorderRequestOpts(requestParameters: PutContentReorderRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['moduleId'] == null) {
+            throw new runtime.RequiredError(
+                'moduleId',
+                'Required parameter "moduleId" was null or undefined when calling putContentReorder().'
+            );
+        }
+
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling putContentReorder().'
+            );
+        }
+
+        if (requestParameters['putContentReorder'] == null) {
+            throw new runtime.RequiredError(
+                'putContentReorder',
+                'Required parameter "putContentReorder" was null or undefined when calling putContentReorder().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/courses/{courseId}/modules/{moduleId}/contents/reorder`;
+        urlPath = urlPath.replace(`{${"moduleId"}}`, encodeURIComponent(String(requestParameters['moduleId'])));
+        urlPath = urlPath.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId'])));
+
+        return {
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PutContentReorderToJSON(requestParameters['putContentReorder']),
+        };
+    }
+
+    /**
+     * Reorder content in a module
+     */
+    async putContentReorderRaw(requestParameters: PutContentReorderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.putContentReorderRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Reorder content in a module
+     */
+    async putContentReorder(requestParameters: PutContentReorderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.putContentReorderRaw(requestParameters, initOverrides);
+    }
+
     /**
      * Creates request options for putContentVersion without sending the request
      */

package/src/apis/ModuleApi.ts

@@ -19,6 +19,7 @@ import type {
   GetModuleList,
   PostModule,
   PutModule,
+  PutModuleReorder,
 } from '../models/index';
 import {
     GetModuleFromJSON,
@@ -29,6 +30,8 @@ import {
     PostModuleToJSON,
     PutModuleFromJSON,
     PutModuleToJSON,
+    PutModuleReorderFromJSON,
+    PutModuleReorderToJSON,
 } from '../models/index';
 
 export interface GetModuleRequest {
@@ -51,6 +54,11 @@ export interface PutModuleRequest {
     putModule: PutModule;
 }
 
+export interface PutModuleReorderRequest {
+    courseId: string;
+    putModuleReorder: PutModuleReorder;
+}
+
 /**
  * 
  */
@@ -272,4 +280,58 @@ export class ModuleApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for putModuleReorder without sending the request
+     */
+    async putModuleReorderRequestOpts(requestParameters: PutModuleReorderRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling putModuleReorder().'
+            );
+        }
+
+        if (requestParameters['putModuleReorder'] == null) {
+            throw new runtime.RequiredError(
+                'putModuleReorder',
+                'Required parameter "putModuleReorder" was null or undefined when calling putModuleReorder().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/courses/{courseId}/modules/reorder`;
+        urlPath = urlPath.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId'])));
+
+        return {
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PutModuleReorderToJSON(requestParameters['putModuleReorder']),
+        };
+    }
+
+    /**
+     * Reorder modules in a course
+     */
+    async putModuleReorderRaw(requestParameters: PutModuleReorderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.putModuleReorderRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Reorder modules in a course
+     */
+    async putModuleReorder(requestParameters: PutModuleReorderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.putModuleReorderRaw(requestParameters, initOverrides);
+    }
+
 }

package/src/models/PostContentQuiz.ts

@@ -65,6 +65,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}
@@ -97,6 +103,7 @@ export function PostContentQuizFromJSONTyped(json: any, ignoreDiscriminator: boo
         'description': json['description'] == null ? undefined : json['description'],
         'questionSelection': PostContentQuizQuestionSelectionFromJSON(json['question_selection']),
         'settings': PostContentQuizSettingsFromJSON(json['settings']),
+        'order': json['order'] == null ? undefined : json['order'],
         'assignment': json['assignment'] == null ? undefined : PostContentQuizAssignmentFromJSON(json['assignment']),
     };
 }
@@ -116,6 +123,7 @@ export function PostContentQuizToJSONTyped(value?: PostContentQuiz | null, ignor
         'description': value['description'],
         'question_selection': PostContentQuizQuestionSelectionToJSON(value['questionSelection']),
         'settings': PostContentQuizSettingsToJSON(value['settings']),
+        'order': value['order'],
         'assignment': PostContentQuizAssignmentToJSON(value['assignment']),
     };
 }

package/src/models/PostContentUpload.ts

@@ -31,6 +31,12 @@ export interface PostContentUpload {
      * @memberof PostContentUpload
      */
     contentType: PostContentUploadContentTypeEnum;
+    /**
+     * Display order within the module. Auto-assigned if not provided.
+     * @type {number}
+     * @memberof PostContentUpload
+     */
+    order?: number;
 }
 
 
@@ -74,6 +80,7 @@ export function PostContentUploadFromJSONTyped(json: any, ignoreDiscriminator: b
         
         'name': json['name'],
         'contentType': json['content_type'],
+        'order': json['order'] == null ? undefined : json['order'],
     };
 }
 
@@ -90,6 +97,7 @@ export function PostContentUploadToJSONTyped(value?: PostContentUpload | null, i
         
         'name': value['name'],
         'content_type': value['contentType'],
+        'order': value['order'],
     };
 }
 

package/src/models/PostCourse.ts

@@ -31,12 +31,6 @@ export interface PostCourse {
      * @memberof PostCourse
      */
     description: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof PostCourse
-     */
-    instructor: string;
 }
 
 /**
@@ -45,7 +39,6 @@ export interface PostCourse {
 export function instanceOfPostCourse(value: object): value is PostCourse {
     if (!('name' in value) || value['name'] === undefined) return false;
     if (!('description' in value) || value['description'] === undefined) return false;
-    if (!('instructor' in value) || value['instructor'] === undefined) return false;
     return true;
 }
 
@@ -61,7 +54,6 @@ export function PostCourseFromJSONTyped(json: any, ignoreDiscriminator: boolean)
         
         'name': json['name'],
         'description': json['description'],
-        'instructor': json['instructor'],
     };
 }
 
@@ -78,7 +70,6 @@ export function PostCourseToJSONTyped(value?: PostCourse | null, ignoreDiscrimin
         
         'name': value['name'],
         'description': value['description'],
-        'instructor': value['instructor'],
     };
 }
 

package/src/models/PostModule.ts

@@ -36,7 +36,7 @@ export interface PostModule {
      * @type {number}
      * @memberof PostModule
      */
-    order: number;
+    order?: number;
 }
 
 /**
@@ -45,7 +45,6 @@ export interface PostModule {
 export function instanceOfPostModule(value: object): value is PostModule {
     if (!('name' in value) || value['name'] === undefined) return false;
     if (!('description' in value) || value['description'] === undefined) return false;
-    if (!('order' in value) || value['order'] === undefined) return false;
     return true;
 }
 
@@ -61,7 +60,7 @@ export function PostModuleFromJSONTyped(json: any, ignoreDiscriminator: boolean)
         
         'name': json['name'],
         'description': json['description'],
-        'order': json['order'],
+        'order': json['order'] == null ? undefined : json['order'],
     };
 }
 

package/src/models/PutContentReorder.ts

@@ -0,0 +1,66 @@
+/* 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 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 function instanceOfPutContentReorder(value: object): value is PutContentReorder {
+    if (!('ids' in value) || value['ids'] === undefined) return false;
+    return true;
+}
+
+export function PutContentReorderFromJSON(json: any): PutContentReorder {
+    return PutContentReorderFromJSONTyped(json, false);
+}
+
+export function PutContentReorderFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutContentReorder {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ids': json['ids'],
+    };
+}
+
+export function PutContentReorderToJSON(json: any): PutContentReorder {
+    return PutContentReorderToJSONTyped(json, false);
+}
+
+export function PutContentReorderToJSONTyped(value?: PutContentReorder | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ids': value['ids'],
+    };
+}
+

package/src/models/PutCourse.ts

@@ -37,12 +37,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}
@@ -71,7 +65,6 @@ export function PutCourseFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         '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'],
     };
 }
@@ -89,7 +82,6 @@ export function PutCourseToJSONTyped(value?: Omit<PutCourse, 'id'> | null, ignor
         
         'name': value['name'],
         'description': value['description'],
-        'instructor': value['instructor'],
         'published': value['published'],
     };
 }

package/src/models/PutModule.ts

@@ -31,12 +31,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}
@@ -64,7 +58,6 @@ export function PutModuleFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         
         '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'],
     };
 }
@@ -82,7 +75,6 @@ export function PutModuleToJSONTyped(value?: PutModule | null, ignoreDiscriminat
         
         'name': value['name'],
         'description': value['description'],
-        'order': value['order'],
         'published': value['published'],
     };
 }