@easyedu/js-lsm-api 1.80.0 → 1.81.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 (91) hide show
  1. package/.openapi-generator/FILES +14 -0
  2. package/README.md +11 -2
  3. package/dist/apis/RichTextApi.d.ts +67 -0
  4. package/dist/apis/RichTextApi.js +158 -0
  5. package/dist/apis/index.d.ts +1 -0
  6. package/dist/apis/index.js +1 -0
  7. package/dist/esm/apis/RichTextApi.d.ts +67 -0
  8. package/dist/esm/apis/RichTextApi.js +154 -0
  9. package/dist/esm/apis/index.d.ts +1 -0
  10. package/dist/esm/apis/index.js +1 -0
  11. package/dist/esm/models/GetQuestion.d.ts +7 -6
  12. package/dist/esm/models/GetQuestion.js +5 -4
  13. package/dist/esm/models/GetQuestionAnswerChoicesInner.d.ts +3 -2
  14. package/dist/esm/models/GetQuestionAnswerChoicesInner.js +3 -2
  15. package/dist/esm/models/GetRichTextAssetUpload.d.ts +50 -0
  16. package/dist/esm/models/GetRichTextAssetUpload.js +55 -0
  17. package/dist/esm/models/PostQuestion.d.ts +7 -6
  18. package/dist/esm/models/PostQuestion.js +5 -4
  19. package/dist/esm/models/PostQuestionAnswerChoicesInner.d.ts +3 -2
  20. package/dist/esm/models/PostQuestionAnswerChoicesInner.js +3 -2
  21. package/dist/esm/models/PostRichTextAssetComplete.d.ts +44 -0
  22. package/dist/esm/models/PostRichTextAssetComplete.js +47 -0
  23. package/dist/esm/models/PostRichTextAssetUpload.d.ts +69 -0
  24. package/dist/esm/models/PostRichTextAssetUpload.js +65 -0
  25. package/dist/esm/models/PutQuestion.d.ts +7 -6
  26. package/dist/esm/models/PutQuestion.js +5 -4
  27. package/dist/esm/models/PutQuestionAnswerChoicesInner.d.ts +3 -2
  28. package/dist/esm/models/PutQuestionAnswerChoicesInner.js +3 -2
  29. package/dist/esm/models/RichTextAsset.d.ts +62 -0
  30. package/dist/esm/models/RichTextAsset.js +59 -0
  31. package/dist/esm/models/RichTextDocument.d.ts +60 -0
  32. package/dist/esm/models/RichTextDocument.js +62 -0
  33. package/dist/esm/models/RichTextInput.d.ts +47 -0
  34. package/dist/esm/models/RichTextInput.js +53 -0
  35. package/dist/esm/models/index.d.ts +6 -0
  36. package/dist/esm/models/index.js +6 -0
  37. package/dist/models/GetQuestion.d.ts +7 -6
  38. package/dist/models/GetQuestion.js +5 -4
  39. package/dist/models/GetQuestionAnswerChoicesInner.d.ts +3 -2
  40. package/dist/models/GetQuestionAnswerChoicesInner.js +3 -2
  41. package/dist/models/GetRichTextAssetUpload.d.ts +50 -0
  42. package/dist/models/GetRichTextAssetUpload.js +62 -0
  43. package/dist/models/PostQuestion.d.ts +7 -6
  44. package/dist/models/PostQuestion.js +5 -4
  45. package/dist/models/PostQuestionAnswerChoicesInner.d.ts +3 -2
  46. package/dist/models/PostQuestionAnswerChoicesInner.js +3 -2
  47. package/dist/models/PostRichTextAssetComplete.d.ts +44 -0
  48. package/dist/models/PostRichTextAssetComplete.js +54 -0
  49. package/dist/models/PostRichTextAssetUpload.d.ts +69 -0
  50. package/dist/models/PostRichTextAssetUpload.js +73 -0
  51. package/dist/models/PutQuestion.d.ts +7 -6
  52. package/dist/models/PutQuestion.js +5 -4
  53. package/dist/models/PutQuestionAnswerChoicesInner.d.ts +3 -2
  54. package/dist/models/PutQuestionAnswerChoicesInner.js +3 -2
  55. package/dist/models/RichTextAsset.d.ts +62 -0
  56. package/dist/models/RichTextAsset.js +66 -0
  57. package/dist/models/RichTextDocument.d.ts +60 -0
  58. package/dist/models/RichTextDocument.js +70 -0
  59. package/dist/models/RichTextInput.d.ts +47 -0
  60. package/dist/models/RichTextInput.js +61 -0
  61. package/dist/models/index.d.ts +6 -0
  62. package/dist/models/index.js +6 -0
  63. package/docs/GetQuestion.md +2 -2
  64. package/docs/GetQuestionAnswerChoicesInner.md +1 -1
  65. package/docs/GetRichTextAssetUpload.md +40 -0
  66. package/docs/PostQuestion.md +2 -2
  67. package/docs/PostQuestionAnswerChoicesInner.md +1 -1
  68. package/docs/PostRichTextAssetComplete.md +38 -0
  69. package/docs/PostRichTextAssetUpload.md +44 -0
  70. package/docs/PutQuestion.md +2 -2
  71. package/docs/PutQuestionAnswerChoicesInner.md +1 -1
  72. package/docs/RichTextApi.md +212 -0
  73. package/docs/RichTextAsset.md +44 -0
  74. package/docs/RichTextDocument.md +40 -0
  75. package/docs/RichTextInput.md +36 -0
  76. package/package.json +1 -1
  77. package/src/apis/RichTextApi.ts +201 -0
  78. package/src/apis/index.ts +1 -0
  79. package/src/models/GetQuestion.ts +17 -10
  80. package/src/models/GetQuestionAnswerChoicesInner.ts +12 -4
  81. package/src/models/GetRichTextAssetUpload.ts +93 -0
  82. package/src/models/PostQuestion.ts +17 -10
  83. package/src/models/PostQuestionAnswerChoicesInner.ts +12 -4
  84. package/src/models/PostRichTextAssetComplete.ts +82 -0
  85. package/src/models/PostRichTextAssetUpload.ts +119 -0
  86. package/src/models/PutQuestion.ts +17 -10
  87. package/src/models/PutQuestionAnswerChoicesInner.ts +12 -4
  88. package/src/models/RichTextAsset.ts +109 -0
  89. package/src/models/RichTextDocument.ts +111 -0
  90. package/src/models/RichTextInput.ts +85 -0
  91. package/src/models/index.ts +6 -0
