@easyedu/js-lsm-api 1.62.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 +8 -0
- package/README.md +22 -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/DispatchApi.d.ts +44 -0
- package/dist/apis/DispatchApi.js +104 -0
- package/dist/apis/ModuleApi.d.ts +18 -0
- package/dist/apis/ModuleApi.js +44 -0
- package/dist/apis/PlayerApi.d.ts +183 -0
- package/dist/apis/PlayerApi.js +454 -0
- package/dist/apis/UserApi.d.ts +32 -0
- package/dist/apis/UserApi.js +82 -0
- package/dist/apis/index.d.ts +2 -0
- package/dist/apis/index.js +2 -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/DispatchApi.d.ts +44 -0
- package/dist/esm/apis/DispatchApi.js +100 -0
- package/dist/esm/apis/ModuleApi.d.ts +18 -0
- package/dist/esm/apis/ModuleApi.js +44 -0
- package/dist/esm/apis/PlayerApi.d.ts +183 -0
- package/dist/esm/apis/PlayerApi.js +450 -0
- package/dist/esm/apis/UserApi.d.ts +32 -0
- package/dist/esm/apis/UserApi.js +82 -0
- package/dist/esm/apis/index.d.ts +2 -0
- package/dist/esm/apis/index.js +2 -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/DispatchApi.md +134 -0
- package/docs/ModuleApi.md +73 -0
- package/docs/PlayerApi.md +760 -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/DispatchApi.ts +106 -0
- package/src/apis/ModuleApi.ts +59 -0
- package/src/apis/PlayerApi.ts +559 -0
- package/src/apis/UserApi.ts +112 -0
- package/src/apis/index.ts +2 -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
|
@@ -16,6 +16,7 @@ docs/CourseShareApi.md
|
|
|
16
16
|
docs/CriteriaBasedSelection.md
|
|
17
17
|
docs/CriteriaBasedSelectionCriteria.md
|
|
18
18
|
docs/CriteriaBasedSelectionDistribution.md
|
|
19
|
+
docs/DispatchApi.md
|
|
19
20
|
docs/DownloadSupportTicketAttachment200Response.md
|
|
20
21
|
docs/EffectiveCertificateConfig.md
|
|
21
22
|
docs/Essay.md
|
|
@@ -173,6 +174,7 @@ docs/MultipleAnswer1.md
|
|
|
173
174
|
docs/NoAnswer.md
|
|
174
175
|
docs/OtherApi.md
|
|
175
176
|
docs/Paginated.md
|
|
177
|
+
docs/PlayerApi.md
|
|
176
178
|
docs/PortalApi.md
|
|
177
179
|
docs/PortalSublicense.md
|
|
178
180
|
docs/PortalSublicenseApi.md
|
|
@@ -224,6 +226,8 @@ docs/PostResetPassword.md
|
|
|
224
226
|
docs/PostRevokeCertificate.md
|
|
225
227
|
docs/PostRole.md
|
|
226
228
|
docs/PostSendResetPassword.md
|
|
229
|
+
docs/PostSignupRequest.md
|
|
230
|
+
docs/PostSignupRequestResponse.md
|
|
227
231
|
docs/PostSupportTicket.md
|
|
228
232
|
docs/PostSupportTicketComment.md
|
|
229
233
|
docs/PostVerifyManifest.md
|
|
@@ -284,8 +288,10 @@ src/apis/ContentApi.ts
|
|
|
284
288
|
src/apis/CourseApi.ts
|
|
285
289
|
src/apis/CourseCatalogApi.ts
|
|
286
290
|
src/apis/CourseShareApi.ts
|
|
291
|
+
src/apis/DispatchApi.ts
|
|
287
292
|
src/apis/ModuleApi.ts
|
|
288
293
|
src/apis/OtherApi.ts
|
|
294
|
+
src/apis/PlayerApi.ts
|
|
289
295
|
src/apis/PortalApi.ts
|
|
290
296
|
src/apis/PortalSublicenseApi.ts
|
|
291
297
|
src/apis/QuestionApi.ts
|
|
@@ -508,6 +514,8 @@ src/models/PostResetPassword.ts
|
|
|
508
514
|
src/models/PostRevokeCertificate.ts
|
|
509
515
|
src/models/PostRole.ts
|
|
510
516
|
src/models/PostSendResetPassword.ts
|
|
517
|
+
src/models/PostSignupRequest.ts
|
|
518
|
+
src/models/PostSignupRequestResponse.ts
|
|
511
519
|
src/models/PostSupportTicket.ts
|
|
512
520
|
src/models/PostSupportTicketComment.ts
|
|
513
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
|
|
@@ -124,6 +126,9 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
124
126
|
*CourseShareApi* | [**putAcceptClone**](docs/CourseShareApi.md#putacceptclone) | **PUT** /course-shares/{shareId}/accept-clone | Accept an offer as a clone (deep copy into your portal)
|
|
125
127
|
*CourseShareApi* | [**putAcceptMirror**](docs/CourseShareApi.md#putacceptmirror) | **PUT** /course-shares/{shareId}/accept-mirror | Accept an offer as a mirror (no copy, live link to source)
|
|
126
128
|
*CourseShareApi* | [**putDeclineShare**](docs/CourseShareApi.md#putdeclineshare) | **PUT** /course-shares/{shareId}/decline | Decline an offer
|
|
129
|
+
*DispatchApi* | [**getDispatchRollup**](docs/DispatchApi.md#getdispatchrollup) | **GET** /dispatch/sessions/{dispatchPackageId}/rollup | Get dispatch package rollup data
|
|
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
|
|
127
132
|
*ModuleApi* | [**getModule**](docs/ModuleApi.md#getmodule) | **GET** /courses/{courseId}/modules/{moduleId} | get a course module
|
|
128
133
|
*ModuleApi* | [**getModuleList**](docs/ModuleApi.md#getmodulelist) | **GET** /courses/{courseId}/modules | get module list
|
|
129
134
|
*ModuleApi* | [**postModule**](docs/ModuleApi.md#postmodule) | **POST** /courses/{courseId}/modules | Post a new module
|
|
@@ -131,6 +136,17 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
131
136
|
*ModuleApi* | [**putModule**](docs/ModuleApi.md#putmodule) | **PUT** /courses/{courseId}/modules/{moduleId} | Update a module by id
|
|
132
137
|
*ModuleApi* | [**putModuleReorder**](docs/ModuleApi.md#putmodulereorder) | **PUT** /courses/{courseId}/modules/reorder | Reorder modules in a course
|
|
133
138
|
*OtherApi* | [**getHealth**](docs/OtherApi.md#gethealth) | **GET** /healthcheck | Health check endpoint
|
|
139
|
+
*PlayerApi* | [**getDispatchScormPlayer**](docs/PlayerApi.md#getdispatchscormplayer) | **GET** /scorm/dispatch/session/{sessionId}/player | Dispatch SCORM player HTML page
|
|
140
|
+
*PlayerApi* | [**getFileAsset**](docs/PlayerApi.md#getfileasset) | **GET** /file/{contentId}/asset | File asset
|
|
141
|
+
*PlayerApi* | [**getFilePlayer**](docs/PlayerApi.md#getfileplayer) | **GET** /file/session/{sessionId}/player | File player HTML page
|
|
142
|
+
*PlayerApi* | [**getImagePlayer**](docs/PlayerApi.md#getimageplayer) | **GET** /image/session/{sessionId}/player | Image player HTML page
|
|
143
|
+
*PlayerApi* | [**getPdfAsset**](docs/PlayerApi.md#getpdfasset) | **GET** /pdf/{contentId}/asset | PDF asset
|
|
144
|
+
*PlayerApi* | [**getPdfPlayer**](docs/PlayerApi.md#getpdfplayer) | **GET** /pdf/session/{sessionId}/player | PDF player HTML page
|
|
145
|
+
*PlayerApi* | [**getQuizPlayer**](docs/PlayerApi.md#getquizplayer) | **GET** /quiz/session/{sessionId}/player | Quiz player HTML page
|
|
146
|
+
*PlayerApi* | [**getScormAsset**](docs/PlayerApi.md#getscormasset) | **GET** /scorm/{contentId}/scorm/asset/{assetPath} | SCORM package asset
|
|
147
|
+
*PlayerApi* | [**getScormPlayer**](docs/PlayerApi.md#getscormplayer) | **GET** /scorm/session/{sessionId}/player | SCORM player HTML page
|
|
148
|
+
*PlayerApi* | [**getVideoAsset**](docs/PlayerApi.md#getvideoasset) | **GET** /video/{contentId}/asset | Video asset
|
|
149
|
+
*PlayerApi* | [**getVideoPlayer**](docs/PlayerApi.md#getvideoplayer) | **GET** /video/session/{sessionId}/player | Video player HTML page
|
|
134
150
|
*PortalApi* | [**deletePortalFavicon**](docs/PortalApi.md#deleteportalfavicon) | **DELETE** /portals/{portalId}/branding/favicon | Remove the portal favicon
|
|
135
151
|
*PortalApi* | [**deletePortalLogo**](docs/PortalApi.md#deleteportallogo) | **DELETE** /portals/{portalId}/branding/logo | Remove the portal logo
|
|
136
152
|
*PortalApi* | [**getPortalById**](docs/PortalApi.md#getportalbyid) | **GET** /portals/{portalId} | Get a portal by id (can use \'current\' to get the current users selected portal)
|
|
@@ -209,10 +225,12 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
209
225
|
*UserApi* | [**getUser**](docs/UserApi.md#getuser) | **GET** /users/{userId} | Get a user by id
|
|
210
226
|
*UserApi* | [**postLogin**](docs/UserApi.md#postlogin) | **POST** /auth/login | Post a new login
|
|
211
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
|
|
212
229
|
*UserApi* | [**postUserAvatarUpload**](docs/UserApi.md#postuseravatarupload) | **POST** /users/{userId}/avatar | Upload a profile photo for the current user
|
|
213
230
|
*UserApi* | [**putUser**](docs/UserApi.md#putuser) | **PUT** /users/{userId} | Update a user by id
|
|
214
231
|
*UserApi* | [**resetPassword**](docs/UserApi.md#resetpassword) | **POST** /auth/reset-password | Reset a users password
|
|
215
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
|
|
216
234
|
|
|
217
235
|
|
|
218
236
|
### Models
|
|
@@ -429,6 +447,8 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
429
447
|
- [PostRevokeCertificate](docs/PostRevokeCertificate.md)
|
|
430
448
|
- [PostRole](docs/PostRole.md)
|
|
431
449
|
- [PostSendResetPassword](docs/PostSendResetPassword.md)
|
|
450
|
+
- [PostSignupRequest](docs/PostSignupRequest.md)
|
|
451
|
+
- [PostSignupRequestResponse](docs/PostSignupRequestResponse.md)
|
|
432
452
|
- [PostSupportTicket](docs/PostSupportTicket.md)
|
|
433
453
|
- [PostSupportTicketComment](docs/PostSupportTicketComment.md)
|
|
434
454
|
- [PostVerifyManifest](docs/PostVerifyManifest.md)
|
|
@@ -489,7 +509,7 @@ and is automatically generated by the
|
|
|
489
509
|
[OpenAPI Generator](https://openapi-generator.tech) project:
|
|
490
510
|
|
|
491
511
|
- API version: `1.0.0`
|
|
492
|
-
- Package version: `1.
|
|
512
|
+
- Package version: `1.64.0`
|
|
493
513
|
- Generator version: `7.22.0`
|
|
494
514
|
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
|
|
495
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
|
*/
|
|
@@ -0,0 +1,44 @@
|
|
|
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
|
+
export interface GetDispatchRollupRequest {
|
|
14
|
+
dispatchPackageId: string;
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
*/
|
|
19
|
+
export declare class DispatchApi extends runtime.BaseAPI {
|
|
20
|
+
/**
|
|
21
|
+
* Creates request options for getDispatchRollup without sending the request
|
|
22
|
+
*/
|
|
23
|
+
getDispatchRollupRequestOpts(requestParameters: GetDispatchRollupRequest): Promise<runtime.RequestOpts>;
|
|
24
|
+
/**
|
|
25
|
+
* Get dispatch package rollup data
|
|
26
|
+
*/
|
|
27
|
+
getDispatchRollupRaw(requestParameters: GetDispatchRollupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
28
|
+
/**
|
|
29
|
+
* Get dispatch package rollup data
|
|
30
|
+
*/
|
|
31
|
+
getDispatchRollup(requestParameters: GetDispatchRollupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
32
|
+
/**
|
|
33
|
+
* Creates request options for postDispatchLaunch without sending the request
|
|
34
|
+
*/
|
|
35
|
+
postDispatchLaunchRequestOpts(): Promise<runtime.RequestOpts>;
|
|
36
|
+
/**
|
|
37
|
+
* Launch a dispatch package
|
|
38
|
+
*/
|
|
39
|
+
postDispatchLaunchRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
40
|
+
/**
|
|
41
|
+
* Launch a dispatch package
|
|
42
|
+
*/
|
|
43
|
+
postDispatchLaunch(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
44
|
+
}
|
|
@@ -0,0 +1,104 @@
|
|
|
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.DispatchApi = void 0;
|
|
26
|
+
const runtime = require("../runtime");
|
|
27
|
+
/**
|
|
28
|
+
*
|
|
29
|
+
*/
|
|
30
|
+
class DispatchApi extends runtime.BaseAPI {
|
|
31
|
+
/**
|
|
32
|
+
* Creates request options for getDispatchRollup without sending the request
|
|
33
|
+
*/
|
|
34
|
+
getDispatchRollupRequestOpts(requestParameters) {
|
|
35
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
36
|
+
if (requestParameters['dispatchPackageId'] == null) {
|
|
37
|
+
throw new runtime.RequiredError('dispatchPackageId', 'Required parameter "dispatchPackageId" was null or undefined when calling getDispatchRollup().');
|
|
38
|
+
}
|
|
39
|
+
const queryParameters = {};
|
|
40
|
+
const headerParameters = {};
|
|
41
|
+
let urlPath = `/dispatch/sessions/{dispatchPackageId}/rollup`;
|
|
42
|
+
urlPath = urlPath.replace('{dispatchPackageId}', encodeURIComponent(String(requestParameters['dispatchPackageId'])));
|
|
43
|
+
return {
|
|
44
|
+
path: urlPath,
|
|
45
|
+
method: 'GET',
|
|
46
|
+
headers: headerParameters,
|
|
47
|
+
query: queryParameters,
|
|
48
|
+
};
|
|
49
|
+
});
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
52
|
+
* Get dispatch package rollup data
|
|
53
|
+
*/
|
|
54
|
+
getDispatchRollupRaw(requestParameters, initOverrides) {
|
|
55
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
56
|
+
const requestOptions = yield this.getDispatchRollupRequestOpts(requestParameters);
|
|
57
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
58
|
+
return new runtime.VoidApiResponse(response);
|
|
59
|
+
});
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* Get dispatch package rollup data
|
|
63
|
+
*/
|
|
64
|
+
getDispatchRollup(requestParameters, initOverrides) {
|
|
65
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
66
|
+
yield this.getDispatchRollupRaw(requestParameters, initOverrides);
|
|
67
|
+
});
|
|
68
|
+
}
|
|
69
|
+
/**
|
|
70
|
+
* Creates request options for postDispatchLaunch without sending the request
|
|
71
|
+
*/
|
|
72
|
+
postDispatchLaunchRequestOpts() {
|
|
73
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
74
|
+
const queryParameters = {};
|
|
75
|
+
const headerParameters = {};
|
|
76
|
+
let urlPath = `/dispatch/launch`;
|
|
77
|
+
return {
|
|
78
|
+
path: urlPath,
|
|
79
|
+
method: 'POST',
|
|
80
|
+
headers: headerParameters,
|
|
81
|
+
query: queryParameters,
|
|
82
|
+
};
|
|
83
|
+
});
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* Launch a dispatch package
|
|
87
|
+
*/
|
|
88
|
+
postDispatchLaunchRaw(initOverrides) {
|
|
89
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
90
|
+
const requestOptions = yield this.postDispatchLaunchRequestOpts();
|
|
91
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
92
|
+
return new runtime.VoidApiResponse(response);
|
|
93
|
+
});
|
|
94
|
+
}
|
|
95
|
+
/**
|
|
96
|
+
* Launch a dispatch package
|
|
97
|
+
*/
|
|
98
|
+
postDispatchLaunch(initOverrides) {
|
|
99
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
100
|
+
yield this.postDispatchLaunchRaw(initOverrides);
|
|
101
|
+
});
|
|
102
|
+
}
|
|
103
|
+
}
|
|
104
|
+
exports.DispatchApi = DispatchApi;
|
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
|
*/
|