@easyedu/js-lsm-api 1.120.0 → 1.122.0

package/README.md

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

package/dist/apis/CourseApi.d.ts

@@ -139,6 +139,7 @@ export interface GetHostedScormExportRegistrationsRequest {
     exportId: string;
     page?: number;
     pageSize?: number;
+    search?: string;
 }
 export interface GetPortalCourseExportsRequest {
     page?: number;

package/dist/apis/CourseApi.js

@@ -922,6 +922,9 @@ class CourseApi extends runtime.BaseAPI {
             if (requestParameters['pageSize'] != null) {
                 queryParameters['page_size'] = requestParameters['pageSize'];
             }
+            if (requestParameters['search'] != null) {
+                queryParameters['search'] = requestParameters['search'];
+            }
             const headerParameters = {};
             let urlPath = `/courses/{courseId}/exports/{exportId}/registrations`;
             urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));

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

@@ -139,6 +139,7 @@ export interface GetHostedScormExportRegistrationsRequest {
     exportId: string;
     page?: number;
     pageSize?: number;
+    search?: string;
 }
 export interface GetPortalCourseExportsRequest {
     page?: number;

package/dist/esm/apis/CourseApi.js

@@ -919,6 +919,9 @@ export class CourseApi extends runtime.BaseAPI {
             if (requestParameters['pageSize'] != null) {
                 queryParameters['page_size'] = requestParameters['pageSize'];
             }
+            if (requestParameters['search'] != null) {
+                queryParameters['search'] = requestParameters['search'];
+            }
             const headerParameters = {};
             let urlPath = `/courses/{courseId}/exports/{exportId}/registrations`;
             urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));

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

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { GetDispatchRollup } from './GetDispatchRollup';
 /**
  *
  * @export
@@ -69,6 +70,12 @@ export interface GetHostedScormRegistration {
      * @memberof GetHostedScormRegistration
      */
     lastItemId?: string | null;
+    /**
+     * Latest course-level completion, success, score, and progress recorded for this learner.
+     * @type {GetDispatchRollup}
+     * @memberof GetHostedScormRegistration
+     */
+    rollup?: GetDispatchRollup | null;
 }
 /**
  * Check if a given object implements the GetHostedScormRegistration interface.

package/dist/esm/models/GetHostedScormRegistration.js

@@ -11,6 +11,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { GetDispatchRollupFromJSON, GetDispatchRollupToJSON, } from './GetDispatchRollup';
 /**
  * Check if a given object implements the GetHostedScormRegistration interface.
  */
@@ -48,6 +49,7 @@ export function GetHostedScormRegistrationFromJSONTyped(json, ignoreDiscriminato
         'lastLaunchAt': json['last_launch_at'],
         'lastOrigin': json['last_origin'] == null ? undefined : json['last_origin'],
         'lastItemId': json['last_item_id'] == null ? undefined : json['last_item_id'],
+        'rollup': json['rollup'] == null ? undefined : GetDispatchRollupFromJSON(json['rollup']),
     };
 }
 export function GetHostedScormRegistrationToJSON(json) {
@@ -67,5 +69,6 @@ export function GetHostedScormRegistrationToJSONTyped(value, ignoreDiscriminator
         'last_launch_at': value['lastLaunchAt'],
         'last_origin': value['lastOrigin'],
         'last_item_id': value['lastItemId'],
+        'rollup': GetDispatchRollupToJSON(value['rollup']),
     };
 }

package/dist/models/GetHostedScormRegistration.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { GetDispatchRollup } from './GetDispatchRollup';
 /**
  *
  * @export
@@ -69,6 +70,12 @@ export interface GetHostedScormRegistration {
      * @memberof GetHostedScormRegistration
      */
     lastItemId?: string | null;
+    /**
+     * Latest course-level completion, success, score, and progress recorded for this learner.
+     * @type {GetDispatchRollup}
+     * @memberof GetHostedScormRegistration
+     */
+    rollup?: GetDispatchRollup | null;
 }
 /**
  * Check if a given object implements the GetHostedScormRegistration interface.

package/dist/models/GetHostedScormRegistration.js

@@ -18,6 +18,7 @@ exports.GetHostedScormRegistrationFromJSON = GetHostedScormRegistrationFromJSON;
 exports.GetHostedScormRegistrationFromJSONTyped = GetHostedScormRegistrationFromJSONTyped;
 exports.GetHostedScormRegistrationToJSON = GetHostedScormRegistrationToJSON;
 exports.GetHostedScormRegistrationToJSONTyped = GetHostedScormRegistrationToJSONTyped;
+const GetDispatchRollup_1 = require("./GetDispatchRollup");
 /**
  * Check if a given object implements the GetHostedScormRegistration interface.
  */
