@easyedu/js-lsm-api 1.30.0 → 1.31.0

package/docs/CourseApi.md

@@ -0,0 +1,845 @@
+# CourseApi
+
+All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com/stage1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**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 |
+| [**getCourseExport**](CourseApi.md#getcourseexport) | **GET** /courses/{courseId}/exports/{exportId} | Get details of a specific SCORM export |
+| [**getCourseExports**](CourseApi.md#getcourseexports) | **GET** /courses/{courseId}/exports | List all SCORM exports for a course |
+| [**getCourseList**](CourseApi.md#getcourselist) | **GET** /courses | get course list |
+| [**getCourseReportingBasic**](CourseApi.md#getcoursereportingbasic) | **GET** /courses/{courseId}/reporting/basic | Get basic course reporting data |
+| [**postCourse**](CourseApi.md#postcourse) | **POST** /courses | Post a new course |
+| [**postCourseEnrollment**](CourseApi.md#postcourseenrollment) | **POST** /courses/{courseId}/enrollments | Create a new course enrollment |
+| [**postCourseExport**](CourseApi.md#postcourseexport) | **POST** /courses/{courseId}/exports | Create a new SCORM export for a course |
+| [**putCourse**](CourseApi.md#putcourse) | **PUT** /courses/{courseId} | Update a course by id |
+| [**putCourseEnrollment**](CourseApi.md#putcourseenrollment) | **PUT** /courses/{courseId}/enrollments/{enrollmentId} | Update a course enrollment |
+
+
+
+## getCourse
+
+> GetCourse getCourse(courseId)
+
+get course
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseApi,
+} from '@easyedu/js-lsm-api';
+import type { GetCourseRequest } 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,
+  } satisfies GetCourseRequest;
+
+  try {
+    const data = await api.getCourse(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`] |
+
+### Return type
+
+[**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** | get course response OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getCourseEnrollment
+
+> GetCourseEnrollment getCourseEnrollment(courseId, enrollmentId)
+
+Get a specific course enrollment
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseApi,
+} from '@easyedu/js-lsm-api';
+import type { GetCourseEnrollmentRequest } 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
+    enrollmentId: enrollmentId_example,
+  } satisfies GetCourseEnrollmentRequest;
+
+  try {
+    const data = await api.getCourseEnrollment(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`] |
+| **enrollmentId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetCourseEnrollment**](GetCourseEnrollment.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | get course enrollment response OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getCourseEnrollments
+
+> GetCourseEnrollmentList getCourseEnrollments(courseId, type, page, pageSize)
+
+Get course enrollments
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseApi,
+} from '@easyedu/js-lsm-api';
+import type { GetCourseEnrollmentsRequest } 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,
+    // 'student' | 'instructor' | Filter enrollments by user type (optional)
+    type: type_example,
+    // number | Page number for pagination (optional)
+    page: 56,
+    // number | Number of items per page (optional)
+    pageSize: 56,
+  } satisfies GetCourseEnrollmentsRequest;
+
+  try {
+    const data = await api.getCourseEnrollments(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`] |
+| **type** | `student`, `instructor` | Filter enrollments by user type | [Optional] [Defaults to `undefined`] [Enum: student, instructor] |
+| **page** | `number` | Page number for pagination | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
+
+### Return type
+
+[**GetCourseEnrollmentList**](GetCourseEnrollmentList.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | get course enrollments response OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getCourseExport
+
+> GetCourseExport getCourseExport(courseId, exportId)
+
+Get details of a specific SCORM export
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseApi,
+} from '@easyedu/js-lsm-api';
+import type { GetCourseExportRequest } 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 GetCourseExportRequest;
+
+  try {
+    const data = await api.getCourseExport(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
+
+[**GetCourseExport**](GetCourseExport.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Export details |  -  |
+| **401** | Unauthorized |  -  |
+| **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)
+
+
+## getCourseExports
+
+> GetCourseExportList getCourseExports(courseId, page, pageSize)
+
+List all SCORM exports for a course
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseApi,
+} from '@easyedu/js-lsm-api';
+import type { GetCourseExportsRequest } 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,
+    // number | Page number for pagination (optional)
+    page: 56,
+    // number | Number of items per page (optional)
+    pageSize: 56,
+  } satisfies GetCourseExportsRequest;
+
+  try {
+    const data = await api.getCourseExports(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`] |
+| **page** | `number` | Page number for pagination | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
+
+### Return type
+
+[**GetCourseExportList**](GetCourseExportList.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 course exports |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | 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)
+
+
+## getCourseList
+
+> GetCourseList getCourseList(enrolled)
+
+get course list
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseApi,
+} from '@easyedu/js-lsm-api';
+import type { GetCourseListRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CourseApi();
+
+  const body = {
+    // boolean | Filter to only courses the authenticated user is enrolled in (optional)
+    enrolled: true,
+  } satisfies GetCourseListRequest;
+
+  try {
+    const data = await api.getCourseList(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **enrolled** | `boolean` | Filter to only courses the authenticated user is enrolled in | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**GetCourseList**](GetCourseList.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | get course list response OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getCourseReportingBasic
+
+> GetCourseReportingBasic getCourseReportingBasic(courseId)
+
+Get basic course reporting data
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseApi,
+} from '@easyedu/js-lsm-api';
+import type { GetCourseReportingBasicRequest } 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,
+  } satisfies GetCourseReportingBasicRequest;
+
+  try {
+    const data = await api.getCourseReportingBasic(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`] |
+
+### Return type
+
+[**GetCourseReportingBasic**](GetCourseReportingBasic.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | get course reporting basic response OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postCourse
+
+> GetCourse postCourse(postCourse)
+
+Post a new course
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseApi,
+} from '@easyedu/js-lsm-api';
+import type { PostCourseRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CourseApi();
+
+  const body = {
+    // PostCourse | Course object that needs to be added
+    postCourse: ...,
+  } satisfies PostCourseRequest;
+
+  try {
+    const data = await api.postCourse(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **postCourse** | [PostCourse](PostCourse.md) | Course object that needs to be added | |
+
+### Return type
+
+[**GetCourse**](GetCourse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | post course response OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postCourseEnrollment
+
+> GetCourseEnrollment postCourseEnrollment(courseId, postCourseEnrollment)
+
+Create a new course enrollment
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseApi,
+} from '@easyedu/js-lsm-api';
+import type { PostCourseEnrollmentRequest } 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,
+    // PostCourseEnrollment | Course enrollment object that needs to be added
+    postCourseEnrollment: ...,
+  } satisfies PostCourseEnrollmentRequest;
+
+  try {
+    const data = await api.postCourseEnrollment(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`] |
+| **postCourseEnrollment** | [PostCourseEnrollment](PostCourseEnrollment.md) | Course enrollment object that needs to be added | |
+
+### Return type
+
+[**GetCourseEnrollment**](GetCourseEnrollment.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | post course enrollment response OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postCourseExport
+
+> GetCourseExport postCourseExport(courseId, postCourseExport)
+
+Create a new SCORM export for a course
+
+Enqueues a job to generate a SCORM export package for the course. Returns immediately with PENDING status.  **NOTES:** - This endpoint enqueues a background job to generate the SCORM package - Actual SCORM package generation is not yet implemented (TODO) - Export metadata should be persisted to a database table (TODO) - Poll GET /courses/{courseId}/exports/{exportId} to check status - Download URL will be available when status becomes COMPLETED 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseApi,
+} from '@easyedu/js-lsm-api';
+import type { PostCourseExportRequest } 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,
+    // PostCourseExport | SCORM export request
+    postCourseExport: ...,
+  } satisfies PostCourseExportRequest;
+
+  try {
+    const data = await api.postCourseExport(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`] |
+| **postCourseExport** | [PostCourseExport](PostCourseExport.md) | SCORM export request | |
+
+### Return type
+
+[**GetCourseExport**](GetCourseExport.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **202** | Export job created successfully |  -  |
+| **400** | Invalid request |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | 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)
+
+
+## putCourse
+
+> GetCourse putCourse(courseId, putCourse)
+
+Update a course by id
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseApi,
+} from '@easyedu/js-lsm-api';
+import type { PutCourseRequest } 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,
+    // PutCourse | Course object that needs to be updated
+    putCourse: ...,
+  } satisfies PutCourseRequest;
+
+  try {
+    const data = await api.putCourse(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`] |
+| **putCourse** | [PutCourse](PutCourse.md) | Course object that needs to be updated | |
+
+### Return type
+
+[**GetCourse**](GetCourse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | put course response OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## putCourseEnrollment
+
+> GetCourseEnrollment putCourseEnrollment(courseId, enrollmentId, putCourseEnrollment)
+
+Update a course enrollment
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseApi,
+} from '@easyedu/js-lsm-api';
+import type { PutCourseEnrollmentRequest } 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
+    enrollmentId: enrollmentId_example,
+    // PutCourseEnrollment | Course enrollment fields to update
+    putCourseEnrollment: ...,
+  } satisfies PutCourseEnrollmentRequest;
+
+  try {
+    const data = await api.putCourseEnrollment(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`] |
+| **enrollmentId** | `string` |  | [Defaults to `undefined`] |
+| **putCourseEnrollment** | [PutCourseEnrollment](PutCourseEnrollment.md) | Course enrollment fields to update | |
+
+### Return type
+
+[**GetCourseEnrollment**](GetCourseEnrollment.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | put course enrollment response OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+