@easyedu/js-lsm-api 1.40.0 → 1.42.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 +22 -0
- package/README.md +23 -2
- package/dist/apis/PortalApi.d.ts +32 -1
- package/dist/apis/PortalApi.js +99 -0
- package/dist/apis/SupportTicketApi.d.ts +191 -0
- package/dist/apis/SupportTicketApi.js +457 -0
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/esm/apis/PortalApi.d.ts +32 -1
- package/dist/esm/apis/PortalApi.js +100 -1
- package/dist/esm/apis/SupportTicketApi.d.ts +191 -0
- package/dist/esm/apis/SupportTicketApi.js +453 -0
- package/dist/esm/apis/index.d.ts +1 -0
- package/dist/esm/apis/index.js +1 -0
- package/dist/esm/models/DownloadSupportTicketAttachment200Response.d.ts +32 -0
- package/dist/esm/models/DownloadSupportTicketAttachment200Response.js +43 -0
- package/dist/esm/models/GetPortal.d.ts +1 -1
- package/dist/esm/models/GetPortal.js +1 -3
- package/dist/esm/models/GetPortalLogoUpload.d.ts +32 -0
- package/dist/esm/models/GetPortalLogoUpload.js +43 -0
- package/dist/esm/models/GetSupportTicket.d.ts +142 -0
- package/dist/esm/models/GetSupportTicket.js +120 -0
- package/dist/esm/models/GetSupportTicketAttachment.d.ts +62 -0
- package/dist/esm/models/GetSupportTicketAttachment.js +63 -0
- package/dist/esm/models/GetSupportTicketComment.d.ts +57 -0
- package/dist/esm/models/GetSupportTicketComment.js +60 -0
- package/dist/esm/models/GetSupportTicketList.d.ts +57 -0
- package/dist/esm/models/GetSupportTicketList.js +60 -0
- package/dist/esm/models/PostSupportTicket.d.ts +71 -0
- package/dist/esm/models/PostSupportTicket.js +74 -0
- package/dist/esm/models/PostSupportTicketComment.d.ts +38 -0
- package/dist/esm/models/PostSupportTicketComment.js +45 -0
- package/dist/esm/models/PutSupportTicket.d.ts +63 -0
- package/dist/esm/models/PutSupportTicket.js +62 -0
- package/dist/esm/models/SupportTicketUser.d.ts +50 -0
- package/dist/esm/models/SupportTicketUser.js +55 -0
- package/dist/esm/models/index.d.ts +10 -0
- package/dist/esm/models/index.js +10 -0
- package/dist/models/DownloadSupportTicketAttachment200Response.d.ts +32 -0
- package/dist/models/DownloadSupportTicketAttachment200Response.js +50 -0
- package/dist/models/GetPortal.d.ts +1 -1
- package/dist/models/GetPortal.js +1 -3
- package/dist/models/GetPortalLogoUpload.d.ts +32 -0
- package/dist/models/GetPortalLogoUpload.js +50 -0
- package/dist/models/GetSupportTicket.d.ts +142 -0
- package/dist/models/GetSupportTicket.js +128 -0
- package/dist/models/GetSupportTicketAttachment.d.ts +62 -0
- package/dist/models/GetSupportTicketAttachment.js +70 -0
- package/dist/models/GetSupportTicketComment.d.ts +57 -0
- package/dist/models/GetSupportTicketComment.js +67 -0
- package/dist/models/GetSupportTicketList.d.ts +57 -0
- package/dist/models/GetSupportTicketList.js +67 -0
- package/dist/models/PostSupportTicket.d.ts +71 -0
- package/dist/models/PostSupportTicket.js +82 -0
- package/dist/models/PostSupportTicketComment.d.ts +38 -0
- package/dist/models/PostSupportTicketComment.js +52 -0
- package/dist/models/PutSupportTicket.d.ts +63 -0
- package/dist/models/PutSupportTicket.js +70 -0
- package/dist/models/SupportTicketUser.d.ts +50 -0
- package/dist/models/SupportTicketUser.js +62 -0
- package/dist/models/index.d.ts +10 -0
- package/dist/models/index.js +10 -0
- package/docs/DownloadSupportTicketAttachment200Response.md +34 -0
- package/docs/GetPortalLogoUpload.md +34 -0
- package/docs/GetSupportTicket.md +60 -0
- package/docs/GetSupportTicketAttachment.md +44 -0
- package/docs/GetSupportTicketComment.md +42 -0
- package/docs/GetSupportTicketList.md +42 -0
- package/docs/PortalApi.md +138 -0
- package/docs/PostSupportTicket.md +40 -0
- package/docs/PostSupportTicketComment.md +36 -0
- package/docs/PutSupportTicket.md +38 -0
- package/docs/SupportTicketApi.md +651 -0
- package/docs/SupportTicketUser.md +40 -0
- package/package.json +1 -1
- package/src/apis/PortalApi.ts +129 -0
- package/src/apis/SupportTicketApi.ts +599 -0
- package/src/apis/index.ts +1 -0
- package/src/models/DownloadSupportTicketAttachment200Response.ts +66 -0
- package/src/models/GetPortal.ts +2 -3
- package/src/models/GetPortalLogoUpload.ts +66 -0
- package/src/models/GetSupportTicket.ts +231 -0
- package/src/models/GetSupportTicketAttachment.ts +111 -0
- package/src/models/GetSupportTicketComment.ts +110 -0
- package/src/models/GetSupportTicketList.ts +110 -0
- package/src/models/PostSupportTicket.ts +118 -0
- package/src/models/PostSupportTicketComment.ts +74 -0
- package/src/models/PutSupportTicket.ts +104 -0
- package/src/models/SupportTicketUser.ts +93 -0
- package/src/models/index.ts +10 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -8,6 +8,7 @@ docs/CourseApi.md
|
|
|
8
8
|
docs/CriteriaBasedSelection.md
|
|
9
9
|
docs/CriteriaBasedSelectionCriteria.md
|
|
10
10
|
docs/CriteriaBasedSelectionDistribution.md
|
|
11
|
+
docs/DownloadSupportTicketAttachment200Response.md
|
|
11
12
|
docs/Essay.md
|
|
12
13
|
docs/Essay1.md
|
|
13
14
|
docs/FillInBlank.md
|
|
@@ -68,6 +69,7 @@ docs/GetPortalBasicReporting.md
|
|
|
68
69
|
docs/GetPortalBasicReportingCertificates.md
|
|
69
70
|
docs/GetPortalBasicReportingPortalInfo.md
|
|
70
71
|
docs/GetPortalList.md
|
|
72
|
+
docs/GetPortalLogoUpload.md
|
|
71
73
|
docs/GetPortalStudentReporting.md
|
|
72
74
|
docs/GetPortalStudentReportingCertificates.md
|
|
73
75
|
docs/GetPortalStudentReportingPortalInfo.md
|
|
@@ -129,6 +131,10 @@ docs/GetScormPackage.md
|
|
|
129
131
|
docs/GetScormPackagePackageInfo.md
|
|
130
132
|
docs/GetScormSessionData.md
|
|
131
133
|
docs/GetScormSessionDataActivity.md
|
|
134
|
+
docs/GetSupportTicket.md
|
|
135
|
+
docs/GetSupportTicketAttachment.md
|
|
136
|
+
docs/GetSupportTicketComment.md
|
|
137
|
+
docs/GetSupportTicketList.md
|
|
132
138
|
docs/GetUser.md
|
|
133
139
|
docs/GetUserQuizAttempts.md
|
|
134
140
|
docs/GetUserQuizAttemptsAllOfAttempts.md
|
|
@@ -189,6 +195,8 @@ docs/PostQuizSettings.md
|
|
|
189
195
|
docs/PostResetPassword.md
|
|
190
196
|
docs/PostRole.md
|
|
191
197
|
docs/PostSendResetPassword.md
|
|
198
|
+
docs/PostSupportTicket.md
|
|
199
|
+
docs/PostSupportTicketComment.md
|
|
192
200
|
docs/PostVerifyManifest.md
|
|
193
201
|
docs/PostVerifyManifestItemsInner.md
|
|
194
202
|
docs/PostVerifyManifestResourcesInner.md
|
|
@@ -207,6 +215,7 @@ docs/PutQuizAnswerGrade.md
|
|
|
207
215
|
docs/PutQuizSettings.md
|
|
208
216
|
docs/PutRole.md
|
|
209
217
|
docs/PutRolePermissions.md
|
|
218
|
+
docs/PutSupportTicket.md
|
|
210
219
|
docs/PutUser.md
|
|
211
220
|
docs/QuestionApi.md
|
|
212
221
|
docs/QuizApi.md
|
|
@@ -228,6 +237,8 @@ docs/ScormSetValueResponse.md
|
|
|
228
237
|
docs/ShortAnswer.md
|
|
229
238
|
docs/ShortAnswer1.md
|
|
230
239
|
docs/SingleAnswer.md
|
|
240
|
+
docs/SupportTicketApi.md
|
|
241
|
+
docs/SupportTicketUser.md
|
|
231
242
|
docs/UserApi.md
|
|
232
243
|
package.json
|
|
233
244
|
src/apis/ChatApi.ts
|
|
@@ -240,12 +251,14 @@ src/apis/QuestionApi.ts
|
|
|
240
251
|
src/apis/QuizApi.ts
|
|
241
252
|
src/apis/ReportingApi.ts
|
|
242
253
|
src/apis/RoleApi.ts
|
|
254
|
+
src/apis/SupportTicketApi.ts
|
|
243
255
|
src/apis/UserApi.ts
|
|
244
256
|
src/apis/index.ts
|
|
245
257
|
src/index.ts
|
|
246
258
|
src/models/CriteriaBasedSelection.ts
|
|
247
259
|
src/models/CriteriaBasedSelectionCriteria.ts
|
|
248
260
|
src/models/CriteriaBasedSelectionDistribution.ts
|
|
261
|
+
src/models/DownloadSupportTicketAttachment200Response.ts
|
|
249
262
|
src/models/Essay.ts
|
|
250
263
|
src/models/Essay1.ts
|
|
251
264
|
src/models/FillInBlank.ts
|
|
@@ -306,6 +319,7 @@ src/models/GetPortalBasicReporting.ts
|
|
|
306
319
|
src/models/GetPortalBasicReportingCertificates.ts
|
|
307
320
|
src/models/GetPortalBasicReportingPortalInfo.ts
|
|
308
321
|
src/models/GetPortalList.ts
|
|
322
|
+
src/models/GetPortalLogoUpload.ts
|
|
309
323
|
src/models/GetPortalStudentReporting.ts
|
|
310
324
|
src/models/GetPortalStudentReportingCertificates.ts
|
|
311
325
|
src/models/GetPortalStudentReportingPortalInfo.ts
|
|
@@ -367,6 +381,10 @@ src/models/GetScormPackage.ts
|
|
|
367
381
|
src/models/GetScormPackagePackageInfo.ts
|
|
368
382
|
src/models/GetScormSessionData.ts
|
|
369
383
|
src/models/GetScormSessionDataActivity.ts
|
|
384
|
+
src/models/GetSupportTicket.ts
|
|
385
|
+
src/models/GetSupportTicketAttachment.ts
|
|
386
|
+
src/models/GetSupportTicketComment.ts
|
|
387
|
+
src/models/GetSupportTicketList.ts
|
|
370
388
|
src/models/GetUser.ts
|
|
371
389
|
src/models/GetUserQuizAttempts.ts
|
|
372
390
|
src/models/GetUserQuizAttemptsAllOfAttempts.ts
|
|
@@ -424,6 +442,8 @@ src/models/PostQuizSettings.ts
|
|
|
424
442
|
src/models/PostResetPassword.ts
|
|
425
443
|
src/models/PostRole.ts
|
|
426
444
|
src/models/PostSendResetPassword.ts
|
|
445
|
+
src/models/PostSupportTicket.ts
|
|
446
|
+
src/models/PostSupportTicketComment.ts
|
|
427
447
|
src/models/PostVerifyManifest.ts
|
|
428
448
|
src/models/PostVerifyManifestItemsInner.ts
|
|
429
449
|
src/models/PostVerifyManifestResourcesInner.ts
|
|
@@ -442,6 +462,7 @@ src/models/PutQuizAnswerGrade.ts
|
|
|
442
462
|
src/models/PutQuizSettings.ts
|
|
443
463
|
src/models/PutRole.ts
|
|
444
464
|
src/models/PutRolePermissions.ts
|
|
465
|
+
src/models/PutSupportTicket.ts
|
|
445
466
|
src/models/PutUser.ts
|
|
446
467
|
src/models/QuizContent.ts
|
|
447
468
|
src/models/QuizContentAssignment.ts
|
|
@@ -459,6 +480,7 @@ src/models/ScormSetValueResponse.ts
|
|
|
459
480
|
src/models/ShortAnswer.ts
|
|
460
481
|
src/models/ShortAnswer1.ts
|
|
461
482
|
src/models/SingleAnswer.ts
|
|
483
|
+
src/models/SupportTicketUser.ts
|
|
462
484
|
src/models/index.ts
|
|
463
485
|
src/runtime.ts
|
|
464
486
|
tsconfig.esm.json
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @easyedu/js-lsm-api@1.
|
|
1
|
+
# @easyedu/js-lsm-api@1.42.0
|
|
2
2
|
|
|
3
3
|
A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
|
|
4
4
|
|
|
@@ -94,11 +94,13 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
94
94
|
*ModuleApi* | [**postModule**](docs/ModuleApi.md#postmodule) | **POST** /courses/{courseId}/modules | Post a new module
|
|
95
95
|
*ModuleApi* | [**putModule**](docs/ModuleApi.md#putmodule) | **PUT** /courses/{courseId}/modules/{moduleId} | Update a module by id
|
|
96
96
|
*OtherApi* | [**getHealth**](docs/OtherApi.md#gethealth) | **GET** /healthcheck | Health check endpoint
|
|
97
|
+
*PortalApi* | [**deletePortalLogo**](docs/PortalApi.md#deleteportallogo) | **DELETE** /portals/{portalId}/branding/logo | Remove the portal logo
|
|
97
98
|
*PortalApi* | [**getPortalById**](docs/PortalApi.md#getportalbyid) | **GET** /portals/{portalId} | Get a portal by id (can use \'current\' to get the current users selected portal)
|
|
98
99
|
*PortalApi* | [**getPortalList**](docs/PortalApi.md#getportallist) | **GET** /portals | Get all portals a user has access to
|
|
99
100
|
*PortalApi* | [**getPortalUsers**](docs/PortalApi.md#getportalusers) | **GET** /portals/{portalId}/users | Get all users for a portal with optional role filtering
|
|
100
101
|
*PortalApi* | [**inviteUserToPortal**](docs/PortalApi.md#inviteusertoportal) | **POST** /portals/{portalId}/invite | Invite a new user to a portal
|
|
101
102
|
*PortalApi* | [**postPortal**](docs/PortalApi.md#postportal) | **POST** /portals | Create a new portal as a child of the current selected portal
|
|
103
|
+
*PortalApi* | [**postPortalLogoUpload**](docs/PortalApi.md#postportallogoupload) | **POST** /portals/{portalId}/branding/logo | Upload a logo image for portal branding
|
|
102
104
|
*PortalApi* | [**putPortalBranding**](docs/PortalApi.md#putportalbranding) | **PUT** /portals/{portalId} | Update portal branding (name, background color, text color)
|
|
103
105
|
*PortalApi* | [**updateSelectedPortal**](docs/PortalApi.md#updateselectedportal) | **PUT** /portals/{portalId}/selected | Update the users current selected portal. Returns new JWT with updated roles.
|
|
104
106
|
*QuestionApi* | [**deleteQuestion**](docs/QuestionApi.md#deletequestion) | **DELETE** /questions/{questionId} | Delete a question by ID
|
|
@@ -151,6 +153,15 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
151
153
|
*RoleApi* | [**unassignUserRole**](docs/RoleApi.md#unassignuserrole) | **DELETE** /roles/users/{userId}/portals/{portalId}/roles/{roleId} | Remove a role from a user for a portal
|
|
152
154
|
*RoleApi* | [**updateRole**](docs/RoleApi.md#updaterole) | **PUT** /roles/{roleId} | Update a custom role name and description
|
|
153
155
|
*RoleApi* | [**updateRolePermissions**](docs/RoleApi.md#updaterolepermissions) | **PUT** /roles/{roleId}/permissions | Replace all permissions for a custom role
|
|
156
|
+
*SupportTicketApi* | [**closeSupportTicket**](docs/SupportTicketApi.md#closesupportticket) | **POST** /support/tickets/{ticketId}/close | Close a support ticket
|
|
157
|
+
*SupportTicketApi* | [**downloadSupportTicketAttachment**](docs/SupportTicketApi.md#downloadsupportticketattachment) | **GET** /support/tickets/{ticketId}/attachments/{attachmentId}/download | Download a ticket attachment
|
|
158
|
+
*SupportTicketApi* | [**getSupportTicket**](docs/SupportTicketApi.md#getsupportticket) | **GET** /support/tickets/{ticketId} | Get support ticket details
|
|
159
|
+
*SupportTicketApi* | [**getSupportTicketComments**](docs/SupportTicketApi.md#getsupportticketcomments) | **GET** /support/tickets/{ticketId}/comments | Get comments for a ticket
|
|
160
|
+
*SupportTicketApi* | [**getSupportTickets**](docs/SupportTicketApi.md#getsupporttickets) | **GET** /support/tickets | List support tickets
|
|
161
|
+
*SupportTicketApi* | [**postSupportTicket**](docs/SupportTicketApi.md#postsupportticket) | **POST** /support/tickets | Create a support ticket
|
|
162
|
+
*SupportTicketApi* | [**postSupportTicketAttachment**](docs/SupportTicketApi.md#postsupportticketattachment) | **POST** /support/tickets/{ticketId}/attachments | Upload an attachment to a ticket
|
|
163
|
+
*SupportTicketApi* | [**postSupportTicketComment**](docs/SupportTicketApi.md#postsupportticketcomment) | **POST** /support/tickets/{ticketId}/comments | Add a comment to a ticket
|
|
164
|
+
*SupportTicketApi* | [**putSupportTicket**](docs/SupportTicketApi.md#putsupportticket) | **PUT** /support/tickets/{ticketId} | Update a support ticket
|
|
154
165
|
*UserApi* | [**getAuthCheck**](docs/UserApi.md#getauthcheck) | **GET** /auth/check | Check if a user is logged in
|
|
155
166
|
*UserApi* | [**getCurrentUserPermissions**](docs/UserApi.md#getcurrentuserpermissions) | **GET** /users/current/permissions | Get the current user\'s permissions
|
|
156
167
|
*UserApi* | [**getUser**](docs/UserApi.md#getuser) | **GET** /users/{userId} | Get a user by id
|
|
@@ -166,6 +177,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
166
177
|
- [CriteriaBasedSelection](docs/CriteriaBasedSelection.md)
|
|
167
178
|
- [CriteriaBasedSelectionCriteria](docs/CriteriaBasedSelectionCriteria.md)
|
|
168
179
|
- [CriteriaBasedSelectionDistribution](docs/CriteriaBasedSelectionDistribution.md)
|
|
180
|
+
- [DownloadSupportTicketAttachment200Response](docs/DownloadSupportTicketAttachment200Response.md)
|
|
169
181
|
- [Essay](docs/Essay.md)
|
|
170
182
|
- [Essay1](docs/Essay1.md)
|
|
171
183
|
- [FillInBlank](docs/FillInBlank.md)
|
|
@@ -226,6 +238,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
226
238
|
- [GetPortalBasicReportingCertificates](docs/GetPortalBasicReportingCertificates.md)
|
|
227
239
|
- [GetPortalBasicReportingPortalInfo](docs/GetPortalBasicReportingPortalInfo.md)
|
|
228
240
|
- [GetPortalList](docs/GetPortalList.md)
|
|
241
|
+
- [GetPortalLogoUpload](docs/GetPortalLogoUpload.md)
|
|
229
242
|
- [GetPortalStudentReporting](docs/GetPortalStudentReporting.md)
|
|
230
243
|
- [GetPortalStudentReportingCertificates](docs/GetPortalStudentReportingCertificates.md)
|
|
231
244
|
- [GetPortalStudentReportingPortalInfo](docs/GetPortalStudentReportingPortalInfo.md)
|
|
@@ -287,6 +300,10 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
287
300
|
- [GetScormPackagePackageInfo](docs/GetScormPackagePackageInfo.md)
|
|
288
301
|
- [GetScormSessionData](docs/GetScormSessionData.md)
|
|
289
302
|
- [GetScormSessionDataActivity](docs/GetScormSessionDataActivity.md)
|
|
303
|
+
- [GetSupportTicket](docs/GetSupportTicket.md)
|
|
304
|
+
- [GetSupportTicketAttachment](docs/GetSupportTicketAttachment.md)
|
|
305
|
+
- [GetSupportTicketComment](docs/GetSupportTicketComment.md)
|
|
306
|
+
- [GetSupportTicketList](docs/GetSupportTicketList.md)
|
|
290
307
|
- [GetUser](docs/GetUser.md)
|
|
291
308
|
- [GetUserQuizAttempts](docs/GetUserQuizAttempts.md)
|
|
292
309
|
- [GetUserQuizAttemptsAllOfAttempts](docs/GetUserQuizAttemptsAllOfAttempts.md)
|
|
@@ -344,6 +361,8 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
344
361
|
- [PostResetPassword](docs/PostResetPassword.md)
|
|
345
362
|
- [PostRole](docs/PostRole.md)
|
|
346
363
|
- [PostSendResetPassword](docs/PostSendResetPassword.md)
|
|
364
|
+
- [PostSupportTicket](docs/PostSupportTicket.md)
|
|
365
|
+
- [PostSupportTicketComment](docs/PostSupportTicketComment.md)
|
|
347
366
|
- [PostVerifyManifest](docs/PostVerifyManifest.md)
|
|
348
367
|
- [PostVerifyManifestItemsInner](docs/PostVerifyManifestItemsInner.md)
|
|
349
368
|
- [PostVerifyManifestResourcesInner](docs/PostVerifyManifestResourcesInner.md)
|
|
@@ -362,6 +381,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
362
381
|
- [PutQuizSettings](docs/PutQuizSettings.md)
|
|
363
382
|
- [PutRole](docs/PutRole.md)
|
|
364
383
|
- [PutRolePermissions](docs/PutRolePermissions.md)
|
|
384
|
+
- [PutSupportTicket](docs/PutSupportTicket.md)
|
|
365
385
|
- [PutUser](docs/PutUser.md)
|
|
366
386
|
- [QuizContent](docs/QuizContent.md)
|
|
367
387
|
- [QuizContentAssignment](docs/QuizContentAssignment.md)
|
|
@@ -379,6 +399,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
379
399
|
- [ShortAnswer](docs/ShortAnswer.md)
|
|
380
400
|
- [ShortAnswer1](docs/ShortAnswer1.md)
|
|
381
401
|
- [SingleAnswer](docs/SingleAnswer.md)
|
|
402
|
+
- [SupportTicketUser](docs/SupportTicketUser.md)
|
|
382
403
|
|
|
383
404
|
### Authorization
|
|
384
405
|
|
|
@@ -392,7 +413,7 @@ and is automatically generated by the
|
|
|
392
413
|
[OpenAPI Generator](https://openapi-generator.tech) project:
|
|
393
414
|
|
|
394
415
|
- API version: `1.0.0`
|
|
395
|
-
- Package version: `1.
|
|
416
|
+
- Package version: `1.42.0`
|
|
396
417
|
- Generator version: `7.21.0`
|
|
397
418
|
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
|
|
398
419
|
|
package/dist/apis/PortalApi.d.ts
CHANGED
|
@@ -10,7 +10,10 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import type { GetPortal, GetPortalList, GetPortalUserList, PostPortal, PostPortalInvite, PutPortalBranding } from '../models/index';
|
|
13
|
+
import type { GetPortal, GetPortalList, GetPortalLogoUpload, GetPortalUserList, PostPortal, PostPortalInvite, PutPortalBranding } from '../models/index';
|
|
14
|
+
export interface DeletePortalLogoRequest {
|
|
15
|
+
portalId: string;
|
|
16
|
+
}
|
|
14
17
|
export interface GetPortalByIdRequest {
|
|
15
18
|
portalId: string;
|
|
16
19
|
}
|
|
@@ -29,6 +32,10 @@ export interface InviteUserToPortalRequest {
|
|
|
29
32
|
export interface PostPortalRequest {
|
|
30
33
|
postPortal: PostPortal;
|
|
31
34
|
}
|
|
35
|
+
export interface PostPortalLogoUploadRequest {
|
|
36
|
+
portalId: string;
|
|
37
|
+
file: Blob;
|
|
38
|
+
}
|
|
32
39
|
export interface PutPortalBrandingRequest {
|
|
33
40
|
portalId: string;
|
|
34
41
|
putPortalBranding: PutPortalBranding;
|
|
@@ -40,6 +47,18 @@ export interface UpdateSelectedPortalRequest {
|
|
|
40
47
|
*
|
|
41
48
|
*/
|
|
42
49
|
export declare class PortalApi extends runtime.BaseAPI {
|
|
50
|
+
/**
|
|
51
|
+
* Creates request options for deletePortalLogo without sending the request
|
|
52
|
+
*/
|
|
53
|
+
deletePortalLogoRequestOpts(requestParameters: DeletePortalLogoRequest): Promise<runtime.RequestOpts>;
|
|
54
|
+
/**
|
|
55
|
+
* Remove the portal logo
|
|
56
|
+
*/
|
|
57
|
+
deletePortalLogoRaw(requestParameters: DeletePortalLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
58
|
+
/**
|
|
59
|
+
* Remove the portal logo
|
|
60
|
+
*/
|
|
61
|
+
deletePortalLogo(requestParameters: DeletePortalLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
43
62
|
/**
|
|
44
63
|
* Creates request options for getPortalById without sending the request
|
|
45
64
|
*/
|
|
@@ -100,6 +119,18 @@ export declare class PortalApi extends runtime.BaseAPI {
|
|
|
100
119
|
* Create a new portal as a child of the current selected portal
|
|
101
120
|
*/
|
|
102
121
|
postPortal(requestParameters: PostPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortal>;
|
|
122
|
+
/**
|
|
123
|
+
* Creates request options for postPortalLogoUpload without sending the request
|
|
124
|
+
*/
|
|
125
|
+
postPortalLogoUploadRequestOpts(requestParameters: PostPortalLogoUploadRequest): Promise<runtime.RequestOpts>;
|
|
126
|
+
/**
|
|
127
|
+
* Upload a logo image for portal branding
|
|
128
|
+
*/
|
|
129
|
+
postPortalLogoUploadRaw(requestParameters: PostPortalLogoUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortalLogoUpload>>;
|
|
130
|
+
/**
|
|
131
|
+
* Upload a logo image for portal branding
|
|
132
|
+
*/
|
|
133
|
+
postPortalLogoUpload(requestParameters: PostPortalLogoUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalLogoUpload>;
|
|
103
134
|
/**
|
|
104
135
|
* Creates request options for putPortalBranding without sending the request
|
|
105
136
|
*/
|
package/dist/apis/PortalApi.js
CHANGED
|
@@ -29,6 +29,44 @@ const index_1 = require("../models/index");
|
|
|
29
29
|
*
|
|
30
30
|
*/
|
|
31
31
|
class PortalApi extends runtime.BaseAPI {
|
|
32
|
+
/**
|
|
33
|
+
* Creates request options for deletePortalLogo without sending the request
|
|
34
|
+
*/
|
|
35
|
+
deletePortalLogoRequestOpts(requestParameters) {
|
|
36
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
37
|
+
if (requestParameters['portalId'] == null) {
|
|
38
|
+
throw new runtime.RequiredError('portalId', 'Required parameter "portalId" was null or undefined when calling deletePortalLogo().');
|
|
39
|
+
}
|
|
40
|
+
const queryParameters = {};
|
|
41
|
+
const headerParameters = {};
|
|
42
|
+
let urlPath = `/portals/{portalId}/branding/logo`;
|
|
43
|
+
urlPath = urlPath.replace(`{${"portalId"}}`, encodeURIComponent(String(requestParameters['portalId'])));
|
|
44
|
+
return {
|
|
45
|
+
path: urlPath,
|
|
46
|
+
method: 'DELETE',
|
|
47
|
+
headers: headerParameters,
|
|
48
|
+
query: queryParameters,
|
|
49
|
+
};
|
|
50
|
+
});
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
* Remove the portal logo
|
|
54
|
+
*/
|
|
55
|
+
deletePortalLogoRaw(requestParameters, initOverrides) {
|
|
56
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
57
|
+
const requestOptions = yield this.deletePortalLogoRequestOpts(requestParameters);
|
|
58
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
59
|
+
return new runtime.VoidApiResponse(response);
|
|
60
|
+
});
|
|
61
|
+
}
|
|
62
|
+
/**
|
|
63
|
+
* Remove the portal logo
|
|
64
|
+
*/
|
|
65
|
+
deletePortalLogo(requestParameters, initOverrides) {
|
|
66
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
67
|
+
yield this.deletePortalLogoRaw(requestParameters, initOverrides);
|
|
68
|
+
});
|
|
69
|
+
}
|
|
32
70
|
/**
|
|
33
71
|
* Creates request options for getPortalById without sending the request
|
|
34
72
|
*/
|
|
@@ -240,6 +278,67 @@ class PortalApi extends runtime.BaseAPI {
|
|
|
240
278
|
return yield response.value();
|
|
241
279
|
});
|
|
242
280
|
}
|
|
281
|
+
/**
|
|
282
|
+
* Creates request options for postPortalLogoUpload without sending the request
|
|
283
|
+
*/
|
|
284
|
+
postPortalLogoUploadRequestOpts(requestParameters) {
|
|
285
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
286
|
+
if (requestParameters['portalId'] == null) {
|
|
287
|
+
throw new runtime.RequiredError('portalId', 'Required parameter "portalId" was null or undefined when calling postPortalLogoUpload().');
|
|
288
|
+
}
|
|
289
|
+
if (requestParameters['file'] == null) {
|
|
290
|
+
throw new runtime.RequiredError('file', 'Required parameter "file" was null or undefined when calling postPortalLogoUpload().');
|
|
291
|
+
}
|
|
292
|
+
const queryParameters = {};
|
|
293
|
+
const headerParameters = {};
|
|
294
|
+
const consumes = [
|
|
295
|
+
{ contentType: 'multipart/form-data' },
|
|
296
|
+
];
|
|
297
|
+
// @ts-ignore: canConsumeForm may be unused
|
|
298
|
+
const canConsumeForm = runtime.canConsumeForm(consumes);
|
|
299
|
+
let formParams;
|
|
300
|
+
let useForm = false;
|
|
301
|
+
// use FormData to transmit files using content-type "multipart/form-data"
|
|
302
|
+
useForm = canConsumeForm;
|
|
303
|
+
if (useForm) {
|
|
304
|
+
formParams = new FormData();
|
|
305
|
+
}
|
|
306
|
+
else {
|
|
307
|
+
formParams = new URLSearchParams();
|
|
308
|
+
}
|
|
309
|
+
if (requestParameters['file'] != null) {
|
|
310
|
+
formParams.append('file', requestParameters['file']);
|
|
311
|
+
}
|
|
312
|
+
let urlPath = `/portals/{portalId}/branding/logo`;
|
|
313
|
+
urlPath = urlPath.replace(`{${"portalId"}}`, encodeURIComponent(String(requestParameters['portalId'])));
|
|
314
|
+
return {
|
|
315
|
+
path: urlPath,
|
|
316
|
+
method: 'POST',
|
|
317
|
+
headers: headerParameters,
|
|
318
|
+
query: queryParameters,
|
|
319
|
+
body: formParams,
|
|
320
|
+
};
|
|
321
|
+
});
|
|
322
|
+
}
|
|
323
|
+
/**
|
|
324
|
+
* Upload a logo image for portal branding
|
|
325
|
+
*/
|
|
326
|
+
postPortalLogoUploadRaw(requestParameters, initOverrides) {
|
|
327
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
328
|
+
const requestOptions = yield this.postPortalLogoUploadRequestOpts(requestParameters);
|
|
329
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
330
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetPortalLogoUploadFromJSON)(jsonValue));
|
|
331
|
+
});
|
|
332
|
+
}
|
|
333
|
+
/**
|
|
334
|
+
* Upload a logo image for portal branding
|
|
335
|
+
*/
|
|
336
|
+
postPortalLogoUpload(requestParameters, initOverrides) {
|
|
337
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
338
|
+
const response = yield this.postPortalLogoUploadRaw(requestParameters, initOverrides);
|
|
339
|
+
return yield response.value();
|
|
340
|
+
});
|
|
341
|
+
}
|
|
243
342
|
/**
|
|
244
343
|
* Creates request options for putPortalBranding without sending the request
|
|
245
344
|
*/
|
|
@@ -0,0 +1,191 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* LMS API
|
|
3
|
+
* LMS API
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import * as runtime from '../runtime';
|
|
13
|
+
import type { DownloadSupportTicketAttachment200Response, GetSupportTicket, GetSupportTicketAttachment, GetSupportTicketComment, GetSupportTicketList, PostSupportTicket, PostSupportTicketComment, PutSupportTicket } from '../models/index';
|
|
14
|
+
export interface CloseSupportTicketRequest {
|
|
15
|
+
ticketId: string;
|
|
16
|
+
}
|
|
17
|
+
export interface DownloadSupportTicketAttachmentRequest {
|
|
18
|
+
ticketId: string;
|
|
19
|
+
attachmentId: string;
|
|
20
|
+
}
|
|
21
|
+
export interface GetSupportTicketRequest {
|
|
22
|
+
ticketId: string;
|
|
23
|
+
}
|
|
24
|
+
export interface GetSupportTicketCommentsRequest {
|
|
25
|
+
ticketId: string;
|
|
26
|
+
}
|
|
27
|
+
export interface GetSupportTicketsRequest {
|
|
28
|
+
page?: number;
|
|
29
|
+
pageSize?: number;
|
|
30
|
+
status?: GetSupportTicketsStatusEnum;
|
|
31
|
+
priority?: GetSupportTicketsPriorityEnum;
|
|
32
|
+
category?: GetSupportTicketsCategoryEnum;
|
|
33
|
+
}
|
|
34
|
+
export interface PostSupportTicketRequest {
|
|
35
|
+
postSupportTicket: PostSupportTicket;
|
|
36
|
+
}
|
|
37
|
+
export interface PostSupportTicketAttachmentRequest {
|
|
38
|
+
ticketId: string;
|
|
39
|
+
file: Blob;
|
|
40
|
+
}
|
|
41
|
+
export interface PostSupportTicketCommentRequest {
|
|
42
|
+
ticketId: string;
|
|
43
|
+
postSupportTicketComment: PostSupportTicketComment;
|
|
44
|
+
}
|
|
45
|
+
export interface PutSupportTicketRequest {
|
|
46
|
+
ticketId: string;
|
|
47
|
+
putSupportTicket: PutSupportTicket;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
*
|
|
51
|
+
*/
|
|
52
|
+
export declare class SupportTicketApi extends runtime.BaseAPI {
|
|
53
|
+
/**
|
|
54
|
+
* Creates request options for closeSupportTicket without sending the request
|
|
55
|
+
*/
|
|
56
|
+
closeSupportTicketRequestOpts(requestParameters: CloseSupportTicketRequest): Promise<runtime.RequestOpts>;
|
|
57
|
+
/**
|
|
58
|
+
* Close a support ticket
|
|
59
|
+
*/
|
|
60
|
+
closeSupportTicketRaw(requestParameters: CloseSupportTicketRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
61
|
+
/**
|
|
62
|
+
* Close a support ticket
|
|
63
|
+
*/
|
|
64
|
+
closeSupportTicket(requestParameters: CloseSupportTicketRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
65
|
+
/**
|
|
66
|
+
* Creates request options for downloadSupportTicketAttachment without sending the request
|
|
67
|
+
*/
|
|
68
|
+
downloadSupportTicketAttachmentRequestOpts(requestParameters: DownloadSupportTicketAttachmentRequest): Promise<runtime.RequestOpts>;
|
|
69
|
+
/**
|
|
70
|
+
* Download a ticket attachment
|
|
71
|
+
*/
|
|
72
|
+
downloadSupportTicketAttachmentRaw(requestParameters: DownloadSupportTicketAttachmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DownloadSupportTicketAttachment200Response>>;
|
|
73
|
+
/**
|
|
74
|
+
* Download a ticket attachment
|
|
75
|
+
*/
|
|
76
|
+
downloadSupportTicketAttachment(requestParameters: DownloadSupportTicketAttachmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DownloadSupportTicketAttachment200Response>;
|
|
77
|
+
/**
|
|
78
|
+
* Creates request options for getSupportTicket without sending the request
|
|
79
|
+
*/
|
|
80
|
+
getSupportTicketRequestOpts(requestParameters: GetSupportTicketRequest): Promise<runtime.RequestOpts>;
|
|
81
|
+
/**
|
|
82
|
+
* Get support ticket details
|
|
83
|
+
*/
|
|
84
|
+
getSupportTicketRaw(requestParameters: GetSupportTicketRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSupportTicket>>;
|
|
85
|
+
/**
|
|
86
|
+
* Get support ticket details
|
|
87
|
+
*/
|
|
88
|
+
getSupportTicket(requestParameters: GetSupportTicketRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSupportTicket>;
|
|
89
|
+
/**
|
|
90
|
+
* Creates request options for getSupportTicketComments without sending the request
|
|
91
|
+
*/
|
|
92
|
+
getSupportTicketCommentsRequestOpts(requestParameters: GetSupportTicketCommentsRequest): Promise<runtime.RequestOpts>;
|
|
93
|
+
/**
|
|
94
|
+
* Get comments for a ticket
|
|
95
|
+
*/
|
|
96
|
+
getSupportTicketCommentsRaw(requestParameters: GetSupportTicketCommentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetSupportTicketComment>>>;
|
|
97
|
+
/**
|
|
98
|
+
* Get comments for a ticket
|
|
99
|
+
*/
|
|
100
|
+
getSupportTicketComments(requestParameters: GetSupportTicketCommentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetSupportTicketComment>>;
|
|
101
|
+
/**
|
|
102
|
+
* Creates request options for getSupportTickets without sending the request
|
|
103
|
+
*/
|
|
104
|
+
getSupportTicketsRequestOpts(requestParameters: GetSupportTicketsRequest): Promise<runtime.RequestOpts>;
|
|
105
|
+
/**
|
|
106
|
+
* List support tickets
|
|
107
|
+
*/
|
|
108
|
+
getSupportTicketsRaw(requestParameters: GetSupportTicketsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSupportTicketList>>;
|
|
109
|
+
/**
|
|
110
|
+
* List support tickets
|
|
111
|
+
*/
|
|
112
|
+
getSupportTickets(requestParameters?: GetSupportTicketsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSupportTicketList>;
|
|
113
|
+
/**
|
|
114
|
+
* Creates request options for postSupportTicket without sending the request
|
|
115
|
+
*/
|
|
116
|
+
postSupportTicketRequestOpts(requestParameters: PostSupportTicketRequest): Promise<runtime.RequestOpts>;
|
|
117
|
+
/**
|
|
118
|
+
* Create a support ticket
|
|
119
|
+
*/
|
|
120
|
+
postSupportTicketRaw(requestParameters: PostSupportTicketRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSupportTicket>>;
|
|
121
|
+
/**
|
|
122
|
+
* Create a support ticket
|
|
123
|
+
*/
|
|
124
|
+
postSupportTicket(requestParameters: PostSupportTicketRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSupportTicket>;
|
|
125
|
+
/**
|
|
126
|
+
* Creates request options for postSupportTicketAttachment without sending the request
|
|
127
|
+
*/
|
|
128
|
+
postSupportTicketAttachmentRequestOpts(requestParameters: PostSupportTicketAttachmentRequest): Promise<runtime.RequestOpts>;
|
|
129
|
+
/**
|
|
130
|
+
* Upload an attachment to a ticket
|
|
131
|
+
*/
|
|
132
|
+
postSupportTicketAttachmentRaw(requestParameters: PostSupportTicketAttachmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSupportTicketAttachment>>;
|
|
133
|
+
/**
|
|
134
|
+
* Upload an attachment to a ticket
|
|
135
|
+
*/
|
|
136
|
+
postSupportTicketAttachment(requestParameters: PostSupportTicketAttachmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSupportTicketAttachment>;
|
|
137
|
+
/**
|
|
138
|
+
* Creates request options for postSupportTicketComment without sending the request
|
|
139
|
+
*/
|
|
140
|
+
postSupportTicketCommentRequestOpts(requestParameters: PostSupportTicketCommentRequest): Promise<runtime.RequestOpts>;
|
|
141
|
+
/**
|
|
142
|
+
* Add a comment to a ticket
|
|
143
|
+
*/
|
|
144
|
+
postSupportTicketCommentRaw(requestParameters: PostSupportTicketCommentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSupportTicketComment>>;
|
|
145
|
+
/**
|
|
146
|
+
* Add a comment to a ticket
|
|
147
|
+
*/
|
|
148
|
+
postSupportTicketComment(requestParameters: PostSupportTicketCommentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSupportTicketComment>;
|
|
149
|
+
/**
|
|
150
|
+
* Creates request options for putSupportTicket without sending the request
|
|
151
|
+
*/
|
|
152
|
+
putSupportTicketRequestOpts(requestParameters: PutSupportTicketRequest): Promise<runtime.RequestOpts>;
|
|
153
|
+
/**
|
|
154
|
+
* Update a support ticket
|
|
155
|
+
*/
|
|
156
|
+
putSupportTicketRaw(requestParameters: PutSupportTicketRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
157
|
+
/**
|
|
158
|
+
* Update a support ticket
|
|
159
|
+
*/
|
|
160
|
+
putSupportTicket(requestParameters: PutSupportTicketRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
161
|
+
}
|
|
162
|
+
/**
|
|
163
|
+
* @export
|
|
164
|
+
*/
|
|
165
|
+
export declare const GetSupportTicketsStatusEnum: {
|
|
166
|
+
readonly Open: "Open";
|
|
167
|
+
readonly InProgress: "InProgress";
|
|
168
|
+
readonly Closed: "Closed";
|
|
169
|
+
};
|
|
170
|
+
export type GetSupportTicketsStatusEnum = typeof GetSupportTicketsStatusEnum[keyof typeof GetSupportTicketsStatusEnum];
|
|
171
|
+
/**
|
|
172
|
+
* @export
|
|
173
|
+
*/
|
|
174
|
+
export declare const GetSupportTicketsPriorityEnum: {
|
|
175
|
+
readonly Low: "Low";
|
|
176
|
+
readonly Medium: "Medium";
|
|
177
|
+
readonly High: "High";
|
|
178
|
+
readonly Critical: "Critical";
|
|
179
|
+
};
|
|
180
|
+
export type GetSupportTicketsPriorityEnum = typeof GetSupportTicketsPriorityEnum[keyof typeof GetSupportTicketsPriorityEnum];
|
|
181
|
+
/**
|
|
182
|
+
* @export
|
|
183
|
+
*/
|
|
184
|
+
export declare const GetSupportTicketsCategoryEnum: {
|
|
185
|
+
readonly Bug: "Bug";
|
|
186
|
+
readonly FeatureRequest: "FeatureRequest";
|
|
187
|
+
readonly AccountIssue: "AccountIssue";
|
|
188
|
+
readonly ContentIssue: "ContentIssue";
|
|
189
|
+
readonly Other: "Other";
|
|
190
|
+
};
|
|
191
|
+
export type GetSupportTicketsCategoryEnum = typeof GetSupportTicketsCategoryEnum[keyof typeof GetSupportTicketsCategoryEnum];
|