@easyedu/js-lsm-api 1.109.0 → 1.111.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.
Files changed (132) hide show
  1. package/.openapi-generator/FILES +20 -0
  2. package/README.md +23 -4
  3. package/dist/apis/ContentLibraryApi.d.ts +5 -4
  4. package/dist/apis/ContentLibraryApi.js +6 -5
  5. package/dist/apis/LearnerExperienceApi.d.ts +153 -0
  6. package/dist/apis/LearnerExperienceApi.js +401 -0
  7. package/dist/apis/QuestionApi.d.ts +1 -11
  8. package/dist/apis/QuestionApi.js +3 -14
  9. package/dist/apis/index.d.ts +1 -0
  10. package/dist/apis/index.js +1 -0
  11. package/dist/esm/apis/ContentLibraryApi.d.ts +5 -4
  12. package/dist/esm/apis/ContentLibraryApi.js +6 -5
  13. package/dist/esm/apis/LearnerExperienceApi.d.ts +153 -0
  14. package/dist/esm/apis/LearnerExperienceApi.js +397 -0
  15. package/dist/esm/apis/QuestionApi.d.ts +1 -11
  16. package/dist/esm/apis/QuestionApi.js +2 -13
  17. package/dist/esm/apis/index.d.ts +1 -0
  18. package/dist/esm/apis/index.js +1 -0
  19. package/dist/esm/models/ContentLibraryTag.d.ts +6 -0
  20. package/dist/esm/models/ContentLibraryTag.js +4 -0
  21. package/dist/esm/models/ContentLibraryTagItem.d.ts +1 -0
  22. package/dist/esm/models/ContentLibraryTagItem.js +2 -1
  23. package/dist/esm/models/GetEffectiveLearnerExperience.d.ts +62 -0
  24. package/dist/esm/models/GetEffectiveLearnerExperience.js +62 -0
  25. package/dist/esm/models/GetLearnerDashboard.d.ts +47 -0
  26. package/dist/esm/models/GetLearnerDashboard.js +54 -0
  27. package/dist/esm/models/GetLearnerDashboardCourseList.d.ts +39 -0
  28. package/dist/esm/models/GetLearnerDashboardCourseList.js +48 -0
  29. package/dist/esm/models/GetLearnerDashboardSummary.d.ts +56 -0
  30. package/dist/esm/models/GetLearnerDashboardSummary.js +59 -0
  31. package/dist/esm/models/GetLearnerExperience.d.ts +67 -0
  32. package/dist/esm/models/GetLearnerExperience.js +65 -0
  33. package/dist/esm/models/GetLearnerExperiencePreview.d.ts +40 -0
  34. package/dist/esm/models/GetLearnerExperiencePreview.js +47 -0
  35. package/dist/esm/models/GetQuestion.d.ts +4 -18
  36. package/dist/esm/models/GetQuestion.js +3 -14
  37. package/dist/esm/models/GetQuestionListFilters.d.ts +3 -18
  38. package/dist/esm/models/GetQuestionListFilters.js +2 -12
  39. package/dist/esm/models/LearnerExperienceVersion.d.ts +86 -0
  40. package/dist/esm/models/LearnerExperienceVersion.js +76 -0
  41. package/dist/esm/models/LibraryQuizCriteriaPreviewQuestion.d.ts +0 -15
  42. package/dist/esm/models/LibraryQuizCriteriaPreviewQuestion.js +0 -12
  43. package/dist/esm/models/LibraryQuizCriterion.d.ts +0 -15
  44. package/dist/esm/models/LibraryQuizCriterion.js +0 -10
  45. package/dist/esm/models/PostLearnerExperiencePreview.d.ts +40 -0
  46. package/dist/esm/models/PostLearnerExperiencePreview.js +45 -0
  47. package/dist/esm/models/PostQuestion.d.ts +0 -15
  48. package/dist/esm/models/PostQuestion.js +0 -12
  49. package/dist/esm/models/PutLearnerExperienceDraft.d.ts +40 -0
  50. package/dist/esm/models/PutLearnerExperienceDraft.js +45 -0
  51. package/dist/esm/models/PutQuestion.d.ts +0 -15
  52. package/dist/esm/models/PutQuestion.js +0 -10
  53. package/dist/esm/models/index.d.ts +9 -0
  54. package/dist/esm/models/index.js +9 -0
  55. package/dist/models/ContentLibraryTag.d.ts +6 -0
  56. package/dist/models/ContentLibraryTag.js +4 -0
  57. package/dist/models/ContentLibraryTagItem.d.ts +1 -0
  58. package/dist/models/ContentLibraryTagItem.js +2 -1
  59. package/dist/models/GetEffectiveLearnerExperience.d.ts +62 -0
  60. package/dist/models/GetEffectiveLearnerExperience.js +70 -0
  61. package/dist/models/GetLearnerDashboard.d.ts +47 -0
  62. package/dist/models/GetLearnerDashboard.js +61 -0
  63. package/dist/models/GetLearnerDashboardCourseList.d.ts +39 -0
  64. package/dist/models/GetLearnerDashboardCourseList.js +55 -0
  65. package/dist/models/GetLearnerDashboardSummary.d.ts +56 -0
  66. package/dist/models/GetLearnerDashboardSummary.js +66 -0
  67. package/dist/models/GetLearnerExperience.d.ts +67 -0
  68. package/dist/models/GetLearnerExperience.js +73 -0
  69. package/dist/models/GetLearnerExperiencePreview.d.ts +40 -0
  70. package/dist/models/GetLearnerExperiencePreview.js +54 -0
  71. package/dist/models/GetQuestion.d.ts +4 -18
  72. package/dist/models/GetQuestion.js +4 -15
  73. package/dist/models/GetQuestionListFilters.d.ts +3 -18
  74. package/dist/models/GetQuestionListFilters.js +3 -13
  75. package/dist/models/LearnerExperienceVersion.d.ts +86 -0
  76. package/dist/models/LearnerExperienceVersion.js +84 -0
  77. package/dist/models/LibraryQuizCriteriaPreviewQuestion.d.ts +0 -15
  78. package/dist/models/LibraryQuizCriteriaPreviewQuestion.js +1 -13
  79. package/dist/models/LibraryQuizCriterion.d.ts +0 -15
  80. package/dist/models/LibraryQuizCriterion.js +1 -11
  81. package/dist/models/PostLearnerExperiencePreview.d.ts +40 -0
  82. package/dist/models/PostLearnerExperiencePreview.js +52 -0
  83. package/dist/models/PostQuestion.d.ts +0 -15
  84. package/dist/models/PostQuestion.js +1 -13
  85. package/dist/models/PutLearnerExperienceDraft.d.ts +40 -0
  86. package/dist/models/PutLearnerExperienceDraft.js +52 -0
  87. package/dist/models/PutQuestion.d.ts +0 -15
  88. package/dist/models/PutQuestion.js +1 -11
  89. package/dist/models/index.d.ts +9 -0
  90. package/dist/models/index.js +9 -0
  91. package/docs/ContentLibraryApi.md +7 -7
  92. package/docs/ContentLibraryTag.md +2 -0
  93. package/docs/GetEffectiveLearnerExperience.md +40 -0
  94. package/docs/GetLearnerDashboard.md +38 -0
  95. package/docs/GetLearnerDashboardCourseList.md +36 -0
  96. package/docs/GetLearnerDashboardSummary.md +42 -0
  97. package/docs/GetLearnerExperience.md +42 -0
  98. package/docs/GetLearnerExperiencePreview.md +36 -0
  99. package/docs/GetQuestion.md +1 -3
  100. package/docs/GetQuestionListFilters.md +2 -4
  101. package/docs/LearnerExperienceApi.md +622 -0
  102. package/docs/LearnerExperienceVersion.md +48 -0
  103. package/docs/LibraryQuizCriteriaPreviewQuestion.md +0 -2
  104. package/docs/LibraryQuizCriterion.md +0 -2
  105. package/docs/PostLearnerExperiencePreview.md +36 -0
  106. package/docs/PostQuestion.md +0 -2
  107. package/docs/PutLearnerExperienceDraft.md +36 -0
  108. package/docs/PutQuestion.md +0 -2
  109. package/docs/QuestionApi.md +4 -7
  110. package/package.json +1 -1
  111. package/src/apis/ContentLibraryApi.ts +6 -5
  112. package/src/apis/LearnerExperienceApi.ts +465 -0
  113. package/src/apis/QuestionApi.ts +3 -17
  114. package/src/apis/index.ts +1 -0
  115. package/src/models/ContentLibraryTag.ts +9 -0
  116. package/src/models/ContentLibraryTagItem.ts +2 -1
  117. package/src/models/GetEffectiveLearnerExperience.ts +105 -0
  118. package/src/models/GetLearnerDashboard.ts +106 -0
  119. package/src/models/GetLearnerDashboardCourseList.ts +83 -0
  120. package/src/models/GetLearnerDashboardSummary.ts +102 -0
  121. package/src/models/GetLearnerExperience.ts +121 -0
  122. package/src/models/GetLearnerExperiencePreview.ts +75 -0
  123. package/src/models/GetQuestion.ts +12 -24
  124. package/src/models/GetQuestionListFilters.ts +5 -23
  125. package/src/models/LearnerExperienceVersion.ts +140 -0
  126. package/src/models/LibraryQuizCriteriaPreviewQuestion.ts +0 -19
  127. package/src/models/LibraryQuizCriterion.ts +0 -18
  128. package/src/models/PostLearnerExperiencePreview.ts +74 -0
  129. package/src/models/PostQuestion.ts +0 -19
  130. package/src/models/PutLearnerExperienceDraft.ts +74 -0
  131. package/src/models/PutQuestion.ts +0 -18
  132. package/src/models/index.ts +9 -0
