@easyedu/js-lsm-api 1.71.0 → 1.73.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 +10 -2
- package/dist/apis/ContentApi.d.ts +2 -2
- package/dist/apis/ContentApi.js +2 -2
- package/dist/apis/SystemApi.d.ts +97 -0
- package/dist/apis/SystemApi.js +234 -0
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/esm/apis/ContentApi.d.ts +2 -2
- package/dist/esm/apis/ContentApi.js +2 -2
- package/dist/esm/apis/SystemApi.d.ts +97 -0
- package/dist/esm/apis/SystemApi.js +230 -0
- package/dist/esm/apis/index.d.ts +1 -0
- package/dist/esm/apis/index.js +1 -0
- package/dist/esm/models/GetSystemBillingItem.d.ts +80 -0
- package/dist/esm/models/GetSystemBillingItem.js +71 -0
- package/dist/esm/models/GetSystemBillingList.d.ts +57 -0
- package/dist/esm/models/GetSystemBillingList.js +60 -0
- package/dist/esm/models/GetSystemMetrics.d.ts +50 -0
- package/dist/esm/models/GetSystemMetrics.js +55 -0
- package/dist/esm/models/index.d.ts +3 -0
- package/dist/esm/models/index.js +3 -0
- package/dist/models/GetSystemBillingItem.d.ts +80 -0
- package/dist/models/GetSystemBillingItem.js +78 -0
- package/dist/models/GetSystemBillingList.d.ts +57 -0
- package/dist/models/GetSystemBillingList.js +67 -0
- package/dist/models/GetSystemMetrics.d.ts +50 -0
- package/dist/models/GetSystemMetrics.js +62 -0
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +3 -0
- package/docs/ContentApi.md +2 -1
- package/docs/GetSystemBillingItem.md +51 -0
- package/docs/GetSystemBillingList.md +42 -0
- package/docs/GetSystemMetrics.md +41 -0
- package/docs/SystemApi.md +345 -0
- package/package.json +1 -1
- package/src/apis/ContentApi.ts +2 -2
- package/src/apis/SystemApi.ts +283 -0
- package/src/apis/index.ts +1 -0
- package/src/models/GetSystemBillingItem.ts +136 -0
- package/src/models/GetSystemBillingList.ts +110 -0
- package/src/models/GetSystemMetrics.ts +93 -0
- package/src/models/index.ts +3 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -158,6 +158,9 @@ docs/GetSupportTicket.md
|
|
|
158
158
|
docs/GetSupportTicketAttachment.md
|
|
159
159
|
docs/GetSupportTicketComment.md
|
|
160
160
|
docs/GetSupportTicketList.md
|
|
161
|
+
docs/GetSystemBillingItem.md
|
|
162
|
+
docs/GetSystemBillingList.md
|
|
163
|
+
docs/GetSystemMetrics.md
|
|
161
164
|
docs/GetUser.md
|
|
162
165
|
docs/GetUserAvatarUpload.md
|
|
163
166
|
docs/GetUserQuizAttempts.md
|
|
@@ -285,6 +288,7 @@ docs/ShortAnswer1.md
|
|
|
285
288
|
docs/SingleAnswer.md
|
|
286
289
|
docs/SupportTicketApi.md
|
|
287
290
|
docs/SupportTicketUser.md
|
|
291
|
+
docs/SystemApi.md
|
|
288
292
|
docs/UpdateSelectedPortalResponse.md
|
|
289
293
|
docs/UpdateSelectedPortalResponseHostPortal.md
|
|
290
294
|
docs/UpdateSelectedPortalResponseSelectedPortal.md
|
|
@@ -307,6 +311,7 @@ src/apis/QuizApi.ts
|
|
|
307
311
|
src/apis/ReportingApi.ts
|
|
308
312
|
src/apis/RoleApi.ts
|
|
309
313
|
src/apis/SupportTicketApi.ts
|
|
314
|
+
src/apis/SystemApi.ts
|
|
310
315
|
src/apis/UserApi.ts
|
|
311
316
|
src/apis/index.ts
|
|
312
317
|
src/index.ts
|
|
@@ -459,6 +464,9 @@ src/models/GetSupportTicket.ts
|
|
|
459
464
|
src/models/GetSupportTicketAttachment.ts
|
|
460
465
|
src/models/GetSupportTicketComment.ts
|
|
461
466
|
src/models/GetSupportTicketList.ts
|
|
467
|
+
src/models/GetSystemBillingItem.ts
|
|
468
|
+
src/models/GetSystemBillingList.ts
|
|
469
|
+
src/models/GetSystemMetrics.ts
|
|
462
470
|
src/models/GetUser.ts
|
|
463
471
|
src/models/GetUserAvatarUpload.ts
|
|
464
472
|
src/models/GetUserQuizAttempts.ts
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @easyedu/js-lsm-api@1.
|
|
1
|
+
# @easyedu/js-lsm-api@1.73.0
|
|
2
2
|
|
|
3
3
|
A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
|
|
4
4
|
|
|
@@ -231,6 +231,11 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
231
231
|
*SupportTicketApi* | [**postSupportTicketAttachment**](docs/SupportTicketApi.md#postsupportticketattachment) | **POST** /support/tickets/{ticketId}/attachments | Upload an attachment to a ticket
|
|
232
232
|
*SupportTicketApi* | [**postSupportTicketComment**](docs/SupportTicketApi.md#postsupportticketcomment) | **POST** /support/tickets/{ticketId}/comments | Add a comment to a ticket
|
|
233
233
|
*SupportTicketApi* | [**putSupportTicket**](docs/SupportTicketApi.md#putsupportticket) | **PUT** /support/tickets/{ticketId} | Update a support ticket
|
|
234
|
+
*SystemApi* | [**getSystemBilling**](docs/SystemApi.md#getsystembilling) | **GET** /system/billing | List mock platform billing information
|
|
235
|
+
*SystemApi* | [**getSystemMetrics**](docs/SystemApi.md#getsystemmetrics) | **GET** /system/metrics | Get platform-wide metrics
|
|
236
|
+
*SystemApi* | [**getSystemPortal**](docs/SystemApi.md#getsystemportal) | **GET** /system/portals/{portalId} | Get platform portal detail
|
|
237
|
+
*SystemApi* | [**getSystemPortals**](docs/SystemApi.md#getsystemportals) | **GET** /system/portals | List all platform portals
|
|
238
|
+
*SystemApi* | [**getSystemSupportTickets**](docs/SystemApi.md#getsystemsupporttickets) | **GET** /system/support/tickets | List open support tickets across the platform
|
|
234
239
|
*UserApi* | [**deleteUserAvatar**](docs/UserApi.md#deleteuseravatar) | **DELETE** /users/{userId}/avatar | Remove the current user\'s profile photo
|
|
235
240
|
*UserApi* | [**getAuthCheck**](docs/UserApi.md#getauthcheck) | **GET** /auth/check | Check if a user is logged in
|
|
236
241
|
*UserApi* | [**getCurrentUserPermissions**](docs/UserApi.md#getcurrentuserpermissions) | **GET** /users/current/permissions | Get the current user\'s permissions
|
|
@@ -396,6 +401,9 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
396
401
|
- [GetSupportTicketAttachment](docs/GetSupportTicketAttachment.md)
|
|
397
402
|
- [GetSupportTicketComment](docs/GetSupportTicketComment.md)
|
|
398
403
|
- [GetSupportTicketList](docs/GetSupportTicketList.md)
|
|
404
|
+
- [GetSystemBillingItem](docs/GetSystemBillingItem.md)
|
|
405
|
+
- [GetSystemBillingList](docs/GetSystemBillingList.md)
|
|
406
|
+
- [GetSystemMetrics](docs/GetSystemMetrics.md)
|
|
399
407
|
- [GetUser](docs/GetUser.md)
|
|
400
408
|
- [GetUserAvatarUpload](docs/GetUserAvatarUpload.md)
|
|
401
409
|
- [GetUserQuizAttempts](docs/GetUserQuizAttempts.md)
|
|
@@ -529,7 +537,7 @@ and is automatically generated by the
|
|
|
529
537
|
[OpenAPI Generator](https://openapi-generator.tech) project:
|
|
530
538
|
|
|
531
539
|
- API version: `1.0.0`
|
|
532
|
-
- Package version: `1.
|
|
540
|
+
- Package version: `1.73.0`
|
|
533
541
|
- Generator version: `7.22.0`
|
|
534
542
|
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
|
|
535
543
|
|
|
@@ -561,12 +561,12 @@ export declare class ContentApi extends runtime.BaseAPI {
|
|
|
561
561
|
*/
|
|
562
562
|
verifyScormManifestRequestOpts(requestParameters: VerifyScormManifestRequest): Promise<runtime.RequestOpts>;
|
|
563
563
|
/**
|
|
564
|
-
*
|
|
564
|
+
* Public endpoint that takes raw imsmanifest.xml content and returns only parsed values derived from the submitted manifest, plus validation warnings. Request body is limited to 1 MiB.
|
|
565
565
|
* Parse and verify a SCORM manifest
|
|
566
566
|
*/
|
|
567
567
|
verifyScormManifestRaw(requestParameters: VerifyScormManifestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostVerifyManifest>>;
|
|
568
568
|
/**
|
|
569
|
-
*
|
|
569
|
+
* Public endpoint that takes raw imsmanifest.xml content and returns only parsed values derived from the submitted manifest, plus validation warnings. Request body is limited to 1 MiB.
|
|
570
570
|
* Parse and verify a SCORM manifest
|
|
571
571
|
*/
|
|
572
572
|
verifyScormManifest(requestParameters: VerifyScormManifestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostVerifyManifest>;
|
package/dist/apis/ContentApi.js
CHANGED
|
@@ -1432,7 +1432,7 @@ class ContentApi extends runtime.BaseAPI {
|
|
|
1432
1432
|
});
|
|
1433
1433
|
}
|
|
1434
1434
|
/**
|
|
1435
|
-
*
|
|
1435
|
+
* Public endpoint that takes raw imsmanifest.xml content and returns only parsed values derived from the submitted manifest, plus validation warnings. Request body is limited to 1 MiB.
|
|
1436
1436
|
* Parse and verify a SCORM manifest
|
|
1437
1437
|
*/
|
|
1438
1438
|
verifyScormManifestRaw(requestParameters, initOverrides) {
|
|
@@ -1443,7 +1443,7 @@ class ContentApi extends runtime.BaseAPI {
|
|
|
1443
1443
|
});
|
|
1444
1444
|
}
|
|
1445
1445
|
/**
|
|
1446
|
-
*
|
|
1446
|
+
* Public endpoint that takes raw imsmanifest.xml content and returns only parsed values derived from the submitted manifest, plus validation warnings. Request body is limited to 1 MiB.
|
|
1447
1447
|
* Parse and verify a SCORM manifest
|
|
1448
1448
|
*/
|
|
1449
1449
|
verifyScormManifest(requestParameters, initOverrides) {
|
|
@@ -0,0 +1,97 @@
|
|
|
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 GetPortal } from '../models/GetPortal';
|
|
14
|
+
import { type GetPortalList } from '../models/GetPortalList';
|
|
15
|
+
import { type GetSupportTicketList } from '../models/GetSupportTicketList';
|
|
16
|
+
import { type GetSystemBillingList } from '../models/GetSystemBillingList';
|
|
17
|
+
import { type GetSystemMetrics } from '../models/GetSystemMetrics';
|
|
18
|
+
export interface GetSystemBillingRequest {
|
|
19
|
+
page?: number;
|
|
20
|
+
pageSize?: number;
|
|
21
|
+
}
|
|
22
|
+
export interface GetSystemPortalRequest {
|
|
23
|
+
portalId: string;
|
|
24
|
+
}
|
|
25
|
+
export interface GetSystemPortalsRequest {
|
|
26
|
+
page?: number;
|
|
27
|
+
pageSize?: number;
|
|
28
|
+
}
|
|
29
|
+
export interface GetSystemSupportTicketsRequest {
|
|
30
|
+
page?: number;
|
|
31
|
+
pageSize?: number;
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
*
|
|
35
|
+
*/
|
|
36
|
+
export declare class SystemApi extends runtime.BaseAPI {
|
|
37
|
+
/**
|
|
38
|
+
* Creates request options for getSystemBilling without sending the request
|
|
39
|
+
*/
|
|
40
|
+
getSystemBillingRequestOpts(requestParameters: GetSystemBillingRequest): Promise<runtime.RequestOpts>;
|
|
41
|
+
/**
|
|
42
|
+
* List mock platform billing information
|
|
43
|
+
*/
|
|
44
|
+
getSystemBillingRaw(requestParameters: GetSystemBillingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSystemBillingList>>;
|
|
45
|
+
/**
|
|
46
|
+
* List mock platform billing information
|
|
47
|
+
*/
|
|
48
|
+
getSystemBilling(requestParameters?: GetSystemBillingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSystemBillingList>;
|
|
49
|
+
/**
|
|
50
|
+
* Creates request options for getSystemMetrics without sending the request
|
|
51
|
+
*/
|
|
52
|
+
getSystemMetricsRequestOpts(): Promise<runtime.RequestOpts>;
|
|
53
|
+
/**
|
|
54
|
+
* Get platform-wide metrics
|
|
55
|
+
*/
|
|
56
|
+
getSystemMetricsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSystemMetrics>>;
|
|
57
|
+
/**
|
|
58
|
+
* Get platform-wide metrics
|
|
59
|
+
*/
|
|
60
|
+
getSystemMetrics(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSystemMetrics>;
|
|
61
|
+
/**
|
|
62
|
+
* Creates request options for getSystemPortal without sending the request
|
|
63
|
+
*/
|
|
64
|
+
getSystemPortalRequestOpts(requestParameters: GetSystemPortalRequest): Promise<runtime.RequestOpts>;
|
|
65
|
+
/**
|
|
66
|
+
* Get platform portal detail
|
|
67
|
+
*/
|
|
68
|
+
getSystemPortalRaw(requestParameters: GetSystemPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortal>>;
|
|
69
|
+
/**
|
|
70
|
+
* Get platform portal detail
|
|
71
|
+
*/
|
|
72
|
+
getSystemPortal(requestParameters: GetSystemPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortal>;
|
|
73
|
+
/**
|
|
74
|
+
* Creates request options for getSystemPortals without sending the request
|
|
75
|
+
*/
|
|
76
|
+
getSystemPortalsRequestOpts(requestParameters: GetSystemPortalsRequest): Promise<runtime.RequestOpts>;
|
|
77
|
+
/**
|
|
78
|
+
* List all platform portals
|
|
79
|
+
*/
|
|
80
|
+
getSystemPortalsRaw(requestParameters: GetSystemPortalsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortalList>>;
|
|
81
|
+
/**
|
|
82
|
+
* List all platform portals
|
|
83
|
+
*/
|
|
84
|
+
getSystemPortals(requestParameters?: GetSystemPortalsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalList>;
|
|
85
|
+
/**
|
|
86
|
+
* Creates request options for getSystemSupportTickets without sending the request
|
|
87
|
+
*/
|
|
88
|
+
getSystemSupportTicketsRequestOpts(requestParameters: GetSystemSupportTicketsRequest): Promise<runtime.RequestOpts>;
|
|
89
|
+
/**
|
|
90
|
+
* List open support tickets across the platform
|
|
91
|
+
*/
|
|
92
|
+
getSystemSupportTicketsRaw(requestParameters: GetSystemSupportTicketsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSupportTicketList>>;
|
|
93
|
+
/**
|
|
94
|
+
* List open support tickets across the platform
|
|
95
|
+
*/
|
|
96
|
+
getSystemSupportTickets(requestParameters?: GetSystemSupportTicketsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSupportTicketList>;
|
|
97
|
+
}
|
|
@@ -0,0 +1,234 @@
|
|
|
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.SystemApi = void 0;
|
|
26
|
+
const runtime = require("../runtime");
|
|
27
|
+
const GetPortal_1 = require("../models/GetPortal");
|
|
28
|
+
const GetPortalList_1 = require("../models/GetPortalList");
|
|
29
|
+
const GetSupportTicketList_1 = require("../models/GetSupportTicketList");
|
|
30
|
+
const GetSystemBillingList_1 = require("../models/GetSystemBillingList");
|
|
31
|
+
const GetSystemMetrics_1 = require("../models/GetSystemMetrics");
|
|
32
|
+
/**
|
|
33
|
+
*
|
|
34
|
+
*/
|
|
35
|
+
class SystemApi extends runtime.BaseAPI {
|
|
36
|
+
/**
|
|
37
|
+
* Creates request options for getSystemBilling without sending the request
|
|
38
|
+
*/
|
|
39
|
+
getSystemBillingRequestOpts(requestParameters) {
|
|
40
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
41
|
+
const queryParameters = {};
|
|
42
|
+
if (requestParameters['page'] != null) {
|
|
43
|
+
queryParameters['page'] = requestParameters['page'];
|
|
44
|
+
}
|
|
45
|
+
if (requestParameters['pageSize'] != null) {
|
|
46
|
+
queryParameters['pageSize'] = requestParameters['pageSize'];
|
|
47
|
+
}
|
|
48
|
+
const headerParameters = {};
|
|
49
|
+
let urlPath = `/system/billing`;
|
|
50
|
+
return {
|
|
51
|
+
path: urlPath,
|
|
52
|
+
method: 'GET',
|
|
53
|
+
headers: headerParameters,
|
|
54
|
+
query: queryParameters,
|
|
55
|
+
};
|
|
56
|
+
});
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* List mock platform billing information
|
|
60
|
+
*/
|
|
61
|
+
getSystemBillingRaw(requestParameters, initOverrides) {
|
|
62
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
63
|
+
const requestOptions = yield this.getSystemBillingRequestOpts(requestParameters);
|
|
64
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
65
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetSystemBillingList_1.GetSystemBillingListFromJSON)(jsonValue));
|
|
66
|
+
});
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* List mock platform billing information
|
|
70
|
+
*/
|
|
71
|
+
getSystemBilling() {
|
|
72
|
+
return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
|
|
73
|
+
const response = yield this.getSystemBillingRaw(requestParameters, initOverrides);
|
|
74
|
+
return yield response.value();
|
|
75
|
+
});
|
|
76
|
+
}
|
|
77
|
+
/**
|
|
78
|
+
* Creates request options for getSystemMetrics without sending the request
|
|
79
|
+
*/
|
|
80
|
+
getSystemMetricsRequestOpts() {
|
|
81
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
82
|
+
const queryParameters = {};
|
|
83
|
+
const headerParameters = {};
|
|
84
|
+
let urlPath = `/system/metrics`;
|
|
85
|
+
return {
|
|
86
|
+
path: urlPath,
|
|
87
|
+
method: 'GET',
|
|
88
|
+
headers: headerParameters,
|
|
89
|
+
query: queryParameters,
|
|
90
|
+
};
|
|
91
|
+
});
|
|
92
|
+
}
|
|
93
|
+
/**
|
|
94
|
+
* Get platform-wide metrics
|
|
95
|
+
*/
|
|
96
|
+
getSystemMetricsRaw(initOverrides) {
|
|
97
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
98
|
+
const requestOptions = yield this.getSystemMetricsRequestOpts();
|
|
99
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
100
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetSystemMetrics_1.GetSystemMetricsFromJSON)(jsonValue));
|
|
101
|
+
});
|
|
102
|
+
}
|
|
103
|
+
/**
|
|
104
|
+
* Get platform-wide metrics
|
|
105
|
+
*/
|
|
106
|
+
getSystemMetrics(initOverrides) {
|
|
107
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
108
|
+
const response = yield this.getSystemMetricsRaw(initOverrides);
|
|
109
|
+
return yield response.value();
|
|
110
|
+
});
|
|
111
|
+
}
|
|
112
|
+
/**
|
|
113
|
+
* Creates request options for getSystemPortal without sending the request
|
|
114
|
+
*/
|
|
115
|
+
getSystemPortalRequestOpts(requestParameters) {
|
|
116
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
117
|
+
if (requestParameters['portalId'] == null) {
|
|
118
|
+
throw new runtime.RequiredError('portalId', 'Required parameter "portalId" was null or undefined when calling getSystemPortal().');
|
|
119
|
+
}
|
|
120
|
+
const queryParameters = {};
|
|
121
|
+
const headerParameters = {};
|
|
122
|
+
let urlPath = `/system/portals/{portalId}`;
|
|
123
|
+
urlPath = urlPath.replace('{portalId}', encodeURIComponent(String(requestParameters['portalId'])));
|
|
124
|
+
return {
|
|
125
|
+
path: urlPath,
|
|
126
|
+
method: 'GET',
|
|
127
|
+
headers: headerParameters,
|
|
128
|
+
query: queryParameters,
|
|
129
|
+
};
|
|
130
|
+
});
|
|
131
|
+
}
|
|
132
|
+
/**
|
|
133
|
+
* Get platform portal detail
|
|
134
|
+
*/
|
|
135
|
+
getSystemPortalRaw(requestParameters, initOverrides) {
|
|
136
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
137
|
+
const requestOptions = yield this.getSystemPortalRequestOpts(requestParameters);
|
|
138
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
139
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetPortal_1.GetPortalFromJSON)(jsonValue));
|
|
140
|
+
});
|
|
141
|
+
}
|
|
142
|
+
/**
|
|
143
|
+
* Get platform portal detail
|
|
144
|
+
*/
|
|
145
|
+
getSystemPortal(requestParameters, initOverrides) {
|
|
146
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
147
|
+
const response = yield this.getSystemPortalRaw(requestParameters, initOverrides);
|
|
148
|
+
return yield response.value();
|
|
149
|
+
});
|
|
150
|
+
}
|
|
151
|
+
/**
|
|
152
|
+
* Creates request options for getSystemPortals without sending the request
|
|
153
|
+
*/
|
|
154
|
+
getSystemPortalsRequestOpts(requestParameters) {
|
|
155
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
156
|
+
const queryParameters = {};
|
|
157
|
+
if (requestParameters['page'] != null) {
|
|
158
|
+
queryParameters['page'] = requestParameters['page'];
|
|
159
|
+
}
|
|
160
|
+
if (requestParameters['pageSize'] != null) {
|
|
161
|
+
queryParameters['pageSize'] = requestParameters['pageSize'];
|
|
162
|
+
}
|
|
163
|
+
const headerParameters = {};
|
|
164
|
+
let urlPath = `/system/portals`;
|
|
165
|
+
return {
|
|
166
|
+
path: urlPath,
|
|
167
|
+
method: 'GET',
|
|
168
|
+
headers: headerParameters,
|
|
169
|
+
query: queryParameters,
|
|
170
|
+
};
|
|
171
|
+
});
|
|
172
|
+
}
|
|
173
|
+
/**
|
|
174
|
+
* List all platform portals
|
|
175
|
+
*/
|
|
176
|
+
getSystemPortalsRaw(requestParameters, initOverrides) {
|
|
177
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
178
|
+
const requestOptions = yield this.getSystemPortalsRequestOpts(requestParameters);
|
|
179
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
180
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetPortalList_1.GetPortalListFromJSON)(jsonValue));
|
|
181
|
+
});
|
|
182
|
+
}
|
|
183
|
+
/**
|
|
184
|
+
* List all platform portals
|
|
185
|
+
*/
|
|
186
|
+
getSystemPortals() {
|
|
187
|
+
return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
|
|
188
|
+
const response = yield this.getSystemPortalsRaw(requestParameters, initOverrides);
|
|
189
|
+
return yield response.value();
|
|
190
|
+
});
|
|
191
|
+
}
|
|
192
|
+
/**
|
|
193
|
+
* Creates request options for getSystemSupportTickets without sending the request
|
|
194
|
+
*/
|
|
195
|
+
getSystemSupportTicketsRequestOpts(requestParameters) {
|
|
196
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
197
|
+
const queryParameters = {};
|
|
198
|
+
if (requestParameters['page'] != null) {
|
|
199
|
+
queryParameters['page'] = requestParameters['page'];
|
|
200
|
+
}
|
|
201
|
+
if (requestParameters['pageSize'] != null) {
|
|
202
|
+
queryParameters['pageSize'] = requestParameters['pageSize'];
|
|
203
|
+
}
|
|
204
|
+
const headerParameters = {};
|
|
205
|
+
let urlPath = `/system/support/tickets`;
|
|
206
|
+
return {
|
|
207
|
+
path: urlPath,
|
|
208
|
+
method: 'GET',
|
|
209
|
+
headers: headerParameters,
|
|
210
|
+
query: queryParameters,
|
|
211
|
+
};
|
|
212
|
+
});
|
|
213
|
+
}
|
|
214
|
+
/**
|
|
215
|
+
* List open support tickets across the platform
|
|
216
|
+
*/
|
|
217
|
+
getSystemSupportTicketsRaw(requestParameters, initOverrides) {
|
|
218
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
219
|
+
const requestOptions = yield this.getSystemSupportTicketsRequestOpts(requestParameters);
|
|
220
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
221
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetSupportTicketList_1.GetSupportTicketListFromJSON)(jsonValue));
|
|
222
|
+
});
|
|
223
|
+
}
|
|
224
|
+
/**
|
|
225
|
+
* List open support tickets across the platform
|
|
226
|
+
*/
|
|
227
|
+
getSystemSupportTickets() {
|
|
228
|
+
return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
|
|
229
|
+
const response = yield this.getSystemSupportTicketsRaw(requestParameters, initOverrides);
|
|
230
|
+
return yield response.value();
|
|
231
|
+
});
|
|
232
|
+
}
|
|
233
|
+
}
|
|
234
|
+
exports.SystemApi = SystemApi;
|
package/dist/apis/index.d.ts
CHANGED
package/dist/apis/index.js
CHANGED
|
@@ -33,4 +33,5 @@ __exportStar(require("./QuizApi"), exports);
|
|
|
33
33
|
__exportStar(require("./ReportingApi"), exports);
|
|
34
34
|
__exportStar(require("./RoleApi"), exports);
|
|
35
35
|
__exportStar(require("./SupportTicketApi"), exports);
|
|
36
|
+
__exportStar(require("./SystemApi"), exports);
|
|
36
37
|
__exportStar(require("./UserApi"), exports);
|
|
@@ -561,12 +561,12 @@ export declare class ContentApi extends runtime.BaseAPI {
|
|
|
561
561
|
*/
|
|
562
562
|
verifyScormManifestRequestOpts(requestParameters: VerifyScormManifestRequest): Promise<runtime.RequestOpts>;
|
|
563
563
|
/**
|
|
564
|
-
*
|
|
564
|
+
* Public endpoint that takes raw imsmanifest.xml content and returns only parsed values derived from the submitted manifest, plus validation warnings. Request body is limited to 1 MiB.
|
|
565
565
|
* Parse and verify a SCORM manifest
|
|
566
566
|
*/
|
|
567
567
|
verifyScormManifestRaw(requestParameters: VerifyScormManifestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostVerifyManifest>>;
|
|
568
568
|
/**
|
|
569
|
-
*
|
|
569
|
+
* Public endpoint that takes raw imsmanifest.xml content and returns only parsed values derived from the submitted manifest, plus validation warnings. Request body is limited to 1 MiB.
|
|
570
570
|
* Parse and verify a SCORM manifest
|
|
571
571
|
*/
|
|
572
572
|
verifyScormManifest(requestParameters: VerifyScormManifestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostVerifyManifest>;
|
|
@@ -1429,7 +1429,7 @@ export class ContentApi extends runtime.BaseAPI {
|
|
|
1429
1429
|
});
|
|
1430
1430
|
}
|
|
1431
1431
|
/**
|
|
1432
|
-
*
|
|
1432
|
+
* Public endpoint that takes raw imsmanifest.xml content and returns only parsed values derived from the submitted manifest, plus validation warnings. Request body is limited to 1 MiB.
|
|
1433
1433
|
* Parse and verify a SCORM manifest
|
|
1434
1434
|
*/
|
|
1435
1435
|
verifyScormManifestRaw(requestParameters, initOverrides) {
|
|
@@ -1440,7 +1440,7 @@ export class ContentApi extends runtime.BaseAPI {
|
|
|
1440
1440
|
});
|
|
1441
1441
|
}
|
|
1442
1442
|
/**
|
|
1443
|
-
*
|
|
1443
|
+
* Public endpoint that takes raw imsmanifest.xml content and returns only parsed values derived from the submitted manifest, plus validation warnings. Request body is limited to 1 MiB.
|
|
1444
1444
|
* Parse and verify a SCORM manifest
|
|
1445
1445
|
*/
|
|
1446
1446
|
verifyScormManifest(requestParameters, initOverrides) {
|
|
@@ -0,0 +1,97 @@
|
|
|
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 GetPortal } from '../models/GetPortal';
|
|
14
|
+
import { type GetPortalList } from '../models/GetPortalList';
|
|
15
|
+
import { type GetSupportTicketList } from '../models/GetSupportTicketList';
|
|
16
|
+
import { type GetSystemBillingList } from '../models/GetSystemBillingList';
|
|
17
|
+
import { type GetSystemMetrics } from '../models/GetSystemMetrics';
|
|
18
|
+
export interface GetSystemBillingRequest {
|
|
19
|
+
page?: number;
|
|
20
|
+
pageSize?: number;
|
|
21
|
+
}
|
|
22
|
+
export interface GetSystemPortalRequest {
|
|
23
|
+
portalId: string;
|
|
24
|
+
}
|
|
25
|
+
export interface GetSystemPortalsRequest {
|
|
26
|
+
page?: number;
|
|
27
|
+
pageSize?: number;
|
|
28
|
+
}
|
|
29
|
+
export interface GetSystemSupportTicketsRequest {
|
|
30
|
+
page?: number;
|
|
31
|
+
pageSize?: number;
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
*
|
|
35
|
+
*/
|
|
36
|
+
export declare class SystemApi extends runtime.BaseAPI {
|
|
37
|
+
/**
|
|
38
|
+
* Creates request options for getSystemBilling without sending the request
|
|
39
|
+
*/
|
|
40
|
+
getSystemBillingRequestOpts(requestParameters: GetSystemBillingRequest): Promise<runtime.RequestOpts>;
|
|
41
|
+
/**
|
|
42
|
+
* List mock platform billing information
|
|
43
|
+
*/
|
|
44
|
+
getSystemBillingRaw(requestParameters: GetSystemBillingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSystemBillingList>>;
|
|
45
|
+
/**
|
|
46
|
+
* List mock platform billing information
|
|
47
|
+
*/
|
|
48
|
+
getSystemBilling(requestParameters?: GetSystemBillingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSystemBillingList>;
|
|
49
|
+
/**
|
|
50
|
+
* Creates request options for getSystemMetrics without sending the request
|
|
51
|
+
*/
|
|
52
|
+
getSystemMetricsRequestOpts(): Promise<runtime.RequestOpts>;
|
|
53
|
+
/**
|
|
54
|
+
* Get platform-wide metrics
|
|
55
|
+
*/
|
|
56
|
+
getSystemMetricsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSystemMetrics>>;
|
|
57
|
+
/**
|
|
58
|
+
* Get platform-wide metrics
|
|
59
|
+
*/
|
|
60
|
+
getSystemMetrics(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSystemMetrics>;
|
|
61
|
+
/**
|
|
62
|
+
* Creates request options for getSystemPortal without sending the request
|
|
63
|
+
*/
|
|
64
|
+
getSystemPortalRequestOpts(requestParameters: GetSystemPortalRequest): Promise<runtime.RequestOpts>;
|
|
65
|
+
/**
|
|
66
|
+
* Get platform portal detail
|
|
67
|
+
*/
|
|
68
|
+
getSystemPortalRaw(requestParameters: GetSystemPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortal>>;
|
|
69
|
+
/**
|
|
70
|
+
* Get platform portal detail
|
|
71
|
+
*/
|
|
72
|
+
getSystemPortal(requestParameters: GetSystemPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortal>;
|
|
73
|
+
/**
|
|
74
|
+
* Creates request options for getSystemPortals without sending the request
|
|
75
|
+
*/
|
|
76
|
+
getSystemPortalsRequestOpts(requestParameters: GetSystemPortalsRequest): Promise<runtime.RequestOpts>;
|
|
77
|
+
/**
|
|
78
|
+
* List all platform portals
|
|
79
|
+
*/
|
|
80
|
+
getSystemPortalsRaw(requestParameters: GetSystemPortalsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortalList>>;
|
|
81
|
+
/**
|
|
82
|
+
* List all platform portals
|
|
83
|
+
*/
|
|
84
|
+
getSystemPortals(requestParameters?: GetSystemPortalsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalList>;
|
|
85
|
+
/**
|
|
86
|
+
* Creates request options for getSystemSupportTickets without sending the request
|
|
87
|
+
*/
|
|
88
|
+
getSystemSupportTicketsRequestOpts(requestParameters: GetSystemSupportTicketsRequest): Promise<runtime.RequestOpts>;
|
|
89
|
+
/**
|
|
90
|
+
* List open support tickets across the platform
|
|
91
|
+
*/
|
|
92
|
+
getSystemSupportTicketsRaw(requestParameters: GetSystemSupportTicketsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSupportTicketList>>;
|
|
93
|
+
/**
|
|
94
|
+
* List open support tickets across the platform
|
|
95
|
+
*/
|
|
96
|
+
getSystemSupportTickets(requestParameters?: GetSystemSupportTicketsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSupportTicketList>;
|
|
97
|
+
}
|