@easyedu/js-lsm-api 1.71.0 → 1.72.0

package/docs/SystemApi.md

@@ -0,0 +1,345 @@
+# SystemApi
+
+All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com/stage1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getSystemBilling**](SystemApi.md#getsystembilling) | **GET** /system/billing | List mock platform billing information |
+| [**getSystemMetrics**](SystemApi.md#getsystemmetrics) | **GET** /system/metrics | Get platform-wide metrics |
+| [**getSystemPortal**](SystemApi.md#getsystemportal) | **GET** /system/portals/{portalId} | Get platform portal detail |
+| [**getSystemPortals**](SystemApi.md#getsystemportals) | **GET** /system/portals | List all platform portals |
+| [**getSystemSupportTickets**](SystemApi.md#getsystemsupporttickets) | **GET** /system/support/tickets | List open support tickets across the platform |
+
+
+
+## getSystemBilling
+
+> GetSystemBillingList getSystemBilling(page, pageSize)
+
+List mock platform billing information
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SystemApi,
+} from '@easyedu/js-lsm-api';
+import type { GetSystemBillingRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new SystemApi();
+
+  const body = {
+    // number (optional)
+    page: 56,
+    // number (optional)
+    pageSize: 56,
+  } satisfies GetSystemBillingRequest;
+
+  try {
+    const data = await api.getSystemBilling(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **page** | `number` |  | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` |  | [Optional] [Defaults to `20`] |
+
+### Return type
+
+[**GetSystemBillingList**](GetSystemBillingList.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Mock billing list |  -  |
+| **403** | Forbidden |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getSystemMetrics
+
+> GetSystemMetrics getSystemMetrics()
+
+Get platform-wide metrics
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SystemApi,
+} from '@easyedu/js-lsm-api';
+import type { GetSystemMetricsRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new SystemApi();
+
+  try {
+    const data = await api.getSystemMetrics();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetSystemMetrics**](GetSystemMetrics.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Platform metrics |  -  |
+| **403** | Forbidden |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getSystemPortal
+
+> GetPortal getSystemPortal(portalId)
+
+Get platform portal detail
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SystemApi,
+} from '@easyedu/js-lsm-api';
+import type { GetSystemPortalRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new SystemApi();
+
+  const body = {
+    // string
+    portalId: portalId_example,
+  } satisfies GetSystemPortalRequest;
+
+  try {
+    const data = await api.getSystemPortal(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **portalId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetPortal**](GetPortal.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Platform portal detail |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Portal not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getSystemPortals
+
+> GetPortalList getSystemPortals(page, pageSize)
+
+List all platform portals
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SystemApi,
+} from '@easyedu/js-lsm-api';
+import type { GetSystemPortalsRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new SystemApi();
+
+  const body = {
+    // number (optional)
+    page: 56,
+    // number (optional)
+    pageSize: 56,
+  } satisfies GetSystemPortalsRequest;
+
+  try {
+    const data = await api.getSystemPortals(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **page** | `number` |  | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` |  | [Optional] [Defaults to `20`] |
+
+### Return type
+
+[**GetPortalList**](GetPortalList.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Platform portal list |  -  |
+| **403** | Forbidden |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getSystemSupportTickets
+
+> GetSupportTicketList getSystemSupportTickets(page, pageSize)
+
+List open support tickets across the platform
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SystemApi,
+} from '@easyedu/js-lsm-api';
+import type { GetSystemSupportTicketsRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new SystemApi();
+
+  const body = {
+    // number (optional)
+    page: 56,
+    // number (optional)
+    pageSize: 56,
+  } satisfies GetSystemSupportTicketsRequest;
+
+  try {
+    const data = await api.getSystemSupportTickets(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **page** | `number` |  | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` |  | [Optional] [Defaults to `20`] |
+
+### Return type
+
+[**GetSupportTicketList**](GetSupportTicketList.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Open platform support tickets |  -  |
+| **403** | Forbidden |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easyedu/js-lsm-api",
-  "version": "1.71.0",
+  "version": "1.72.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/SystemApi.ts

@@ -0,0 +1,283 @@
+/* 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.
+ */
+
+import * as runtime from '../runtime';
+import {
+    type GetPortal,
+    GetPortalFromJSON,
+    GetPortalToJSON,
+} from '../models/GetPortal';
+import {
+    type GetPortalList,
+    GetPortalListFromJSON,
+    GetPortalListToJSON,
+} from '../models/GetPortalList';
+import {
+    type GetSupportTicketList,
+    GetSupportTicketListFromJSON,
+    GetSupportTicketListToJSON,
+} from '../models/GetSupportTicketList';
+import {
+    type GetSystemBillingList,
+    GetSystemBillingListFromJSON,
+    GetSystemBillingListToJSON,
+} from '../models/GetSystemBillingList';
+import {
+    type GetSystemMetrics,
+    GetSystemMetricsFromJSON,
+    GetSystemMetricsToJSON,
+} 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 class SystemApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for getSystemBilling without sending the request
+     */
+    async getSystemBillingRequestOpts(requestParameters: GetSystemBillingRequest): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['pageSize'] != null) {
+            queryParameters['pageSize'] = requestParameters['pageSize'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/system/billing`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * List mock platform billing information
+     */
+    async getSystemBillingRaw(requestParameters: GetSystemBillingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSystemBillingList>> {
+        const requestOptions = await this.getSystemBillingRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetSystemBillingListFromJSON(jsonValue));
+    }
+
+    /**
+     * List mock platform billing information
+     */
+    async getSystemBilling(requestParameters: GetSystemBillingRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSystemBillingList> {
+        const response = await this.getSystemBillingRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getSystemMetrics without sending the request
+     */
+    async getSystemMetricsRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/system/metrics`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get platform-wide metrics
+     */
+    async getSystemMetricsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSystemMetrics>> {
+        const requestOptions = await this.getSystemMetricsRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetSystemMetricsFromJSON(jsonValue));
+    }
+
+    /**
+     * Get platform-wide metrics
+     */
+    async getSystemMetrics(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSystemMetrics> {
+        const response = await this.getSystemMetricsRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getSystemPortal without sending the request
+     */
+    async getSystemPortalRequestOpts(requestParameters: GetSystemPortalRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['portalId'] == null) {
+            throw new runtime.RequiredError(
+                'portalId',
+                'Required parameter "portalId" was null or undefined when calling getSystemPortal().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        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
+     */
+    async getSystemPortalRaw(requestParameters: GetSystemPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortal>> {
+        const requestOptions = await this.getSystemPortalRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetPortalFromJSON(jsonValue));
+    }
+
+    /**
+     * Get platform portal detail
+     */
+    async getSystemPortal(requestParameters: GetSystemPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortal> {
+        const response = await this.getSystemPortalRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getSystemPortals without sending the request
+     */
+    async getSystemPortalsRequestOpts(requestParameters: GetSystemPortalsRequest): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['pageSize'] != null) {
+            queryParameters['pageSize'] = requestParameters['pageSize'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/system/portals`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * List all platform portals
+     */
+    async getSystemPortalsRaw(requestParameters: GetSystemPortalsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortalList>> {
+        const requestOptions = await this.getSystemPortalsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetPortalListFromJSON(jsonValue));
+    }
+
+    /**
+     * List all platform portals
+     */
+    async getSystemPortals(requestParameters: GetSystemPortalsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalList> {
+        const response = await this.getSystemPortalsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getSystemSupportTickets without sending the request
+     */
+    async getSystemSupportTicketsRequestOpts(requestParameters: GetSystemSupportTicketsRequest): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['pageSize'] != null) {
+            queryParameters['pageSize'] = requestParameters['pageSize'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/system/support/tickets`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * List open support tickets across the platform
+     */
+    async getSystemSupportTicketsRaw(requestParameters: GetSystemSupportTicketsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSupportTicketList>> {
+        const requestOptions = await this.getSystemSupportTicketsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetSupportTicketListFromJSON(jsonValue));
+    }
+
+    /**
+     * List open support tickets across the platform
+     */
+    async getSystemSupportTickets(requestParameters: GetSystemSupportTicketsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSupportTicketList> {
+        const response = await this.getSystemSupportTicketsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/index.ts

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