@easyedu/js-lsm-api 1.70.0 → 1.72.0

package/dist/models/GetSystemBillingItem.d.ts

@@ -0,0 +1,80 @@
+/**
+ * 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.
+ */
+/**
+ * Mock per-portal billing summary for platform administrators.
+ * @export
+ * @interface GetSystemBillingItem
+ */
+export interface GetSystemBillingItem {
+    /**
+     *
+     * @type {string}
+     * @memberof GetSystemBillingItem
+     */
+    portalId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetSystemBillingItem
+     */
+    portalName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetSystemBillingItem
+     */
+    plan: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetSystemBillingItem
+     */
+    status: string;
+    /**
+     *
+     * @type {number}
+     * @memberof GetSystemBillingItem
+     */
+    seatLimit?: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof GetSystemBillingItem
+     */
+    activeEnrollmentCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetSystemBillingItem
+     */
+    monthlyAmountCents: number;
+    /**
+     *
+     * @type {string}
+     * @memberof GetSystemBillingItem
+     */
+    currency: string;
+    /**
+     *
+     * @type {number}
+     * @memberof GetSystemBillingItem
+     */
+    renewalAt?: number | null;
+}
+/**
+ * Check if a given object implements the GetSystemBillingItem interface.
+ */
+export declare function instanceOfGetSystemBillingItem(value: object): value is GetSystemBillingItem;
+export declare function GetSystemBillingItemFromJSON(json: any): GetSystemBillingItem;
+export declare function GetSystemBillingItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetSystemBillingItem;
+export declare function GetSystemBillingItemToJSON(json: any): GetSystemBillingItem;
+export declare function GetSystemBillingItemToJSONTyped(value?: GetSystemBillingItem | null, ignoreDiscriminator?: boolean): any;

package/dist/models/GetSystemBillingItem.js

@@ -0,0 +1,78 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfGetSystemBillingItem = instanceOfGetSystemBillingItem;
+exports.GetSystemBillingItemFromJSON = GetSystemBillingItemFromJSON;
+exports.GetSystemBillingItemFromJSONTyped = GetSystemBillingItemFromJSONTyped;
+exports.GetSystemBillingItemToJSON = GetSystemBillingItemToJSON;
+exports.GetSystemBillingItemToJSONTyped = GetSystemBillingItemToJSONTyped;
+/**
+ * Check if a given object implements the GetSystemBillingItem interface.
+ */
+function instanceOfGetSystemBillingItem(value) {
+    if (!('portalId' in value) || value['portalId'] === undefined)
+        return false;
+    if (!('portalName' in value) || value['portalName'] === undefined)
+        return false;
+    if (!('plan' in value) || value['plan'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('activeEnrollmentCount' in value) || value['activeEnrollmentCount'] === undefined)
+        return false;
+    if (!('monthlyAmountCents' in value) || value['monthlyAmountCents'] === undefined)
+        return false;
+    if (!('currency' in value) || value['currency'] === undefined)
+        return false;
+    return true;
+}
+function GetSystemBillingItemFromJSON(json) {
+    return GetSystemBillingItemFromJSONTyped(json, false);
+}
+function GetSystemBillingItemFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'portalId': json['portal_id'],
+        'portalName': json['portal_name'],
+        'plan': json['plan'],
+        'status': json['status'],
+        'seatLimit': json['seat_limit'] == null ? undefined : json['seat_limit'],
+        'activeEnrollmentCount': json['active_enrollment_count'],
+        'monthlyAmountCents': json['monthly_amount_cents'],
+        'currency': json['currency'],
+        'renewalAt': json['renewal_at'] == null ? undefined : json['renewal_at'],
+    };
+}
+function GetSystemBillingItemToJSON(json) {
+    return GetSystemBillingItemToJSONTyped(json, false);
+}
+function GetSystemBillingItemToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'portal_id': value['portalId'],
+        'portal_name': value['portalName'],
+        'plan': value['plan'],
+        'status': value['status'],
+        'seat_limit': value['seatLimit'],
+        'active_enrollment_count': value['activeEnrollmentCount'],
+        'monthly_amount_cents': value['monthlyAmountCents'],
+        'currency': value['currency'],
+        'renewal_at': value['renewalAt'],
+    };
+}

package/dist/models/GetSystemBillingList.d.ts