@@ -0,0 +1,36 @@
1
+
2
+ # PostLearnerExperiencePreview
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `designDocument` | { [key: string]: any; }
10
+ `changeNotes` | string
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { PostLearnerExperiencePreview } from '@easyedu/js-lsm-api'
16
+
17
+ // TODO: Update the object below with actual values
18
+ const example = {
19
+ "designDocument": null,
20
+ "changeNotes": null,
21
+ } satisfies PostLearnerExperiencePreview
22
+
23
+ console.log(example)
24
+
25
+ // Convert the instance to a JSON string
26
+ const exampleJSON: string = JSON.stringify(example)
27
+ console.log(exampleJSON)
28
+
29
+ // Parse the JSON string back to an object
30
+ const exampleParsed = JSON.parse(exampleJSON) as PostLearnerExperiencePreview
31
+ console.log(exampleParsed)
32
+ ```
33
+
34
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
35
+
36
+
@@ -11,7 +11,6 @@ Name | Type
11
11
  `answerChoices` | [Array<PostQuestionAnswerChoicesInner>](PostQuestionAnswerChoicesInner.md)
12
12
  `correctAnswer` | string
13
13
  `explanation` | [RichTextInput](RichTextInput.md)
14
- `difficultyLevel` | string
15
14
  `tags` | Array<string>
16
15
  `version` | string
17
16
 
@@ -27,7 +26,6 @@ const example = {
27
26
  "answerChoices": null,
28
27
  "correctAnswer": null,
29
28
  "explanation": null,
30
- "difficultyLevel": null,
31
29
  "tags": null,
32
30
  "version": null,
33
31
  } satisfies PostQuestion
@@ -0,0 +1,36 @@
1
+
2
+ # PutLearnerExperienceDraft
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `designDocument` | { [key: string]: any; }
10
+ `changeNotes` | string
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { PutLearnerExperienceDraft } from '@easyedu/js-lsm-api'
16
+
17
+ // TODO: Update the object below with actual values
18
+ const example = {
19
+ "designDocument": null,
20
+ "changeNotes": null,
21
+ } satisfies PutLearnerExperienceDraft
22
+
23
+ console.log(example)
24
+
25
+ // Convert the instance to a JSON string
26
+ const exampleJSON: string = JSON.stringify(example)
27
+ console.log(exampleJSON)
28
+
29
+ // Parse the JSON string back to an object
30
+ const exampleParsed = JSON.parse(exampleJSON) as PutLearnerExperienceDraft
31
+ console.log(exampleParsed)
32
+ ```
33
+
34
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
35
+
36
+
@@ -11,7 +11,6 @@ Name | Type
11
11
  `answerChoices` | [Array<PutQuestionAnswerChoicesInner>](PutQuestionAnswerChoicesInner.md)
