@easyedu/js-lsm-api 1.70.0 → 1.72.0

package/dist/esm/apis/SystemApi.js

@@ -0,0 +1,230 @@
+/* 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());
+    });
+};
+import * as runtime from '../runtime';
+import { GetPortalFromJSON, } from '../models/GetPortal';
+import { GetPortalListFromJSON, } from '../models/GetPortalList';
+import { GetSupportTicketListFromJSON, } from '../models/GetSupportTicketList';
+import { GetSystemBillingListFromJSON, } from '../models/GetSystemBillingList';
+import { GetSystemMetricsFromJSON, } from '../models/GetSystemMetrics';
+/**
+ *
+ */
+export 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) => 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) => 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) => 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) => 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) => 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();
+        });
+    }
+}

package/dist/esm/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/esm/apis/index.js

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

package/dist/esm/models/GetCourseStudentReportingPerformance.d.ts

@@ -16,7 +16,7 @@
  */
 export interface GetCourseStudentReportingPerformance {
     /**
-     * Average score percentage across all modules
+     * Average of scored quiz and SCORM content rollups in the course, using each content item's score rollup strategy. Null when no score is available.
      * @type {number}
      * @memberof GetCourseStudentReportingPerformance
      */

package/dist/esm/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/esm/models/GetSystemBillingItem.js

@@ -0,0 +1,71 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the GetSystemBillingItem interface.
+ */
+export 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;
+}
+export function GetSystemBillingItemFromJSON(json) {
+    return GetSystemBillingItemFromJSONTyped(json, false);
+}
+export 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'],
+    };
+}
+export function GetSystemBillingItemToJSON(json) {
+    return GetSystemBillingItemToJSONTyped(json, false);
+}
+export 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/esm/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/esm/models/GetSystemBillingList.js

@@ -0,0 +1,60 @@
+/* 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 { GetSystemBillingItemFromJSON, GetSystemBillingItemToJSON, } from './GetSystemBillingItem';
+/**
+ * Check if a given object implements the GetSystemBillingList interface.
+ */
+export 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;
+}
+export function GetSystemBillingListFromJSON(json) {
+    return GetSystemBillingListFromJSONTyped(json, false);
+}
+export 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(GetSystemBillingItemFromJSON)),
+    };
+}
+export function GetSystemBillingListToJSON(json) {
+    return GetSystemBillingListToJSONTyped(json, false);
+}
+export 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(GetSystemBillingItemToJSON)),
+    };
+}

package/dist/esm/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/esm/models/GetSystemMetrics.js

@@ -0,0 +1,55 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the GetSystemMetrics interface.
+ */
+export 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;
+}
+export function GetSystemMetricsFromJSON(json) {
+    return GetSystemMetricsFromJSONTyped(json, false);
+}
+export 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'],
+    };
+}
+export function GetSystemMetricsToJSON(json) {
+    return GetSystemMetricsToJSONTyped(json, false);
+}
+export 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/esm/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/esm/models/index.js

@@ -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';

package/dist/models/GetCourseStudentReportingPerformance.d.ts

@@ -16,7 +16,7 @@
  */
 export interface GetCourseStudentReportingPerformance {
     /**
-     * Average score percentage across all modules
+     * Average of scored quiz and SCORM content rollups in the course, using each content item's score rollup strategy. Null when no score is available.
      * @type {number}
      * @memberof GetCourseStudentReportingPerformance
      */