@easyedu/js-lsm-api 1.94.0 → 1.95.0

package/docs/ReportingApi.md

@@ -4,23 +4,16 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 
 | 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) |
+| [**getCourseVersionModuleReporting**](ReportingApi.md#getcourseversionmodulereporting) | **GET** /courses/{courseId}/versions/{courseVersionId}/modules/{moduleId}/reporting | Get instructor reporting for one module in an explicit course version |
+| [**getCourseVersionReporting**](ReportingApi.md#getcourseversionreporting) | **GET** /courses/{courseId}/versions/{courseVersionId}/reporting | Get instructor reporting for one explicit course version |
 
 
 
-## getContentGradeDetail
+## getCourseVersionModuleReporting
 
-> GetContentGradeDetail getContentGradeDetail(courseId, moduleId, contentId, studentId)
+> GetCourseVersionModuleReporting getCourseVersionModuleReporting(courseId, courseVersionId, moduleId)
 
-Get detailed grade information for a specific student and content (can use \'current\' for studentId)
+Get instructor reporting for one module in an explicit course version
 
 ### Example
 
@@ -29,7 +22,7 @@ import {
   Configuration,
   ReportingApi,
 } from '@easyedu/js-lsm-api';
-import type { GetContentGradeDetailRequest } from '@easyedu/js-lsm-api';
+import type { GetCourseVersionModuleReportingRequest } from '@easyedu/js-lsm-api';
 
 async function example() {
   console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
@@ -39,15 +32,13 @@ async function example() {
     // string
     courseId: courseId_example,
     // string
-    moduleId: moduleId_example,
+    courseVersionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
     // string
-    contentId: contentId_example,
-    // string | The student\'s external ID
-    studentId: studentId_example,
-  } satisfies GetContentGradeDetailRequest;
+    moduleId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetCourseVersionModuleReportingRequest;
 
   try {
-    const data = await api.getContentGradeDetail(body);
+    const data = await api.getCourseVersionModuleReporting(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -64,13 +55,12 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **courseId** | `string` |  | [Defaults to `undefined`] |
+| **courseVersionId** | `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)
+[**GetCourseVersionModuleReporting**](GetCourseVersionModuleReporting.md)
 
 ### Authorization
 
@@ -85,19 +75,17 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | Successful response |  -  |
-| **401** | Unauthorized |  -  |
-| **403** | Forbidden |  -  |
-| **404** | Course, module, content, or student not found |  -  |
+| **200** | Version-pinned module and item reporting |  -  |
+| **404** | Course version module not found in the selected portal |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
-## getContentGrades
+## getCourseVersionReporting
 
-> GetContentGrades getContentGrades(courseId, moduleId, contentId, page, pageSize, search, includeInactive, enrollmentStatus)
+> GetCourseVersionReporting getCourseVersionReporting(courseId, courseVersionId)
 
-Get grades for all students enrolled in course for specific content
+Get instructor reporting for one explicit course version
 
 ### Example
 
@@ -106,7 +94,7 @@ import {
   Configuration,
   ReportingApi,
 } from '@easyedu/js-lsm-api';
-import type { GetContentGradesRequest } from '@easyedu/js-lsm-api';
+import type { GetCourseVersionReportingRequest } from '@easyedu/js-lsm-api';
 
 async function example() {
   console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
@@ -116,102 +104,11 @@ async function example() {
     // 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,
-    // boolean | Include inactive student enrollment statuses in the gradebook result. When false, includes Enrolled, InProgress, and Completed. When true, also includes Failed, Expired, Withdrawn, and Suspended. Removed and Archived are always excluded. (optional)
-    includeInactive: true,
-    // string | Comma-separated enrollment statuses to include. Allowed values are Enrolled, InProgress, Completed, Failed, Expired, Withdrawn, and Suspended. Overrides includeInactive when present. (optional)
-    enrollmentStatus: enrollmentStatus_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`] |
-| **includeInactive** | `boolean` | Include inactive student enrollment statuses in the gradebook result. When false, includes Enrolled, InProgress, and Completed. When true, also includes Failed, Expired, Withdrawn, and Suspended. Removed and Archived are always excluded. | [Optional] [Defaults to `false`] |
-| **enrollmentStatus** | `string` | Comma-separated enrollment statuses to include. Allowed values are Enrolled, InProgress, Completed, Failed, Expired, Withdrawn, and Suspended. Overrides includeInactive when present. | [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;
+    courseVersionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetCourseVersionReportingRequest;
 
   try {
-    const data = await api.getContentInstructorBasicReporting(body);
+    const data = await api.getCourseVersionReporting(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -228,435 +125,11 @@ example().catch(console.error);
 | 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`] |
+| **courseVersionId** | `string` |  | [Defaults to `undefined`] |
 
 ### Return type
 
-[**GetPortalStudentReporting**](GetPortalStudentReporting.md)
+[**GetCourseVersionReporting**](GetCourseVersionReporting.md)
 
 ### Authorization
 
@@ -671,10 +144,8 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | Successful response |  -  |
-| **401** | Unauthorized |  -  |
-| **403** | Forbidden |  -  |
-| **404** | Portal or student not found |  -  |
+| **200** | Version-pinned course reporting |  -  |
+| **404** | Course version not found in the selected portal |  -  |
 
 [[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.94.0",
+  "version": "1.95.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {