@easyedu/js-lsm-api 1.63.0 → 1.64.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +4 -0
- package/README.md +9 -2
- package/dist/apis/ContentApi.d.ts +19 -0
- package/dist/apis/ContentApi.js +48 -0
- package/dist/apis/CourseApi.d.ts +17 -0
- package/dist/apis/CourseApi.js +40 -0
- package/dist/apis/ModuleApi.d.ts +18 -0
- package/dist/apis/ModuleApi.js +44 -0
- package/dist/apis/UserApi.d.ts +32 -0
- package/dist/apis/UserApi.js +82 -0
- package/dist/esm/apis/ContentApi.d.ts +19 -0
- package/dist/esm/apis/ContentApi.js +48 -0
- package/dist/esm/apis/CourseApi.d.ts +17 -0
- package/dist/esm/apis/CourseApi.js +40 -0
- package/dist/esm/apis/ModuleApi.d.ts +18 -0
- package/dist/esm/apis/ModuleApi.js +44 -0
- package/dist/esm/apis/UserApi.d.ts +32 -0
- package/dist/esm/apis/UserApi.js +82 -0
- package/dist/esm/models/PostSignupRequest.d.ts +68 -0
- package/dist/esm/models/PostSignupRequest.js +67 -0
- package/dist/esm/models/PostSignupRequestResponse.d.ts +32 -0
- package/dist/esm/models/PostSignupRequestResponse.js +43 -0
- package/dist/esm/models/index.d.ts +2 -0
- package/dist/esm/models/index.js +2 -0
- package/dist/models/PostSignupRequest.d.ts +68 -0
- package/dist/models/PostSignupRequest.js +74 -0
- package/dist/models/PostSignupRequestResponse.d.ts +32 -0
- package/dist/models/PostSignupRequestResponse.js +50 -0
- package/dist/models/index.d.ts +2 -0
- package/dist/models/index.js +2 -0
- package/docs/ContentApi.md +76 -0
- package/docs/CourseApi.md +70 -0
- package/docs/ModuleApi.md +73 -0
- package/docs/PostSignupRequest.md +46 -0
- package/docs/PostSignupRequestResponse.md +34 -0
- package/docs/UserApi.md +134 -0
- package/package.json +1 -1
- package/src/apis/ContentApi.ts +68 -0
- package/src/apis/CourseApi.ts +50 -0
- package/src/apis/ModuleApi.ts +59 -0
- package/src/apis/UserApi.ts +112 -0
- package/src/models/PostSignupRequest.ts +120 -0
- package/src/models/PostSignupRequestResponse.ts +66 -0
- package/src/models/index.ts +2 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -226,6 +226,8 @@ docs/PostResetPassword.md
|
|
|
226
226
|
docs/PostRevokeCertificate.md
|
|
227
227
|
docs/PostRole.md
|
|
228
228
|
docs/PostSendResetPassword.md
|
|
229
|
+
docs/PostSignupRequest.md
|
|
230
|
+
docs/PostSignupRequestResponse.md
|
|
229
231
|
docs/PostSupportTicket.md
|
|
230
232
|
docs/PostSupportTicketComment.md
|
|
231
233
|
docs/PostVerifyManifest.md
|
|
@@ -512,6 +514,8 @@ src/models/PostResetPassword.ts
|
|
|
512
514
|
src/models/PostRevokeCertificate.ts
|
|
513
515
|
src/models/PostRole.ts
|
|
514
516
|
src/models/PostSendResetPassword.ts
|
|
517
|
+
src/models/PostSignupRequest.ts
|
|
518
|
+
src/models/PostSignupRequestResponse.ts
|
|
515
519
|
src/models/PostSupportTicket.ts
|
|
516
520
|
src/models/PostSupportTicketComment.ts
|
|
517
521
|
src/models/PostVerifyManifest.ts
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @easyedu/js-lsm-api@1.
|
|
1
|
+
# @easyedu/js-lsm-api@1.64.0
|
|
2
2
|
|
|
3
3
|
A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
|
|
4
4
|
|
|
@@ -69,6 +69,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
69
69
|
*ChatApi* | [**postConversation**](docs/ChatApi.md#postconversation) | **POST** /chat/conversations | Create a new conversation
|
|
70
70
|
*ChatApi* | [**postMessage**](docs/ChatApi.md#postmessage) | **POST** /chat/conversations/{conversationId}/messages | Send a message to a conversation
|
|
71
71
|
*ContentApi* | [**commitScormSession**](docs/ContentApi.md#commitscormsession) | **POST** /scorm/sessions/{scormSessionId}/commit | Commit SCORM session data
|
|
72
|
+
*ContentApi* | [**deleteContent**](docs/ContentApi.md#deletecontent) | **DELETE** /courses/{courseId}/modules/{moduleId}/contents/{contentId} | Delete content by id
|
|
72
73
|
*ContentApi* | [**getContent**](docs/ContentApi.md#getcontent) | **GET** /courses/{courseId}/modules/{moduleId}/contents/{contentId} | get content
|
|
73
74
|
*ContentApi* | [**getContentList**](docs/ContentApi.md#getcontentlist) | **GET** /courses/{courseId}/modules/{moduleId}/contents | get content list
|
|
74
75
|
*ContentApi* | [**getContentSession**](docs/ContentApi.md#getcontentsession) | **GET** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/session | get content session
|
|
@@ -92,6 +93,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
92
93
|
*ContentApi* | [**setScormValue**](docs/ContentApi.md#setscormvalue) | **POST** /scorm/sessions/{scormSessionId}/set-value | Set a SCORM CMI data element value
|
|
93
94
|
*ContentApi* | [**terminateScormSession**](docs/ContentApi.md#terminatescormsession) | **POST** /scorm/sessions/{scormSessionId}/terminate | Terminate a SCORM session
|
|
94
95
|
*ContentApi* | [**verifyScormManifest**](docs/ContentApi.md#verifyscormmanifest) | **POST** /scorm/tools/verify-manifest | Parse and verify a SCORM manifest
|
|
96
|
+
*CourseApi* | [**deleteCourse**](docs/CourseApi.md#deletecourse) | **DELETE** /courses/{courseId} | Delete a course by id
|
|
95
97
|
*CourseApi* | [**deleteCourseImage**](docs/CourseApi.md#deletecourseimage) | **DELETE** /courses/{courseId}/image | Remove the course image
|
|
96
98
|
*CourseApi* | [**getCourse**](docs/CourseApi.md#getcourse) | **GET** /courses/{courseId} | get course
|
|
97
99
|
*CourseApi* | [**getCourseEnrollment**](docs/CourseApi.md#getcourseenrollment) | **GET** /courses/{courseId}/enrollments/{enrollmentId} | Get a specific course enrollment
|
|
@@ -126,6 +128,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
126
128
|
*CourseShareApi* | [**putDeclineShare**](docs/CourseShareApi.md#putdeclineshare) | **PUT** /course-shares/{shareId}/decline | Decline an offer
|
|
127
129
|
*DispatchApi* | [**getDispatchRollup**](docs/DispatchApi.md#getdispatchrollup) | **GET** /dispatch/sessions/{dispatchPackageId}/rollup | Get dispatch package rollup data
|
|
128
130
|
*DispatchApi* | [**postDispatchLaunch**](docs/DispatchApi.md#postdispatchlaunch) | **POST** /dispatch/launch | Launch a dispatch package
|
|
131
|
+
*ModuleApi* | [**deleteModule**](docs/ModuleApi.md#deletemodule) | **DELETE** /courses/{courseId}/modules/{moduleId} | Delete a module by id
|
|
129
132
|
*ModuleApi* | [**getModule**](docs/ModuleApi.md#getmodule) | **GET** /courses/{courseId}/modules/{moduleId} | get a course module
|
|
130
133
|
*ModuleApi* | [**getModuleList**](docs/ModuleApi.md#getmodulelist) | **GET** /courses/{courseId}/modules | get module list
|
|
131
134
|
*ModuleApi* | [**postModule**](docs/ModuleApi.md#postmodule) | **POST** /courses/{courseId}/modules | Post a new module
|
|
@@ -222,10 +225,12 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
222
225
|
*UserApi* | [**getUser**](docs/UserApi.md#getuser) | **GET** /users/{userId} | Get a user by id
|
|
223
226
|
*UserApi* | [**postLogin**](docs/UserApi.md#postlogin) | **POST** /auth/login | Post a new login
|
|
224
227
|
*UserApi* | [**postLogout**](docs/UserApi.md#postlogout) | **POST** /auth/logout | Logout a user
|
|
228
|
+
*UserApi* | [**postSignupRequest**](docs/UserApi.md#postsignuprequest) | **POST** /auth/signup-request | Request a new organization signup
|
|
225
229
|
*UserApi* | [**postUserAvatarUpload**](docs/UserApi.md#postuseravatarupload) | **POST** /users/{userId}/avatar | Upload a profile photo for the current user
|
|
226
230
|
*UserApi* | [**putUser**](docs/UserApi.md#putuser) | **PUT** /users/{userId} | Update a user by id
|
|
227
231
|
*UserApi* | [**resetPassword**](docs/UserApi.md#resetpassword) | **POST** /auth/reset-password | Reset a users password
|
|
228
232
|
*UserApi* | [**sendResetPassword**](docs/UserApi.md#sendresetpassword) | **POST** /auth/send-reset-password | Send a reset password email
|
|
233
|
+
*UserApi* | [**verifySignupRequest**](docs/UserApi.md#verifysignuprequest) | **GET** /auth/signup/verify | Verify a signup request and provision the portal
|
|
229
234
|
|
|
230
235
|
|
|
231
236
|
### Models
|
|
@@ -442,6 +447,8 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
442
447
|
- [PostRevokeCertificate](docs/PostRevokeCertificate.md)
|
|
443
448
|
- [PostRole](docs/PostRole.md)
|
|
444
449
|
- [PostSendResetPassword](docs/PostSendResetPassword.md)
|
|
450
|
+
- [PostSignupRequest](docs/PostSignupRequest.md)
|
|
451
|
+
- [PostSignupRequestResponse](docs/PostSignupRequestResponse.md)
|
|
445
452
|
- [PostSupportTicket](docs/PostSupportTicket.md)
|
|
446
453
|
- [PostSupportTicketComment](docs/PostSupportTicketComment.md)
|
|
447
454
|
- [PostVerifyManifest](docs/PostVerifyManifest.md)
|
|
@@ -502,7 +509,7 @@ and is automatically generated by the
|
|
|
502
509
|
[OpenAPI Generator](https://openapi-generator.tech) project:
|
|
503
510
|
|
|
504
511
|
- API version: `1.0.0`
|
|
505
|
-
- Package version: `1.
|
|
512
|
+
- Package version: `1.64.0`
|
|
506
513
|
- Generator version: `7.22.0`
|
|
507
514
|
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
|
|
508
515
|
|
|
@@ -35,6 +35,11 @@ import { type ScormSetValueResponse } from '../models/ScormSetValueResponse';
|
|
|
35
35
|
export interface CommitScormSessionRequest {
|
|
36
36
|
scormSessionId: string;
|
|
37
37
|
}
|
|
38
|
+
export interface DeleteContentRequest {
|
|
39
|
+
contentId: string;
|
|
40
|
+
moduleId: string;
|
|
41
|
+
courseId: string;
|
|
42
|
+
}
|
|
38
43
|
export interface GetContentRequest {
|
|
39
44
|
contentId: string;
|
|
40
45
|
moduleId: string;
|
|
@@ -168,6 +173,20 @@ export declare class ContentApi extends runtime.BaseAPI {
|
|
|
168
173
|
* Commit SCORM session data
|
|
169
174
|
*/
|
|
170
175
|
commitScormSession(requestParameters: CommitScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
176
|
+
/**
|
|
177
|
+
* Creates request options for deleteContent without sending the request
|
|
178
|
+
*/
|
|
179
|
+
deleteContentRequestOpts(requestParameters: DeleteContentRequest): Promise<runtime.RequestOpts>;
|
|
180
|
+
/**
|
|
181
|
+
* Soft-deletes the content item.
|
|
182
|
+
* Delete content by id
|
|
183
|
+
*/
|
|
184
|
+
deleteContentRaw(requestParameters: DeleteContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
185
|
+
/**
|
|
186
|
+
* Soft-deletes the content item.
|
|
187
|
+
* Delete content by id
|
|
188
|
+
*/
|
|
189
|
+
deleteContent(requestParameters: DeleteContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
171
190
|
/**
|
|
172
191
|
* Creates request options for getContent without sending the request
|
|
173
192
|
*/
|
package/dist/apis/ContentApi.js
CHANGED
|
@@ -90,6 +90,54 @@ class ContentApi extends runtime.BaseAPI {
|
|
|
90
90
|
yield this.commitScormSessionRaw(requestParameters, initOverrides);
|
|
91
91
|
});
|
|
92
92
|
}
|
|
93
|
+
/**
|
|
94
|
+
* Creates request options for deleteContent without sending the request
|
|
95
|
+
*/
|
|
96
|
+
deleteContentRequestOpts(requestParameters) {
|
|
97
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
98
|
+
if (requestParameters['contentId'] == null) {
|
|
99
|
+
throw new runtime.RequiredError('contentId', 'Required parameter "contentId" was null or undefined when calling deleteContent().');
|
|
100
|
+
}
|
|
101
|
+
if (requestParameters['moduleId'] == null) {
|
|
102
|
+
throw new runtime.RequiredError('moduleId', 'Required parameter "moduleId" was null or undefined when calling deleteContent().');
|
|
103
|
+
}
|
|
104
|
+
if (requestParameters['courseId'] == null) {
|
|
105
|
+
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling deleteContent().');
|
|
106
|
+
}
|
|
107
|
+
const queryParameters = {};
|
|
108
|
+
const headerParameters = {};
|
|
109
|
+
let urlPath = `/courses/{courseId}/modules/{moduleId}/contents/{contentId}`;
|
|
110
|
+
urlPath = urlPath.replace('{contentId}', encodeURIComponent(String(requestParameters['contentId'])));
|
|
111
|
+
urlPath = urlPath.replace('{moduleId}', encodeURIComponent(String(requestParameters['moduleId'])));
|
|
112
|
+
urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
|
|
113
|
+
return {
|
|
114
|
+
path: urlPath,
|
|
115
|
+
method: 'DELETE',
|
|
116
|
+
headers: headerParameters,
|
|
117
|
+
query: queryParameters,
|
|
118
|
+
};
|
|
119
|
+
});
|
|
120
|
+
}
|
|
121
|
+
/**
|
|
122
|
+
* Soft-deletes the content item.
|
|
123
|
+
* Delete content by id
|
|
124
|
+
*/
|
|
125
|
+
deleteContentRaw(requestParameters, initOverrides) {
|
|
126
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
127
|
+
const requestOptions = yield this.deleteContentRequestOpts(requestParameters);
|
|
128
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
129
|
+
return new runtime.VoidApiResponse(response);
|
|
130
|
+
});
|
|
131
|
+
}
|
|
132
|
+
/**
|
|
133
|
+
* Soft-deletes the content item.
|
|
134
|
+
* Delete content by id
|
|
135
|
+
*/
|
|
136
|
+
deleteContent(requestParameters, initOverrides) {
|
|
137
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
138
|
+
yield this.deleteContentRaw(requestParameters, initOverrides);
|
|
139
|
+
});
|
|
140
|
+
}
|
|
93
141
|
/**
|
|
94
142
|
* Creates request options for getContent without sending the request
|
|
95
143
|
*/
|
package/dist/apis/CourseApi.d.ts
CHANGED
|
@@ -24,6 +24,9 @@ import { type PostCourseExport } from '../models/PostCourseExport';
|
|
|
24
24
|
import { type PostDuplicate } from '../models/PostDuplicate';
|
|
25
25
|
import { type PutCourse } from '../models/PutCourse';
|
|
26
26
|
import { type PutCourseEnrollment } from '../models/PutCourseEnrollment';
|
|
27
|
+
export interface DeleteCourseRequest {
|
|
28
|
+
courseId: string;
|
|
29
|
+
}
|
|
27
30
|
export interface DeleteCourseImageRequest {
|
|
28
31
|
courseId: string;
|
|
29
32
|
}
|
|
@@ -91,6 +94,20 @@ export interface PutCourseEnrollmentRequest {
|
|
|
91
94
|
*
|
|
92
95
|
*/
|
|
93
96
|
export declare class CourseApi extends runtime.BaseAPI {
|
|
97
|
+
/**
|
|
98
|
+
* Creates request options for deleteCourse without sending the request
|
|
99
|
+
*/
|
|
100
|
+
deleteCourseRequestOpts(requestParameters: DeleteCourseRequest): Promise<runtime.RequestOpts>;
|
|
101
|
+
/**
|
|
102
|
+
* Soft-deletes the course and its modules/content.
|
|
103
|
+
* Delete a course by id
|
|
104
|
+
*/
|
|
105
|
+
deleteCourseRaw(requestParameters: DeleteCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
106
|
+
/**
|
|
107
|
+
* Soft-deletes the course and its modules/content.
|
|
108
|
+
* Delete a course by id
|
|
109
|
+
*/
|
|
110
|
+
deleteCourse(requestParameters: DeleteCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
94
111
|
/**
|
|
95
112
|
* Creates request options for deleteCourseImage without sending the request
|
|
96
113
|
*/
|
package/dist/apis/CourseApi.js
CHANGED
|
@@ -42,6 +42,46 @@ const PutCourseEnrollment_1 = require("../models/PutCourseEnrollment");
|
|
|
42
42
|
*
|
|
43
43
|
*/
|
|
44
44
|
class CourseApi extends runtime.BaseAPI {
|
|
45
|
+
/**
|
|
46
|
+
* Creates request options for deleteCourse without sending the request
|
|
47
|
+
*/
|
|
48
|
+
deleteCourseRequestOpts(requestParameters) {
|
|
49
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
50
|
+
if (requestParameters['courseId'] == null) {
|
|
51
|
+
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling deleteCourse().');
|
|
52
|
+
}
|
|
53
|
+
const queryParameters = {};
|
|
54
|
+
const headerParameters = {};
|
|
55
|
+
let urlPath = `/courses/{courseId}`;
|
|
56
|
+
urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
|
|
57
|
+
return {
|
|
58
|
+
path: urlPath,
|
|
59
|
+
method: 'DELETE',
|
|
60
|
+
headers: headerParameters,
|
|
61
|
+
query: queryParameters,
|
|
62
|
+
};
|
|
63
|
+
});
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* Soft-deletes the course and its modules/content.
|
|
67
|
+
* Delete a course by id
|
|
68
|
+
*/
|
|
69
|
+
deleteCourseRaw(requestParameters, initOverrides) {
|
|
70
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
71
|
+
const requestOptions = yield this.deleteCourseRequestOpts(requestParameters);
|
|
72
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
73
|
+
return new runtime.VoidApiResponse(response);
|
|
74
|
+
});
|
|
75
|
+
}
|
|
76
|
+
/**
|
|
77
|
+
* Soft-deletes the course and its modules/content.
|
|
78
|
+
* Delete a course by id
|
|
79
|
+
*/
|
|
80
|
+
deleteCourse(requestParameters, initOverrides) {
|
|
81
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
82
|
+
yield this.deleteCourseRaw(requestParameters, initOverrides);
|
|
83
|
+
});
|
|
84
|
+
}
|
|
45
85
|
/**
|
|
46
86
|
* Creates request options for deleteCourseImage without sending the request
|
|
47
87
|
*/
|
package/dist/apis/ModuleApi.d.ts
CHANGED
|
@@ -16,6 +16,10 @@ import { type PostDuplicate1 } from '../models/PostDuplicate1';
|
|
|
16
16
|
import { type PostModule } from '../models/PostModule';
|
|
17
17
|
import { type PutModule } from '../models/PutModule';
|
|
18
18
|
import { type PutModuleReorder } from '../models/PutModuleReorder';
|
|
19
|
+
export interface DeleteModuleRequest {
|
|
20
|
+
moduleId: string;
|
|
21
|
+
courseId: string;
|
|
22
|
+
}
|
|
19
23
|
export interface GetModuleRequest {
|
|
20
24
|
moduleId: string;
|
|
21
25
|
courseId: string;
|
|
@@ -45,6 +49,20 @@ export interface PutModuleReorderRequest {
|
|
|
45
49
|
*
|
|
46
50
|
*/
|
|
47
51
|
export declare class ModuleApi extends runtime.BaseAPI {
|
|
52
|
+
/**
|
|
53
|
+
* Creates request options for deleteModule without sending the request
|
|
54
|
+
*/
|
|
55
|
+
deleteModuleRequestOpts(requestParameters: DeleteModuleRequest): Promise<runtime.RequestOpts>;
|
|
56
|
+
/**
|
|
57
|
+
* Soft-deletes the module and its content.
|
|
58
|
+
* Delete a module by id
|
|
59
|
+
*/
|
|
60
|
+
deleteModuleRaw(requestParameters: DeleteModuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
61
|
+
/**
|
|
62
|
+
* Soft-deletes the module and its content.
|
|
63
|
+
* Delete a module by id
|
|
64
|
+
*/
|
|
65
|
+
deleteModule(requestParameters: DeleteModuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
48
66
|
/**
|
|
49
67
|
* Creates request options for getModule without sending the request
|
|
50
68
|
*/
|
package/dist/apis/ModuleApi.js
CHANGED
|
@@ -34,6 +34,50 @@ const PutModuleReorder_1 = require("../models/PutModuleReorder");
|
|
|
34
34
|
*
|
|
35
35
|
*/
|
|
36
36
|
class ModuleApi extends runtime.BaseAPI {
|
|
37
|
+
/**
|
|
38
|
+
* Creates request options for deleteModule without sending the request
|
|
39
|
+
*/
|
|
40
|
+
deleteModuleRequestOpts(requestParameters) {
|
|
41
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
42
|
+
if (requestParameters['moduleId'] == null) {
|
|
43
|
+
throw new runtime.RequiredError('moduleId', 'Required parameter "moduleId" was null or undefined when calling deleteModule().');
|
|
44
|
+
}
|
|
45
|
+
if (requestParameters['courseId'] == null) {
|
|
46
|
+
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling deleteModule().');
|
|
47
|
+
}
|
|
48
|
+
const queryParameters = {};
|
|
49
|
+
const headerParameters = {};
|
|
50
|
+
let urlPath = `/courses/{courseId}/modules/{moduleId}`;
|
|
51
|
+
urlPath = urlPath.replace('{moduleId}', encodeURIComponent(String(requestParameters['moduleId'])));
|
|
52
|
+
urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
|
|
53
|
+
return {
|
|
54
|
+
path: urlPath,
|
|
55
|
+
method: 'DELETE',
|
|
56
|
+
headers: headerParameters,
|
|
57
|
+
query: queryParameters,
|
|
58
|
+
};
|
|
59
|
+
});
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* Soft-deletes the module and its content.
|
|
63
|
+
* Delete a module by id
|
|
64
|
+
*/
|
|
65
|
+
deleteModuleRaw(requestParameters, initOverrides) {
|
|
66
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
67
|
+
const requestOptions = yield this.deleteModuleRequestOpts(requestParameters);
|
|
68
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
69
|
+
return new runtime.VoidApiResponse(response);
|
|
70
|
+
});
|
|
71
|
+
}
|
|
72
|
+
/**
|
|
73
|
+
* Soft-deletes the module and its content.
|
|
74
|
+
* Delete a module by id
|
|
75
|
+
*/
|
|
76
|
+
deleteModule(requestParameters, initOverrides) {
|
|
77
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
78
|
+
yield this.deleteModuleRaw(requestParameters, initOverrides);
|
|
79
|
+
});
|
|
80
|
+
}
|
|
37
81
|
/**
|
|
38
82
|
* Creates request options for getModule without sending the request
|
|
39
83
|
*/
|
package/dist/apis/UserApi.d.ts
CHANGED
|
@@ -16,6 +16,8 @@ import { type LoginRes } from '../models/LoginRes';
|
|
|
16
16
|
import { type PostLogin } from '../models/PostLogin';
|
|
17
17
|
import { type PostResetPassword } from '../models/PostResetPassword';
|
|
18
18
|
import { type PostSendResetPassword } from '../models/PostSendResetPassword';
|
|
19
|
+
import { type PostSignupRequest } from '../models/PostSignupRequest';
|
|
20
|
+
import { type PostSignupRequestResponse } from '../models/PostSignupRequestResponse';
|
|
19
21
|
import { type PutUser } from '../models/PutUser';
|
|
20
22
|
export interface DeleteUserAvatarRequest {
|
|
21
23
|
userId: string;
|
|
@@ -26,6 +28,9 @@ export interface GetUserRequest {
|
|
|
26
28
|
export interface PostLoginRequest {
|
|
27
29
|
postLogin: PostLogin;
|
|
28
30
|
}
|
|
31
|
+
export interface PostSignupRequestRequest {
|
|
32
|
+
postSignupRequest: PostSignupRequest;
|
|
33
|
+
}
|
|
29
34
|
export interface PostUserAvatarUploadRequest {
|
|
30
35
|
userId: string;
|
|
31
36
|
file: Blob;
|
|
@@ -40,6 +45,9 @@ export interface ResetPasswordRequest {
|
|
|
40
45
|
export interface SendResetPasswordRequest {
|
|
41
46
|
postSendResetPassword: PostSendResetPassword;
|
|
42
47
|
}
|
|
48
|
+
export interface VerifySignupRequestRequest {
|
|
49
|
+
token: string;
|
|
50
|
+
}
|
|
43
51
|
/**
|
|
44
52
|
*
|
|
45
53
|
*/
|
|
@@ -118,6 +126,18 @@ export declare class UserApi extends runtime.BaseAPI {
|
|
|
118
126
|
* Logout a user
|
|
119
127
|
*/
|
|
120
128
|
postLogout(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
129
|
+
/**
|
|
130
|
+
* Creates request options for postSignupRequest without sending the request
|
|
131
|
+
*/
|
|
132
|
+
postSignupRequestRequestOpts(requestParameters: PostSignupRequestRequest): Promise<runtime.RequestOpts>;
|
|
133
|
+
/**
|
|
134
|
+
* Request a new organization signup
|
|
135
|
+
*/
|
|
136
|
+
postSignupRequestRaw(requestParameters: PostSignupRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostSignupRequestResponse>>;
|
|
137
|
+
/**
|
|
138
|
+
* Request a new organization signup
|
|
139
|
+
*/
|
|
140
|
+
postSignupRequest(requestParameters: PostSignupRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostSignupRequestResponse>;
|
|
121
141
|
/**
|
|
122
142
|
* Creates request options for postUserAvatarUpload without sending the request
|
|
123
143
|
*/
|
|
@@ -166,4 +186,16 @@ export declare class UserApi extends runtime.BaseAPI {
|
|
|
166
186
|
* Send a reset password email
|
|
167
187
|
*/
|
|
168
188
|
sendResetPassword(requestParameters: SendResetPasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
189
|
+
/**
|
|
190
|
+
* Creates request options for verifySignupRequest without sending the request
|
|
191
|
+
*/
|
|
192
|
+
verifySignupRequestRequestOpts(requestParameters: VerifySignupRequestRequest): Promise<runtime.RequestOpts>;
|
|
193
|
+
/**
|
|
194
|
+
* Verify a signup request and provision the portal
|
|
195
|
+
*/
|
|
196
|
+
verifySignupRequestRaw(requestParameters: VerifySignupRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
197
|
+
/**
|
|
198
|
+
* Verify a signup request and provision the portal
|
|
199
|
+
*/
|
|
200
|
+
verifySignupRequest(requestParameters: VerifySignupRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
169
201
|
}
|
package/dist/apis/UserApi.js
CHANGED
|
@@ -30,6 +30,8 @@ const LoginRes_1 = require("../models/LoginRes");
|
|
|
30
30
|
const PostLogin_1 = require("../models/PostLogin");
|
|
31
31
|
const PostResetPassword_1 = require("../models/PostResetPassword");
|
|
32
32
|
const PostSendResetPassword_1 = require("../models/PostSendResetPassword");
|
|
33
|
+
const PostSignupRequest_1 = require("../models/PostSignupRequest");
|
|
34
|
+
const PostSignupRequestResponse_1 = require("../models/PostSignupRequestResponse");
|
|
33
35
|
const PutUser_1 = require("../models/PutUser");
|
|
34
36
|
/**
|
|
35
37
|
*
|
|
@@ -257,6 +259,46 @@ class UserApi extends runtime.BaseAPI {
|
|
|
257
259
|
yield this.postLogoutRaw(initOverrides);
|
|
258
260
|
});
|
|
259
261
|
}
|
|
262
|
+
/**
|
|
263
|
+
* Creates request options for postSignupRequest without sending the request
|
|
264
|
+
*/
|
|
265
|
+
postSignupRequestRequestOpts(requestParameters) {
|
|
266
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
267
|
+
if (requestParameters['postSignupRequest'] == null) {
|
|
268
|
+
throw new runtime.RequiredError('postSignupRequest', 'Required parameter "postSignupRequest" was null or undefined when calling postSignupRequest().');
|
|
269
|
+
}
|
|
270
|
+
const queryParameters = {};
|
|
271
|
+
const headerParameters = {};
|
|
272
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
273
|
+
let urlPath = `/auth/signup-request`;
|
|
274
|
+
return {
|
|
275
|
+
path: urlPath,
|
|
276
|
+
method: 'POST',
|
|
277
|
+
headers: headerParameters,
|
|
278
|
+
query: queryParameters,
|
|
279
|
+
body: (0, PostSignupRequest_1.PostSignupRequestToJSON)(requestParameters['postSignupRequest']),
|
|
280
|
+
};
|
|
281
|
+
});
|
|
282
|
+
}
|
|
283
|
+
/**
|
|
284
|
+
* Request a new organization signup
|
|
285
|
+
*/
|
|
286
|
+
postSignupRequestRaw(requestParameters, initOverrides) {
|
|
287
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
288
|
+
const requestOptions = yield this.postSignupRequestRequestOpts(requestParameters);
|
|
289
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
290
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, PostSignupRequestResponse_1.PostSignupRequestResponseFromJSON)(jsonValue));
|
|
291
|
+
});
|
|
292
|
+
}
|
|
293
|
+
/**
|
|
294
|
+
* Request a new organization signup
|
|
295
|
+
*/
|
|
296
|
+
postSignupRequest(requestParameters, initOverrides) {
|
|
297
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
298
|
+
const response = yield this.postSignupRequestRaw(requestParameters, initOverrides);
|
|
299
|
+
return yield response.value();
|
|
300
|
+
});
|
|
301
|
+
}
|
|
260
302
|
/**
|
|
261
303
|
* Creates request options for postUserAvatarUpload without sending the request
|
|
262
304
|
*/
|
|
@@ -440,5 +482,45 @@ class UserApi extends runtime.BaseAPI {
|
|
|
440
482
|
yield this.sendResetPasswordRaw(requestParameters, initOverrides);
|
|
441
483
|
});
|
|
442
484
|
}
|
|
485
|
+
/**
|
|
486
|
+
* Creates request options for verifySignupRequest without sending the request
|
|
487
|
+
*/
|
|
488
|
+
verifySignupRequestRequestOpts(requestParameters) {
|
|
489
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
490
|
+
if (requestParameters['token'] == null) {
|
|
491
|
+
throw new runtime.RequiredError('token', 'Required parameter "token" was null or undefined when calling verifySignupRequest().');
|
|
492
|
+
}
|
|
493
|
+
const queryParameters = {};
|
|
494
|
+
if (requestParameters['token'] != null) {
|
|
495
|
+
queryParameters['token'] = requestParameters['token'];
|
|
496
|
+
}
|
|
497
|
+
const headerParameters = {};
|
|
498
|
+
let urlPath = `/auth/signup/verify`;
|
|
499
|
+
return {
|
|
500
|
+
path: urlPath,
|
|
501
|
+
method: 'GET',
|
|
502
|
+
headers: headerParameters,
|
|
503
|
+
query: queryParameters,
|
|
504
|
+
};
|
|
505
|
+
});
|
|
506
|
+
}
|
|
507
|
+
/**
|
|
508
|
+
* Verify a signup request and provision the portal
|
|
509
|
+
*/
|
|
510
|
+
verifySignupRequestRaw(requestParameters, initOverrides) {
|
|
511
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
512
|
+
const requestOptions = yield this.verifySignupRequestRequestOpts(requestParameters);
|
|
513
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
514
|
+
return new runtime.VoidApiResponse(response);
|
|
515
|
+
});
|
|
516
|
+
}
|
|
517
|
+
/**
|
|
518
|
+
* Verify a signup request and provision the portal
|
|
519
|
+
*/
|
|
520
|
+
verifySignupRequest(requestParameters, initOverrides) {
|
|
521
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
522
|
+
yield this.verifySignupRequestRaw(requestParameters, initOverrides);
|
|
523
|
+
});
|
|
524
|
+
}
|
|
443
525
|
}
|
|
444
526
|
exports.UserApi = UserApi;
|
|
@@ -35,6 +35,11 @@ import { type ScormSetValueResponse } from '../models/ScormSetValueResponse';
|
|
|
35
35
|
export interface CommitScormSessionRequest {
|
|
36
36
|
scormSessionId: string;
|
|
37
37
|
}
|
|
38
|
+
export interface DeleteContentRequest {
|
|
39
|
+
contentId: string;
|
|
40
|
+
moduleId: string;
|
|
41
|
+
courseId: string;
|
|
42
|
+
}
|
|
38
43
|
export interface GetContentRequest {
|
|
39
44
|
contentId: string;
|
|
40
45
|
moduleId: string;
|
|
@@ -168,6 +173,20 @@ export declare class ContentApi extends runtime.BaseAPI {
|
|
|
168
173
|
* Commit SCORM session data
|
|
169
174
|
*/
|
|
170
175
|
commitScormSession(requestParameters: CommitScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
176
|
+
/**
|
|
177
|
+
* Creates request options for deleteContent without sending the request
|
|
178
|
+
*/
|
|
179
|
+
deleteContentRequestOpts(requestParameters: DeleteContentRequest): Promise<runtime.RequestOpts>;
|
|
180
|
+
/**
|
|
181
|
+
* Soft-deletes the content item.
|
|
182
|
+
* Delete content by id
|
|
183
|
+
*/
|
|
184
|
+
deleteContentRaw(requestParameters: DeleteContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
185
|
+
/**
|
|
186
|
+
* Soft-deletes the content item.
|
|
187
|
+
* Delete content by id
|
|
188
|
+
*/
|
|
189
|
+
deleteContent(requestParameters: DeleteContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
171
190
|
/**
|
|
172
191
|
* Creates request options for getContent without sending the request
|
|
173
192
|
*/
|
|
@@ -87,6 +87,54 @@ export class ContentApi extends runtime.BaseAPI {
|
|
|
87
87
|
yield this.commitScormSessionRaw(requestParameters, initOverrides);
|
|
88
88
|
});
|
|
89
89
|
}
|
|
90
|
+
/**
|
|
91
|
+
* Creates request options for deleteContent without sending the request
|
|
92
|
+
*/
|
|
93
|
+
deleteContentRequestOpts(requestParameters) {
|
|
94
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
95
|
+
if (requestParameters['contentId'] == null) {
|
|
96
|
+
throw new runtime.RequiredError('contentId', 'Required parameter "contentId" was null or undefined when calling deleteContent().');
|
|
97
|
+
}
|
|
98
|
+
if (requestParameters['moduleId'] == null) {
|
|
99
|
+
throw new runtime.RequiredError('moduleId', 'Required parameter "moduleId" was null or undefined when calling deleteContent().');
|
|
100
|
+
}
|
|
101
|
+
if (requestParameters['courseId'] == null) {
|
|
102
|
+
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling deleteContent().');
|
|
103
|
+
}
|
|
104
|
+
const queryParameters = {};
|
|
105
|
+
const headerParameters = {};
|
|
106
|
+
let urlPath = `/courses/{courseId}/modules/{moduleId}/contents/{contentId}`;
|
|
107
|
+
urlPath = urlPath.replace('{contentId}', encodeURIComponent(String(requestParameters['contentId'])));
|
|
108
|
+
urlPath = urlPath.replace('{moduleId}', encodeURIComponent(String(requestParameters['moduleId'])));
|
|
109
|
+
urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
|
|
110
|
+
return {
|
|
111
|
+
path: urlPath,
|
|
112
|
+
method: 'DELETE',
|
|
113
|
+
headers: headerParameters,
|
|
114
|
+
query: queryParameters,
|
|
115
|
+
};
|
|
116
|
+
});
|
|
117
|
+
}
|
|
118
|
+
/**
|
|
119
|
+
* Soft-deletes the content item.
|
|
120
|
+
* Delete content by id
|
|
121
|
+
*/
|
|
122
|
+
deleteContentRaw(requestParameters, initOverrides) {
|
|
123
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
124
|
+
const requestOptions = yield this.deleteContentRequestOpts(requestParameters);
|
|
125
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
126
|
+
return new runtime.VoidApiResponse(response);
|
|
127
|
+
});
|
|
128
|
+
}
|
|
129
|
+
/**
|
|
130
|
+
* Soft-deletes the content item.
|
|
131
|
+
* Delete content by id
|
|
132
|
+
*/
|
|
133
|
+
deleteContent(requestParameters, initOverrides) {
|
|
134
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
135
|
+
yield this.deleteContentRaw(requestParameters, initOverrides);
|
|
136
|
+
});
|
|
137
|
+
}
|
|
90
138
|
/**
|
|
91
139
|
* Creates request options for getContent without sending the request
|
|
92
140
|
*/
|
|
@@ -24,6 +24,9 @@ import { type PostCourseExport } from '../models/PostCourseExport';
|
|
|
24
24
|
import { type PostDuplicate } from '../models/PostDuplicate';
|
|
25
25
|
import { type PutCourse } from '../models/PutCourse';
|
|
26
26
|
import { type PutCourseEnrollment } from '../models/PutCourseEnrollment';
|
|
27
|
+
export interface DeleteCourseRequest {
|
|
28
|
+
courseId: string;
|
|
29
|
+
}
|
|
27
30
|
export interface DeleteCourseImageRequest {
|
|
28
31
|
courseId: string;
|
|
29
32
|
}
|
|
@@ -91,6 +94,20 @@ export interface PutCourseEnrollmentRequest {
|
|
|
91
94
|
*
|
|
92
95
|
*/
|
|
93
96
|
export declare class CourseApi extends runtime.BaseAPI {
|
|
97
|
+
/**
|
|
98
|
+
* Creates request options for deleteCourse without sending the request
|
|
99
|
+
*/
|
|
100
|
+
deleteCourseRequestOpts(requestParameters: DeleteCourseRequest): Promise<runtime.RequestOpts>;
|
|
101
|
+
/**
|
|
102
|
+
* Soft-deletes the course and its modules/content.
|
|
103
|
+
* Delete a course by id
|
|
104
|
+
*/
|
|
105
|
+
deleteCourseRaw(requestParameters: DeleteCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
106
|
+
/**
|
|
107
|
+
* Soft-deletes the course and its modules/content.
|
|
108
|
+
* Delete a course by id
|
|
109
|
+
*/
|
|
110
|
+
deleteCourse(requestParameters: DeleteCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
94
111
|
/**
|
|
95
112
|
* Creates request options for deleteCourseImage without sending the request
|
|
96
113
|
*/
|
|
@@ -39,6 +39,46 @@ import { PutCourseEnrollmentToJSON, } from '../models/PutCourseEnrollment';
|
|
|
39
39
|
*
|
|
40
40
|
*/
|
|
41
41
|
export class CourseApi extends runtime.BaseAPI {
|
|
42
|
+
/**
|
|
43
|
+
* Creates request options for deleteCourse without sending the request
|
|
44
|
+
*/
|
|
45
|
+
deleteCourseRequestOpts(requestParameters) {
|
|
46
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
47
|
+
if (requestParameters['courseId'] == null) {
|
|
48
|
+
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling deleteCourse().');
|
|
49
|
+
}
|
|
50
|
+
const queryParameters = {};
|
|
51
|
+
const headerParameters = {};
|
|
52
|
+
let urlPath = `/courses/{courseId}`;
|
|
53
|
+
urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
|
|
54
|
+
return {
|
|
55
|
+
path: urlPath,
|
|
56
|
+
method: 'DELETE',
|
|
57
|
+
headers: headerParameters,
|
|
58
|
+
query: queryParameters,
|
|
59
|
+
};
|
|
60
|
+
});
|
|
61
|
+
}
|
|
62
|
+
/**
|
|
63
|
+
* Soft-deletes the course and its modules/content.
|
|
64
|
+
* Delete a course by id
|
|
65
|
+
*/
|
|
66
|
+
deleteCourseRaw(requestParameters, initOverrides) {
|
|
67
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
68
|
+
const requestOptions = yield this.deleteCourseRequestOpts(requestParameters);
|
|
69
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
70
|
+
return new runtime.VoidApiResponse(response);
|
|
71
|
+
});
|
|
72
|
+
}
|
|
73
|
+
/**
|
|
74
|
+
* Soft-deletes the course and its modules/content.
|
|
75
|
+
* Delete a course by id
|
|
76
|
+
*/
|
|
77
|
+
deleteCourse(requestParameters, initOverrides) {
|
|
78
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
79
|
+
yield this.deleteCourseRaw(requestParameters, initOverrides);
|
|
80
|
+
});
|
|
81
|
+
}
|
|
42
82
|
/**
|
|
43
83
|
* Creates request options for deleteCourseImage without sending the request
|
|
44
84
|
*/
|