12
12
  `correctAnswer` | string
13
13
  `explanation` | [RichTextInput](RichTextInput.md)
14
- `difficultyLevel` | string
15
14
  `tags` | Array<string>
16
15
  `version` | string
17
16
 
@@ -27,7 +26,6 @@ const example = {
27
26
  "answerChoices": null,
28
27
  "correctAnswer": null,
29
28
  "explanation": null,
30
- "difficultyLevel": null,
31
29
  "tags": null,
32
30
  "version": null,
33
31
  } satisfies PutQuestion
@@ -147,7 +147,7 @@ No authorization required
147
147
 
148
148
  ## getQuestionList
149
149
 
150
- > GetQuestionList getQuestionList(page, pageSize, questionType, difficultyLevel, tags, search)
150
+ > GetQuestionList getQuestionList(page, pageSize, questionType, tagId, search)
151
151
 
152
152
  Get list of questions with filtering and pagination
153
153
 
@@ -171,10 +171,8 @@ async function example() {
171
171
  pageSize: 56,
172
172
  // 'single_answer' | 'multiple_answer' | 'fill_in_blank' | Filter by question type (optional)
173
173
  questionType: questionType_example,
174
- // 'beginner' | 'intermediate' | 'advanced' | Filter by difficulty level (optional)
175
- difficultyLevel: difficultyLevel_example,
176
- // Array<string> | Filter by tags (optional)
177
- tags: ...,
174
+ // string | Filter by a shared tag (optional)
175
+ tagId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
178
176
  // string | Search in question text (optional)
179
177
  search: search_example,
180
178
  } satisfies GetQuestionListRequest;
