@easyedu/js-lsm-api 1.121.0 → 1.123.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # @easyedu/js-lsm-api@1.121.0
1
+ # @easyedu/js-lsm-api@1.123.0
2
2
 
3
3
  A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
4
4
 
@@ -786,7 +786,7 @@ and is automatically generated by the
786
786
  [OpenAPI Generator](https://openapi-generator.tech) project:
787
787
 
788
788
  - API version: `1.0.0`
789
- - Package version: `1.121.0`
789
+ - Package version: `1.123.0`
790
790
  - Generator version: `7.22.0`
791
791
  - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
792
792
 
@@ -139,6 +139,7 @@ export interface GetHostedScormExportRegistrationsRequest {
139
139
  exportId: string;
140
140
  page?: number;
141
141
  pageSize?: number;
142
+ search?: string;
142
143
  }
143
144
  export interface GetPortalCourseExportsRequest {
144
145
  page?: number;
@@ -922,6 +922,9 @@ class CourseApi extends runtime.BaseAPI {
922
922
  if (requestParameters['pageSize'] != null) {
923
923
  queryParameters['page_size'] = requestParameters['pageSize'];
924
924
  }
925
+ if (requestParameters['search'] != null) {
926
+ queryParameters['search'] = requestParameters['search'];
927
+ }
925
928
  const headerParameters = {};
926
929
  let urlPath = `/courses/{courseId}/exports/{exportId}/registrations`;
927
930
  urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
@@ -87,6 +87,7 @@ export interface GetResourceSessionListRequest {
87
87
  }
88
88
  export interface GetResourceSessionPlayerRequest {
89
89
  sessionId: string;
90
+ reviewActivityId?: string;
90
91
  }
91
92
  export interface GetResourceSessionScormApiLogsRequest {
92
93
  sessionId: string;
@@ -532,6 +532,9 @@ class PlayerApi extends runtime.BaseAPI {
532
532
  throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling getResourceSessionPlayer().');
533
533
  }
534
534
  const queryParameters = {};
535
+ if (requestParameters['reviewActivityId'] != null) {
536
+ queryParameters['review_activity_id'] = requestParameters['reviewActivityId'];
537
+ }
535
538
  const headerParameters = {};
536
539
  let urlPath = `/resource/sessions/{sessionId}/player`;
537
540
  urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
@@ -139,6 +139,7 @@ export interface GetHostedScormExportRegistrationsRequest {
139
139
  exportId: string;
140
140
  page?: number;
141
141
  pageSize?: number;
142
+ search?: string;
142
143
  }
143
144
  export interface GetPortalCourseExportsRequest {
144
145
  page?: number;
@@ -919,6 +919,9 @@ export class CourseApi extends runtime.BaseAPI {
919
919
  if (requestParameters['pageSize'] != null) {
920
920
  queryParameters['page_size'] = requestParameters['pageSize'];
921
921
  }
922
+ if (requestParameters['search'] != null) {
923
+ queryParameters['search'] = requestParameters['search'];
924
+ }
922
925
  const headerParameters = {};
923
926
  let urlPath = `/courses/{courseId}/exports/{exportId}/registrations`;
924
927
  urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
@@ -87,6 +87,7 @@ export interface GetResourceSessionListRequest {
87
87
  }
88
88
  export interface GetResourceSessionPlayerRequest {
89
89
  sessionId: string;
90
+ reviewActivityId?: string;
90
91
  }
91
92
  export interface GetResourceSessionScormApiLogsRequest {
92
93
  sessionId: string;
@@ -529,6 +529,9 @@ export class PlayerApi extends runtime.BaseAPI {
529
529
  throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling getResourceSessionPlayer().');
530
530
  }
531
531
  const queryParameters = {};
532
+ if (requestParameters['reviewActivityId'] != null) {
533
+ queryParameters['review_activity_id'] = requestParameters['reviewActivityId'];
534
+ }
532
535
  const headerParameters = {};
533
536
  let urlPath = `/resource/sessions/{sessionId}/player`;
534
537
  urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
package/docs/CourseApi.md CHANGED
@@ -1397,7 +1397,7 @@ No authorization required
1397
1397
 
1398
1398
  ## getHostedScormExportRegistrations
1399
1399
 
1400
- > GetHostedScormRegistrationList getHostedScormExportRegistrations(courseId, exportId, page, pageSize)
1400
+ > GetHostedScormRegistrationList getHostedScormExportRegistrations(courseId, exportId, page, pageSize, search)
1401
1401
 
1402
1402
  List hosted SCORM learner registrations
1403
1403
 
@@ -1423,6 +1423,8 @@ async function example() {
1423
1423
  page: 56,
1424
1424
  // number (optional)
1425
1425
  pageSize: 56,
1426
+ // string | Case-insensitive learner name or external learner ID search. (optional)
1427
+ search: search_example,
1426
1428
  } satisfies GetHostedScormExportRegistrationsRequest;
1427
1429
 
1428
1430
  try {
@@ -1446,6 +1448,7 @@ example().catch(console.error);
1446
1448
  | **exportId** | `string` | | [Defaults to `undefined`] |
1447
1449
  | **page** | `number` | | [Optional] [Defaults to `1`] |
1448
1450
  | **pageSize** | `number` | | [Optional] [Defaults to `20`] |
1451
+ | **search** | `string` | Case-insensitive learner name or external learner ID search. | [Optional] [Defaults to `undefined`] |
1449
1452
 
1450
1453
  ### Return type
1451
1454
 
package/docs/PlayerApi.md CHANGED
@@ -763,7 +763,7 @@ No authorization required
763
763
 
764
764
  ## getResourceSessionPlayer
765
765
 
766
- > string getResourceSessionPlayer(sessionId)
766
+ > string getResourceSessionPlayer(sessionId, reviewActivityId)
767
767
 
768
768
  Serve the player for a version-pinned reusable resource session
769
769
 
@@ -783,6 +783,8 @@ async function example() {
783
783
  const body = {
784
784
  // string
785
785
  sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
786
+ // string | Select a tracked SCO while reviewing a completed SCORM 2004 sequence. (optional)
787
+ reviewActivityId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
786
788
  } satisfies GetResourceSessionPlayerRequest;
787
789
 
788
790
  try {
@@ -803,6 +805,7 @@ example().catch(console.error);
803
805
  | Name | Type | Description | Notes |
804
806
  |------------- | ------------- | ------------- | -------------|
805
807
  | **sessionId** | `string` | | [Defaults to `undefined`] |
808
+ | **reviewActivityId** | `string` | Select a tracked SCO while reviewing a completed SCORM 2004 sequence. | [Optional] [Defaults to `undefined`] |
806
809
 
807
810
  ### Return type
808
811
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@easyedu/js-lsm-api",
3
- "version": "1.121.0",
3
+ "version": "1.123.0",
4
4
  "description": "OpenAPI client for @easyedu/js-lsm-api",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
@@ -319,6 +319,7 @@ export interface GetHostedScormExportRegistrationsRequest {
319
319
  exportId: string;
320
320
  page?: number;
321
321
  pageSize?: number;
322
+ search?: string;
322
323
  }
323
324
 
324
325
  export interface GetPortalCourseExportsRequest {
@@ -1514,6 +1515,10 @@ export class CourseApi extends runtime.BaseAPI {
1514
1515
  queryParameters['page_size'] = requestParameters['pageSize'];
1515
1516
  }
1516
1517
 
1518
+ if (requestParameters['search'] != null) {
1519
+ queryParameters['search'] = requestParameters['search'];
1520
+ }
1521
+
1517
1522
  const headerParameters: runtime.HTTPHeaders = {};
1518
1523
 
1519
1524
 
@@ -182,6 +182,7 @@ export interface GetResourceSessionListRequest {
182
182
 
183
183
  export interface GetResourceSessionPlayerRequest {
184
184
  sessionId: string;
185
+ reviewActivityId?: string;
185
186
  }
186
187
 
187
188
  export interface GetResourceSessionScormApiLogsRequest {
@@ -825,6 +826,10 @@ export class PlayerApi extends runtime.BaseAPI {
825
826
 
826
827
  const queryParameters: any = {};
827
828
 
829
+ if (requestParameters['reviewActivityId'] != null) {
830
+ queryParameters['review_activity_id'] = requestParameters['reviewActivityId'];
831
+ }
832
+
828
833
  const headerParameters: runtime.HTTPHeaders = {};
829
834
 
830
835