@easyedu/js-lsm-api 1.51.0 → 1.53.0

package/docs/CourseCatalogApi.md

@@ -0,0 +1,544 @@
+# CourseCatalogApi
+
+All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com/stage1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**addCourseToCatalog**](CourseCatalogApi.md#addcoursetocatalog) | **POST** /catalogs/{catalogId}/courses/{courseId} | Add a course to a catalog |
+| [**deleteCourseCatalog**](CourseCatalogApi.md#deletecoursecatalog) | **DELETE** /catalogs/{catalogId} | Delete a catalog |
+| [**getCatalogCourses**](CourseCatalogApi.md#getcatalogcourses) | **GET** /catalogs/{catalogId}/courses | List the courses in a catalog |
+| [**getCourseCatalog**](CourseCatalogApi.md#getcoursecatalog) | **GET** /catalogs/{catalogId} | Get a catalog |
+| [**getCourseCatalogs**](CourseCatalogApi.md#getcoursecatalogs) | **GET** /catalogs | List catalogs in the current portal |
+| [**postCourseCatalog**](CourseCatalogApi.md#postcoursecatalog) | **POST** /catalogs | Create a course catalog |
+| [**putCourseCatalog**](CourseCatalogApi.md#putcoursecatalog) | **PUT** /catalogs/{catalogId} | Update a catalog |
+| [**removeCourseFromCatalog**](CourseCatalogApi.md#removecoursefromcatalog) | **DELETE** /catalogs/{catalogId}/courses/{courseId} | Remove a course from a catalog |
+
+
+
+## addCourseToCatalog
+
+> addCourseToCatalog(catalogId, courseId)
+
+Add a course to a catalog
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseCatalogApi,
+} from '@easyedu/js-lsm-api';
+import type { AddCourseToCatalogRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CourseCatalogApi();
+
+  const body = {
+    // string
+    catalogId: catalogId_example,
+    // string
+    courseId: courseId_example,
+  } satisfies AddCourseToCatalogRequest;
+
+  try {
+    const data = await api.addCourseToCatalog(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **catalogId** | `string` |  | [Defaults to `undefined`] |
+| **courseId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Added |  -  |
+| **404** | Catalog 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)
+
+
+## deleteCourseCatalog
+
+> deleteCourseCatalog(catalogId)
+
+Delete a catalog
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseCatalogApi,
+} from '@easyedu/js-lsm-api';
+import type { DeleteCourseCatalogRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CourseCatalogApi();
+
+  const body = {
+    // string
+    catalogId: catalogId_example,
+  } satisfies DeleteCourseCatalogRequest;
+
+  try {
+    const data = await api.deleteCourseCatalog(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **catalogId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Deleted |  -  |
+| **404** | 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)
+
+
+## getCatalogCourses
+
+> Array<GetCourse> getCatalogCourses(catalogId)
+
+List the courses in a catalog
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseCatalogApi,
+} from '@easyedu/js-lsm-api';
+import type { GetCatalogCoursesRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CourseCatalogApi();
+
+  const body = {
+    // string
+    catalogId: catalogId_example,
+  } satisfies GetCatalogCoursesRequest;
+
+  try {
+    const data = await api.getCatalogCourses(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **catalogId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**Array<GetCourse>**](GetCourse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Courses in the catalog |  -  |
+| **403** | Catalog not owned by your portal |  -  |
+| **404** | Catalog 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)
+
+
+## getCourseCatalog
+
+> CourseCatalog getCourseCatalog(catalogId)
+
+Get a catalog
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseCatalogApi,
+} from '@easyedu/js-lsm-api';
+import type { GetCourseCatalogRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CourseCatalogApi();
+
+  const body = {
+    // string
+    catalogId: catalogId_example,
+  } satisfies GetCourseCatalogRequest;
+
+  try {
+    const data = await api.getCourseCatalog(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **catalogId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**CourseCatalog**](CourseCatalog.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Catalog details |  -  |
+| **404** | 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)
+
+
+## getCourseCatalogs
+
+> Array<CourseCatalog> getCourseCatalogs()
+
+List catalogs in the current portal
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseCatalogApi,
+} from '@easyedu/js-lsm-api';
+import type { GetCourseCatalogsRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CourseCatalogApi();
+
+  try {
+    const data = await api.getCourseCatalogs();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<CourseCatalog>**](CourseCatalog.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of catalogs |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postCourseCatalog
+
+> CourseCatalog postCourseCatalog(postCourseCatalog)
+
+Create a course catalog
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseCatalogApi,
+} from '@easyedu/js-lsm-api';
+import type { PostCourseCatalogRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CourseCatalogApi();
+
+  const body = {
+    // PostCourseCatalog
+    postCourseCatalog: ...,
+  } satisfies PostCourseCatalogRequest;
+
+  try {
+    const data = await api.postCourseCatalog(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **postCourseCatalog** | [PostCourseCatalog](PostCourseCatalog.md) |  | |
+
+### Return type
+
+[**CourseCatalog**](CourseCatalog.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Created |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## putCourseCatalog
+
+> CourseCatalog putCourseCatalog(catalogId, putCourseCatalog)
+
+Update a catalog
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseCatalogApi,
+} from '@easyedu/js-lsm-api';
+import type { PutCourseCatalogRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CourseCatalogApi();
+
+  const body = {
+    // string
+    catalogId: catalogId_example,
+    // PutCourseCatalog
+    putCourseCatalog: ...,
+  } satisfies PutCourseCatalogRequest;
+
+  try {
+    const data = await api.putCourseCatalog(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **catalogId** | `string` |  | [Defaults to `undefined`] |
+| **putCourseCatalog** | [PutCourseCatalog](PutCourseCatalog.md) |  | |
+
+### Return type
+
+[**CourseCatalog**](CourseCatalog.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 |  -  |
+| **404** | 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)
+
+
+## removeCourseFromCatalog
+
+> removeCourseFromCatalog(catalogId, courseId)
+
+Remove a course from a catalog
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseCatalogApi,
+} from '@easyedu/js-lsm-api';
+import type { RemoveCourseFromCatalogRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CourseCatalogApi();
+
+  const body = {
+    // string
+    catalogId: catalogId_example,
+    // string
+    courseId: courseId_example,
+  } satisfies RemoveCourseFromCatalogRequest;
+
+  try {
+    const data = await api.removeCourseFromCatalog(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **catalogId** | `string` |  | [Defaults to `undefined`] |
+| **courseId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Removed |  -  |
+| **404** | Catalog 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)
+

package/docs/CourseShare.md

@@ -0,0 +1,46 @@
+
+# CourseShare
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`sourcePortalId` | number
+`targetPortalId` | number
+`courseId` | number
+`allowedMode` | string
+`state` | string
+`allowResharing` | boolean
+
+## Example
+
+```typescript
+import type { CourseShare } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "sourcePortalId": null,
+  "targetPortalId": null,
+  "courseId": null,
+  "allowedMode": null,
+  "state": null,
+  "allowResharing": null,
+} satisfies CourseShare
+
+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 CourseShare
+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)
+
+