@@ -199,8 +197,7 @@ example().catch(console.error);
199
197
  | **page** | `number` | Page number | [Optional] [Defaults to `1`] |
200
198
  | **pageSize** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
201
199
  | **questionType** | `single_answer`, `multiple_answer`, `fill_in_blank` | Filter by question type | [Optional] [Defaults to `undefined`] [Enum: single_answer, multiple_answer, fill_in_blank] |
202
- | **difficultyLevel** | `beginner`, `intermediate`, `advanced` | Filter by difficulty level | [Optional] [Defaults to `undefined`] [Enum: beginner, intermediate, advanced] |
203
- | **tags** | `Array<string>` | Filter by tags | [Optional] |
200
+ | **tagId** | `string` | Filter by a shared tag | [Optional] [Defaults to `undefined`] |
204
201
  | **search** | `string` | Search in question text | [Optional] [Defaults to `undefined`] |
205
202
 
206
203
  ### Return type
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@easyedu/js-lsm-api",
3
- "version": "1.109.0",
3
+ "version": "1.111.0",
4
4
  "description": "OpenAPI client for @easyedu/js-lsm-api",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
@@ -288,7 +288,7 @@ export class ContentLibraryApi extends runtime.BaseAPI {
288
288
  }
289
289
 
290
290
  /**
291
- * Delete an archived, unused Content Library tag
291
+ * Delete a Content Library tag and remove it from associated content
292
292
  */
