@easyedu/js-lsm-api 1.102.0 → 1.104.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 (118) hide show
  1. package/.openapi-generator/FILES +28 -0
  2. package/README.md +23 -3
  3. package/dist/apis/ChatApi.d.ts +98 -0
  4. package/dist/apis/ChatApi.js +255 -0
  5. package/dist/apis/ContentLibraryQuizApi.d.ts +3 -2
  6. package/dist/apis/ContentLibraryQuizApi.js +5 -2
  7. package/dist/apis/CourseApi.d.ts +4 -0
  8. package/dist/apis/CourseApi.js +12 -0
  9. package/dist/esm/apis/ChatApi.d.ts +98 -0
  10. package/dist/esm/apis/ChatApi.js +255 -0
  11. package/dist/esm/apis/ContentLibraryQuizApi.d.ts +3 -2
  12. package/dist/esm/apis/ContentLibraryQuizApi.js +5 -2
  13. package/dist/esm/apis/CourseApi.d.ts +4 -0
  14. package/dist/esm/apis/CourseApi.js +12 -0
  15. package/dist/esm/models/AdminChatMessage.d.ts +51 -0
  16. package/dist/esm/models/AdminChatMessage.js +54 -0
  17. package/dist/esm/models/AdminConversationDetail.d.ts +90 -0
  18. package/dist/esm/models/AdminConversationDetail.js +81 -0
  19. package/dist/esm/models/AdminConversationList.d.ts +57 -0
  20. package/dist/esm/models/AdminConversationList.js +60 -0
  21. package/dist/esm/models/AdminConversationSummary.d.ts +83 -0
  22. package/dist/esm/models/AdminConversationSummary.js +76 -0
  23. package/dist/esm/models/ChatDailyUsage.d.ts +39 -0
  24. package/dist/esm/models/ChatDailyUsage.js +48 -0
  25. package/dist/esm/models/ChatModelUsage.d.ts +68 -0
  26. package/dist/esm/models/ChatModelUsage.js +67 -0
  27. package/dist/esm/models/ChatQuota.d.ts +56 -0
  28. package/dist/esm/models/ChatQuota.js +59 -0
  29. package/dist/esm/models/ChatQuotaExceeded.d.ts +56 -0
  30. package/dist/esm/models/ChatQuotaExceeded.js +59 -0
  31. package/dist/esm/models/ChatTurnUsage.d.ts +82 -0
  32. package/dist/esm/models/ChatTurnUsage.js +78 -0
  33. package/dist/esm/models/ChatUsageTotals.d.ts +68 -0
  34. package/dist/esm/models/ChatUsageTotals.js +67 -0
  35. package/dist/esm/models/ChatUserIdentity.d.ts +50 -0
  36. package/dist/esm/models/ChatUserIdentity.js +55 -0
  37. package/dist/esm/models/GetChatSettings.d.ts +51 -0
  38. package/dist/esm/models/GetChatSettings.js +57 -0
  39. package/dist/esm/models/GetChatUsage.d.ts +59 -0
  40. package/dist/esm/models/GetChatUsage.js +62 -0
  41. package/dist/esm/models/GetCourseVersionProgression.d.ts +1 -1
  42. package/dist/esm/models/PostCourseVersionItemSession.d.ts +1 -1
  43. package/dist/esm/models/PutChatSettings.d.ts +32 -0
  44. package/dist/esm/models/PutChatSettings.js +43 -0
  45. package/dist/esm/models/index.d.ts +14 -0
  46. package/dist/esm/models/index.js +14 -0
  47. package/dist/models/AdminChatMessage.d.ts +51 -0
  48. package/dist/models/AdminChatMessage.js +61 -0
  49. package/dist/models/AdminConversationDetail.d.ts +90 -0
  50. package/dist/models/AdminConversationDetail.js +88 -0
  51. package/dist/models/AdminConversationList.d.ts +57 -0
  52. package/dist/models/AdminConversationList.js +67 -0
  53. package/dist/models/AdminConversationSummary.d.ts +83 -0
  54. package/dist/models/AdminConversationSummary.js +83 -0
  55. package/dist/models/ChatDailyUsage.d.ts +39 -0
  56. package/dist/models/ChatDailyUsage.js +55 -0
  57. package/dist/models/ChatModelUsage.d.ts +68 -0
  58. package/dist/models/ChatModelUsage.js +74 -0
  59. package/dist/models/ChatQuota.d.ts +56 -0
  60. package/dist/models/ChatQuota.js +66 -0
  61. package/dist/models/ChatQuotaExceeded.d.ts +56 -0
  62. package/dist/models/ChatQuotaExceeded.js +66 -0
  63. package/dist/models/ChatTurnUsage.d.ts +82 -0
  64. package/dist/models/ChatTurnUsage.js +86 -0
  65. package/dist/models/ChatUsageTotals.d.ts +68 -0
  66. package/dist/models/ChatUsageTotals.js +74 -0
  67. package/dist/models/ChatUserIdentity.d.ts +50 -0
  68. package/dist/models/ChatUserIdentity.js +62 -0
  69. package/dist/models/GetChatSettings.d.ts +51 -0
  70. package/dist/models/GetChatSettings.js +65 -0
  71. package/dist/models/GetChatUsage.d.ts +59 -0
  72. package/dist/models/GetChatUsage.js +69 -0
  73. package/dist/models/GetCourseVersionProgression.d.ts +1 -1
  74. package/dist/models/PostCourseVersionItemSession.d.ts +1 -1
  75. package/dist/models/PutChatSettings.d.ts +32 -0
  76. package/dist/models/PutChatSettings.js +50 -0
  77. package/dist/models/index.d.ts +14 -0
  78. package/dist/models/index.js +14 -0
  79. package/docs/AdminChatMessage.md +40 -0
  80. package/docs/AdminConversationDetail.md +52 -0
  81. package/docs/AdminConversationList.md +42 -0
  82. package/docs/AdminConversationSummary.md +50 -0
  83. package/docs/ChatApi.md +422 -0
  84. package/docs/ChatDailyUsage.md +36 -0
  85. package/docs/ChatModelUsage.md +46 -0
  86. package/docs/ChatQuota.md +42 -0
  87. package/docs/ChatQuotaExceeded.md +42 -0
  88. package/docs/ChatTurnUsage.md +48 -0
  89. package/docs/ChatUsageTotals.md +46 -0
  90. package/docs/ChatUserIdentity.md +40 -0
  91. package/docs/ContentLibraryQuizApi.md +7 -4
  92. package/docs/CourseApi.md +16 -4
  93. package/docs/GetChatSettings.md +38 -0
  94. package/docs/GetChatUsage.md +42 -0
  95. package/docs/GetCourseVersionProgression.md +1 -1
  96. package/docs/PostCourseVersionItemSession.md +1 -1
  97. package/docs/PutChatSettings.md +34 -0
  98. package/package.json +1 -1
  99. package/src/apis/ChatApi.ts +339 -0
  100. package/src/apis/ContentLibraryQuizApi.ts +7 -2
  101. package/src/apis/CourseApi.ts +20 -0
  102. package/src/models/AdminChatMessage.ts +100 -0
  103. package/src/models/AdminConversationDetail.ts +175 -0
  104. package/src/models/AdminConversationList.ts +110 -0
  105. package/src/models/AdminConversationSummary.ts +159 -0
  106. package/src/models/ChatDailyUsage.ts +83 -0
  107. package/src/models/ChatModelUsage.ts +120 -0
  108. package/src/models/ChatQuota.ts +102 -0
  109. package/src/models/ChatQuotaExceeded.ts +102 -0
  110. package/src/models/ChatTurnUsage.ts +140 -0
  111. package/src/models/ChatUsageTotals.ts +120 -0
  112. package/src/models/ChatUserIdentity.ts +93 -0
  113. package/src/models/GetChatSettings.ts +94 -0
  114. package/src/models/GetChatUsage.ts +124 -0
  115. package/src/models/GetCourseVersionProgression.ts +1 -1
  116. package/src/models/PostCourseVersionItemSession.ts +1 -1
  117. package/src/models/PutChatSettings.ts +66 -0
  118. package/src/models/index.ts +14 -0