@@ -148,6 +148,7 @@ docs/GetQuizResultsQuestionsInnerStudentAnswer.md
148
148
  docs/GetQuizResultsScore.md
149
149
  docs/GetQuizResultsTiming.md
150
150
  docs/GetQuizStatistics.md
151
+ docs/GetRichTextAssetUpload.md
151
152
  docs/GetRole.md
152
153
  docs/GetScormApiLogItem.md
153
154
  docs/GetScormApiLogs.md
@@ -250,6 +251,8 @@ docs/PostQuizQuestionsQuestionsInner.md
250
251
  docs/PostQuizSettings.md
251
252
  docs/PostResetPassword.md
252
253
  docs/PostRevokeCertificate.md
254
+ docs/PostRichTextAssetComplete.md
255
+ docs/PostRichTextAssetUpload.md
253
256
  docs/PostRole.md
254
257
  docs/PostSendResetPassword.md
255
258
  docs/PostSignupRequest.md
@@ -289,6 +292,10 @@ docs/QuizContent.md
289
292
  docs/QuizContentAssignment.md
290
293
  docs/QuizContentSettings.md
291
294
  docs/ReportingApi.md
295
+ docs/RichTextApi.md
296
+ docs/RichTextAsset.md
297
+ docs/RichTextDocument.md
298
+ docs/RichTextInput.md
292
299
  docs/RoleApi.md
293
300
  docs/SCORMContent.md
294
301
  docs/ScormGetValueResponse.md
@@ -326,6 +333,7 @@ src/apis/PortalSublicenseApi.ts
326
333
  src/apis/QuestionApi.ts
327
334
  src/apis/QuizApi.ts
328
335
  src/apis/ReportingApi.ts
336
+ src/apis/RichTextApi.ts
329
337
  src/apis/RoleApi.ts
330
338
  src/apis/SupportTicketApi.ts
331
339
  src/apis/SystemApi.ts
@@ -471,6 +479,7 @@ src/models/GetQuizResultsQuestionsInnerStudentAnswer.ts
471
479
  src/models/GetQuizResultsScore.ts
472
480
  src/models/GetQuizResultsTiming.ts
473
481
  src/models/GetQuizStatistics.ts
482
+ src/models/GetRichTextAssetUpload.ts
474
483
  src/models/GetRole.ts
475
484
  src/models/GetScormApiLogItem.ts
476
485
  src/models/GetScormApiLogs.ts
@@ -568,6 +577,8 @@ src/models/PostQuizQuestionsQuestionsInner.ts
568
577
  src/models/PostQuizSettings.ts
569
578
  src/models/PostResetPassword.ts
570
579
  src/models/PostRevokeCertificate.ts
