@easyedu/js-lsm-api 1.75.0 → 1.76.0

package/README.md

@@ -1,4 +1,4 @@
-# @easyedu/js-lsm-api@1.75.0
+# @easyedu/js-lsm-api@1.76.0
 
 A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
 
@@ -538,7 +538,7 @@ and is automatically generated by the
 [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: `1.0.0`
-- Package version: `1.75.0`
+- Package version: `1.76.0`
 - Generator version: `7.22.0`
 - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
 

package/dist/apis/ReportingApi.d.ts

@@ -32,6 +32,8 @@ export interface GetContentGradesRequest {
     page?: number;
     pageSize?: number;
     search?: string;
+    includeInactive?: boolean;
+    enrollmentStatus?: string;
 }
 export interface GetContentInstructorBasicReportingRequest {
     courseId: string;

package/dist/apis/ReportingApi.js

@@ -112,6 +112,12 @@ class ReportingApi extends runtime.BaseAPI {
             if (requestParameters['search'] != null) {
                 queryParameters['search'] = requestParameters['search'];
             }
+            if (requestParameters['includeInactive'] != null) {
+                queryParameters['includeInactive'] = requestParameters['includeInactive'];
+            }
+            if (requestParameters['enrollmentStatus'] != null) {
+                queryParameters['enrollmentStatus'] = requestParameters['enrollmentStatus'];
+            }
             const headerParameters = {};
             let urlPath = `/courses/{courseId}/modules/{moduleId}/contents/{contentId}/reporting/grades`;
             urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));

package/dist/esm/apis/ReportingApi.d.ts

@@ -32,6 +32,8 @@ export interface GetContentGradesRequest {
     page?: number;
     pageSize?: number;
     search?: string;
+    includeInactive?: boolean;
+    enrollmentStatus?: string;
 }
 export interface GetContentInstructorBasicReportingRequest {
     courseId: string;

package/dist/esm/apis/ReportingApi.js

@@ -109,6 +109,12 @@ export class ReportingApi extends runtime.BaseAPI {
             if (requestParameters['search'] != null) {
                 queryParameters['search'] = requestParameters['search'];
             }
+            if (requestParameters['includeInactive'] != null) {
+                queryParameters['includeInactive'] = requestParameters['includeInactive'];
+            }
+            if (requestParameters['enrollmentStatus'] != null) {
+                queryParameters['enrollmentStatus'] = requestParameters['enrollmentStatus'];
+            }
             const headerParameters = {};
             let urlPath = `/courses/{courseId}/modules/{moduleId}/contents/{contentId}/reporting/grades`;
             urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));

package/dist/esm/models/GetContentGradesItemsInner.d.ts

@@ -40,6 +40,18 @@ export interface GetContentGradesItemsInner {
      * @memberof GetContentGradesItemsInner
      */
     gradeStatus: GetContentGradesItemsInnerGradeStatusEnum;
+    /**
+     * Canonical student enrollment status used for this grade row
+     * @type {GetContentGradesItemsInnerEnrollmentStatusEnum}
+     * @memberof GetContentGradesItemsInner
+     */
+    enrollmentStatus: GetContentGradesItemsInnerEnrollmentStatusEnum;
+    /**
+     * Derived learner access state for UI indicators
+     * @type {GetContentGradesItemsInnerAccessStateEnum}
+     * @memberof GetContentGradesItemsInner
+     */
+    accessState: GetContentGradesItemsInnerAccessStateEnum;
 }
 /**
  * @export
@@ -62,6 +74,31 @@ export declare const GetContentGradesItemsInnerGradeStatusEnum: {
     readonly NotApplicable: "NotApplicable";
 };
 export type GetContentGradesItemsInnerGradeStatusEnum = typeof GetContentGradesItemsInnerGradeStatusEnum[keyof typeof GetContentGradesItemsInnerGradeStatusEnum];
+/**
+ * @export
+ */
+export declare const GetContentGradesItemsInnerEnrollmentStatusEnum: {
+    readonly Enrolled: "Enrolled";
+    readonly InProgress: "InProgress";
+    readonly Completed: "Completed";
+    readonly Failed: "Failed";
+    readonly Expired: "Expired";
+    readonly Withdrawn: "Withdrawn";
+    readonly Suspended: "Suspended";
+};
+export type GetContentGradesItemsInnerEnrollmentStatusEnum = typeof GetContentGradesItemsInnerEnrollmentStatusEnum[keyof typeof GetContentGradesItemsInnerEnrollmentStatusEnum];
+/**
+ * @export
+ */
+export declare const GetContentGradesItemsInnerAccessStateEnum: {
+    readonly Active: "active";
+    readonly CompletedReview: "completed_review";
+    readonly Expired: "expired";
+    readonly Suspended: "suspended";
+    readonly Failed: "failed";
+    readonly Withdrawn: "withdrawn";
+};
+export type GetContentGradesItemsInnerAccessStateEnum = typeof GetContentGradesItemsInnerAccessStateEnum[keyof typeof GetContentGradesItemsInnerAccessStateEnum];
 /**
  * Check if a given object implements the GetContentGradesItemsInner interface.
  */

package/dist/esm/models/GetContentGradesItemsInner.js

@@ -31,6 +31,29 @@ export const GetContentGradesItemsInnerGradeStatusEnum = {
     PercentageEarned: 'PercentageEarned',
     NotApplicable: 'NotApplicable'
 };
+/**
+ * @export
+ */
+export const GetContentGradesItemsInnerEnrollmentStatusEnum = {
+    Enrolled: 'Enrolled',
+    InProgress: 'InProgress',
+    Completed: 'Completed',
+    Failed: 'Failed',
+    Expired: 'Expired',
+    Withdrawn: 'Withdrawn',
+    Suspended: 'Suspended'
+};
+/**
+ * @export
+ */
+export const GetContentGradesItemsInnerAccessStateEnum = {
+    Active: 'active',
+    CompletedReview: 'completed_review',
+    Expired: 'expired',
+    Suspended: 'suspended',
+    Failed: 'failed',
+    Withdrawn: 'withdrawn'
+};
 /**
  * Check if a given object implements the GetContentGradesItemsInner interface.
  */
@@ -41,6 +64,10 @@ export function instanceOfGetContentGradesItemsInner(value) {
         return false;
     if (!('gradeStatus' in value) || value['gradeStatus'] === undefined)
         return false;
+    if (!('enrollmentStatus' in value) || value['enrollmentStatus'] === undefined)
+        return false;
+    if (!('accessState' in value) || value['accessState'] === undefined)
+        return false;
     return true;
 }
 export function GetContentGradesItemsInnerFromJSON(json) {
@@ -55,6 +82,8 @@ export function GetContentGradesItemsInnerFromJSONTyped(json, ignoreDiscriminato
         'user': GetContentGradesItemsInnerUserFromJSON(json['user']),
         'completion': json['completion'],
         'gradeStatus': json['grade_status'],
+        'enrollmentStatus': json['enrollment_status'],
+        'accessState': json['access_state'],
     };
 }
 export function GetContentGradesItemsInnerToJSON(json) {
@@ -69,5 +98,7 @@ export function GetContentGradesItemsInnerToJSONTyped(value, ignoreDiscriminator
         'user': GetContentGradesItemsInnerUserToJSON(value['user']),
         'completion': value['completion'],
         'grade_status': value['gradeStatus'],
+        'enrollment_status': value['enrollmentStatus'],
+        'access_state': value['accessState'],
     };
 }

package/dist/models/GetContentGradesItemsInner.d.ts

@@ -40,6 +40,18 @@ export interface GetContentGradesItemsInner {
      * @memberof GetContentGradesItemsInner
      */
     gradeStatus: GetContentGradesItemsInnerGradeStatusEnum;
+    /**
+     * Canonical student enrollment status used for this grade row
+     * @type {GetContentGradesItemsInnerEnrollmentStatusEnum}
+     * @memberof GetContentGradesItemsInner
+     */
+    enrollmentStatus: GetContentGradesItemsInnerEnrollmentStatusEnum;
+    /**
+     * Derived learner access state for UI indicators
+     * @type {GetContentGradesItemsInnerAccessStateEnum}
+     * @memberof GetContentGradesItemsInner
+     */
+    accessState: GetContentGradesItemsInnerAccessStateEnum;
 }
 /**
  * @export
@@ -62,6 +74,31 @@ export declare const GetContentGradesItemsInnerGradeStatusEnum: {
     readonly NotApplicable: "NotApplicable";
 };
 export type GetContentGradesItemsInnerGradeStatusEnum = typeof GetContentGradesItemsInnerGradeStatusEnum[keyof typeof GetContentGradesItemsInnerGradeStatusEnum];
+/**
+ * @export
+ */
+export declare const GetContentGradesItemsInnerEnrollmentStatusEnum: {
+    readonly Enrolled: "Enrolled";
+    readonly InProgress: "InProgress";
+    readonly Completed: "Completed";
+    readonly Failed: "Failed";
+    readonly Expired: "Expired";
+    readonly Withdrawn: "Withdrawn";
+    readonly Suspended: "Suspended";
+};
+export type GetContentGradesItemsInnerEnrollmentStatusEnum = typeof GetContentGradesItemsInnerEnrollmentStatusEnum[keyof typeof GetContentGradesItemsInnerEnrollmentStatusEnum];
+/**
+ * @export
+ */
+export declare const GetContentGradesItemsInnerAccessStateEnum: {
+    readonly Active: "active";
+    readonly CompletedReview: "completed_review";
+    readonly Expired: "expired";
+    readonly Suspended: "suspended";
+    readonly Failed: "failed";
+    readonly Withdrawn: "withdrawn";
+};
+export type GetContentGradesItemsInnerAccessStateEnum = typeof GetContentGradesItemsInnerAccessStateEnum[keyof typeof GetContentGradesItemsInnerAccessStateEnum];
 /**
  * Check if a given object implements the GetContentGradesItemsInner interface.
  */

package/dist/models/GetContentGradesItemsInner.js

@@ -13,7 +13,7 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GetContentGradesItemsInnerGradeStatusEnum = exports.GetContentGradesItemsInnerCompletionEnum = void 0;
+exports.GetContentGradesItemsInnerAccessStateEnum = exports.GetContentGradesItemsInnerEnrollmentStatusEnum = exports.GetContentGradesItemsInnerGradeStatusEnum = exports.GetContentGradesItemsInnerCompletionEnum = void 0;
 exports.instanceOfGetContentGradesItemsInner = instanceOfGetContentGradesItemsInner;
 exports.GetContentGradesItemsInnerFromJSON = GetContentGradesItemsInnerFromJSON;
 exports.GetContentGradesItemsInnerFromJSONTyped = GetContentGradesItemsInnerFromJSONTyped;
@@ -39,6 +39,29 @@ exports.GetContentGradesItemsInnerGradeStatusEnum = {
     PercentageEarned: 'PercentageEarned',
     NotApplicable: 'NotApplicable'
 };
+/**
+ * @export
+ */
+exports.GetContentGradesItemsInnerEnrollmentStatusEnum = {
+    Enrolled: 'Enrolled',
+    InProgress: 'InProgress',
+    Completed: 'Completed',
+    Failed: 'Failed',
+    Expired: 'Expired',
+    Withdrawn: 'Withdrawn',
+    Suspended: 'Suspended'
+};
+/**
+ * @export
+ */
+exports.GetContentGradesItemsInnerAccessStateEnum = {
+    Active: 'active',
+    CompletedReview: 'completed_review',
+    Expired: 'expired',
+    Suspended: 'suspended',
+    Failed: 'failed',
+    Withdrawn: 'withdrawn'
+};
 /**
  * Check if a given object implements the GetContentGradesItemsInner interface.
  */
@@ -49,6 +72,10 @@ function instanceOfGetContentGradesItemsInner(value) {
         return false;
     if (!('gradeStatus' in value) || value['gradeStatus'] === undefined)
         return false;
+    if (!('enrollmentStatus' in value) || value['enrollmentStatus'] === undefined)
+        return false;
+    if (!('accessState' in value) || value['accessState'] === undefined)
+        return false;
     return true;
 }
 function GetContentGradesItemsInnerFromJSON(json) {
@@ -63,6 +90,8 @@ function GetContentGradesItemsInnerFromJSONTyped(json, ignoreDiscriminator) {
         'user': (0, GetContentGradesItemsInnerUser_1.GetContentGradesItemsInnerUserFromJSON)(json['user']),
         'completion': json['completion'],
         'gradeStatus': json['grade_status'],
+        'enrollmentStatus': json['enrollment_status'],
+        'accessState': json['access_state'],
     };
 }
 function GetContentGradesItemsInnerToJSON(json) {
@@ -77,5 +106,7 @@ function GetContentGradesItemsInnerToJSONTyped(value, ignoreDiscriminator = fals
         'user': (0, GetContentGradesItemsInnerUser_1.GetContentGradesItemsInnerUserToJSON)(value['user']),
         'completion': value['completion'],
         'grade_status': value['gradeStatus'],
+        'enrollment_status': value['enrollmentStatus'],
+        'access_state': value['accessState'],
     };
 }

package/docs/GetContentGradesItemsInner.md

@@ -10,6 +10,8 @@ Name | Type
 `user` | [GetContentGradesItemsInnerUser](GetContentGradesItemsInnerUser.md)
 `completion` | string
 `gradeStatus` | string
+`enrollmentStatus` | string
+`accessState` | string
 
 ## Example
 
@@ -22,6 +24,8 @@ const example = {
   "user": null,
   "completion": null,
   "gradeStatus": null,
+  "enrollmentStatus": null,
+  "accessState": null,
 } satisfies GetContentGradesItemsInner
 
 console.log(example)

package/docs/ReportingApi.md

@@ -95,7 +95,7 @@ No authorization required
 
 ## getContentGrades
 
-> GetContentGrades getContentGrades(courseId, moduleId, contentId, page, pageSize, search)
+> GetContentGrades getContentGrades(courseId, moduleId, contentId, page, pageSize, search, includeInactive, enrollmentStatus)
 
 Get grades for all students enrolled in course for specific content
 
@@ -125,6 +125,10 @@ async function example() {
     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 {
@@ -150,6 +154,8 @@ example().catch(console.error);
 | **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
 

package/package.json

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

package/src/apis/ReportingApi.ts

@@ -73,6 +73,8 @@ export interface GetContentGradesRequest {
     page?: number;
     pageSize?: number;
     search?: string;
+    includeInactive?: boolean;
+    enrollmentStatus?: string;
 }
 
 export interface GetContentInstructorBasicReportingRequest {
@@ -223,6 +225,14 @@ export class ReportingApi extends runtime.BaseAPI {
             queryParameters['search'] = requestParameters['search'];
         }
 
+        if (requestParameters['includeInactive'] != null) {
+            queryParameters['includeInactive'] = requestParameters['includeInactive'];
+        }
+
+        if (requestParameters['enrollmentStatus'] != null) {
+            queryParameters['enrollmentStatus'] = requestParameters['enrollmentStatus'];
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
 

package/src/models/GetContentGradesItemsInner.ts

@@ -51,6 +51,18 @@ export interface GetContentGradesItemsInner {
      * @memberof GetContentGradesItemsInner
      */
     gradeStatus: GetContentGradesItemsInnerGradeStatusEnum;
+    /**
+     * Canonical student enrollment status used for this grade row
+     * @type {GetContentGradesItemsInnerEnrollmentStatusEnum}
+     * @memberof GetContentGradesItemsInner
+     */
+    enrollmentStatus: GetContentGradesItemsInnerEnrollmentStatusEnum;
+    /**
+     * Derived learner access state for UI indicators
+     * @type {GetContentGradesItemsInnerAccessStateEnum}
+     * @memberof GetContentGradesItemsInner
+     */
+    accessState: GetContentGradesItemsInnerAccessStateEnum;
 }
 
 
@@ -77,6 +89,33 @@ export const GetContentGradesItemsInnerGradeStatusEnum = {
 } as const;
 export type GetContentGradesItemsInnerGradeStatusEnum = typeof GetContentGradesItemsInnerGradeStatusEnum[keyof typeof GetContentGradesItemsInnerGradeStatusEnum];
 
+/**
+ * @export
+ */
+export const GetContentGradesItemsInnerEnrollmentStatusEnum = {
+    Enrolled: 'Enrolled',
+    InProgress: 'InProgress',
+    Completed: 'Completed',
+    Failed: 'Failed',
+    Expired: 'Expired',
+    Withdrawn: 'Withdrawn',
+    Suspended: 'Suspended'
+} as const;
+export type GetContentGradesItemsInnerEnrollmentStatusEnum = typeof GetContentGradesItemsInnerEnrollmentStatusEnum[keyof typeof GetContentGradesItemsInnerEnrollmentStatusEnum];
+
+/**
+ * @export
+ */
+export const GetContentGradesItemsInnerAccessStateEnum = {
+    Active: 'active',
+    CompletedReview: 'completed_review',
+    Expired: 'expired',
+    Suspended: 'suspended',
+    Failed: 'failed',
+    Withdrawn: 'withdrawn'
+} as const;
+export type GetContentGradesItemsInnerAccessStateEnum = typeof GetContentGradesItemsInnerAccessStateEnum[keyof typeof GetContentGradesItemsInnerAccessStateEnum];
+
 
 /**
  * Check if a given object implements the GetContentGradesItemsInner interface.
@@ -85,6 +124,8 @@ export function instanceOfGetContentGradesItemsInner(value: object): value is Ge
     if (!('user' in value) || value['user'] === undefined) return false;
     if (!('completion' in value) || value['completion'] === undefined) return false;
     if (!('gradeStatus' in value) || value['gradeStatus'] === undefined) return false;
+    if (!('enrollmentStatus' in value) || value['enrollmentStatus'] === undefined) return false;
+    if (!('accessState' in value) || value['accessState'] === undefined) return false;
     return true;
 }
 
@@ -102,6 +143,8 @@ export function GetContentGradesItemsInnerFromJSONTyped(json: any, ignoreDiscrim
         'user': GetContentGradesItemsInnerUserFromJSON(json['user']),
         'completion': json['completion'],
         'gradeStatus': json['grade_status'],
+        'enrollmentStatus': json['enrollment_status'],
+        'accessState': json['access_state'],
     };
 }
 
@@ -120,6 +163,8 @@ export function GetContentGradesItemsInnerToJSONTyped(value?: GetContentGradesIt
         'user': GetContentGradesItemsInnerUserToJSON(value['user']),
         'completion': value['completion'],
         'grade_status': value['gradeStatus'],
+        'enrollment_status': value['enrollmentStatus'],
+        'access_state': value['accessState'],
     };
 }