@easyedu/js-lsm-api 1.70.0 → 1.72.0

package/.openapi-generator/FILES

@@ -158,6 +158,9 @@ docs/GetSupportTicket.md
 docs/GetSupportTicketAttachment.md
 docs/GetSupportTicketComment.md
 docs/GetSupportTicketList.md
+docs/GetSystemBillingItem.md
+docs/GetSystemBillingList.md
+docs/GetSystemMetrics.md
 docs/GetUser.md
 docs/GetUserAvatarUpload.md
 docs/GetUserQuizAttempts.md
@@ -285,6 +288,7 @@ docs/ShortAnswer1.md
 docs/SingleAnswer.md
 docs/SupportTicketApi.md
 docs/SupportTicketUser.md
+docs/SystemApi.md
 docs/UpdateSelectedPortalResponse.md
 docs/UpdateSelectedPortalResponseHostPortal.md
 docs/UpdateSelectedPortalResponseSelectedPortal.md
@@ -307,6 +311,7 @@ src/apis/QuizApi.ts
 src/apis/ReportingApi.ts
 src/apis/RoleApi.ts
 src/apis/SupportTicketApi.ts
+src/apis/SystemApi.ts
 src/apis/UserApi.ts
 src/apis/index.ts
 src/index.ts
@@ -459,6 +464,9 @@ src/models/GetSupportTicket.ts
 src/models/GetSupportTicketAttachment.ts
 src/models/GetSupportTicketComment.ts
 src/models/GetSupportTicketList.ts
+src/models/GetSystemBillingItem.ts
+src/models/GetSystemBillingList.ts
+src/models/GetSystemMetrics.ts
 src/models/GetUser.ts
 src/models/GetUserAvatarUpload.ts
 src/models/GetUserQuizAttempts.ts

package/README.md

@@ -1,4 +1,4 @@
-# @easyedu/js-lsm-api@1.70.0
+# @easyedu/js-lsm-api@1.72.0
 
 A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
 
