@easyedu/js-lsm-api 1.29.0 → 1.31.0

package/docs/ReportingApi.md

@@ -0,0 +1,674 @@
+# ReportingApi
+
+All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com/stage1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getContentGradeDetail**](ReportingApi.md#getcontentgradedetail) | **GET** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/reporting/grades/{studentId} | Get detailed grade information for a specific student and content (can use \'current\' for studentId) |
+| [**getContentGrades**](ReportingApi.md#getcontentgrades) | **GET** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/reporting/grades | Get grades for all students enrolled in course for specific content |
+| [**getContentInstructorBasicReporting**](ReportingApi.md#getcontentinstructorbasicreporting) | **GET** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/reporting/instructor/basic | Get basic instructor reporting for content |
+| [**getCourseInstructorReportingBasic**](ReportingApi.md#getcourseinstructorreportingbasic) | **GET** /courses/{courseId}/reporting/instructor/basic | Get basic course reporting data for instructors |
+| [**getCourseStudentReporting**](ReportingApi.md#getcoursestudentreporting) | **GET** /courses/{courseId}/reporting/students/{studentId} | Get student-specific reporting for a course (can use \'current\' for studentId) |
+| [**getModuleInstructorBasicReporting**](ReportingApi.md#getmoduleinstructorbasicreporting) | **GET** /courses/{courseId}/modules/{moduleId}/reporting/instructor/basic | Get basic instructor reporting for a module |
+| [**getModuleStudentReporting**](ReportingApi.md#getmodulestudentreporting) | **GET** /courses/{courseId}/modules/{moduleId}/reporting/students/{studentId} | Get student-specific reporting for a module (can use \'current\' for studentId) |
+| [**getPortalBasicReporting**](ReportingApi.md#getportalbasicreporting) | **GET** /portals/{portalId}/reporting/basic | Get basic reporting for a portal (can use \'current\' for portalId) |
+| [**getPortalStudentReporting**](ReportingApi.md#getportalstudentreporting) | **GET** /portals/{portalId}/reporting/students/{studentId} | Get student reporting for a portal (can use \'current\' for portalId and studentId) |
+
+
+
+## getContentGradeDetail
+
+> GetContentGradeDetail getContentGradeDetail(courseId, moduleId, contentId, studentId)
+
+Get detailed grade information for a specific student and content (can use \'current\' for studentId)
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReportingApi,
+} from '@easyedu/js-lsm-api';
+import type { GetContentGradeDetailRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ReportingApi();
+
+  const body = {
+    // string
+    courseId: courseId_example,
+    // string
+    moduleId: moduleId_example,
+    // string
+    contentId: contentId_example,
+    // string | The student\'s external ID
+    studentId: studentId_example,
+  } satisfies GetContentGradeDetailRequest;
+
+  try {
+    const data = await api.getContentGradeDetail(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`] |
+| **contentId** | `string` |  | [Defaults to `undefined`] |
+| **studentId** | `string` | The student\'s external ID | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetContentGradeDetail**](GetContentGradeDetail.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful response |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Course, module, content, or student 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)
+
+
+## getContentGrades
+
+> GetContentGrades getContentGrades(courseId, moduleId, contentId, page, pageSize, search)
+
+Get grades for all students enrolled in course for specific content
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReportingApi,
+} from '@easyedu/js-lsm-api';
+import type { GetContentGradesRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ReportingApi();
+
+  const body = {
+    // string
+    courseId: courseId_example,
+    // string
+    moduleId: moduleId_example,
+    // string
+    contentId: contentId_example,
+    // number | Page number for pagination (optional)
+    page: 56,
+    // number | Number of items per page (optional)
+    pageSize: 56,
+    // string | Search filter for user first name or last name (optional)
+    search: search_example,
+  } satisfies GetContentGradesRequest;
+
+  try {
+    const data = await api.getContentGrades(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`] |
+| **contentId** | `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`] |
+| **search** | `string` | Search filter for user first name or last name | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**GetContentGrades**](GetContentGrades.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful response |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Course, module, or content 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)
+
+
+## getContentInstructorBasicReporting
+
+> GetContentInstructorBasicReporting getContentInstructorBasicReporting(courseId, moduleId, contentId)
+
+Get basic instructor reporting for content
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReportingApi,
+} from '@easyedu/js-lsm-api';
+import type { GetContentInstructorBasicReportingRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ReportingApi();
+
+  const body = {
+    // string
+    courseId: courseId_example,
+    // string
+    moduleId: moduleId_example,
+    // string
+    contentId: contentId_example,
+  } satisfies GetContentInstructorBasicReportingRequest;
+
+  try {
+    const data = await api.getContentInstructorBasicReporting(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`] |
+| **contentId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetContentInstructorBasicReporting**](GetContentInstructorBasicReporting.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful response |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Course, module, or content 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)
+
+
+## getCourseInstructorReportingBasic
+
+> GetCourseReportingBasic getCourseInstructorReportingBasic(courseId)
+
+Get basic course reporting data for instructors
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReportingApi,
+} from '@easyedu/js-lsm-api';
+import type { GetCourseInstructorReportingBasicRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ReportingApi();
+
+  const body = {
+    // string
+    courseId: courseId_example,
+  } satisfies GetCourseInstructorReportingBasicRequest;
+
+  try {
+    const data = await api.getCourseInstructorReportingBasic(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** | Successful response |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **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)
+
+
+## getCourseStudentReporting
+
+> GetCourseStudentReporting getCourseStudentReporting(courseId, studentId)
+
+Get student-specific reporting for a course (can use \'current\' for studentId)
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReportingApi,
+} from '@easyedu/js-lsm-api';
+import type { GetCourseStudentReportingRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ReportingApi();
+
+  const body = {
+    // string
+    courseId: courseId_example,
+    // string | The student\'s external ID
+    studentId: studentId_example,
+  } satisfies GetCourseStudentReportingRequest;
+
+  try {
+    const data = await api.getCourseStudentReporting(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`] |
+| **studentId** | `string` | The student\'s external ID | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetCourseStudentReporting**](GetCourseStudentReporting.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful response |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Course or student 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)
+
+
+## getModuleInstructorBasicReporting
+
+> GetModuleInstructorBasicReporting getModuleInstructorBasicReporting(courseId, moduleId)
+
+Get basic instructor reporting for a module
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReportingApi,
+} from '@easyedu/js-lsm-api';
+import type { GetModuleInstructorBasicReportingRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ReportingApi();
+
+  const body = {
+    // string
+    courseId: courseId_example,
+    // string
+    moduleId: moduleId_example,
+  } satisfies GetModuleInstructorBasicReportingRequest;
+
+  try {
+    const data = await api.getModuleInstructorBasicReporting(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`] |
+
+### Return type
+
+[**GetModuleInstructorBasicReporting**](GetModuleInstructorBasicReporting.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful response |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Course or module 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)
+
+
+## getModuleStudentReporting
+
+> GetModuleStudentReporting getModuleStudentReporting(courseId, moduleId, studentId)
+
+Get student-specific reporting for a module (can use \'current\' for studentId)
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReportingApi,
+} from '@easyedu/js-lsm-api';
+import type { GetModuleStudentReportingRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ReportingApi();
+
+  const body = {
+    // string
+    courseId: courseId_example,
+    // string
+    moduleId: moduleId_example,
+    // string | The student\'s external ID
+    studentId: studentId_example,
+  } satisfies GetModuleStudentReportingRequest;
+
+  try {
+    const data = await api.getModuleStudentReporting(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`] |
+| **studentId** | `string` | The student\'s external ID | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetModuleStudentReporting**](GetModuleStudentReporting.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful response |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Course, module, or user 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)
+
+
+## getPortalBasicReporting
+
+> GetPortalBasicReporting getPortalBasicReporting(portalId)
+
+Get basic reporting for a portal (can use \'current\' for portalId)
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReportingApi,
+} from '@easyedu/js-lsm-api';
+import type { GetPortalBasicReportingRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ReportingApi();
+
+  const body = {
+    // string
+    portalId: portalId_example,
+  } satisfies GetPortalBasicReportingRequest;
+
+  try {
+    const data = await api.getPortalBasicReporting(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **portalId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetPortalBasicReporting**](GetPortalBasicReporting.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful response |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Portal 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)
+
+
+## getPortalStudentReporting
+
+> GetPortalStudentReporting getPortalStudentReporting(portalId, studentId)
+
+Get student reporting for a portal (can use \'current\' for portalId and studentId)
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReportingApi,
+} from '@easyedu/js-lsm-api';
+import type { GetPortalStudentReportingRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ReportingApi();
+
+  const body = {
+    // string
+    portalId: portalId_example,
+    // string
+    studentId: studentId_example,
+  } satisfies GetPortalStudentReportingRequest;
+
+  try {
+    const data = await api.getPortalStudentReporting(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **portalId** | `string` |  | [Defaults to `undefined`] |
+| **studentId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetPortalStudentReporting**](GetPortalStudentReporting.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful response |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Portal or student 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/SCORMContent.md

@@ -0,0 +1,38 @@
+
+# SCORMContent
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`scormVersion` | string
+`launchUrl` | string
+`manifestData` | object
+
+## Example
+
+```typescript
+import type { SCORMContent } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "scormVersion": null,
+  "launchUrl": null,
+  "manifestData": null,
+} satisfies SCORMContent
+
+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 SCORMContent
+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)
+
+