@@ -55,6 +56,7 @@ function GetHostedScormRegistrationFromJSONTyped(json, ignoreDiscriminator) {
         'lastLaunchAt': json['last_launch_at'],
         'lastOrigin': json['last_origin'] == null ? undefined : json['last_origin'],
         'lastItemId': json['last_item_id'] == null ? undefined : json['last_item_id'],
+        'rollup': json['rollup'] == null ? undefined : (0, GetDispatchRollup_1.GetDispatchRollupFromJSON)(json['rollup']),
     };
 }
 function GetHostedScormRegistrationToJSON(json) {
@@ -74,5 +76,6 @@ function GetHostedScormRegistrationToJSONTyped(value, ignoreDiscriminator = fals
         'last_launch_at': value['lastLaunchAt'],
         'last_origin': value['lastOrigin'],
         'last_item_id': value['lastItemId'],
+        'rollup': (0, GetDispatchRollup_1.GetDispatchRollupToJSON)(value['rollup']),
     };
 }

package/docs/CourseApi.md

@@ -1397,7 +1397,7 @@ No authorization required
 
 ## getHostedScormExportRegistrations
 
-> GetHostedScormRegistrationList getHostedScormExportRegistrations(courseId, exportId, page, pageSize)
+> GetHostedScormRegistrationList getHostedScormExportRegistrations(courseId, exportId, page, pageSize, search)
 
 List hosted SCORM learner registrations
 
@@ -1423,6 +1423,8 @@ async function example() {
     page: 56,
     // number (optional)
     pageSize: 56,
+    // string | Case-insensitive learner name or external learner ID search. (optional)
+    search: search_example,
   } satisfies GetHostedScormExportRegistrationsRequest;
 
   try {
@@ -1446,6 +1448,7 @@ example().catch(console.error);
 | **exportId** | `string` |  | [Defaults to `undefined`] |
 | **page** | `number` |  | [Optional] [Defaults to `1`] |
 | **pageSize** | `number` |  | [Optional] [Defaults to `20`] |
+| **search** | `string` | Case-insensitive learner name or external learner ID search. | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 

package/docs/GetHostedScormRegistration.md

@@ -15,6 +15,7 @@ Name | Type
 `lastLaunchAt` | number
 `lastOrigin` | string
 `lastItemId` | string
+`rollup` | [GetDispatchRollup](GetDispatchRollup.md)
 
 ## Example
 
@@ -32,6 +33,7 @@ const example = {
   "lastLaunchAt": null,
   "lastOrigin": null,
   "lastItemId": null,
+  "rollup": null,
 } satisfies GetHostedScormRegistration
 
 console.log(example)

package/package.json

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

package/src/apis/CourseApi.ts

@@ -319,6 +319,7 @@ export interface GetHostedScormExportRegistrationsRequest {
     exportId: string;
     page?: number;
     pageSize?: number;
+    search?: string;
 }
 
 export interface GetPortalCourseExportsRequest {
@@ -1514,6 +1515,10 @@ export class CourseApi extends runtime.BaseAPI {
             queryParameters['page_size'] = requestParameters['pageSize'];
         }
 
+        if (requestParameters['search'] != null) {
+            queryParameters['search'] = requestParameters['search'];
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
 

package/src/models/GetHostedScormRegistration.ts

@@ -13,6 +13,14 @@
  */
 
 import { mapValues } from '../runtime';
+import type { GetDispatchRollup } from './GetDispatchRollup';
+import {
+    GetDispatchRollupFromJSON,
+    GetDispatchRollupFromJSONTyped,
+    GetDispatchRollupToJSON,
+    GetDispatchRollupToJSONTyped,
+} from './GetDispatchRollup';
+
 /**
  * 
  * @export
@@ -73,6 +81,12 @@ export interface GetHostedScormRegistration {
      * @memberof GetHostedScormRegistration
      */
     lastItemId?: string | null;
+    /**
+     * Latest course-level completion, success, score, and progress recorded for this learner.
+     * @type {GetDispatchRollup}
+     * @memberof GetHostedScormRegistration
+     */
+    rollup?: GetDispatchRollup | null;
 }
 
 /**
@@ -108,6 +122,7 @@ export function GetHostedScormRegistrationFromJSONTyped(json: any, ignoreDiscrim
         'lastLaunchAt': json['last_launch_at'],
         'lastOrigin': json['last_origin'] == null ? undefined : json['last_origin'],
         'lastItemId': json['last_item_id'] == null ? undefined : json['last_item_id'],
+        'rollup': json['rollup'] == null ? undefined : GetDispatchRollupFromJSON(json['rollup']),
     };
 }
 
@@ -131,6 +146,7 @@ export function GetHostedScormRegistrationToJSONTyped(value?: GetHostedScormRegi
         'last_launch_at': value['lastLaunchAt'],
         'last_origin': value['lastOrigin'],
         'last_item_id': value['lastItemId'],
+        'rollup': GetDispatchRollupToJSON(value['rollup']),
     };
 }