@easyedu/js-lsm-api 1.70.0 → 1.72.0

package/src/models/GetSystemBillingItem.ts

@@ -0,0 +1,136 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * 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 function instanceOfGetSystemBillingItem(value: object): value is GetSystemBillingItem {
+    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;
+}
+
+export function GetSystemBillingItemFromJSON(json: any): GetSystemBillingItem {
+    return GetSystemBillingItemFromJSONTyped(json, false);
+}
+
+export function GetSystemBillingItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetSystemBillingItem {
+    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'],
+    };
+}
+
+export function GetSystemBillingItemToJSON(json: any): GetSystemBillingItem {
+    return GetSystemBillingItemToJSONTyped(json, false);
+}
+
+export function GetSystemBillingItemToJSONTyped(value?: GetSystemBillingItem | null, ignoreDiscriminator: boolean = false): any {
+    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/src/models/GetSystemBillingList.ts

@@ -0,0 +1,110 @@
+/* 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 { mapValues } from '../runtime';
+import type { GetSystemBillingItem } from './GetSystemBillingItem';
+import {
+    GetSystemBillingItemFromJSON,
+    GetSystemBillingItemFromJSONTyped,
+    GetSystemBillingItemToJSON,
+    GetSystemBillingItemToJSONTyped,
+} 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 function instanceOfGetSystemBillingList(value: object): value is GetSystemBillingList {
+    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;
+}
+
+export function GetSystemBillingListFromJSON(json: any): GetSystemBillingList {
+    return GetSystemBillingListFromJSONTyped(json, false);
+}
+
+export function GetSystemBillingListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetSystemBillingList {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'page': json['page'],
+        'pageSize': json['pageSize'],
+        'totalPages': json['totalPages'],
+        'totalItems': json['totalItems'],
+        'items': ((json['items'] as Array<any>).map(GetSystemBillingItemFromJSON)),
+    };
+}
+
+export function GetSystemBillingListToJSON(json: any): GetSystemBillingList {
+    return GetSystemBillingListToJSONTyped(json, false);
+}
+
+export function GetSystemBillingListToJSONTyped(value?: GetSystemBillingList | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'page': value['page'],
+        'pageSize': value['pageSize'],
+        'totalPages': value['totalPages'],
+        'totalItems': value['totalItems'],
+        'items': ((value['items'] as Array<any>).map(GetSystemBillingItemToJSON)),
+    };
+}
+

package/src/models/GetSystemMetrics.ts

@@ -0,0 +1,93 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * 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 function instanceOfGetSystemMetrics(value: object): value is GetSystemMetrics {
+    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;
+}
+
+export function GetSystemMetricsFromJSON(json: any): GetSystemMetrics {
+    return GetSystemMetricsFromJSONTyped(json, false);
+}
+
+export function GetSystemMetricsFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetSystemMetrics {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'portalCount': json['portal_count'],
+        'userCount': json['user_count'],
+        'courseCount': json['course_count'],
+        'openSupportTicketCount': json['open_support_ticket_count'],
+    };
+}
+
+export function GetSystemMetricsToJSON(json: any): GetSystemMetrics {
+    return GetSystemMetricsToJSONTyped(json, false);
+}
+
+export function GetSystemMetricsToJSONTyped(value?: GetSystemMetrics | null, ignoreDiscriminator: boolean = false): any {
+    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/src/models/index.ts

@@ -149,6 +149,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';