@easyedu/js-lsm-api 1.63.0 → 1.65.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 +13 -2
- package/dist/apis/ContentApi.d.ts +37 -0
- package/dist/apis/ContentApi.js +98 -0
- package/dist/apis/CourseApi.d.ts +49 -0
- package/dist/apis/CourseApi.js +124 -0
- package/dist/apis/ModuleApi.d.ts +18 -0
- package/dist/apis/ModuleApi.js +44 -0
- package/dist/apis/PortalApi.d.ts +16 -0
- package/dist/apis/PortalApi.js +42 -0
- package/dist/apis/UserApi.d.ts +32 -0
- package/dist/apis/UserApi.js +82 -0
- package/dist/esm/apis/ContentApi.d.ts +37 -0
- package/dist/esm/apis/ContentApi.js +98 -0
- package/dist/esm/apis/CourseApi.d.ts +49 -0
- package/dist/esm/apis/CourseApi.js +124 -0
- package/dist/esm/apis/ModuleApi.d.ts +18 -0
- package/dist/esm/apis/ModuleApi.js +44 -0
- package/dist/esm/apis/PortalApi.d.ts +16 -0
- package/dist/esm/apis/PortalApi.js +42 -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 +155 -0
- package/docs/CourseApi.md +211 -0
- package/docs/ModuleApi.md +73 -0
- package/docs/PortalApi.md +71 -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 +143 -0
- package/src/apis/CourseApi.ts +164 -0
- package/src/apis/ModuleApi.ts +59 -0
- package/src/apis/PortalApi.ts +57 -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/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,17 @@ 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
|
+
}
|
|
43
|
+
export interface DeleteContentVersionRequest {
|
|
44
|
+
contentId: string;
|
|
45
|
+
moduleId: string;
|
|
46
|
+
courseId: string;
|
|
47
|
+
versionId: string;
|
|
48
|
+
}
|
|
38
49
|
export interface GetContentRequest {
|
|
39
50
|
contentId: string;
|
|
40
51
|
moduleId: string;
|
|
@@ -168,6 +179,32 @@ export declare class ContentApi extends runtime.BaseAPI {
|
|
|
168
179
|
* Commit SCORM session data
|
|
169
180
|
*/
|
|
170
181
|
commitScormSession(requestParameters: CommitScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
182
|
+
/**
|
|
183
|
+
* Creates request options for deleteContent without sending the request
|
|
184
|
+
*/
|
|
185
|
+
deleteContentRequestOpts(requestParameters: DeleteContentRequest): Promise<runtime.RequestOpts>;
|
|
186
|
+
/**
|
|
187
|
+
* Soft-deletes the content item.
|
|
188
|
+
* Delete content by id
|
|
189
|
+
*/
|
|
190
|
+
deleteContentRaw(requestParameters: DeleteContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
191
|
+
/**
|
|
192
|
+
* Soft-deletes the content item.
|
|
193
|
+
* Delete content by id
|
|
194
|
+
*/
|
|
195
|
+
deleteContent(requestParameters: DeleteContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
196
|
+
/**
|
|
197
|
+
* Creates request options for deleteContentVersion without sending the request
|
|
198
|
+
*/
|
|
199
|
+
deleteContentVersionRequestOpts(requestParameters: DeleteContentVersionRequest): Promise<runtime.RequestOpts>;
|
|
200
|
+
/**
|
|
201
|
+
* Delete an inactive content version
|
|
202
|
+
*/
|
|
203
|
+
deleteContentVersionRaw(requestParameters: DeleteContentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
204
|
+
/**
|
|
205
|
+
* Delete an inactive content version
|
|
206
|
+
*/
|
|
207
|
+
deleteContentVersion(requestParameters: DeleteContentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
171
208
|
/**
|
|
172
209
|
* Creates request options for getContent without sending the request
|
|
173
210
|
*/
|
|
@@ -87,6 +87,104 @@ 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
|
+
}
|
|
138
|
+
/**
|
|
139
|
+
* Creates request options for deleteContentVersion without sending the request
|
|
140
|
+
*/
|
|
141
|
+
deleteContentVersionRequestOpts(requestParameters) {
|
|
142
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
143
|
+
if (requestParameters['contentId'] == null) {
|
|
144
|
+
throw new runtime.RequiredError('contentId', 'Required parameter "contentId" was null or undefined when calling deleteContentVersion().');
|
|
145
|
+
}
|
|
146
|
+
if (requestParameters['moduleId'] == null) {
|
|
147
|
+
throw new runtime.RequiredError('moduleId', 'Required parameter "moduleId" was null or undefined when calling deleteContentVersion().');
|
|
148
|
+
}
|
|
149
|
+
if (requestParameters['courseId'] == null) {
|
|
150
|
+
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling deleteContentVersion().');
|
|
151
|
+
}
|
|
152
|
+
if (requestParameters['versionId'] == null) {
|
|
153
|
+
throw new runtime.RequiredError('versionId', 'Required parameter "versionId" was null or undefined when calling deleteContentVersion().');
|
|
154
|
+
}
|
|
155
|
+
const queryParameters = {};
|
|
156
|
+
const headerParameters = {};
|
|
157
|
+
let urlPath = `/courses/{courseId}/modules/{moduleId}/contents/{contentId}/versions/{versionId}`;
|
|
158
|
+
urlPath = urlPath.replace('{contentId}', encodeURIComponent(String(requestParameters['contentId'])));
|
|
159
|
+
urlPath = urlPath.replace('{moduleId}', encodeURIComponent(String(requestParameters['moduleId'])));
|
|
160
|
+
urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
|
|
161
|
+
urlPath = urlPath.replace('{versionId}', encodeURIComponent(String(requestParameters['versionId'])));
|
|
162
|
+
return {
|
|
163
|
+
path: urlPath,
|
|
164
|
+
method: 'DELETE',
|
|
165
|
+
headers: headerParameters,
|
|
166
|
+
query: queryParameters,
|
|
167
|
+
};
|
|
168
|
+
});
|
|
169
|
+
}
|
|
170
|
+
/**
|
|
171
|
+
* Delete an inactive content version
|
|
172
|
+
*/
|
|
173
|
+
deleteContentVersionRaw(requestParameters, initOverrides) {
|
|
174
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
175
|
+
const requestOptions = yield this.deleteContentVersionRequestOpts(requestParameters);
|
|
176
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
177
|
+
return new runtime.VoidApiResponse(response);
|
|
178
|
+
});
|
|
179
|
+
}
|
|
180
|
+
/**
|
|
181
|
+
* Delete an inactive content version
|
|
182
|
+
*/
|
|
183
|
+
deleteContentVersion(requestParameters, initOverrides) {
|
|
184
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
185
|
+
yield this.deleteContentVersionRaw(requestParameters, initOverrides);
|
|
186
|
+
});
|
|
187
|
+
}
|
|
90
188
|
/**
|
|
91
189
|
* Creates request options for getContent without sending the request
|
|
92
190
|
*/
|
|
@@ -24,6 +24,17 @@ 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
|
+
}
|
|
30
|
+
export interface DeleteCourseEnrollmentRequest {
|
|
31
|
+
courseId: string;
|
|
32
|
+
enrollmentId: string;
|
|
33
|
+
}
|
|
34
|
+
export interface DeleteCourseExportRequest {
|
|
35
|
+
courseId: string;
|
|
36
|
+
exportId: string;
|
|
37
|
+
}
|
|
27
38
|
export interface DeleteCourseImageRequest {
|
|
28
39
|
courseId: string;
|
|
29
40
|
}
|
|
@@ -91,6 +102,44 @@ export interface PutCourseEnrollmentRequest {
|
|
|
91
102
|
*
|
|
92
103
|
*/
|
|
93
104
|
export declare class CourseApi extends runtime.BaseAPI {
|
|
105
|
+
/**
|
|
106
|
+
* Creates request options for deleteCourse without sending the request
|
|
107
|
+
*/
|
|
108
|
+
deleteCourseRequestOpts(requestParameters: DeleteCourseRequest): Promise<runtime.RequestOpts>;
|
|
109
|
+
/**
|
|
110
|
+
* Soft-deletes the course and its modules/content.
|
|
111
|
+
* Delete a course by id
|
|
112
|
+
*/
|
|
113
|
+
deleteCourseRaw(requestParameters: DeleteCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
114
|
+
/**
|
|
115
|
+
* Soft-deletes the course and its modules/content.
|
|
116
|
+
* Delete a course by id
|
|
117
|
+
*/
|
|
118
|
+
deleteCourse(requestParameters: DeleteCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
119
|
+
/**
|
|
120
|
+
* Creates request options for deleteCourseEnrollment without sending the request
|
|
121
|
+
*/
|
|
122
|
+
deleteCourseEnrollmentRequestOpts(requestParameters: DeleteCourseEnrollmentRequest): Promise<runtime.RequestOpts>;
|
|
123
|
+
/**
|
|
124
|
+
* Remove a course enrollment
|
|
125
|
+
*/
|
|
126
|
+
deleteCourseEnrollmentRaw(requestParameters: DeleteCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
127
|
+
/**
|
|
128
|
+
* Remove a course enrollment
|
|
129
|
+
*/
|
|
130
|
+
deleteCourseEnrollment(requestParameters: DeleteCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
131
|
+
/**
|
|
132
|
+
* Creates request options for deleteCourseExport without sending the request
|
|
133
|
+
*/
|
|
134
|
+
deleteCourseExportRequestOpts(requestParameters: DeleteCourseExportRequest): Promise<runtime.RequestOpts>;
|
|
135
|
+
/**
|
|
136
|
+
* Delete a course export
|
|
137
|
+
*/
|
|
138
|
+
deleteCourseExportRaw(requestParameters: DeleteCourseExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
139
|
+
/**
|
|
140
|
+
* Delete a course export
|
|
141
|
+
*/
|
|
142
|
+
deleteCourseExport(requestParameters: DeleteCourseExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
94
143
|
/**
|
|
95
144
|
* Creates request options for deleteCourseImage without sending the request
|
|
96
145
|
*/
|
|
@@ -39,6 +39,130 @@ 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
|
+
}
|
|
82
|
+
/**
|
|
83
|
+
* Creates request options for deleteCourseEnrollment without sending the request
|
|
84
|
+
*/
|
|
85
|
+
deleteCourseEnrollmentRequestOpts(requestParameters) {
|
|
86
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
87
|
+
if (requestParameters['courseId'] == null) {
|
|
88
|
+
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling deleteCourseEnrollment().');
|
|
89
|
+
}
|
|
90
|
+
if (requestParameters['enrollmentId'] == null) {
|
|
91
|
+
throw new runtime.RequiredError('enrollmentId', 'Required parameter "enrollmentId" was null or undefined when calling deleteCourseEnrollment().');
|
|
92
|
+
}
|
|
93
|
+
const queryParameters = {};
|
|
94
|
+
const headerParameters = {};
|
|
95
|
+
let urlPath = `/courses/{courseId}/enrollments/{enrollmentId}`;
|
|
96
|
+
urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
|
|
97
|
+
urlPath = urlPath.replace('{enrollmentId}', encodeURIComponent(String(requestParameters['enrollmentId'])));
|
|
98
|
+
return {
|
|
99
|
+
path: urlPath,
|
|
100
|
+
method: 'DELETE',
|
|
101
|
+
headers: headerParameters,
|
|
102
|
+
query: queryParameters,
|
|
103
|
+
};
|
|
104
|
+
});
|
|
105
|
+
}
|
|
106
|
+
/**
|
|
107
|
+
* Remove a course enrollment
|
|
108
|
+
*/
|
|
109
|
+
deleteCourseEnrollmentRaw(requestParameters, initOverrides) {
|
|
110
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
111
|
+
const requestOptions = yield this.deleteCourseEnrollmentRequestOpts(requestParameters);
|
|
112
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
113
|
+
return new runtime.VoidApiResponse(response);
|
|
114
|
+
});
|
|
115
|
+
}
|
|
116
|
+
/**
|
|
117
|
+
* Remove a course enrollment
|
|
118
|
+
*/
|
|
119
|
+
deleteCourseEnrollment(requestParameters, initOverrides) {
|
|
120
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
121
|
+
yield this.deleteCourseEnrollmentRaw(requestParameters, initOverrides);
|
|
122
|
+
});
|
|
123
|
+
}
|
|
124
|
+
/**
|
|
125
|
+
* Creates request options for deleteCourseExport without sending the request
|
|
126
|
+
*/
|
|
127
|
+
deleteCourseExportRequestOpts(requestParameters) {
|
|
128
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
129
|
+
if (requestParameters['courseId'] == null) {
|
|
130
|
+
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling deleteCourseExport().');
|
|
131
|
+
}
|
|
132
|
+
if (requestParameters['exportId'] == null) {
|
|
133
|
+
throw new runtime.RequiredError('exportId', 'Required parameter "exportId" was null or undefined when calling deleteCourseExport().');
|
|
134
|
+
}
|
|
135
|
+
const queryParameters = {};
|
|
136
|
+
const headerParameters = {};
|
|
137
|
+
let urlPath = `/courses/{courseId}/exports/{exportId}`;
|
|
138
|
+
urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
|
|
139
|
+
urlPath = urlPath.replace('{exportId}', encodeURIComponent(String(requestParameters['exportId'])));
|
|
140
|
+
return {
|
|
141
|
+
path: urlPath,
|
|
142
|
+
method: 'DELETE',
|
|
143
|
+
headers: headerParameters,
|
|
144
|
+
query: queryParameters,
|
|
145
|
+
};
|
|
146
|
+
});
|
|
147
|
+
}
|
|
148
|
+
/**
|
|
149
|
+
* Delete a course export
|
|
150
|
+
*/
|
|
151
|
+
deleteCourseExportRaw(requestParameters, initOverrides) {
|
|
152
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
153
|
+
const requestOptions = yield this.deleteCourseExportRequestOpts(requestParameters);
|
|
154
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
155
|
+
return new runtime.VoidApiResponse(response);
|
|
156
|
+
});
|
|
157
|
+
}
|
|
158
|
+
/**
|
|
159
|
+
* Delete a course export
|
|
160
|
+
*/
|
|
161
|
+
deleteCourseExport(requestParameters, initOverrides) {
|
|
162
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
163
|
+
yield this.deleteCourseExportRaw(requestParameters, initOverrides);
|
|
164
|
+
});
|
|
165
|
+
}
|
|
42
166
|
/**
|
|
43
167
|
* Creates request options for deleteCourseImage without sending the request
|
|
44
168
|
*/
|
|
@@ -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
|
*/
|
|
@@ -31,6 +31,50 @@ import { PutModuleReorderToJSON, } from '../models/PutModuleReorder';
|
|
|
31
31
|
*
|
|
32
32
|
*/
|
|
33
33
|
export class ModuleApi extends runtime.BaseAPI {
|
|
34
|
+
/**
|
|
35
|
+
* Creates request options for deleteModule without sending the request
|
|
36
|
+
*/
|
|
37
|
+
deleteModuleRequestOpts(requestParameters) {
|
|
38
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
39
|
+
if (requestParameters['moduleId'] == null) {
|
|
40
|
+
throw new runtime.RequiredError('moduleId', 'Required parameter "moduleId" was null or undefined when calling deleteModule().');
|
|
41
|
+
}
|
|
42
|
+
if (requestParameters['courseId'] == null) {
|
|
43
|
+
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling deleteModule().');
|
|
44
|
+
}
|
|
45
|
+
const queryParameters = {};
|
|
46
|
+
const headerParameters = {};
|
|
47
|
+
let urlPath = `/courses/{courseId}/modules/{moduleId}`;
|
|
48
|
+
urlPath = urlPath.replace('{moduleId}', encodeURIComponent(String(requestParameters['moduleId'])));
|
|
49
|
+
urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
|
|
50
|
+
return {
|
|
51
|
+
path: urlPath,
|
|
52
|
+
method: 'DELETE',
|
|
53
|
+
headers: headerParameters,
|
|
54
|
+
query: queryParameters,
|
|
55
|
+
};
|
|
56
|
+
});
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* Soft-deletes the module and its content.
|
|
60
|
+
* Delete a module by id
|
|
61
|
+
*/
|
|
62
|
+
deleteModuleRaw(requestParameters, initOverrides) {
|
|
63
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
64
|
+
const requestOptions = yield this.deleteModuleRequestOpts(requestParameters);
|
|
65
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
66
|
+
return new runtime.VoidApiResponse(response);
|
|
67
|
+
});
|
|
68
|
+
}
|
|
69
|
+
/**
|
|
70
|
+
* Soft-deletes the module and its content.
|
|
71
|
+
* Delete a module by id
|
|
72
|
+
*/
|
|
73
|
+
deleteModule(requestParameters, initOverrides) {
|
|
74
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
75
|
+
yield this.deleteModuleRaw(requestParameters, initOverrides);
|
|
76
|
+
});
|
|
77
|
+
}
|
|
34
78
|
/**
|
|
35
79
|
* Creates request options for getModule without sending the request
|
|
36
80
|
*/
|
|
@@ -56,6 +56,10 @@ export interface PutPortalBrandingRequest {
|
|
|
56
56
|
portalId: string;
|
|
57
57
|
putPortalBranding: PutPortalBranding;
|
|
58
58
|
}
|
|
59
|
+
export interface RemovePortalUserRequest {
|
|
60
|
+
portalId: string;
|
|
61
|
+
userId: string;
|
|
62
|
+
}
|
|
59
63
|
export interface UpdateSelectedPortalRequest {
|
|
60
64
|
portalId: string;
|
|
61
65
|
}
|
|
@@ -197,6 +201,18 @@ export declare class PortalApi extends runtime.BaseAPI {
|
|
|
197
201
|
* Update portal branding (name, background color, text color)
|
|
198
202
|
*/
|
|
199
203
|
putPortalBranding(requestParameters: PutPortalBrandingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortal>;
|
|
204
|
+
/**
|
|
205
|
+
* Creates request options for removePortalUser without sending the request
|
|
206
|
+
*/
|
|
207
|
+
removePortalUserRequestOpts(requestParameters: RemovePortalUserRequest): Promise<runtime.RequestOpts>;
|
|
208
|
+
/**
|
|
209
|
+
* Remove a user from a portal
|
|
210
|
+
*/
|
|
211
|
+
removePortalUserRaw(requestParameters: RemovePortalUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
212
|
+
/**
|
|
213
|
+
* Remove a user from a portal
|
|
214
|
+
*/
|
|
215
|
+
removePortalUser(requestParameters: RemovePortalUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
200
216
|
/**
|
|
201
217
|
* Creates request options for updateSelectedPortal without sending the request
|
|
202
218
|
*/
|