293
293
  async deleteContentLibraryTagRaw(requestParameters: DeleteContentLibraryTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
294
294
  const requestOptions = await this.deleteContentLibraryTagRequestOpts(requestParameters);
@@ -298,7 +298,7 @@ export class ContentLibraryApi extends runtime.BaseAPI {
298
298
  }
299
299
 
300
300
  /**
301
- * Delete an archived, unused Content Library tag
301
+ * Delete a Content Library tag and remove it from associated content
302
302
  */
303
303
  async deleteContentLibraryTag(requestParameters: DeleteContentLibraryTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
304
304
  await this.deleteContentLibraryTagRaw(requestParameters, initOverrides);
@@ -510,7 +510,7 @@ export class ContentLibraryApi extends runtime.BaseAPI {
510
510
  }
511
511
 
512
512
  /**
513
- * List resources and quizzes associated with a tag
513
+ * List resources, quizzes, and questions associated with a tag
514
514
  */
515
515
  async getContentLibraryTagItemListRaw(requestParameters: GetContentLibraryTagItemListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContentLibraryTagItemList>> {
516
516
  const requestOptions = await this.getContentLibraryTagItemListRequestOpts(requestParameters);
@@ -520,7 +520,7 @@ export class ContentLibraryApi extends runtime.BaseAPI {
520
520
  }
521
521
 
522
522
  /**
523
- * List resources and quizzes associated with a tag
523
+ * List resources, quizzes, and questions associated with a tag
524
524
  */
525
525
  async getContentLibraryTagItemList(requestParameters: GetContentLibraryTagItemListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentLibraryTagItemList> {
526
526
  const response = await this.getContentLibraryTagItemListRaw(requestParameters, initOverrides);
@@ -1650,7 +1650,8 @@ export class ContentLibraryApi extends runtime.BaseAPI {
1650
1650
  */
1651
1651
  export const GetContentLibraryTagItemListKindEnum = {
1652
1652
  Resource: 'resource',
1653
- Quiz: 'quiz'
1653
+ Quiz: 'quiz',
1654
+ Question: 'question'
1654
1655
  } as const;
1655
1656
  export type GetContentLibraryTagItemListKindEnum = typeof GetContentLibraryTagItemListKindEnum[keyof typeof GetContentLibraryTagItemListKindEnum];
1656
1657
  /**
@@ -0,0 +1,465 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * LMS API
5
+ * LMS API
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import * as runtime from '../runtime';
16
+ import {
17
+ type GetEffectiveLearnerExperience,
18
+ GetEffectiveLearnerExperienceFromJSON,
19
+ GetEffectiveLearnerExperienceToJSON,
20
+ } from '../models/GetEffectiveLearnerExperience';
21
+ import {
22
+ type GetLearnerDashboard,
23
+ GetLearnerDashboardFromJSON,
24
+ GetLearnerDashboardToJSON,
25
+ } from '../models/GetLearnerDashboard';
26
+ import {
27
+ type GetLearnerExperience,
28
+ GetLearnerExperienceFromJSON,
29
+ GetLearnerExperienceToJSON,
30
+ } from '../models/GetLearnerExperience';
31
+ import {
32
+ type GetLearnerExperiencePreview,
33
+ GetLearnerExperiencePreviewFromJSON,
34
+ GetLearnerExperiencePreviewToJSON,
35
+ } from '../models/GetLearnerExperiencePreview';
36
+ import {
37
+ type LearnerExperienceVersion,
38
+ LearnerExperienceVersionFromJSON,
39
+ LearnerExperienceVersionToJSON,
40
+ } from '../models/LearnerExperienceVersion';
41
+ import {
42
+ type PostLearnerExperiencePreview,
43
+ PostLearnerExperiencePreviewFromJSON,
44
+ PostLearnerExperiencePreviewToJSON,
45
+ } from '../models/PostLearnerExperiencePreview';
46
+ import {
47
+ type PutLearnerExperienceDraft,
48
+ PutLearnerExperienceDraftFromJSON,
49
+ PutLearnerExperienceDraftToJSON,
50
+ } from '../models/PutLearnerExperienceDraft';
51
+
52
+ export interface PostLearnerExperiencePreviewRequest {
53
+ postLearnerExperiencePreview: PostLearnerExperiencePreview;
54
+ }
55
+
56
+ export interface PostLearnerExperienceVersionRestoreRequest {
57
+ versionId: string;
58
+ }
59
+
60
+ export interface PutLearnerExperienceDraftRequest {
61
+ putLearnerExperienceDraft: PutLearnerExperienceDraft;
62
+ }
63
+
64
+ /**
65
+ *
66
+ */
67
+ export class LearnerExperienceApi extends runtime.BaseAPI {
68
+
69
+ /**
70
+ * Creates request options for deleteLearnerExperienceDraft without sending the request
71
+ */
72
+ async deleteLearnerExperienceDraftRequestOpts(): Promise<runtime.RequestOpts> {
73
+ const queryParameters: any = {};
74
+
75
+ const headerParameters: runtime.HTTPHeaders = {};
76
+
77
+
78
+ let urlPath = `/learner-experience/draft`;
79
+
80
+ return {
81
+ path: urlPath,
82
+ method: 'DELETE',
83
+ headers: headerParameters,
84
+ query: queryParameters,
85
+ };
86
+ }
87
+
88
+ /**
89
+ * Discard the selected portal\'s learner experience draft
90
+ */
91
+ async deleteLearnerExperienceDraftRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
92
+ const requestOptions = await this.deleteLearnerExperienceDraftRequestOpts();
93
+ const response = await this.request(requestOptions, initOverrides);
94
+
95
+ return new runtime.VoidApiResponse(response);
96
+ }
97
+
98
+ /**
99
+ * Discard the selected portal\'s learner experience draft
100
+ */
101
+ async deleteLearnerExperienceDraft(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
102
+ await this.deleteLearnerExperienceDraftRaw(initOverrides);
103
+ }
104
+
105
+ /**
106
+ * Creates request options for getCurrentLearnerDashboard without sending the request
107
+ */
108
+ async getCurrentLearnerDashboardRequestOpts(): Promise<runtime.RequestOpts> {
109
+ const queryParameters: any = {};
110
+
111
+ const headerParameters: runtime.HTTPHeaders = {};
112
+
113
+
114
+ let urlPath = `/users/current/dashboard`;
115
+
116
+ return {
117
+ path: urlPath,
118
+ method: 'GET',
119
+ headers: headerParameters,
120
+ query: queryParameters,
121
+ };
122
+ }
123
+
124
+ /**
125
+ * Get the authenticated learner\'s resolved dashboard and personalized data
126
+ */
127
+ async getCurrentLearnerDashboardRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetLearnerDashboard>> {
128
+ const requestOptions = await this.getCurrentLearnerDashboardRequestOpts();
129
+ const response = await this.request(requestOptions, initOverrides);
130
+
131
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetLearnerDashboardFromJSON(jsonValue));
132
+ }
133
+
134
+ /**
135
+ * Get the authenticated learner\'s resolved dashboard and personalized data
136
+ */
137
+ async getCurrentLearnerDashboard(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetLearnerDashboard> {
138
+ const response = await this.getCurrentLearnerDashboardRaw(initOverrides);
139
+ return await response.value();
140
+ }
141
+
142
+ /**
143
+ * Creates request options for getEffectiveLearnerExperience without sending the request
144
+ */
145
+ async getEffectiveLearnerExperienceRequestOpts(): Promise<runtime.RequestOpts> {
146
+ const queryParameters: any = {};
147
+
148
+ const headerParameters: runtime.HTTPHeaders = {};
149
+
150
+
151
+ let urlPath = `/learner-experience/effective`;
152
+
153
+ return {
154
+ path: urlPath,
155
+ method: 'GET',
156
+ headers: headerParameters,
157
+ query: queryParameters,
158
+ };
159
+ }
160
+
161
+ /**
162
+ * Get the effective published learner experience for the authenticated user
163
+ */
164
+ async getEffectiveLearnerExperienceRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetEffectiveLearnerExperience>> {
165
+ const requestOptions = await this.getEffectiveLearnerExperienceRequestOpts();
166
+ const response = await this.request(requestOptions, initOverrides);
167
+
168
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetEffectiveLearnerExperienceFromJSON(jsonValue));
169
+ }
170
+
171
+ /**
172
+ * Get the effective published learner experience for the authenticated user
173
+ */
174
+ async getEffectiveLearnerExperience(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetEffectiveLearnerExperience> {
175
+ const response = await this.getEffectiveLearnerExperienceRaw(initOverrides);
176
+ return await response.value();
177
+ }
178
+
179
+ /**
180
+ * Creates request options for getLearnerExperience without sending the request
181
+ */
182
+ async getLearnerExperienceRequestOpts(): Promise<runtime.RequestOpts> {
183
+ const queryParameters: any = {};
184
+
185
+ const headerParameters: runtime.HTTPHeaders = {};
186
+
187
+
188
+ let urlPath = `/learner-experience`;
189
+
190
+ return {
191
+ path: urlPath,
192
+ method: 'GET',
193
+ headers: headerParameters,
194
+ query: queryParameters,
195
+ };
196
+ }
197
+
198
+ /**
199
+ * Get the selected portal\'s effective learner experience and local history
200
+ */
201
+ async getLearnerExperienceRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetLearnerExperience>> {
202
+ const requestOptions = await this.getLearnerExperienceRequestOpts();
203
+ const response = await this.request(requestOptions, initOverrides);
204
+
205
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetLearnerExperienceFromJSON(jsonValue));
206
+ }
207
+
208
+ /**
209
+ * Get the selected portal\'s effective learner experience and local history
210
+ */
211
+ async getLearnerExperience(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetLearnerExperience> {
212
+ const response = await this.getLearnerExperienceRaw(initOverrides);
213
+ return await response.value();
214
+ }
215
+
216
+ /**
217
+ * Creates request options for postLearnerExperienceDraft without sending the request
218
+ */
219
+ async postLearnerExperienceDraftRequestOpts(): Promise<runtime.RequestOpts> {
220
+ const queryParameters: any = {};
221
+
222
+ const headerParameters: runtime.HTTPHeaders = {};
223
+
224
+
225
+ let urlPath = `/learner-experience/draft`;
226
+
227
+ return {
228
+ path: urlPath,
229
+ method: 'POST',
230
+ headers: headerParameters,
231
+ query: queryParameters,
232
+ };
233
+ }
234
+
235
+ /**
236
+ * Create a portal learner experience draft from the effective version
237
+ */
238
+ async postLearnerExperienceDraftRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LearnerExperienceVersion>> {
239
+ const requestOptions = await this.postLearnerExperienceDraftRequestOpts();
240
+ const response = await this.request(requestOptions, initOverrides);
241
+
242
+ return new runtime.JSONApiResponse(response, (jsonValue) => LearnerExperienceVersionFromJSON(jsonValue));
243
+ }
244
+
245
+ /**
246
+ * Create a portal learner experience draft from the effective version
247
+ */
248
+ async postLearnerExperienceDraft(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LearnerExperienceVersion> {
249
+ const response = await this.postLearnerExperienceDraftRaw(initOverrides);
250
+ return await response.value();
251
+ }
252
+
253
+ /**
254
+ * Creates request options for postLearnerExperienceInherit without sending the request
255
+ */
256
+ async postLearnerExperienceInheritRequestOpts(): Promise<runtime.RequestOpts> {
257
+ const queryParameters: any = {};
258
+
259
+ const headerParameters: runtime.HTTPHeaders = {};
260
+
261
+
262
+ let urlPath = `/learner-experience/inherit`;
263
+
264
+ return {
265
+ path: urlPath,
266
+ method: 'POST',
267
+ headers: headerParameters,
268
+ query: queryParameters,
269
+ };
270
+ }
271
+
272
+ /**
273
+ * Disable the local learner experience override and resume inheritance
274
+ */
275
+ async postLearnerExperienceInheritRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
276
+ const requestOptions = await this.postLearnerExperienceInheritRequestOpts();
277
+ const response = await this.request(requestOptions, initOverrides);
278
+
279
+ return new runtime.VoidApiResponse(response);
280
+ }
281
+
282
+ /**
283
+ * Disable the local learner experience override and resume inheritance
284
+ */
285
+ async postLearnerExperienceInherit(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
286
+ await this.postLearnerExperienceInheritRaw(initOverrides);
287
+ }
288
+
289
+ /**
290
+ * Creates request options for postLearnerExperiencePreview without sending the request
291
+ */
292
+ async postLearnerExperiencePreviewRequestOpts(requestParameters: PostLearnerExperiencePreviewRequest): Promise<runtime.RequestOpts> {
293
+ if (requestParameters['postLearnerExperiencePreview'] == null) {
294
+ throw new runtime.RequiredError(
295
+ 'postLearnerExperiencePreview',
296
+ 'Required parameter "postLearnerExperiencePreview" was null or undefined when calling postLearnerExperiencePreview().'
297
+ );
298
+ }
299
+
300
+ const queryParameters: any = {};
301
+
302
+ const headerParameters: runtime.HTTPHeaders = {};
303
+
304
+ headerParameters['Content-Type'] = 'application/json';
305
+
306
+
307
+ let urlPath = `/learner-experience/preview`;
308
+
309
+ return {
310
+ path: urlPath,
311
+ method: 'POST',
312
+ headers: headerParameters,
313
+ query: queryParameters,
314
+ body: PostLearnerExperiencePreviewToJSON(requestParameters['postLearnerExperiencePreview']),
315
+ };
316
+ }
317
+
318
+ /**
319
+ * Validate and preview an unsaved learner experience document
320
+ */
321
+ async postLearnerExperiencePreviewRaw(requestParameters: PostLearnerExperiencePreviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetLearnerExperiencePreview>> {
322
+ const requestOptions = await this.postLearnerExperiencePreviewRequestOpts(requestParameters);
323
+ const response = await this.request(requestOptions, initOverrides);
324
+
325
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetLearnerExperiencePreviewFromJSON(jsonValue));
326
+ }
327
+
328
+ /**
329
+ * Validate and preview an unsaved learner experience document
330
+ */
331
+ async postLearnerExperiencePreview(requestParameters: PostLearnerExperiencePreviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetLearnerExperiencePreview> {
332
+ const response = await this.postLearnerExperiencePreviewRaw(requestParameters, initOverrides);
333
+ return await response.value();
334
+ }
335
+
336
+ /**
337
+ * Creates request options for postLearnerExperiencePublish without sending the request
338
+ */
339
+ async postLearnerExperiencePublishRequestOpts(): Promise<runtime.RequestOpts> {
340
+ const queryParameters: any = {};
341
+
342
+ const headerParameters: runtime.HTTPHeaders = {};
343
+
344
+
345
+ let urlPath = `/learner-experience/publish`;
346
+
347
+ return {
348
+ path: urlPath,
349
+ method: 'POST',
350
+ headers: headerParameters,
351
+ query: queryParameters,
352
+ };
353
+ }
354
+
355
+ /**
356
+ * Publish the selected portal\'s learner experience draft
357
+ */
358
+ async postLearnerExperiencePublishRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LearnerExperienceVersion>> {
359
+ const requestOptions = await this.postLearnerExperiencePublishRequestOpts();
360
+ const response = await this.request(requestOptions, initOverrides);
361
+
362
+ return new runtime.JSONApiResponse(response, (jsonValue) => LearnerExperienceVersionFromJSON(jsonValue));
363
+ }
364
+
365
+ /**
366
+ * Publish the selected portal\'s learner experience draft
367
+ */
368
+ async postLearnerExperiencePublish(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LearnerExperienceVersion> {
369
+ const response = await this.postLearnerExperiencePublishRaw(initOverrides);
370
+ return await response.value();
371
+ }
372
+
373
+ /**
374
+ * Creates request options for postLearnerExperienceVersionRestore without sending the request
375
+ */
376
+ async postLearnerExperienceVersionRestoreRequestOpts(requestParameters: PostLearnerExperienceVersionRestoreRequest): Promise<runtime.RequestOpts> {
377
+ if (requestParameters['versionId'] == null) {
378
+ throw new runtime.RequiredError(
379
+ 'versionId',
380
+ 'Required parameter "versionId" was null or undefined when calling postLearnerExperienceVersionRestore().'
381
+ );
382
+ }
383
+
384
+ const queryParameters: any = {};
385
+
386
+ const headerParameters: runtime.HTTPHeaders = {};
387
+
388
+
389
+ let urlPath = `/learner-experience/versions/{versionId}/restore`;
390
+ urlPath = urlPath.replace('{versionId}', encodeURIComponent(String(requestParameters['versionId'])));
391
+
392
+ return {
393
+ path: urlPath,
394
+ method: 'POST',
395
+ headers: headerParameters,
396
+ query: queryParameters,
397
+ };
398
+ }
399
+
400
+ /**
401
+ * Create a new draft from a historical learner experience version
402
+ */
403
+ async postLearnerExperienceVersionRestoreRaw(requestParameters: PostLearnerExperienceVersionRestoreRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LearnerExperienceVersion>> {
404
+ const requestOptions = await this.postLearnerExperienceVersionRestoreRequestOpts(requestParameters);
405
+ const response = await this.request(requestOptions, initOverrides);
406
+
407
+ return new runtime.JSONApiResponse(response, (jsonValue) => LearnerExperienceVersionFromJSON(jsonValue));
408
+ }
409
+
410
+ /**
411
+ * Create a new draft from a historical learner experience version
412
+ */
413
+ async postLearnerExperienceVersionRestore(requestParameters: PostLearnerExperienceVersionRestoreRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LearnerExperienceVersion> {
414
+ const response = await this.postLearnerExperienceVersionRestoreRaw(requestParameters, initOverrides);
415
+ return await response.value();
416
+ }
417
+
418
+ /**
419
+ * Creates request options for putLearnerExperienceDraft without sending the request
420
+ */
421
+ async putLearnerExperienceDraftRequestOpts(requestParameters: PutLearnerExperienceDraftRequest): Promise<runtime.RequestOpts> {
422
+ if (requestParameters['putLearnerExperienceDraft'] == null) {
423
+ throw new runtime.RequiredError(
424
+ 'putLearnerExperienceDraft',
425
+ 'Required parameter "putLearnerExperienceDraft" was null or undefined when calling putLearnerExperienceDraft().'
426
+ );
427
+ }
428
+
429
+ const queryParameters: any = {};
430
+
431
+ const headerParameters: runtime.HTTPHeaders = {};
432
+
433
+ headerParameters['Content-Type'] = 'application/json';
434
+
435
+
436
+ let urlPath = `/learner-experience/draft`;
437
+
438
+ return {
439
+ path: urlPath,
440
+ method: 'PUT',
441
+ headers: headerParameters,
442
+ query: queryParameters,
443
+ body: PutLearnerExperienceDraftToJSON(requestParameters['putLearnerExperienceDraft']),
444
+ };
445
+ }
446
+
447
+ /**
448
+ * Update the selected portal\'s learner experience draft
449
+ */
450
+ async putLearnerExperienceDraftRaw(requestParameters: PutLearnerExperienceDraftRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LearnerExperienceVersion>> {
451
+ const requestOptions = await this.putLearnerExperienceDraftRequestOpts(requestParameters);
452
+ const response = await this.request(requestOptions, initOverrides);
453
+
454
+ return new runtime.JSONApiResponse(response, (jsonValue) => LearnerExperienceVersionFromJSON(jsonValue));
455
+ }
456
+
457
+ /**
458
+ * Update the selected portal\'s learner experience draft
459
+ */
460
+ async putLearnerExperienceDraft(requestParameters: PutLearnerExperienceDraftRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LearnerExperienceVersion> {
461
+ const response = await this.putLearnerExperienceDraftRaw(requestParameters, initOverrides);
462
+ return await response.value();
463
+ }
464
+
465
+ }