580
+ src/models/PostRichTextAssetComplete.ts
581
+ src/models/PostRichTextAssetUpload.ts
571
582
  src/models/PostRole.ts
572
583
  src/models/PostSendResetPassword.ts
573
584
  src/models/PostSignupRequest.ts
@@ -604,6 +615,9 @@ src/models/PutUser.ts
604
615
  src/models/QuizContent.ts
605
616
  src/models/QuizContentAssignment.ts
606
617
  src/models/QuizContentSettings.ts
618
+ src/models/RichTextAsset.ts
619
+ src/models/RichTextDocument.ts
620
+ src/models/RichTextInput.ts
607
621
  src/models/SCORMContent.ts
608
622
  src/models/ScormGetValueResponse.ts
609
623
  src/models/ScormSessionData.ts
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # @easyedu/js-lsm-api@1.80.0
1
+ # @easyedu/js-lsm-api@1.81.0
2
2
 
3
3
  A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
4
4
 
@@ -217,6 +217,9 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
217
217
  *ReportingApi* | [**getModuleStudentReporting**](docs/ReportingApi.md#getmodulestudentreporting) | **GET** /courses/{courseId}/modules/{moduleId}/reporting/students/{studentId} | Get student-specific reporting for a module (can use \'current\' for studentId)
218
218
  *ReportingApi* | [**getPortalBasicReporting**](docs/ReportingApi.md#getportalbasicreporting) | **GET** /portals/{portalId}/reporting/basic | Get basic reporting for a portal (can use \'current\' for portalId)
219
219
  *ReportingApi* | [**getPortalStudentReporting**](docs/ReportingApi.md#getportalstudentreporting) | **GET** /portals/{portalId}/reporting/students/{studentId} | Get student reporting for a portal (can use \'current\' for portalId and studentId)
220
+ *RichTextApi* | [**getRichTextAsset**](docs/RichTextApi.md#getrichtextasset) | **GET** /rich-text/assets/{assetId} | Redirect to a signed rich text asset URL
221
+ *RichTextApi* | [**postRichTextAssetComplete**](docs/RichTextApi.md#postrichtextassetcomplete) | **POST** /rich-text/assets/{assetId}/complete | Complete a pending rich text asset upload
222
+ *RichTextApi* | [**postRichTextAssetUpload**](docs/RichTextApi.md#postrichtextassetupload) | **POST** /rich-text/assets/uploads | Create a pending rich text asset upload
220
223
  *RoleApi* | [**assignUserRole**](docs/RoleApi.md#assignuserrole) | **POST** /roles/users/{userId}/portals/{portalId}/roles/{roleId} | Assign a role to a user for a portal
221
224
  *RoleApi* | [**createRole**](docs/RoleApi.md#createrole) | **POST** /roles | Create a custom role scoped to the current portal
222
225
  *RoleApi* | [**deleteRole**](docs/RoleApi.md#deleterole) | **DELETE** /roles/{roleId} | Deactivate a custom role
@@ -398,6 +401,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
398
401
  - [GetQuizResultsScore](docs/GetQuizResultsScore.md)
399
402
  - [GetQuizResultsTiming](docs/GetQuizResultsTiming.md)
400
403
  - [GetQuizStatistics](docs/GetQuizStatistics.md)
404
+ - [GetRichTextAssetUpload](docs/GetRichTextAssetUpload.md)
401
405
  - [GetRole](docs/GetRole.md)
402
406
  - [GetScormApiLogItem](docs/GetScormApiLogItem.md)
403
407
  - [GetScormApiLogs](docs/GetScormApiLogs.md)
@@ -495,6 +499,8 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
495
499
  - [PostQuizSettings](docs/PostQuizSettings.md)
496
500
  - [PostResetPassword](docs/PostResetPassword.md)
497
501
  - [PostRevokeCertificate](docs/PostRevokeCertificate.md)
502
+ - [PostRichTextAssetComplete](docs/PostRichTextAssetComplete.md)
503
+ - [PostRichTextAssetUpload](docs/PostRichTextAssetUpload.md)
498
504
  - [PostRole](docs/PostRole.md)
499
505
  - [PostSendResetPassword](docs/PostSendResetPassword.md)
500
506
  - [PostSignupRequest](docs/PostSignupRequest.md)
@@ -531,6 +537,9 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
531
537
  - [QuizContent](docs/QuizContent.md)
532
538
  - [QuizContentAssignment](docs/QuizContentAssignment.md)
533
539
  - [QuizContentSettings](docs/QuizContentSettings.md)
540
+ - [RichTextAsset](docs/RichTextAsset.md)
541
+ - [RichTextDocument](docs/RichTextDocument.md)
542
+ - [RichTextInput](docs/RichTextInput.md)
534
543
  - [SCORMContent](docs/SCORMContent.md)
535
544
  - [ScormGetValueResponse](docs/ScormGetValueResponse.md)
536
545
  - [ScormSessionData](docs/ScormSessionData.md)
@@ -561,7 +570,7 @@ and is automatically generated by the
561
570
  [OpenAPI Generator](https://openapi-generator.tech) project:
562
571
 
563
572
  - API version: `1.0.0`
564
- - Package version: `1.80.0`
573
+ - Package version: `1.81.0`
565
574
  - Generator version: `7.22.0`
566
575
  - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
567
576
 
@@ -0,0 +1,67 @@
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 * as runtime from '../runtime';
13
+ import { type GetRichTextAssetUpload } from '../models/GetRichTextAssetUpload';
14
+ import { type PostRichTextAssetComplete } from '../models/PostRichTextAssetComplete';
15
+ import { type PostRichTextAssetUpload } from '../models/PostRichTextAssetUpload';
16
+ import { type RichTextAsset } from '../models/RichTextAsset';
17
+ export interface GetRichTextAssetRequest {
18
+ assetId: string;
19
+ }
20
+ export interface PostRichTextAssetCompleteRequest {
21
+ assetId: string;
22
+ postRichTextAssetComplete: PostRichTextAssetComplete;
23
+ }
24
+ export interface PostRichTextAssetUploadRequest {
25
+ postRichTextAssetUpload: PostRichTextAssetUpload;
26
+ }
27
+ /**
28
+ *
29
+ */
30
+ export declare class RichTextApi extends runtime.BaseAPI {
31
+ /**
32
+ * Creates request options for getRichTextAsset without sending the request
33
+ */
34
+ getRichTextAssetRequestOpts(requestParameters: GetRichTextAssetRequest): Promise<runtime.RequestOpts>;
35
+ /**
36
+ * Redirect to a signed rich text asset URL
37
+ */
38
+ getRichTextAssetRaw(requestParameters: GetRichTextAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
39
+ /**
40
+ * Redirect to a signed rich text asset URL
41
+ */
42
+ getRichTextAsset(requestParameters: GetRichTextAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
43
+ /**
44
+ * Creates request options for postRichTextAssetComplete without sending the request
45
+ */
46
+ postRichTextAssetCompleteRequestOpts(requestParameters: PostRichTextAssetCompleteRequest): Promise<runtime.RequestOpts>;
47
+ /**
48
+ * Complete a pending rich text asset upload
49
+ */
50
+ postRichTextAssetCompleteRaw(requestParameters: PostRichTextAssetCompleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RichTextAsset>>;
51
+ /**
52
+ * Complete a pending rich text asset upload
53
+ */
54
+ postRichTextAssetComplete(requestParameters: PostRichTextAssetCompleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RichTextAsset>;
55
+ /**
56
+ * Creates request options for postRichTextAssetUpload without sending the request
57
+ */
58
+ postRichTextAssetUploadRequestOpts(requestParameters: PostRichTextAssetUploadRequest): Promise<runtime.RequestOpts>;
59
+ /**
60
+ * Create a pending rich text asset upload
61
+ */
62
+ postRichTextAssetUploadRaw(requestParameters: PostRichTextAssetUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetRichTextAssetUpload>>;
63
+ /**
64
+ * Create a pending rich text asset upload
65
+ */
66
+ postRichTextAssetUpload(requestParameters: PostRichTextAssetUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetRichTextAssetUpload>;
67
+ }
@@ -0,0 +1,158 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * LMS API
6
+ * LMS API
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
16
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
17
+ return new (P || (P = Promise))(function (resolve, reject) {
18
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
19
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
20
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
21
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
22
+ });
23
+ };
24
+ Object.defineProperty(exports, "__esModule", { value: true });
25
+ exports.RichTextApi = void 0;
26
+ const runtime = require("../runtime");
27
+ const GetRichTextAssetUpload_1 = require("../models/GetRichTextAssetUpload");
28
+ const PostRichTextAssetComplete_1 = require("../models/PostRichTextAssetComplete");
29
+ const PostRichTextAssetUpload_1 = require("../models/PostRichTextAssetUpload");
30
+ const RichTextAsset_1 = require("../models/RichTextAsset");
31
+ /**
32
+ *
33
+ */
34
+ class RichTextApi extends runtime.BaseAPI {
35
+ /**
36
+ * Creates request options for getRichTextAsset without sending the request
37
+ */
38
+ getRichTextAssetRequestOpts(requestParameters) {
39
+ return __awaiter(this, void 0, void 0, function* () {
40
+ if (requestParameters['assetId'] == null) {
41
+ throw new runtime.RequiredError('assetId', 'Required parameter "assetId" was null or undefined when calling getRichTextAsset().');
42
+ }
43
+ const queryParameters = {};
44
+ const headerParameters = {};
45
+ let urlPath = `/rich-text/assets/{assetId}`;
46
+ urlPath = urlPath.replace('{assetId}', encodeURIComponent(String(requestParameters['assetId'])));
47
+ return {
48
+ path: urlPath,
49
+ method: 'GET',
50
+ headers: headerParameters,
51
+ query: queryParameters,
52
+ };
53
+ });
54
+ }
55
+ /**
56
+ * Redirect to a signed rich text asset URL
57
+ */
58
+ getRichTextAssetRaw(requestParameters, initOverrides) {
59
+ return __awaiter(this, void 0, void 0, function* () {
60
+ const requestOptions = yield this.getRichTextAssetRequestOpts(requestParameters);
61
+ const response = yield this.request(requestOptions, initOverrides);
62
+ return new runtime.VoidApiResponse(response);
63
+ });
64
+ }
65
+ /**
66
+ * Redirect to a signed rich text asset URL
67
+ */
68
+ getRichTextAsset(requestParameters, initOverrides) {
69
+ return __awaiter(this, void 0, void 0, function* () {
70
+ yield this.getRichTextAssetRaw(requestParameters, initOverrides);
71
+ });
72
+ }
73
+ /**
74
+ * Creates request options for postRichTextAssetComplete without sending the request
75
+ */
76
+ postRichTextAssetCompleteRequestOpts(requestParameters) {
77
+ return __awaiter(this, void 0, void 0, function* () {
78
+ if (requestParameters['assetId'] == null) {
79
+ throw new runtime.RequiredError('assetId', 'Required parameter "assetId" was null or undefined when calling postRichTextAssetComplete().');
80
+ }
81
+ if (requestParameters['postRichTextAssetComplete'] == null) {
82
+ throw new runtime.RequiredError('postRichTextAssetComplete', 'Required parameter "postRichTextAssetComplete" was null or undefined when calling postRichTextAssetComplete().');
83
+ }
84
+ const queryParameters = {};
85
+ const headerParameters = {};
86
+ headerParameters['Content-Type'] = 'application/json';
87
+ let urlPath = `/rich-text/assets/{assetId}/complete`;
88
+ urlPath = urlPath.replace('{assetId}', encodeURIComponent(String(requestParameters['assetId'])));
89
+ return {
90
+ path: urlPath,
91
+ method: 'POST',
92
+ headers: headerParameters,
93
+ query: queryParameters,
94
+ body: (0, PostRichTextAssetComplete_1.PostRichTextAssetCompleteToJSON)(requestParameters['postRichTextAssetComplete']),
95
+ };
96
+ });
97
+ }
98
+ /**
99
+ * Complete a pending rich text asset upload
100
+ */
101
+ postRichTextAssetCompleteRaw(requestParameters, initOverrides) {
102
+ return __awaiter(this, void 0, void 0, function* () {
103
+ const requestOptions = yield this.postRichTextAssetCompleteRequestOpts(requestParameters);
104
+ const response = yield this.request(requestOptions, initOverrides);
105
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, RichTextAsset_1.RichTextAssetFromJSON)(jsonValue));
106
+ });
107
+ }
108
+ /**
109
+ * Complete a pending rich text asset upload
110
+ */
111
+ postRichTextAssetComplete(requestParameters, initOverrides) {
112
+ return __awaiter(this, void 0, void 0, function* () {
113
+ const response = yield this.postRichTextAssetCompleteRaw(requestParameters, initOverrides);
114
+ return yield response.value();
115
+ });
116
+ }
117
+ /**
118
+ * Creates request options for postRichTextAssetUpload without sending the request
119
+ */
120
+ postRichTextAssetUploadRequestOpts(requestParameters) {
121
+ return __awaiter(this, void 0, void 0, function* () {
122
+ if (requestParameters['postRichTextAssetUpload'] == null) {
123
+ throw new runtime.RequiredError('postRichTextAssetUpload', 'Required parameter "postRichTextAssetUpload" was null or undefined when calling postRichTextAssetUpload().');
124
+ }
125
+ const queryParameters = {};
126
+ const headerParameters = {};
127
+ headerParameters['Content-Type'] = 'application/json';
128
+ let urlPath = `/rich-text/assets/uploads`;
129
+ return {
130
+ path: urlPath,
131
+ method: 'POST',
132
+ headers: headerParameters,
133
+ query: queryParameters,
134
+ body: (0, PostRichTextAssetUpload_1.PostRichTextAssetUploadToJSON)(requestParameters['postRichTextAssetUpload']),
135
+ };
136
+ });
137
+ }
138
+ /**
139
+ * Create a pending rich text asset upload
140
+ */
141
+ postRichTextAssetUploadRaw(requestParameters, initOverrides) {
142
+ return __awaiter(this, void 0, void 0, function* () {
143
+ const requestOptions = yield this.postRichTextAssetUploadRequestOpts(requestParameters);
144
+ const response = yield this.request(requestOptions, initOverrides);
145
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetRichTextAssetUpload_1.GetRichTextAssetUploadFromJSON)(jsonValue));
146
+ });
147
+ }
148
+ /**
149
+ * Create a pending rich text asset upload
150
+ */
151
+ postRichTextAssetUpload(requestParameters, initOverrides) {
152
+ return __awaiter(this, void 0, void 0, function* () {
153
+ const response = yield this.postRichTextAssetUploadRaw(requestParameters, initOverrides);
154
+ return yield response.value();
155
+ });
156
+ }
157
+ }
158
+ exports.RichTextApi = RichTextApi;
@@ -13,6 +13,7 @@ export * from './PortalSublicenseApi';
13
13
  export * from './QuestionApi';
14
14
  export * from './QuizApi';
15
15
  export * from './ReportingApi';
16
+ export * from './RichTextApi';
16
17
  export * from './RoleApi';
17
18
  export * from './SupportTicketApi';
18
19
  export * from './SystemApi';
@@ -31,6 +31,7 @@ __exportStar(require("./PortalSublicenseApi"), exports);
31
31
  __exportStar(require("./QuestionApi"), exports);
32
32
  __exportStar(require("./QuizApi"), exports);
33
33
  __exportStar(require("./ReportingApi"), exports);
34
+ __exportStar(require("./RichTextApi"), exports);
34
35
  __exportStar(require("./RoleApi"), exports);
35
36
  __exportStar(require("./SupportTicketApi"), exports);
36
37
  __exportStar(require("./SystemApi"), exports);
@@ -0,0 +1,67 @@
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 * as runtime from '../runtime';
13
+ import { type GetRichTextAssetUpload } from '../models/GetRichTextAssetUpload';
14
+ import { type PostRichTextAssetComplete } from '../models/PostRichTextAssetComplete';
15
+ import { type PostRichTextAssetUpload } from '../models/PostRichTextAssetUpload';
16
+ import { type RichTextAsset } from '../models/RichTextAsset';
17
+ export interface GetRichTextAssetRequest {
18
+ assetId: string;
19
+ }
20
+ export interface PostRichTextAssetCompleteRequest {
21
+ assetId: string;
22
+ postRichTextAssetComplete: PostRichTextAssetComplete;
23
+ }
24
+ export interface PostRichTextAssetUploadRequest {
25
+ postRichTextAssetUpload: PostRichTextAssetUpload;
26
+ }
27
+ /**
28
+ *
29
+ */
30
+ export declare class RichTextApi extends runtime.BaseAPI {
31
+ /**
32
+ * Creates request options for getRichTextAsset without sending the request
33
+ */
34
+ getRichTextAssetRequestOpts(requestParameters: GetRichTextAssetRequest): Promise<runtime.RequestOpts>;
35
+ /**
36
+ * Redirect to a signed rich text asset URL
37
+ */
38
+ getRichTextAssetRaw(requestParameters: GetRichTextAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
39
+ /**
40
+ * Redirect to a signed rich text asset URL
41
+ */
42
+ getRichTextAsset(requestParameters: GetRichTextAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
43
+ /**
44
+ * Creates request options for postRichTextAssetComplete without sending the request
45
+ */
46
+ postRichTextAssetCompleteRequestOpts(requestParameters: PostRichTextAssetCompleteRequest): Promise<runtime.RequestOpts>;
47
+ /**
48
+ * Complete a pending rich text asset upload
49
+ */
50
+ postRichTextAssetCompleteRaw(requestParameters: PostRichTextAssetCompleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RichTextAsset>>;
51
+ /**
52
+ * Complete a pending rich text asset upload
53
+ */
54
+ postRichTextAssetComplete(requestParameters: PostRichTextAssetCompleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RichTextAsset>;
55
+ /**
56
+ * Creates request options for postRichTextAssetUpload without sending the request
57
+ */
58
+ postRichTextAssetUploadRequestOpts(requestParameters: PostRichTextAssetUploadRequest): Promise<runtime.RequestOpts>;
59
+ /**
60
+ * Create a pending rich text asset upload
61
+ */
62
+ postRichTextAssetUploadRaw(requestParameters: PostRichTextAssetUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetRichTextAssetUpload>>;
63
+ /**
64
+ * Create a pending rich text asset upload
65
+ */
66
+ postRichTextAssetUpload(requestParameters: PostRichTextAssetUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetRichTextAssetUpload>;
67
+ }
@@ -0,0 +1,154 @@
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
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
15
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
16
+ return new (P || (P = Promise))(function (resolve, reject) {
17
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
18
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
19
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
20
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
21
+ });
22
+ };
23
+ import * as runtime from '../runtime';
24
+ import { GetRichTextAssetUploadFromJSON, } from '../models/GetRichTextAssetUpload';
25
+ import { PostRichTextAssetCompleteToJSON, } from '../models/PostRichTextAssetComplete';
26
+ import { PostRichTextAssetUploadToJSON, } from '../models/PostRichTextAssetUpload';
27
+ import { RichTextAssetFromJSON, } from '../models/RichTextAsset';
28
+ /**
29
+ *
30
+ */
31
+ export class RichTextApi extends runtime.BaseAPI {
32
+ /**
33
+ * Creates request options for getRichTextAsset without sending the request
34
+ */
35
+ getRichTextAssetRequestOpts(requestParameters) {
36
+ return __awaiter(this, void 0, void 0, function* () {
37
+ if (requestParameters['assetId'] == null) {
38
+ throw new runtime.RequiredError('assetId', 'Required parameter "assetId" was null or undefined when calling getRichTextAsset().');
39
+ }
40
+ const queryParameters = {};
41
+ const headerParameters = {};
42
+ let urlPath = `/rich-text/assets/{assetId}`;
43
+ urlPath = urlPath.replace('{assetId}', encodeURIComponent(String(requestParameters['assetId'])));
44
+ return {
45
+ path: urlPath,
46
+ method: 'GET',
47
+ headers: headerParameters,
48
+ query: queryParameters,
49
+ };
50
+ });
51
+ }
52
+ /**
53
+ * Redirect to a signed rich text asset URL
54
+ */
55
+ getRichTextAssetRaw(requestParameters, initOverrides) {
56
+ return __awaiter(this, void 0, void 0, function* () {
57
+ const requestOptions = yield this.getRichTextAssetRequestOpts(requestParameters);
58
+ const response = yield this.request(requestOptions, initOverrides);
59
+ return new runtime.VoidApiResponse(response);
60
+ });
61
+ }
62
+ /**
63
+ * Redirect to a signed rich text asset URL
64
+ */
65
+ getRichTextAsset(requestParameters, initOverrides) {
66
+ return __awaiter(this, void 0, void 0, function* () {
67
+ yield this.getRichTextAssetRaw(requestParameters, initOverrides);
68
+ });
69
+ }
70
+ /**
71
+ * Creates request options for postRichTextAssetComplete without sending the request
72
+ */
73
+ postRichTextAssetCompleteRequestOpts(requestParameters) {
74
+ return __awaiter(this, void 0, void 0, function* () {
75
+ if (requestParameters['assetId'] == null) {
76
+ throw new runtime.RequiredError('assetId', 'Required parameter "assetId" was null or undefined when calling postRichTextAssetComplete().');
77
+ }
78
+ if (requestParameters['postRichTextAssetComplete'] == null) {
79
+ throw new runtime.RequiredError('postRichTextAssetComplete', 'Required parameter "postRichTextAssetComplete" was null or undefined when calling postRichTextAssetComplete().');
80
+ }
81
+ const queryParameters = {};
82
+ const headerParameters = {};
83
+ headerParameters['Content-Type'] = 'application/json';
84
+ let urlPath = `/rich-text/assets/{assetId}/complete`;
85
+ urlPath = urlPath.replace('{assetId}', encodeURIComponent(String(requestParameters['assetId'])));
86
+ return {
87
+ path: urlPath,
88
+ method: 'POST',
89
+ headers: headerParameters,
90
+ query: queryParameters,
91
+ body: PostRichTextAssetCompleteToJSON(requestParameters['postRichTextAssetComplete']),
92
+ };
93
+ });
94
+ }
95
+ /**
96
+ * Complete a pending rich text asset upload
97
+ */
98
+ postRichTextAssetCompleteRaw(requestParameters, initOverrides) {
99
+ return __awaiter(this, void 0, void 0, function* () {
100
+ const requestOptions = yield this.postRichTextAssetCompleteRequestOpts(requestParameters);
101
+ const response = yield this.request(requestOptions, initOverrides);
102
+ return new runtime.JSONApiResponse(response, (jsonValue) => RichTextAssetFromJSON(jsonValue));
103
+ });
104
+ }
105
+ /**
106
+ * Complete a pending rich text asset upload
107
+ */
108
+ postRichTextAssetComplete(requestParameters, initOverrides) {
109
+ return __awaiter(this, void 0, void 0, function* () {
110
+ const response = yield this.postRichTextAssetCompleteRaw(requestParameters, initOverrides);
111
+ return yield response.value();
112
+ });
113
+ }
114
+ /**
115
+ * Creates request options for postRichTextAssetUpload without sending the request
116
+ */
117
+ postRichTextAssetUploadRequestOpts(requestParameters) {
118
+ return __awaiter(this, void 0, void 0, function* () {
119
+ if (requestParameters['postRichTextAssetUpload'] == null) {
120
+ throw new runtime.RequiredError('postRichTextAssetUpload', 'Required parameter "postRichTextAssetUpload" was null or undefined when calling postRichTextAssetUpload().');
121
+ }
122
+ const queryParameters = {};
123
+ const headerParameters = {};
124
+ headerParameters['Content-Type'] = 'application/json';
125
+ let urlPath = `/rich-text/assets/uploads`;
126
+ return {
127
+ path: urlPath,
128
+ method: 'POST',
129
+ headers: headerParameters,
130
+ query: queryParameters,
131
+ body: PostRichTextAssetUploadToJSON(requestParameters['postRichTextAssetUpload']),
132
+ };
133
+ });
134
+ }
135
+ /**
136
+ * Create a pending rich text asset upload
137
+ */
138
+ postRichTextAssetUploadRaw(requestParameters, initOverrides) {
139
+ return __awaiter(this, void 0, void 0, function* () {
140
+ const requestOptions = yield this.postRichTextAssetUploadRequestOpts(requestParameters);
141
+ const response = yield this.request(requestOptions, initOverrides);
142
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetRichTextAssetUploadFromJSON(jsonValue));
143
+ });
144
+ }
145
+ /**
146
+ * Create a pending rich text asset upload
147
+ */
148
+ postRichTextAssetUpload(requestParameters, initOverrides) {
149
+ return __awaiter(this, void 0, void 0, function* () {
150
+ const response = yield this.postRichTextAssetUploadRaw(requestParameters, initOverrides);
151
+ return yield response.value();
152
+ });
153
+ }
154
+ }
@@ -13,6 +13,7 @@ export * from './PortalSublicenseApi';
13
13
  export * from './QuestionApi';
14
14
  export * from './QuizApi';
15
15
  export * from './ReportingApi';
16
+ export * from './RichTextApi';
16
17
  export * from './RoleApi';
17
18
  export * from './SupportTicketApi';
18
19
  export * from './SystemApi';
@@ -15,6 +15,7 @@ export * from './PortalSublicenseApi';
15
15
  export * from './QuestionApi';
16
16
  export * from './QuizApi';
17
17
  export * from './ReportingApi';
18
+ export * from './RichTextApi';
18
19
  export * from './RoleApi';
19
20
  export * from './SupportTicketApi';
20
21
  export * from './SystemApi';
@@ -9,6 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import type { RichTextDocument } from './RichTextDocument';
12
13
  import type { GetQuestionAnswerChoicesInner } from './GetQuestionAnswerChoicesInner';
13
14
  import type { GetQuestionQuizzesInner } from './GetQuestionQuizzesInner';
14
15
  /**
@@ -24,11 +25,11 @@ export interface GetQuestion {
24
25
  */
25
26
  readonly id: string;
26
27
  /**
27
- * The main question text or prompt
28
- * @type {string}
28
+ *
29
+ * @type {RichTextDocument}
29
30
  * @memberof GetQuestion
30
31
  */
31
- questionText: string;
32
+ questionText: RichTextDocument;
32
33
  /**
33
34
  * Type of question
34
35
  * @type {GetQuestionQuestionTypeEnum}
@@ -48,11 +49,11 @@ export interface GetQuestion {
48
49
  */
49
50
  correctAnswer?: string;
50
51
  /**
51
- * Explanation of the correct answer
52
- * @type {string}
52
+ *
53
+ * @type {RichTextDocument}
53
54
  * @memberof GetQuestion
54
55
  */
55
- explanation?: string;
56
+ explanation?: RichTextDocument;
56
57
  /**
57
58
  * Topic category (Fire Alarm, Fire Pump, Fire Sprinkler, etc.)
58
59
  * @type {string}