@@ -0,0 +1,57 @@
+/**
+ * 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 type { GetSystemBillingItem } from './GetSystemBillingItem';
+/**
+ *
+ * @export
+ * @interface GetSystemBillingList
+ */
+export interface GetSystemBillingList {
+    /**
+     * The current page number
+     * @type {number}
+     * @memberof GetSystemBillingList
+     */
+    page: number;
+    /**
+     * The number of items per page
+     * @type {number}
+     * @memberof GetSystemBillingList
+     */
+    pageSize: number;
+    /**
+     * The total number of pages
+     * @type {number}
+     * @memberof GetSystemBillingList
+     */
+    totalPages: number;
+    /**
+     * The total number of items
+     * @type {number}
+     * @memberof GetSystemBillingList
+     */
+    totalItems: number;
+    /**
+     *
+     * @type {Array<GetSystemBillingItem>}
+     * @memberof GetSystemBillingList
+     */
+    items: Array<GetSystemBillingItem>;
+}
+/**
+ * Check if a given object implements the GetSystemBillingList interface.
+ */
+export declare function instanceOfGetSystemBillingList(value: object): value is GetSystemBillingList;
+export declare function GetSystemBillingListFromJSON(json: any): GetSystemBillingList;
+export declare function GetSystemBillingListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetSystemBillingList;
+export declare function GetSystemBillingListToJSON(json: any): GetSystemBillingList;
+export declare function GetSystemBillingListToJSONTyped(value?: GetSystemBillingList | null, ignoreDiscriminator?: boolean): any;

package/dist/models/GetSystemBillingList.js

@@ -0,0 +1,67 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfGetSystemBillingList = instanceOfGetSystemBillingList;
+exports.GetSystemBillingListFromJSON = GetSystemBillingListFromJSON;
+exports.GetSystemBillingListFromJSONTyped = GetSystemBillingListFromJSONTyped;
+exports.GetSystemBillingListToJSON = GetSystemBillingListToJSON;
+exports.GetSystemBillingListToJSONTyped = GetSystemBillingListToJSONTyped;
+const GetSystemBillingItem_1 = require("./GetSystemBillingItem");
+/**
+ * Check if a given object implements the GetSystemBillingList interface.
+ */
+function instanceOfGetSystemBillingList(value) {
+    if (!('page' in value) || value['page'] === undefined)
+        return false;
+    if (!('pageSize' in value) || value['pageSize'] === undefined)
+        return false;
+    if (!('totalPages' in value) || value['totalPages'] === undefined)
+        return false;
+    if (!('totalItems' in value) || value['totalItems'] === undefined)
+        return false;
+    if (!('items' in value) || value['items'] === undefined)
+        return false;
+    return true;
+}
+function GetSystemBillingListFromJSON(json) {
+    return GetSystemBillingListFromJSONTyped(json, false);
+}
+function GetSystemBillingListFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'page': json['page'],
+        'pageSize': json['pageSize'],
+        'totalPages': json['totalPages'],
+        'totalItems': json['totalItems'],
+        'items': (json['items'].map(GetSystemBillingItem_1.GetSystemBillingItemFromJSON)),
+    };
+}
+function GetSystemBillingListToJSON(json) {
+    return GetSystemBillingListToJSONTyped(json, false);
+}
+function GetSystemBillingListToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'page': value['page'],
+        'pageSize': value['pageSize'],
+        'totalPages': value['totalPages'],
+        'totalItems': value['totalItems'],
+        'items': (value['items'].map(GetSystemBillingItem_1.GetSystemBillingItemToJSON)),
+    };
+}

package/dist/models/GetSystemMetrics.d.ts

@@ -0,0 +1,50 @@
+/**
+ * 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.
+ */
+/**
+ * Platform-wide read-only metrics for platform administrators.
+ * @export
+ * @interface GetSystemMetrics
+ */
+export interface GetSystemMetrics {
+    /**
+     *
+     * @type {number}
+     * @memberof GetSystemMetrics
+     */
+    portalCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetSystemMetrics
+     */
+    userCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetSystemMetrics
+     */
+    courseCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetSystemMetrics
+     */
+    openSupportTicketCount: number;
+}
+/**
+ * Check if a given object implements the GetSystemMetrics interface.
+ */
+export declare function instanceOfGetSystemMetrics(value: object): value is GetSystemMetrics;
+export declare function GetSystemMetricsFromJSON(json: any): GetSystemMetrics;
+export declare function GetSystemMetricsFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetSystemMetrics;
+export declare function GetSystemMetricsToJSON(json: any): GetSystemMetrics;
+export declare function GetSystemMetricsToJSONTyped(value?: GetSystemMetrics | null, ignoreDiscriminator?: boolean): any;

package/dist/models/GetSystemMetrics.js

