@easyedu/js-lsm-api 1.102.0 → 1.103.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.102.0
1
+ # @easyedu/js-lsm-api@1.103.0
2
2
 
3
3
  A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
4
4
 
@@ -150,7 +150,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
150
150
  *ContentLibraryQuizApi* | [**getLibraryQuizSessionResults**](docs/ContentLibraryQuizApi.md#getlibraryquizsessionresults) | **GET** /quiz/sessions/{sessionId}/results | Get reusable quiz session results
151
151
  *ContentLibraryQuizApi* | [**getLibraryQuizUsage**](docs/ContentLibraryQuizApi.md#getlibraryquizusage) | **GET** /content-library/quizzes/{quizId}/usage | Get course and learner usage for a reusable quiz
152
152
  *ContentLibraryQuizApi* | [**getLibraryQuizVersion**](docs/ContentLibraryQuizApi.md#getlibraryquizversion) | **GET** /content-library/quizzes/{quizId}/versions/{versionId} | Get a reusable quiz version
153
- *ContentLibraryQuizApi* | [**postCourseLibraryQuizSession**](docs/ContentLibraryQuizApi.md#postcourselibraryquizsession) | **POST** /courses/{courseId}/versions/{courseVersionId}/items/{itemId}/quiz-sessions | Start or resume a live attempt for a course-pinned quiz version
153
+ *ContentLibraryQuizApi* | [**postCourseLibraryQuizSession**](docs/ContentLibraryQuizApi.md#postcourselibraryquizsession) | **POST** /courses/{courseId}/versions/{courseVersionId}/items/{itemId}/quiz-sessions | Start or resume a live or sandbox-preview attempt for a course-pinned quiz version
154
154
  *ContentLibraryQuizApi* | [**postLibraryQuiz**](docs/ContentLibraryQuizApi.md#postlibraryquiz) | **POST** /content-library/quizzes | Create a reusable quiz and its first draft version
155
155
  *ContentLibraryQuizApi* | [**postLibraryQuizArchive**](docs/ContentLibraryQuizApi.md#postlibraryquizarchive) | **POST** /content-library/quizzes/{quizId}/archive | Archive a reusable quiz
156
156
  *ContentLibraryQuizApi* | [**postLibraryQuizCriteriaPreview**](docs/ContentLibraryQuizApi.md#postlibraryquizcriteriapreview) | **POST** /content-library/quizzes/{quizId}/versions/{versionId}/criteria/preview | Preview questions matching unsaved quiz-selection criteria
@@ -625,7 +625,7 @@ and is automatically generated by the
625
625
  [OpenAPI Generator](https://openapi-generator.tech) project:
626
626
 
627
627
  - API version: `1.0.0`
628
- - Package version: `1.102.0`
628
+ - Package version: `1.103.0`
629
629
  - Generator version: `7.22.0`
630
630
  - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
631
631
 
@@ -89,6 +89,7 @@ export interface PostCourseLibraryQuizSessionRequest {
89
89
  courseId: string;
90
90
  courseVersionId: string;
91
91
  itemId: string;
92
+ preview?: boolean;
92
93
  postCourseLibraryQuizSession?: PostCourseLibraryQuizSession;
93
94
  }
94
95
  export interface PostLibraryQuizRequest {
@@ -296,11 +297,11 @@ export declare class ContentLibraryQuizApi extends runtime.BaseAPI {
296
297
  */
297
298
  postCourseLibraryQuizSessionRequestOpts(requestParameters: PostCourseLibraryQuizSessionRequest): Promise<runtime.RequestOpts>;
298
299
  /**
299
- * Start or resume a live attempt for a course-pinned quiz version
300
+ * Start or resume a live or sandbox-preview attempt for a course-pinned quiz version
300
301
  */
301
302
  postCourseLibraryQuizSessionRaw(requestParameters: PostCourseLibraryQuizSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetLibraryQuizSession>>;
302
303
  /**
303
- * Start or resume a live attempt for a course-pinned quiz version
304
+ * Start or resume a live or sandbox-preview attempt for a course-pinned quiz version
304
305
  */
305
306
  postCourseLibraryQuizSession(requestParameters: PostCourseLibraryQuizSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetLibraryQuizSession>;
306
307
  /**
@@ -552,6 +552,9 @@ class ContentLibraryQuizApi extends runtime.BaseAPI {
552
552
  throw new runtime.RequiredError('itemId', 'Required parameter "itemId" was null or undefined when calling postCourseLibraryQuizSession().');
553
553
  }
554
554
  const queryParameters = {};
555
+ if (requestParameters['preview'] != null) {
556
+ queryParameters['preview'] = requestParameters['preview'];
557
+ }
555
558
  const headerParameters = {};
556
559
  headerParameters['Content-Type'] = 'application/json';
557
560
  let urlPath = `/courses/{courseId}/versions/{courseVersionId}/items/{itemId}/quiz-sessions`;
@@ -568,7 +571,7 @@ class ContentLibraryQuizApi extends runtime.BaseAPI {
568
571
  });
569
572
  }
570
573
  /**
571
- * Start or resume a live attempt for a course-pinned quiz version
574
+ * Start or resume a live or sandbox-preview attempt for a course-pinned quiz version
572
575
  */
573
576
  postCourseLibraryQuizSessionRaw(requestParameters, initOverrides) {
574
577
  return __awaiter(this, void 0, void 0, function* () {
@@ -578,7 +581,7 @@ class ContentLibraryQuizApi extends runtime.BaseAPI {
578
581
  });
579
582
  }
580
583
  /**
581
- * Start or resume a live attempt for a course-pinned quiz version
584
+ * Start or resume a live or sandbox-preview attempt for a course-pinned quiz version
582
585
  */
583
586
  postCourseLibraryQuizSession(requestParameters, initOverrides) {
584
587
  return __awaiter(this, void 0, void 0, function* () {
@@ -115,11 +115,13 @@ export interface GetCourseListRequest {
115
115
  export interface GetCourseVersionRequest {
116
116
  courseId: string;
117
117
  courseVersionId: string;
118
+ preview?: boolean;
118
119
  }
119
120
  export interface GetCourseVersionItemLaunchRequest {
120
121
  courseId: string;
121
122
  courseVersionId: string;
122
123
  itemId: string;
124
+ preview?: boolean;
123
125
  }
124
126
  export interface GetCourseVersionListRequest {
125
127
  courseId: string;
@@ -127,6 +129,7 @@ export interface GetCourseVersionListRequest {
127
129
  export interface GetCourseVersionProgressionRequest {
128
130
  courseId: string;
129
131
  courseVersionId: string;
132
+ preview?: boolean;
130
133
  }
131
134
  export interface PostCourseRequest {
132
135
  postCourse: PostCourse;
@@ -173,6 +176,7 @@ export interface PostCourseVersionItemSessionRequest {
173
176
  courseId: string;
174
177
  courseVersionId: string;
175
178
  itemId: string;
179
+ preview?: boolean;
176
180
  postCourseVersionItemSession?: PostCourseVersionItemSession;
177
181
  }
178
182
  export interface PostCourseVersionPublishRequest {
@@ -732,6 +732,9 @@ class CourseApi extends runtime.BaseAPI {
732
732
  throw new runtime.RequiredError('courseVersionId', 'Required parameter "courseVersionId" was null or undefined when calling getCourseVersion().');
733
733
  }
734
734
  const queryParameters = {};
735
+ if (requestParameters['preview'] != null) {
736
+ queryParameters['preview'] = requestParameters['preview'];
737
+ }
735
738
  const headerParameters = {};
736
739
  let urlPath = `/courses/{courseId}/versions/{courseVersionId}`;
737
740
  urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
@@ -778,6 +781,9 @@ class CourseApi extends runtime.BaseAPI {
778
781
  throw new runtime.RequiredError('itemId', 'Required parameter "itemId" was null or undefined when calling getCourseVersionItemLaunch().');
779
782
  }
780
783
  const queryParameters = {};
784
+ if (requestParameters['preview'] != null) {
785
+ queryParameters['preview'] = requestParameters['preview'];
786
+ }
781
787
  const headerParameters = {};
782
788
  let urlPath = `/courses/{courseId}/versions/{courseVersionId}/items/{itemId}/launch`;
783
789
  urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
@@ -861,6 +867,9 @@ class CourseApi extends runtime.BaseAPI {
861
867
  throw new runtime.RequiredError('courseVersionId', 'Required parameter "courseVersionId" was null or undefined when calling getCourseVersionProgression().');
862
868
  }
863
869
  const queryParameters = {};
870
+ if (requestParameters['preview'] != null) {
871
+ queryParameters['preview'] = requestParameters['preview'];
872
+ }
864
873
  const headerParameters = {};
865
874
  let urlPath = `/courses/{courseId}/versions/{courseVersionId}/progression`;
866
875
  urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
@@ -1373,6 +1382,9 @@ class CourseApi extends runtime.BaseAPI {
1373
1382
  throw new runtime.RequiredError('itemId', 'Required parameter "itemId" was null or undefined when calling postCourseVersionItemSession().');
1374
1383
  }
1375
1384
  const queryParameters = {};
1385
+ if (requestParameters['preview'] != null) {
1386
+ queryParameters['preview'] = requestParameters['preview'];
1387
+ }
1376
1388
  const headerParameters = {};
1377
1389
  headerParameters['Content-Type'] = 'application/json';
1378
1390
  let urlPath = `/courses/{courseId}/versions/{courseVersionId}/items/{itemId}/sessions`;
@@ -89,6 +89,7 @@ export interface PostCourseLibraryQuizSessionRequest {
89
89
  courseId: string;
90
90
  courseVersionId: string;
91
91
  itemId: string;
92
+ preview?: boolean;
92
93
  postCourseLibraryQuizSession?: PostCourseLibraryQuizSession;
93
94
  }
94
95
  export interface PostLibraryQuizRequest {
@@ -296,11 +297,11 @@ export declare class ContentLibraryQuizApi extends runtime.BaseAPI {
296
297
  */
297
298
  postCourseLibraryQuizSessionRequestOpts(requestParameters: PostCourseLibraryQuizSessionRequest): Promise<runtime.RequestOpts>;
298
299
  /**
299
- * Start or resume a live attempt for a course-pinned quiz version
300
+ * Start or resume a live or sandbox-preview attempt for a course-pinned quiz version
300
301
  */
301
302
  postCourseLibraryQuizSessionRaw(requestParameters: PostCourseLibraryQuizSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetLibraryQuizSession>>;
302
303
  /**
303
- * Start or resume a live attempt for a course-pinned quiz version
304
+ * Start or resume a live or sandbox-preview attempt for a course-pinned quiz version
304
305
  */
305
306
  postCourseLibraryQuizSession(requestParameters: PostCourseLibraryQuizSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetLibraryQuizSession>;
306
307
  /**
@@ -549,6 +549,9 @@ export class ContentLibraryQuizApi extends runtime.BaseAPI {
549
549
  throw new runtime.RequiredError('itemId', 'Required parameter "itemId" was null or undefined when calling postCourseLibraryQuizSession().');
550
550
  }
551
551
  const queryParameters = {};
552
+ if (requestParameters['preview'] != null) {
553
+ queryParameters['preview'] = requestParameters['preview'];
554
+ }
552
555
  const headerParameters = {};
553
556
  headerParameters['Content-Type'] = 'application/json';
554
557
  let urlPath = `/courses/{courseId}/versions/{courseVersionId}/items/{itemId}/quiz-sessions`;
@@ -565,7 +568,7 @@ export class ContentLibraryQuizApi extends runtime.BaseAPI {
565
568
  });
566
569
  }
567
570
  /**
568
- * Start or resume a live attempt for a course-pinned quiz version
571
+ * Start or resume a live or sandbox-preview attempt for a course-pinned quiz version
569
572
  */
570
573
  postCourseLibraryQuizSessionRaw(requestParameters, initOverrides) {
571
574
  return __awaiter(this, void 0, void 0, function* () {
@@ -575,7 +578,7 @@ export class ContentLibraryQuizApi extends runtime.BaseAPI {
575
578
  });
576
579
  }
577
580
  /**
578
- * Start or resume a live attempt for a course-pinned quiz version
581
+ * Start or resume a live or sandbox-preview attempt for a course-pinned quiz version
579
582
  */
580
583
  postCourseLibraryQuizSession(requestParameters, initOverrides) {
581
584
  return __awaiter(this, void 0, void 0, function* () {
@@ -115,11 +115,13 @@ export interface GetCourseListRequest {
115
115
  export interface GetCourseVersionRequest {
116
116
  courseId: string;
117
117
  courseVersionId: string;
118
+ preview?: boolean;
118
119
  }
119
120
  export interface GetCourseVersionItemLaunchRequest {
120
121
  courseId: string;
121
122
  courseVersionId: string;
122
123
  itemId: string;
124
+ preview?: boolean;
123
125
  }
124
126
  export interface GetCourseVersionListRequest {
125
127
  courseId: string;
@@ -127,6 +129,7 @@ export interface GetCourseVersionListRequest {
127
129
  export interface GetCourseVersionProgressionRequest {
128
130
  courseId: string;
129
131
  courseVersionId: string;
132
+ preview?: boolean;
130
133
  }
131
134
  export interface PostCourseRequest {
132
135
  postCourse: PostCourse;
@@ -173,6 +176,7 @@ export interface PostCourseVersionItemSessionRequest {
173
176
  courseId: string;
174
177
  courseVersionId: string;
175
178
  itemId: string;
179
+ preview?: boolean;
176
180
  postCourseVersionItemSession?: PostCourseVersionItemSession;
177
181
  }
178
182
  export interface PostCourseVersionPublishRequest {
@@ -729,6 +729,9 @@ export class CourseApi extends runtime.BaseAPI {
729
729
  throw new runtime.RequiredError('courseVersionId', 'Required parameter "courseVersionId" was null or undefined when calling getCourseVersion().');
730
730
  }
731
731
  const queryParameters = {};
732
+ if (requestParameters['preview'] != null) {
733
+ queryParameters['preview'] = requestParameters['preview'];
734
+ }
732
735
  const headerParameters = {};
733
736
  let urlPath = `/courses/{courseId}/versions/{courseVersionId}`;
734
737
  urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
@@ -775,6 +778,9 @@ export class CourseApi extends runtime.BaseAPI {
775
778
  throw new runtime.RequiredError('itemId', 'Required parameter "itemId" was null or undefined when calling getCourseVersionItemLaunch().');
776
779
  }
777
780
  const queryParameters = {};
781
+ if (requestParameters['preview'] != null) {
782
+ queryParameters['preview'] = requestParameters['preview'];
783
+ }
778
784
  const headerParameters = {};
779
785
  let urlPath = `/courses/{courseId}/versions/{courseVersionId}/items/{itemId}/launch`;
780
786
  urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
@@ -858,6 +864,9 @@ export class CourseApi extends runtime.BaseAPI {
858
864
  throw new runtime.RequiredError('courseVersionId', 'Required parameter "courseVersionId" was null or undefined when calling getCourseVersionProgression().');
859
865
  }
860
866
  const queryParameters = {};
867
+ if (requestParameters['preview'] != null) {
868
+ queryParameters['preview'] = requestParameters['preview'];
869
+ }
861
870
  const headerParameters = {};
862
871
  let urlPath = `/courses/{courseId}/versions/{courseVersionId}/progression`;
863
872
  urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
@@ -1370,6 +1379,9 @@ export class CourseApi extends runtime.BaseAPI {
1370
1379
  throw new runtime.RequiredError('itemId', 'Required parameter "itemId" was null or undefined when calling postCourseVersionItemSession().');
1371
1380
  }
1372
1381
  const queryParameters = {};
1382
+ if (requestParameters['preview'] != null) {
1383
+ queryParameters['preview'] = requestParameters['preview'];
1384
+ }
1373
1385
  const headerParameters = {};
1374
1386
  headerParameters['Content-Type'] = 'application/json';
1375
1387
  let urlPath = `/courses/{courseId}/versions/{courseVersionId}/items/{itemId}/sessions`;
@@ -13,7 +13,7 @@ import type { GetCourseVersionItemProgression } from './GetCourseVersionItemProg
13
13
  import type { CourseProgressionMode } from './CourseProgressionMode';
14
14
  import type { GetCourseVersionSectionProgression } from './GetCourseVersionSectionProgression';
15
15
  /**
16
- * Learner-specific completion and lock state for an enrollment-pinned course version.
16
+ * Learner-specific live completion state, or isolated sandbox completion state during an authorized course preview.
17
17
  * @export
18
18
  * @interface GetCourseVersionProgression
19
19
  */
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * Start or resume a learner attempt for an exact course resource version.
13
+ * Start or resume a learner attempt, or an isolated sandbox preview attempt, for an exact course resource version.
14
14
  * @export
15
15
  * @interface PostCourseVersionItemSession
16
16
  */
@@ -13,7 +13,7 @@ import type { GetCourseVersionItemProgression } from './GetCourseVersionItemProg
13
13
  import type { CourseProgressionMode } from './CourseProgressionMode';
14
14
  import type { GetCourseVersionSectionProgression } from './GetCourseVersionSectionProgression';
15
15
  /**
16
- * Learner-specific completion and lock state for an enrollment-pinned course version.
16
+ * Learner-specific live completion state, or isolated sandbox completion state during an authorized course preview.
17
17
  * @export
18
18
  * @interface GetCourseVersionProgression
19
19
  */
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * Start or resume a learner attempt for an exact course resource version.
13
+ * Start or resume a learner attempt, or an isolated sandbox preview attempt, for an exact course resource version.
14
14
  * @export
15
15
  * @interface PostCourseVersionItemSession
16
16
  */
@@ -15,7 +15,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
15
15
  | [**getLibraryQuizSessionResults**](ContentLibraryQuizApi.md#getlibraryquizsessionresults) | **GET** /quiz/sessions/{sessionId}/results | Get reusable quiz session results |
16
16
  | [**getLibraryQuizUsage**](ContentLibraryQuizApi.md#getlibraryquizusage) | **GET** /content-library/quizzes/{quizId}/usage | Get course and learner usage for a reusable quiz |
17
17
  | [**getLibraryQuizVersion**](ContentLibraryQuizApi.md#getlibraryquizversion) | **GET** /content-library/quizzes/{quizId}/versions/{versionId} | Get a reusable quiz version |
18
- | [**postCourseLibraryQuizSession**](ContentLibraryQuizApi.md#postcourselibraryquizsession) | **POST** /courses/{courseId}/versions/{courseVersionId}/items/{itemId}/quiz-sessions | Start or resume a live attempt for a course-pinned quiz version |
18
+ | [**postCourseLibraryQuizSession**](ContentLibraryQuizApi.md#postcourselibraryquizsession) | **POST** /courses/{courseId}/versions/{courseVersionId}/items/{itemId}/quiz-sessions | Start or resume a live or sandbox-preview attempt for a course-pinned quiz version |
19
19
  | [**postLibraryQuiz**](ContentLibraryQuizApi.md#postlibraryquiz) | **POST** /content-library/quizzes | Create a reusable quiz and its first draft version |
20
20
  | [**postLibraryQuizArchive**](ContentLibraryQuizApi.md#postlibraryquizarchive) | **POST** /content-library/quizzes/{quizId}/archive | Archive a reusable quiz |
21
21
  | [**postLibraryQuizCriteriaPreview**](ContentLibraryQuizApi.md#postlibraryquizcriteriapreview) | **POST** /content-library/quizzes/{quizId}/versions/{versionId}/criteria/preview | Preview questions matching unsaved quiz-selection criteria |
@@ -810,9 +810,9 @@ No authorization required
810
810
 
811
811
  ## postCourseLibraryQuizSession
812
812
 
813
- > GetLibraryQuizSession postCourseLibraryQuizSession(courseId, courseVersionId, itemId, postCourseLibraryQuizSession)
813
+ > GetLibraryQuizSession postCourseLibraryQuizSession(courseId, courseVersionId, itemId, preview, postCourseLibraryQuizSession)
814
814
 
815
- Start or resume a live attempt for a course-pinned quiz version
815
+ Start or resume a live or sandbox-preview attempt for a course-pinned quiz version
816
816
 
817
817
  ### Example
818
818
 
@@ -834,6 +834,8 @@ async function example() {
834
834
  courseVersionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
835
835
  // string
836
836
  itemId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
837
+ // boolean | Start or resume an isolated sandbox quiz attempt for course preview. (optional)
838
+ preview: true,
837
839
  // PostCourseLibraryQuizSession (optional)
838
840
  postCourseLibraryQuizSession: ...,
839
841
  } satisfies PostCourseLibraryQuizSessionRequest;
@@ -858,6 +860,7 @@ example().catch(console.error);
858
860
  | **courseId** | `string` | | [Defaults to `undefined`] |
859
861
  | **courseVersionId** | `string` | | [Defaults to `undefined`] |
860
862
  | **itemId** | `string` | | [Defaults to `undefined`] |
863
+ | **preview** | `boolean` | Start or resume an isolated sandbox quiz attempt for course preview. | [Optional] [Defaults to `false`] |
861
864
  | **postCourseLibraryQuizSession** | [PostCourseLibraryQuizSession](PostCourseLibraryQuizSession.md) | | [Optional] |
862
865
 
863
866
  ### Return type
@@ -877,7 +880,7 @@ No authorization required
877
880
  ### HTTP response details
878
881
  | Status code | Description | Response headers |
879
882
  |-------------|-------------|------------------|
880
- | **200** | Current or newly created live quiz session | - |
883
+ | **200** | Current or newly created live or sandbox-preview quiz session | - |
881
884
  | **403** | Learner is not assigned to the pinned course version | - |
882
885
  | **409** | Maximum attempts reached | - |
883
886
 
package/docs/CourseApi.md CHANGED
@@ -1107,7 +1107,7 @@ No authorization required
1107
1107
 
1108
1108
  ## getCourseVersion
1109
1109
 
1110
- > GetCourseVersion getCourseVersion(courseId, courseVersionId)
1110
+ > GetCourseVersion getCourseVersion(courseId, courseVersionId, preview)
1111
1111
 
1112
1112
  Get one immutable course version or preview the owned draft
1113
1113
 
@@ -1129,6 +1129,8 @@ async function example() {
1129
1129
  courseId: courseId_example,
1130
1130
  // string
1131
1131
  courseVersionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
1132
+ // boolean | Return the owning portal\'s draft or historical version with student visibility rules applied. (optional)
1133
+ preview: true,
1132
1134
  } satisfies GetCourseVersionRequest;
1133
1135
 
1134
1136
  try {
@@ -1150,6 +1152,7 @@ example().catch(console.error);
1150
1152
  |------------- | ------------- | ------------- | -------------|
1151
1153
  | **courseId** | `string` | | [Defaults to `undefined`] |
1152
1154
  | **courseVersionId** | `string` | | [Defaults to `undefined`] |
1155
+ | **preview** | `boolean` | Return the owning portal\&#39;s draft or historical version with student visibility rules applied. | [Optional] [Defaults to `false`] |
1153
1156
 
1154
1157
  ### Return type
1155
1158
 
@@ -1176,7 +1179,7 @@ No authorization required
1176
1179
 
1177
1180
  ## getCourseVersionItemLaunch
1178
1181
 
1179
- > GetCourseVersionItemLaunch getCourseVersionItemLaunch(courseId, courseVersionId, itemId)
1182
+ > GetCourseVersionItemLaunch getCourseVersionItemLaunch(courseId, courseVersionId, itemId, preview)
1180
1183
 
1181
1184
  Resolve the exact immutable resource launch selected by a course version
1182
1185
 
@@ -1200,6 +1203,8 @@ async function example() {
1200
1203
  courseVersionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
1201
1204
  // string
1202
1205
  itemId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
1206
+ // boolean | Resolve this placement in isolated student-view preview mode. (optional)
1207
+ preview: true,
1203
1208
  } satisfies GetCourseVersionItemLaunchRequest;
1204
1209
 
1205
1210
  try {
@@ -1222,6 +1227,7 @@ example().catch(console.error);
1222
1227
  | **courseId** | `string` | | [Defaults to `undefined`] |
1223
1228
  | **courseVersionId** | `string` | | [Defaults to `undefined`] |
1224
1229
  | **itemId** | `string` | | [Defaults to `undefined`] |
1230
+ | **preview** | `boolean` | Resolve this placement in isolated student-view preview mode. | [Optional] [Defaults to `false`] |
1225
1231
 
1226
1232
  ### Return type
1227
1233
 
@@ -1314,7 +1320,7 @@ No authorization required
1314
1320
 
1315
1321
  ## getCourseVersionProgression
1316
1322
 
1317
- > GetCourseVersionProgression getCourseVersionProgression(courseId, courseVersionId)
1323
+ > GetCourseVersionProgression getCourseVersionProgression(courseId, courseVersionId, preview)
1318
1324
 
1319
1325
  Get learner-specific completion and section lock state
1320
1326
 
@@ -1336,6 +1342,8 @@ async function example() {
1336
1342
  courseId: courseId_example,
1337
1343
  // string
1338
1344
  courseVersionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
1345
+ // boolean | Read isolated sandbox progress while previewing an owned draft or historical version. (optional)
1346
+ preview: true,
1339
1347
  } satisfies GetCourseVersionProgressionRequest;
1340
1348
 
1341
1349
  try {
@@ -1357,6 +1365,7 @@ example().catch(console.error);
1357
1365
  |------------- | ------------- | ------------- | -------------|
1358
1366
  | **courseId** | `string` | | [Defaults to `undefined`] |
1359
1367
  | **courseVersionId** | `string` | | [Defaults to `undefined`] |
1368
+ | **preview** | `boolean` | Read isolated sandbox progress while previewing an owned draft or historical version. | [Optional] [Defaults to `false`] |
1360
1369
 
1361
1370
  ### Return type
1362
1371
 
@@ -2085,7 +2094,7 @@ No authorization required
2085
2094
 
2086
2095
  ## postCourseVersionItemSession
2087
2096
 
2088
- > GetCourseVersionItemSession postCourseVersionItemSession(courseId, courseVersionId, itemId, postCourseVersionItemSession)
2097
+ > GetCourseVersionItemSession postCourseVersionItemSession(courseId, courseVersionId, itemId, preview, postCourseVersionItemSession)
2089
2098
 
2090
2099
  Start or resume a version-pinned resource attempt
2091
2100
 
@@ -2109,6 +2118,8 @@ async function example() {
2109
2118
  courseVersionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
2110
2119
  // string
2111
2120
  itemId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
2121
+ // boolean | Start or resume an isolated sandbox attempt for course preview. (optional)
2122
+ preview: true,
2112
2123
  // PostCourseVersionItemSession (optional)
2113
2124
  postCourseVersionItemSession: ...,
2114
2125
  } satisfies PostCourseVersionItemSessionRequest;
@@ -2133,6 +2144,7 @@ example().catch(console.error);
2133
2144
  | **courseId** | `string` | | [Defaults to `undefined`] |
2134
2145
  | **courseVersionId** | `string` | | [Defaults to `undefined`] |
2135
2146
  | **itemId** | `string` | | [Defaults to `undefined`] |
2147
+ | **preview** | `boolean` | Start or resume an isolated sandbox attempt for course preview. | [Optional] [Defaults to `false`] |
2136
2148
  | **postCourseVersionItemSession** | [PostCourseVersionItemSession](PostCourseVersionItemSession.md) | | [Optional] |
2137
2149
 
2138
2150
  ### Return type
@@ -1,7 +1,7 @@
1
1
 
2
2
  # GetCourseVersionProgression
3
3
 
4
- Learner-specific completion and lock state for an enrollment-pinned course version.
4
+ Learner-specific live completion state, or isolated sandbox completion state during an authorized course preview.
5
5
 
6
6
  ## Properties
7
7
 
@@ -1,7 +1,7 @@
1
1
 
2
2
  # PostCourseVersionItemSession
3
3
 
4
- Start or resume a learner attempt for an exact course resource version.
4
+ Start or resume a learner attempt, or an isolated sandbox preview attempt, for an exact course resource version.
5
5
 
6
6
  ## Properties
7
7
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@easyedu/js-lsm-api",
3
- "version": "1.102.0",
3
+ "version": "1.103.0",
4
4
  "description": "OpenAPI client for @easyedu/js-lsm-api",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
@@ -196,6 +196,7 @@ export interface PostCourseLibraryQuizSessionRequest {
196
196
  courseId: string;
197
197
  courseVersionId: string;
198
198
  itemId: string;
199
+ preview?: boolean;
199
200
  postCourseLibraryQuizSession?: PostCourseLibraryQuizSession;
200
201
  }
201
202
 
@@ -888,6 +889,10 @@ export class ContentLibraryQuizApi extends runtime.BaseAPI {
888
889
 
889
890
  const queryParameters: any = {};
890
891
 
892
+ if (requestParameters['preview'] != null) {
893
+ queryParameters['preview'] = requestParameters['preview'];
894
+ }
895
+
891
896
  const headerParameters: runtime.HTTPHeaders = {};
892
897
 
893
898
  headerParameters['Content-Type'] = 'application/json';
@@ -908,7 +913,7 @@ export class ContentLibraryQuizApi extends runtime.BaseAPI {
908
913
  }
909
914
 
910
915
  /**
911
- * Start or resume a live attempt for a course-pinned quiz version
916
+ * Start or resume a live or sandbox-preview attempt for a course-pinned quiz version
912
917
  */
913
918
  async postCourseLibraryQuizSessionRaw(requestParameters: PostCourseLibraryQuizSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetLibraryQuizSession>> {
914
919
  const requestOptions = await this.postCourseLibraryQuizSessionRequestOpts(requestParameters);
@@ -918,7 +923,7 @@ export class ContentLibraryQuizApi extends runtime.BaseAPI {
918
923
  }
919
924
 
920
925
  /**
921
- * Start or resume a live attempt for a course-pinned quiz version
926
+ * Start or resume a live or sandbox-preview attempt for a course-pinned quiz version
922
927
  */
923
928
  async postCourseLibraryQuizSession(requestParameters: PostCourseLibraryQuizSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetLibraryQuizSession> {
924
929
  const response = await this.postCourseLibraryQuizSessionRaw(requestParameters, initOverrides);
@@ -279,12 +279,14 @@ export interface GetCourseListRequest {
279
279
  export interface GetCourseVersionRequest {
280
280
  courseId: string;
281
281
  courseVersionId: string;
282
+ preview?: boolean;
282
283
  }
283
284
 
284
285
  export interface GetCourseVersionItemLaunchRequest {
285
286
  courseId: string;
286
287
  courseVersionId: string;
287
288
  itemId: string;
289
+ preview?: boolean;
288
290
  }
289
291
 
290
292
  export interface GetCourseVersionListRequest {
@@ -294,6 +296,7 @@ export interface GetCourseVersionListRequest {
294
296
  export interface GetCourseVersionProgressionRequest {
295
297
  courseId: string;
296
298
  courseVersionId: string;
299
+ preview?: boolean;
297
300
  }
298
301
 
299
302
  export interface PostCourseRequest {
@@ -351,6 +354,7 @@ export interface PostCourseVersionItemSessionRequest {
351
354
  courseId: string;
352
355
  courseVersionId: string;
353
356
  itemId: string;
357
+ preview?: boolean;
354
358
  postCourseVersionItemSession?: PostCourseVersionItemSession;
355
359
  }
356
360
 
@@ -1237,6 +1241,10 @@ export class CourseApi extends runtime.BaseAPI {
1237
1241
 
1238
1242
  const queryParameters: any = {};
1239
1243
 
1244
+ if (requestParameters['preview'] != null) {
1245
+ queryParameters['preview'] = requestParameters['preview'];
1246
+ }
1247
+
1240
1248
  const headerParameters: runtime.HTTPHeaders = {};
1241
1249
 
1242
1250
 
@@ -1297,6 +1305,10 @@ export class CourseApi extends runtime.BaseAPI {
1297
1305
 
1298
1306
  const queryParameters: any = {};
1299
1307
 
1308
+ if (requestParameters['preview'] != null) {
1309
+ queryParameters['preview'] = requestParameters['preview'];
1310
+ }
1311
+
1300
1312
  const headerParameters: runtime.HTTPHeaders = {};
1301
1313
 
1302
1314
 
@@ -1396,6 +1408,10 @@ export class CourseApi extends runtime.BaseAPI {
1396
1408
 
1397
1409
  const queryParameters: any = {};
1398
1410
 
1411
+ if (requestParameters['preview'] != null) {
1412
+ queryParameters['preview'] = requestParameters['preview'];
1413
+ }
1414
+
1399
1415
  const headerParameters: runtime.HTTPHeaders = {};
1400
1416
 
1401
1417
 
@@ -2027,6 +2043,10 @@ export class CourseApi extends runtime.BaseAPI {
2027
2043
 
2028
2044
  const queryParameters: any = {};
2029
2045
 
2046
+ if (requestParameters['preview'] != null) {
2047
+ queryParameters['preview'] = requestParameters['preview'];
2048
+ }
2049
+
2030
2050
  const headerParameters: runtime.HTTPHeaders = {};
2031
2051
 
2032
2052
  headerParameters['Content-Type'] = 'application/json';
@@ -36,7 +36,7 @@ import {
36
36
  } from './GetCourseVersionSectionProgression';
37
37
 
38
38
  /**
39
- * Learner-specific completion and lock state for an enrollment-pinned course version.
39
+ * Learner-specific live completion state, or isolated sandbox completion state during an authorized course preview.
40
40
  * @export
41
41
  * @interface GetCourseVersionProgression
42
42
  */
@@ -14,7 +14,7 @@
14
14
 
15
15
  import { mapValues } from '../runtime';
16
16
  /**
17
- * Start or resume a learner attempt for an exact course resource version.
17
+ * Start or resume a learner attempt, or an isolated sandbox preview attempt, for an exact course resource version.
18
18
  * @export
19
19
  * @interface PostCourseVersionItemSession
20
20
  */