@@ -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`;
@@ -10,15 +10,38 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
+ import { type AdminConversationDetail } from '../models/AdminConversationDetail';
14
+ import { type AdminConversationList } from '../models/AdminConversationList';
15
+ import { type ChatQuota } from '../models/ChatQuota';
13
16
  import { type GetChatMessage } from '../models/GetChatMessage';
17
+ import { type GetChatSettings } from '../models/GetChatSettings';
18
+ import { type GetChatUsage } from '../models/GetChatUsage';
14
19
  import { type GetConversationList } from '../models/GetConversationList';
15
20
  import { type PostConversation } from '../models/PostConversation';
16
21
  import { type PostConversationResponse } from '../models/PostConversationResponse';
17
22
  import { type PostMessage } from '../models/PostMessage';
18
23
  import { type PostMessageResponse } from '../models/PostMessageResponse';
24
+ import { type PutChatSettings } from '../models/PutChatSettings';
19
25
  export interface DeleteConversationRequest {
20
26
  conversationId: string;
21
27
  }
28
+ export interface GetChatAdminConversationRequest {
29
+ conversationId: string;
30
+ }
31
+ export interface GetChatAdminConversationsRequest {
32
+ page?: number;
33
+ pageSize?: number;
34
+ userId?: string;
35
+ model?: string;
36
+ createdFrom?: number;
37
+ createdTo?: number;
38
+ }
39
+ export interface GetChatAdminUsageRequest {
40
+ userId?: string;
41
+ model?: string;
42
+ from?: number;
43
+ to?: number;
44
+ }
22
45
  export interface GetConversationMessagesRequest {
23
46
  conversationId: string;
24
47
  }
@@ -33,6 +56,9 @@ export interface PostMessageRequest {
33
56
  conversationId: string;
34
57
  postMessage: PostMessage;
35
58
  }
59
+ export interface PutChatAdminSettingsRequest {
60
+ putChatSettings: PutChatSettings;
61
+ }
36
62
  /**
37
63
  *
38
64
  */
@@ -49,6 +75,66 @@ export declare class ChatApi extends runtime.BaseAPI {
49
75
  * Delete a conversation
50
76
  */
51
77
  deleteConversation(requestParameters: DeleteConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
78
+ /**
79
+ * Creates request options for getChatAdminConversation without sending the request
80
+ */
81
+ getChatAdminConversationRequestOpts(requestParameters: GetChatAdminConversationRequest): Promise<runtime.RequestOpts>;
82
+ /**
83
+ * Get a conversation transcript from the selected portal
84
+ */
85
+ getChatAdminConversationRaw(requestParameters: GetChatAdminConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConversationDetail>>;
86
+ /**
87
+ * Get a conversation transcript from the selected portal
88
+ */
89
+ getChatAdminConversation(requestParameters: GetChatAdminConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConversationDetail>;
90
+ /**
91
+ * Creates request options for getChatAdminConversations without sending the request
92
+ */
93
+ getChatAdminConversationsRequestOpts(requestParameters: GetChatAdminConversationsRequest): Promise<runtime.RequestOpts>;
94
+ /**
95
+ * List conversations in the selected portal
96
+ */
97
+ getChatAdminConversationsRaw(requestParameters: GetChatAdminConversationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConversationList>>;
98
+ /**
99
+ * List conversations in the selected portal
100
+ */
101
+ getChatAdminConversations(requestParameters?: GetChatAdminConversationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConversationList>;
102
+ /**
103
+ * Creates request options for getChatAdminSettings without sending the request
104
+ */
105
+ getChatAdminSettingsRequestOpts(): Promise<runtime.RequestOpts>;
106
+ /**
107
+ * Get chatbot settings for the selected portal
108
+ */
109
+ getChatAdminSettingsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetChatSettings>>;
110
+ /**
111
+ * Get chatbot settings for the selected portal
112
+ */
113
+ getChatAdminSettings(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetChatSettings>;
114
+ /**
115
+ * Creates request options for getChatAdminUsage without sending the request
116
+ */
117
+ getChatAdminUsageRequestOpts(requestParameters: GetChatAdminUsageRequest): Promise<runtime.RequestOpts>;
118
+ /**
119
+ * Get chatbot usage analytics for the selected portal
120
+ */
121
+ getChatAdminUsageRaw(requestParameters: GetChatAdminUsageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetChatUsage>>;
122
+ /**
123
+ * Get chatbot usage analytics for the selected portal
124
+ */
125
+ getChatAdminUsage(requestParameters?: GetChatAdminUsageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetChatUsage>;
126
+ /**
127
+ * Creates request options for getChatQuota without sending the request
128
+ */
129
+ getChatQuotaRequestOpts(): Promise<runtime.RequestOpts>;
130
+ /**
131
+ * Get the current user\'s chat quota
132
+ */
133
+ getChatQuotaRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ChatQuota>>;
134
+ /**
135
+ * Get the current user\'s chat quota
136
+ */
137
+ getChatQuota(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ChatQuota>;
52
138
  /**
53
139
  * Creates request options for getConversationMessages without sending the request
54
140
  */
@@ -97,4 +183,16 @@ export declare class ChatApi extends runtime.BaseAPI {
97
183
  * Send a message to a conversation
98
184
  */
99
185
  postMessage(requestParameters: PostMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostMessageResponse>;
186
+ /**
187
+ * Creates request options for putChatAdminSettings without sending the request
188
+ */
189
+ putChatAdminSettingsRequestOpts(requestParameters: PutChatAdminSettingsRequest): Promise<runtime.RequestOpts>;
190
+ /**
191
+ * Update chatbot settings for the selected portal
192
+ */
193
+ putChatAdminSettingsRaw(requestParameters: PutChatAdminSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetChatSettings>>;
194
+ /**
195
+ * Update chatbot settings for the selected portal
196
+ */
197
+ putChatAdminSettings(requestParameters: PutChatAdminSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetChatSettings>;
100
198
  }
@@ -21,12 +21,18 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
21
21
  });
22
22
  };
23
23
  import * as runtime from '../runtime';
24
+ import { AdminConversationDetailFromJSON, } from '../models/AdminConversationDetail';
25
+ import { AdminConversationListFromJSON, } from '../models/AdminConversationList';
26
+ import { ChatQuotaFromJSON, } from '../models/ChatQuota';
24
27
  import { GetChatMessageFromJSON, } from '../models/GetChatMessage';
28
+ import { GetChatSettingsFromJSON, } from '../models/GetChatSettings';
29
+ import { GetChatUsageFromJSON, } from '../models/GetChatUsage';
25
30
  import { GetConversationListFromJSON, } from '../models/GetConversationList';
26
31
  import { PostConversationToJSON, } from '../models/PostConversation';
27
32
  import { PostConversationResponseFromJSON, } from '../models/PostConversationResponse';
28
33
  import { PostMessageToJSON, } from '../models/PostMessage';
29
34
  import { PostMessageResponseFromJSON, } from '../models/PostMessageResponse';
35
+ import { PutChatSettingsToJSON, } from '../models/PutChatSettings';
30
36
  /**
31
37
  *
32
38
  */
@@ -69,6 +75,215 @@ export class ChatApi extends runtime.BaseAPI {
69
75
  yield this.deleteConversationRaw(requestParameters, initOverrides);
70
76
  });
71
77
  }
78
+ /**
79
+ * Creates request options for getChatAdminConversation without sending the request
80
+ */
81
+ getChatAdminConversationRequestOpts(requestParameters) {
82
+ return __awaiter(this, void 0, void 0, function* () {
83
+ if (requestParameters['conversationId'] == null) {
84
+ throw new runtime.RequiredError('conversationId', 'Required parameter "conversationId" was null or undefined when calling getChatAdminConversation().');
85
+ }
86
+ const queryParameters = {};
87
+ const headerParameters = {};
88
+ let urlPath = `/chat/admin/conversations/{conversationId}`;
89
+ urlPath = urlPath.replace('{conversationId}', encodeURIComponent(String(requestParameters['conversationId'])));
90
+ return {
91
+ path: urlPath,
92
+ method: 'GET',
93
+ headers: headerParameters,
94
+ query: queryParameters,
95
+ };
96
+ });
97
+ }
98
+ /**
99
+ * Get a conversation transcript from the selected portal
100
+ */
101
+ getChatAdminConversationRaw(requestParameters, initOverrides) {
102
+ return __awaiter(this, void 0, void 0, function* () {
103
+ const requestOptions = yield this.getChatAdminConversationRequestOpts(requestParameters);
104
+ const response = yield this.request(requestOptions, initOverrides);
105
+ return new runtime.JSONApiResponse(response, (jsonValue) => AdminConversationDetailFromJSON(jsonValue));
106
+ });
107
+ }
108
+ /**
109
+ * Get a conversation transcript from the selected portal
110
+ */
111
+ getChatAdminConversation(requestParameters, initOverrides) {
112
+ return __awaiter(this, void 0, void 0, function* () {
113
+ const response = yield this.getChatAdminConversationRaw(requestParameters, initOverrides);
114
+ return yield response.value();
115
+ });
116
+ }
117
+ /**
118
+ * Creates request options for getChatAdminConversations without sending the request
119
+ */
120
+ getChatAdminConversationsRequestOpts(requestParameters) {
121
+ return __awaiter(this, void 0, void 0, function* () {
122
+ const queryParameters = {};
123
+ if (requestParameters['page'] != null) {
124
+ queryParameters['page'] = requestParameters['page'];
125
+ }
126
+ if (requestParameters['pageSize'] != null) {
127
+ queryParameters['pageSize'] = requestParameters['pageSize'];
128
+ }
129
+ if (requestParameters['userId'] != null) {
130
+ queryParameters['userId'] = requestParameters['userId'];
131
+ }
132
+ if (requestParameters['model'] != null) {
133
+ queryParameters['model'] = requestParameters['model'];
134
+ }
135
+ if (requestParameters['createdFrom'] != null) {
136
+ queryParameters['createdFrom'] = requestParameters['createdFrom'];
137
+ }
138
+ if (requestParameters['createdTo'] != null) {
139
+ queryParameters['createdTo'] = requestParameters['createdTo'];
140
+ }
141
+ const headerParameters = {};
142
+ let urlPath = `/chat/admin/conversations`;
143
+ return {
144
+ path: urlPath,
145
+ method: 'GET',
146
+ headers: headerParameters,
147
+ query: queryParameters,
148
+ };
149
+ });
150
+ }
151
+ /**
152
+ * List conversations in the selected portal
153
+ */
154
+ getChatAdminConversationsRaw(requestParameters, initOverrides) {
155
+ return __awaiter(this, void 0, void 0, function* () {
156
+ const requestOptions = yield this.getChatAdminConversationsRequestOpts(requestParameters);
157
+ const response = yield this.request(requestOptions, initOverrides);
158
+ return new runtime.JSONApiResponse(response, (jsonValue) => AdminConversationListFromJSON(jsonValue));
159
+ });
160
+ }
161
+ /**
162
+ * List conversations in the selected portal
163
+ */
164
+ getChatAdminConversations() {
165
+ return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
166
+ const response = yield this.getChatAdminConversationsRaw(requestParameters, initOverrides);
167
+ return yield response.value();
168
+ });
169
+ }
170
+ /**
171
+ * Creates request options for getChatAdminSettings without sending the request
172
+ */
173
+ getChatAdminSettingsRequestOpts() {
174
+ return __awaiter(this, void 0, void 0, function* () {
175
+ const queryParameters = {};
176
+ const headerParameters = {};
177
+ let urlPath = `/chat/admin/settings`;
178
+ return {
179
+ path: urlPath,
180
+ method: 'GET',
181
+ headers: headerParameters,
182
+ query: queryParameters,
183
+ };
184
+ });
185
+ }
186
+ /**
187
+ * Get chatbot settings for the selected portal
188
+ */
189
+ getChatAdminSettingsRaw(initOverrides) {
190
+ return __awaiter(this, void 0, void 0, function* () {
191
+ const requestOptions = yield this.getChatAdminSettingsRequestOpts();
192
+ const response = yield this.request(requestOptions, initOverrides);
193
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetChatSettingsFromJSON(jsonValue));
194
+ });
195
+ }
196
+ /**
197
+ * Get chatbot settings for the selected portal
198
+ */
199
+ getChatAdminSettings(initOverrides) {
200
+ return __awaiter(this, void 0, void 0, function* () {
201
+ const response = yield this.getChatAdminSettingsRaw(initOverrides);
202
+ return yield response.value();
203
+ });
204
+ }
205
+ /**
206
+ * Creates request options for getChatAdminUsage without sending the request
207
+ */
208
+ getChatAdminUsageRequestOpts(requestParameters) {
209
+ return __awaiter(this, void 0, void 0, function* () {
210
+ const queryParameters = {};
211
+ if (requestParameters['userId'] != null) {
212
+ queryParameters['userId'] = requestParameters['userId'];
213
+ }
214
+ if (requestParameters['model'] != null) {
215
+ queryParameters['model'] = requestParameters['model'];
216
+ }
217
+ if (requestParameters['from'] != null) {
218
+ queryParameters['from'] = requestParameters['from'];
219
+ }
220
+ if (requestParameters['to'] != null) {
221
+ queryParameters['to'] = requestParameters['to'];
222
+ }
223
+ const headerParameters = {};
224
+ let urlPath = `/chat/admin/usage`;
225
+ return {
226
+ path: urlPath,
227
+ method: 'GET',
228
+ headers: headerParameters,
229
+ query: queryParameters,
230
+ };
231
+ });
232
+ }
233
+ /**
234
+ * Get chatbot usage analytics for the selected portal
235
+ */
236
+ getChatAdminUsageRaw(requestParameters, initOverrides) {
237
+ return __awaiter(this, void 0, void 0, function* () {
238
+ const requestOptions = yield this.getChatAdminUsageRequestOpts(requestParameters);
239
+ const response = yield this.request(requestOptions, initOverrides);
240
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetChatUsageFromJSON(jsonValue));
241
+ });
242
+ }
243
+ /**
244
+ * Get chatbot usage analytics for the selected portal
245
+ */
246
+ getChatAdminUsage() {
247
+ return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
248
+ const response = yield this.getChatAdminUsageRaw(requestParameters, initOverrides);
249
+ return yield response.value();
250
+ });
251
+ }
252
+ /**
253
+ * Creates request options for getChatQuota without sending the request
254
+ */
255
+ getChatQuotaRequestOpts() {
256
+ return __awaiter(this, void 0, void 0, function* () {
257
+ const queryParameters = {};
258
+ const headerParameters = {};
259
+ let urlPath = `/chat/quota`;
260
+ return {
261
+ path: urlPath,
262
+ method: 'GET',
263
+ headers: headerParameters,
264
+ query: queryParameters,
265
+ };
266
+ });
267
+ }
268
+ /**
269
+ * Get the current user\'s chat quota
270
+ */
271
+ getChatQuotaRaw(initOverrides) {
272
+ return __awaiter(this, void 0, void 0, function* () {
273
+ const requestOptions = yield this.getChatQuotaRequestOpts();
274
+ const response = yield this.request(requestOptions, initOverrides);
275
+ return new runtime.JSONApiResponse(response, (jsonValue) => ChatQuotaFromJSON(jsonValue));
276
+ });
277
+ }
278
+ /**
279
+ * Get the current user\'s chat quota
280
+ */
281
+ getChatQuota(initOverrides) {
282
+ return __awaiter(this, void 0, void 0, function* () {
283
+ const response = yield this.getChatQuotaRaw(initOverrides);
284
+ return yield response.value();
285
+ });
286
+ }
72
287
  /**
73
288
  * Creates request options for getConversationMessages without sending the request
74
289
  */
@@ -233,4 +448,44 @@ export class ChatApi extends runtime.BaseAPI {
233
448
  return yield response.value();
234
449
  });
235
450
  }
451
+ /**
452
+ * Creates request options for putChatAdminSettings without sending the request
453
+ */
454
+ putChatAdminSettingsRequestOpts(requestParameters) {
455
+ return __awaiter(this, void 0, void 0, function* () {
456
+ if (requestParameters['putChatSettings'] == null) {
457
+ throw new runtime.RequiredError('putChatSettings', 'Required parameter "putChatSettings" was null or undefined when calling putChatAdminSettings().');
458
+ }
459
+ const queryParameters = {};
460
+ const headerParameters = {};
461
+ headerParameters['Content-Type'] = 'application/json';
462
+ let urlPath = `/chat/admin/settings`;
463
+ return {
464
+ path: urlPath,
465
+ method: 'PUT',
466
+ headers: headerParameters,
467
+ query: queryParameters,
468
+ body: PutChatSettingsToJSON(requestParameters['putChatSettings']),
469
+ };
470
+ });
471
+ }
472
+ /**
473
+ * Update chatbot settings for the selected portal
474
+ */
475
+ putChatAdminSettingsRaw(requestParameters, initOverrides) {
476
+ return __awaiter(this, void 0, void 0, function* () {
477
+ const requestOptions = yield this.putChatAdminSettingsRequestOpts(requestParameters);
478
+ const response = yield this.request(requestOptions, initOverrides);
479
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetChatSettingsFromJSON(jsonValue));
480
+ });
481
+ }
482
+ /**
483
+ * Update chatbot settings for the selected portal
484
+ */
485
+ putChatAdminSettings(requestParameters, initOverrides) {
486
+ return __awaiter(this, void 0, void 0, function* () {
487
+ const response = yield this.putChatAdminSettingsRaw(requestParameters, initOverrides);
488
+ return yield response.value();
489
+ });
490
+ }
236
491
  }
@@ -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`;
@@ -0,0 +1,51 @@
1
+ /**
2
+ * LMS API
3
+ * LMS API
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { ChatTurnUsage } from './ChatTurnUsage';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface AdminChatMessage
17
+ */
18
+ export interface AdminChatMessage {
19
+ /**
20
+ *
21
+ * @type {string}
22
+ * @memberof AdminChatMessage
23
+ */
24
+ role: string;
25
+ /**
26
+ *
27
+ * @type {string}
28
+ * @memberof AdminChatMessage
29
+ */
30
+ content: string;
31
+ /**
32
+ *
33
+ * @type {number}
34
+ * @memberof AdminChatMessage
35
+ */
36
+ createdAt: number;
37
+ /**
38
+ *
39
+ * @type {ChatTurnUsage}
40
+ * @memberof AdminChatMessage
41
+ */
42
+ usage?: ChatTurnUsage | null;
43
+ }
44
+ /**
45
+ * Check if a given object implements the AdminChatMessage interface.
46
+ */
47
+ export declare function instanceOfAdminChatMessage(value: object): value is AdminChatMessage;
48
+ export declare function AdminChatMessageFromJSON(json: any): AdminChatMessage;
49
+ export declare function AdminChatMessageFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminChatMessage;
50
+ export declare function AdminChatMessageToJSON(json: any): AdminChatMessage;
51
+ export declare function AdminChatMessageToJSONTyped(value?: AdminChatMessage | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,54 @@
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
+ import { ChatTurnUsageFromJSON, ChatTurnUsageToJSON, } from './ChatTurnUsage';
15
+ /**
16
+ * Check if a given object implements the AdminChatMessage interface.
17
+ */
18
+ export function instanceOfAdminChatMessage(value) {
19
+ if (!('role' in value) || value['role'] === undefined)
20
+ return false;
21
+ if (!('content' in value) || value['content'] === undefined)
22
+ return false;
23
+ if (!('createdAt' in value) || value['createdAt'] === undefined)
24
+ return false;
25
+ return true;
26
+ }
27
+ export function AdminChatMessageFromJSON(json) {
28
+ return AdminChatMessageFromJSONTyped(json, false);
29
+ }
30
+ export function AdminChatMessageFromJSONTyped(json, ignoreDiscriminator) {
31
+ if (json == null) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'role': json['role'],
36
+ 'content': json['content'],
37
+ 'createdAt': json['created_at'],
38
+ 'usage': json['usage'] == null ? undefined : ChatTurnUsageFromJSON(json['usage']),
39
+ };
40
+ }
41
+ export function AdminChatMessageToJSON(json) {
42
+ return AdminChatMessageToJSONTyped(json, false);
43
+ }
44
+ export function AdminChatMessageToJSONTyped(value, ignoreDiscriminator = false) {
45
+ if (value == null) {
46
+ return value;
47
+ }
48
+ return {
49
+ 'role': value['role'],
50
+ 'content': value['content'],
51
+ 'created_at': value['createdAt'],
52
+ 'usage': ChatTurnUsageToJSON(value['usage']),
53
+ };
54
+ }