@@ -0,0 +1,62 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfGetSystemMetrics = instanceOfGetSystemMetrics;
+exports.GetSystemMetricsFromJSON = GetSystemMetricsFromJSON;
+exports.GetSystemMetricsFromJSONTyped = GetSystemMetricsFromJSONTyped;
+exports.GetSystemMetricsToJSON = GetSystemMetricsToJSON;
+exports.GetSystemMetricsToJSONTyped = GetSystemMetricsToJSONTyped;
+/**
+ * Check if a given object implements the GetSystemMetrics interface.
+ */
+function instanceOfGetSystemMetrics(value) {
+    if (!('portalCount' in value) || value['portalCount'] === undefined)
+        return false;
+    if (!('userCount' in value) || value['userCount'] === undefined)
+        return false;
+    if (!('courseCount' in value) || value['courseCount'] === undefined)
+        return false;
+    if (!('openSupportTicketCount' in value) || value['openSupportTicketCount'] === undefined)
+        return false;
+    return true;
+}
+function GetSystemMetricsFromJSON(json) {
+    return GetSystemMetricsFromJSONTyped(json, false);
+}
+function GetSystemMetricsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'portalCount': json['portal_count'],
+        'userCount': json['user_count'],
+        'courseCount': json['course_count'],
+        'openSupportTicketCount': json['open_support_ticket_count'],
+    };
+}
+function GetSystemMetricsToJSON(json) {
+    return GetSystemMetricsToJSONTyped(json, false);
+}
+function GetSystemMetricsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'portal_count': value['portalCount'],
+        'user_count': value['userCount'],
+        'course_count': value['courseCount'],
+        'open_support_ticket_count': value['openSupportTicketCount'],
+    };
+}

package/dist/models/index.d.ts

@@ -147,6 +147,9 @@ export * from './GetSupportTicket';
 export * from './GetSupportTicketAttachment';
 export * from './GetSupportTicketComment';
 export * from './GetSupportTicketList';
+export * from './GetSystemBillingItem';
+export * from './GetSystemBillingList';
+export * from './GetSystemMetrics';
 export * from './GetUser';
 export * from './GetUserAvatarUpload';
 export * from './GetUserQuizAttempts';

package/dist/models/index.js

@@ -165,6 +165,9 @@ __exportStar(require("./GetSupportTicket"), exports);
 __exportStar(require("./GetSupportTicketAttachment"), exports);
 __exportStar(require("./GetSupportTicketComment"), exports);
 __exportStar(require("./GetSupportTicketList"), exports);
+__exportStar(require("./GetSystemBillingItem"), exports);
+__exportStar(require("./GetSystemBillingList"), exports);
+__exportStar(require("./GetSystemMetrics"), exports);
 __exportStar(require("./GetUser"), exports);
 __exportStar(require("./GetUserAvatarUpload"), exports);
 __exportStar(require("./GetUserQuizAttempts"), exports);

package/docs/GetSystemBillingItem.md

@@ -0,0 +1,51 @@
+
+# GetSystemBillingItem
+
+Mock per-portal billing summary for platform administrators.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`portalId` | string
+`portalName` | string
+`plan` | string
+`status` | string
+`seatLimit` | number
+`activeEnrollmentCount` | number
+`monthlyAmountCents` | number
+`currency` | string
+`renewalAt` | number
+
+## Example
+
+```typescript
+import type { GetSystemBillingItem } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "portalId": null,
+  "portalName": null,
+  "plan": null,
+  "status": null,
+  "seatLimit": null,
+  "activeEnrollmentCount": null,
+  "monthlyAmountCents": null,
+  "currency": null,
+  "renewalAt": null,
+} satisfies GetSystemBillingItem
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetSystemBillingItem
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GetSystemBillingList.md

@@ -0,0 +1,42 @@
+
+# GetSystemBillingList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`page` | number
+`pageSize` | number
+`totalPages` | number
+`totalItems` | number
+`items` | [Array<GetSystemBillingItem>](GetSystemBillingItem.md)
+
+## Example
+
+```typescript
+import type { GetSystemBillingList } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "page": null,
+  "pageSize": null,
+  "totalPages": null,
+  "totalItems": null,
+  "items": null,
+} satisfies GetSystemBillingList
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetSystemBillingList
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GetSystemMetrics.md

@@ -0,0 +1,41 @@
+
+# GetSystemMetrics
+
+Platform-wide read-only metrics for platform administrators.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`portalCount` | number
+`userCount` | number
+`courseCount` | number
+`openSupportTicketCount` | number
+
+## Example
+
+```typescript
+import type { GetSystemMetrics } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "portalCount": null,
+  "userCount": null,
+  "courseCount": null,
+  "openSupportTicketCount": null,
+} satisfies GetSystemMetrics
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetSystemMetrics
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+