@@ -231,6 +231,11 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 *SupportTicketApi* | [**postSupportTicketAttachment**](docs/SupportTicketApi.md#postsupportticketattachment) | **POST** /support/tickets/{ticketId}/attachments | Upload an attachment to a ticket
 *SupportTicketApi* | [**postSupportTicketComment**](docs/SupportTicketApi.md#postsupportticketcomment) | **POST** /support/tickets/{ticketId}/comments | Add a comment to a ticket
 *SupportTicketApi* | [**putSupportTicket**](docs/SupportTicketApi.md#putsupportticket) | **PUT** /support/tickets/{ticketId} | Update a support ticket
+*SystemApi* | [**getSystemBilling**](docs/SystemApi.md#getsystembilling) | **GET** /system/billing | List mock platform billing information
+*SystemApi* | [**getSystemMetrics**](docs/SystemApi.md#getsystemmetrics) | **GET** /system/metrics | Get platform-wide metrics
+*SystemApi* | [**getSystemPortal**](docs/SystemApi.md#getsystemportal) | **GET** /system/portals/{portalId} | Get platform portal detail
+*SystemApi* | [**getSystemPortals**](docs/SystemApi.md#getsystemportals) | **GET** /system/portals | List all platform portals
+*SystemApi* | [**getSystemSupportTickets**](docs/SystemApi.md#getsystemsupporttickets) | **GET** /system/support/tickets | List open support tickets across the platform
 *UserApi* | [**deleteUserAvatar**](docs/UserApi.md#deleteuseravatar) | **DELETE** /users/{userId}/avatar | Remove the current user\'s profile photo
 *UserApi* | [**getAuthCheck**](docs/UserApi.md#getauthcheck) | **GET** /auth/check | Check if a user is logged in
 *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
 - [GetSupportTicketAttachment](docs/GetSupportTicketAttachment.md)
 - [GetSupportTicketComment](docs/GetSupportTicketComment.md)
 - [GetSupportTicketList](docs/GetSupportTicketList.md)
+- [GetSystemBillingItem](docs/GetSystemBillingItem.md)
+- [GetSystemBillingList](docs/GetSystemBillingList.md)
+- [GetSystemMetrics](docs/GetSystemMetrics.md)
 - [GetUser](docs/GetUser.md)
 - [GetUserAvatarUpload](docs/GetUserAvatarUpload.md)
 - [GetUserQuizAttempts](docs/GetUserQuizAttempts.md)
@@ -529,7 +537,7 @@ and is automatically generated by the
 [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: `1.0.0`
-- Package version: `1.70.0`
+- Package version: `1.72.0`
 - Generator version: `7.22.0`
 - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
 

package/dist/apis/SystemApi.d.ts

@@ -0,0 +1,97 @@
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import { type GetPortal } from '../models/GetPortal';
+import { type GetPortalList } from '../models/GetPortalList';
+import { type GetSupportTicketList } from '../models/GetSupportTicketList';
+import { type GetSystemBillingList } from '../models/GetSystemBillingList';
+import { type GetSystemMetrics } from '../models/GetSystemMetrics';
+export interface GetSystemBillingRequest {
+    page?: number;
+    pageSize?: number;
+}
+export interface GetSystemPortalRequest {
+    portalId: string;
+}
+export interface GetSystemPortalsRequest {
+    page?: number;
+    pageSize?: number;
+}
+export interface GetSystemSupportTicketsRequest {
+    page?: number;
+    pageSize?: number;
+}
+/**
+ *
+ */
+export declare class SystemApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for getSystemBilling without sending the request
+     */
+    getSystemBillingRequestOpts(requestParameters: GetSystemBillingRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List mock platform billing information
+     */
+    getSystemBillingRaw(requestParameters: GetSystemBillingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSystemBillingList>>;
+    /**
+     * List mock platform billing information
+     */
+    getSystemBilling(requestParameters?: GetSystemBillingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSystemBillingList>;
+    /**
+     * Creates request options for getSystemMetrics without sending the request
+     */
+    getSystemMetricsRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * Get platform-wide metrics
+     */
+    getSystemMetricsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSystemMetrics>>;
+    /**
+     * Get platform-wide metrics
+     */
+    getSystemMetrics(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSystemMetrics>;
+    /**
+     * Creates request options for getSystemPortal without sending the request
+     */
+    getSystemPortalRequestOpts(requestParameters: GetSystemPortalRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get platform portal detail
+     */
+    getSystemPortalRaw(requestParameters: GetSystemPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortal>>;
+    /**
+     * Get platform portal detail
+     */
+    getSystemPortal(requestParameters: GetSystemPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortal>;
+    /**
+     * Creates request options for getSystemPortals without sending the request
+     */
+    getSystemPortalsRequestOpts(requestParameters: GetSystemPortalsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List all platform portals
+     */
+    getSystemPortalsRaw(requestParameters: GetSystemPortalsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortalList>>;
+    /**
+     * List all platform portals
+     */
+    getSystemPortals(requestParameters?: GetSystemPortalsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalList>;
+    /**
+     * Creates request options for getSystemSupportTickets without sending the request
+     */
+    getSystemSupportTicketsRequestOpts(requestParameters: GetSystemSupportTicketsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List open support tickets across the platform
+     */
+    getSystemSupportTicketsRaw(requestParameters: GetSystemSupportTicketsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSupportTicketList>>;
+    /**
+     * List open support tickets across the platform
+     */
+    getSystemSupportTickets(requestParameters?: GetSystemSupportTicketsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSupportTicketList>;
+}

package/dist/apis/SystemApi.js

@@ -0,0 +1,234 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SystemApi = void 0;
+const runtime = require("../runtime");
+const GetPortal_1 = require("../models/GetPortal");
+const GetPortalList_1 = require("../models/GetPortalList");
+const GetSupportTicketList_1 = require("../models/GetSupportTicketList");
+const GetSystemBillingList_1 = require("../models/GetSystemBillingList");
+const GetSystemMetrics_1 = require("../models/GetSystemMetrics");
+/**
+ *
+ */
+class SystemApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for getSystemBilling without sending the request
+     */
+    getSystemBillingRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['page'] != null) {
+                queryParameters['page'] = requestParameters['page'];
+            }
+            if (requestParameters['pageSize'] != null) {
+                queryParameters['pageSize'] = requestParameters['pageSize'];
+            }
+            const headerParameters = {};
+            let urlPath = `/system/billing`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * List mock platform billing information
+     */
+    getSystemBillingRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getSystemBillingRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetSystemBillingList_1.GetSystemBillingListFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * List mock platform billing information
+     */
+    getSystemBilling() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.getSystemBillingRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getSystemMetrics without sending the request
+     */
+    getSystemMetricsRequestOpts() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/system/metrics`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Get platform-wide metrics
+     */
+    getSystemMetricsRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getSystemMetricsRequestOpts();
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetSystemMetrics_1.GetSystemMetricsFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Get platform-wide metrics
+     */
+    getSystemMetrics(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getSystemMetricsRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getSystemPortal without sending the request
+     */
+    getSystemPortalRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['portalId'] == null) {
+                throw new runtime.RequiredError('portalId', 'Required parameter "portalId" was null or undefined when calling getSystemPortal().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/system/portals/{portalId}`;
+            urlPath = urlPath.replace('{portalId}', encodeURIComponent(String(requestParameters['portalId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Get platform portal detail
+     */
+    getSystemPortalRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getSystemPortalRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetPortal_1.GetPortalFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Get platform portal detail
+     */
+    getSystemPortal(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getSystemPortalRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getSystemPortals without sending the request
+     */
+    getSystemPortalsRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['page'] != null) {
+                queryParameters['page'] = requestParameters['page'];
+            }
+            if (requestParameters['pageSize'] != null) {
+                queryParameters['pageSize'] = requestParameters['pageSize'];
+            }
+            const headerParameters = {};
+            let urlPath = `/system/portals`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * List all platform portals
+     */
+    getSystemPortalsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getSystemPortalsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetPortalList_1.GetPortalListFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * List all platform portals
+     */
+    getSystemPortals() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.getSystemPortalsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getSystemSupportTickets without sending the request
+     */
+    getSystemSupportTicketsRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['page'] != null) {
+                queryParameters['page'] = requestParameters['page'];
+            }
+            if (requestParameters['pageSize'] != null) {
+                queryParameters['pageSize'] = requestParameters['pageSize'];
+            }
+            const headerParameters = {};
+            let urlPath = `/system/support/tickets`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * List open support tickets across the platform
+     */
+    getSystemSupportTicketsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getSystemSupportTicketsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetSupportTicketList_1.GetSupportTicketListFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * List open support tickets across the platform
+     */
+    getSystemSupportTickets() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.getSystemSupportTicketsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.SystemApi = SystemApi;

package/dist/apis/index.d.ts

@@ -15,4 +15,5 @@ export * from './QuizApi';
 export * from './ReportingApi';
 export * from './RoleApi';
 export * from './SupportTicketApi';
+export * from './SystemApi';
 export * from './UserApi';

package/dist/apis/index.js

@@ -33,4 +33,5 @@ __exportStar(require("./QuizApi"), exports);
 __exportStar(require("./ReportingApi"), exports);
 __exportStar(require("./RoleApi"), exports);
 __exportStar(require("./SupportTicketApi"), exports);
+__exportStar(require("./SystemApi"), exports);
 __exportStar(require("./UserApi"), exports);

package/dist/esm/apis/SystemApi.d.ts

@@ -0,0 +1,97 @@
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import { type GetPortal } from '../models/GetPortal';
+import { type GetPortalList } from '../models/GetPortalList';
+import { type GetSupportTicketList } from '../models/GetSupportTicketList';
+import { type GetSystemBillingList } from '../models/GetSystemBillingList';
+import { type GetSystemMetrics } from '../models/GetSystemMetrics';
+export interface GetSystemBillingRequest {
+    page?: number;
+    pageSize?: number;
+}
+export interface GetSystemPortalRequest {
+    portalId: string;
+}
+export interface GetSystemPortalsRequest {
+    page?: number;
+    pageSize?: number;
+}
+export interface GetSystemSupportTicketsRequest {
+    page?: number;
+    pageSize?: number;
+}
+/**
+ *
+ */
+export declare class SystemApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for getSystemBilling without sending the request
+     */
+    getSystemBillingRequestOpts(requestParameters: GetSystemBillingRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List mock platform billing information
+     */
+    getSystemBillingRaw(requestParameters: GetSystemBillingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSystemBillingList>>;
+    /**
+     * List mock platform billing information
+     */
+    getSystemBilling(requestParameters?: GetSystemBillingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSystemBillingList>;
+    /**
+     * Creates request options for getSystemMetrics without sending the request
+     */
+    getSystemMetricsRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * Get platform-wide metrics
+     */
+    getSystemMetricsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSystemMetrics>>;
+    /**
+     * Get platform-wide metrics
+     */
+    getSystemMetrics(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSystemMetrics>;
+    /**
+     * Creates request options for getSystemPortal without sending the request
+     */
+    getSystemPortalRequestOpts(requestParameters: GetSystemPortalRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get platform portal detail
+     */
+    getSystemPortalRaw(requestParameters: GetSystemPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortal>>;
+    /**
+     * Get platform portal detail
+     */
+    getSystemPortal(requestParameters: GetSystemPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortal>;
+    /**
+     * Creates request options for getSystemPortals without sending the request
+     */
+    getSystemPortalsRequestOpts(requestParameters: GetSystemPortalsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List all platform portals
+     */
+    getSystemPortalsRaw(requestParameters: GetSystemPortalsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortalList>>;
+    /**
+     * List all platform portals
+     */
+    getSystemPortals(requestParameters?: GetSystemPortalsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalList>;
+    /**
+     * Creates request options for getSystemSupportTickets without sending the request
+     */
+    getSystemSupportTicketsRequestOpts(requestParameters: GetSystemSupportTicketsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List open support tickets across the platform
+     */
+    getSystemSupportTicketsRaw(requestParameters: GetSystemSupportTicketsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSupportTicketList>>;
+    /**
+     * List open support tickets across the platform
+     */
+    getSystemSupportTickets(requestParameters?: GetSystemSupportTicketsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSupportTicketList>;
+}