@easyedu/js-lsm-api 1.130.0 → 1.132.0

package/dist/esm/apis/ReportingApi.js

@@ -24,10 +24,58 @@ import * as runtime from '../runtime';
 import { GetCourseVersionReportingFromJSON, } from '../models/GetCourseVersionReporting';
 import { GetCourseVersionSectionReportingFromJSON, } from '../models/GetCourseVersionSectionReporting';
 import { GetPortalManagementDashboardFromJSON, } from '../models/GetPortalManagementDashboard';
+import { GetReportCatalogFromJSON, } from '../models/GetReportCatalog';
+import { GetReportQueryResultFromJSON, } from '../models/GetReportQueryResult';
+import { PostReportExportToJSON, } from '../models/PostReportExport';
+import { PostReportQueryToJSON, } from '../models/PostReportQuery';
 /**
  *
  */
 export class ReportingApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for exportReport without sending the request
+     */
+    exportReportRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['reportKey'] == null) {
+                throw new runtime.RequiredError('reportKey', 'Required parameter "reportKey" was null or undefined when calling exportReport().');
+            }
+            if (requestParameters['postReportExport'] == null) {
+                throw new runtime.RequiredError('postReportExport', 'Required parameter "postReportExport" was null or undefined when calling exportReport().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            let urlPath = `/reporting/reports/{reportKey}/export`;
+            urlPath = urlPath.replace('{reportKey}', encodeURIComponent(String(requestParameters['reportKey'])));
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: PostReportExportToJSON(requestParameters['postReportExport']),
+            };
+        });
+    }
+    /**
+     * Export all rows of a report as CSV or XLSX
+     */
+    exportReportRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.exportReportRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.BlobApiResponse(response);
+        });
+    }
+    /**
+     * Export all rows of a report as CSV or XLSX
+     */
+    exportReport(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.exportReportRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates request options for getCourseVersionReporting without sending the request
      */
@@ -156,4 +204,87 @@ export class ReportingApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Creates request options for getReportCatalog without sending the request
+     */
+    getReportCatalogRequestOpts() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/reporting/reports`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Returns report definitions with columns, supported filters, select options resolved for the selected portal, and default sort. Reports whose permission the caller lacks are omitted.
+     * List the reports the caller can run in the selected portal
+     */
+    getReportCatalogRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getReportCatalogRequestOpts();
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => GetReportCatalogFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns report definitions with columns, supported filters, select options resolved for the selected portal, and default sort. Reports whose permission the caller lacks are omitted.
+     * List the reports the caller can run in the selected portal
+     */
+    getReportCatalog(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getReportCatalogRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for queryReport without sending the request
+     */
+    queryReportRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['reportKey'] == null) {
+                throw new runtime.RequiredError('reportKey', 'Required parameter "reportKey" was null or undefined when calling queryReport().');
+            }
+            if (requestParameters['postReportQuery'] == null) {
+                throw new runtime.RequiredError('postReportQuery', 'Required parameter "postReportQuery" was null or undefined when calling queryReport().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            let urlPath = `/reporting/reports/{reportKey}/query`;
+            urlPath = urlPath.replace('{reportKey}', encodeURIComponent(String(requestParameters['reportKey'])));
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: PostReportQueryToJSON(requestParameters['postReportQuery']),
+            };
+        });
+    }
+    /**
+     * Read-only. POST is used because filters vary per report. Results are scoped to the selected portal and its team portals.
+     * Run a report and return one page of rows
+     */
+    queryReportRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.queryReportRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => GetReportQueryResultFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Read-only. POST is used because filters vary per report. Results are scoped to the selected portal and its team portals.
+     * Run a report and return one page of rows
+     */
+    queryReport(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.queryReportRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
 }

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

@@ -15,6 +15,7 @@ import { type GetPortalList } from '../models/GetPortalList';
 import { type GetSupportTicketList } from '../models/GetSupportTicketList';
 import { type GetSystemBillingList } from '../models/GetSystemBillingList';
 import { type GetSystemMetrics } from '../models/GetSystemMetrics';
+import { type GetSystemPortalOverview } from '../models/GetSystemPortalOverview';
 export interface GetSystemBillingRequest {
     page?: number;
     pageSize?: number;
@@ -22,6 +23,9 @@ export interface GetSystemBillingRequest {
 export interface GetSystemPortalRequest {
     portalId: string;
 }
+export interface GetSystemPortalOverviewRequest {
+    portalId: string;
+}
 export interface GetSystemPortalsRequest {
     page?: number;
     pageSize?: number;
@@ -70,6 +74,18 @@ export declare class SystemApi extends runtime.BaseAPI {
      * Get platform portal detail
      */
     getSystemPortal(requestParameters: GetSystemPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortal>;
+    /**
+     * Creates request options for getSystemPortalOverview without sending the request
+     */
+    getSystemPortalOverviewRequestOpts(requestParameters: GetSystemPortalOverviewRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get detailed platform portal overview and usage statistics
+     */
+    getSystemPortalOverviewRaw(requestParameters: GetSystemPortalOverviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSystemPortalOverview>>;
+    /**
+     * Get detailed platform portal overview and usage statistics
+     */
+    getSystemPortalOverview(requestParameters: GetSystemPortalOverviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSystemPortalOverview>;
     /**
      * Creates request options for getSystemPortals without sending the request
      */

package/dist/esm/apis/SystemApi.js

@@ -26,6 +26,7 @@ import { GetPortalListFromJSON, } from '../models/GetPortalList';
 import { GetSupportTicketListFromJSON, } from '../models/GetSupportTicketList';
 import { GetSystemBillingListFromJSON, } from '../models/GetSystemBillingList';
 import { GetSystemMetricsFromJSON, } from '../models/GetSystemMetrics';
+import { GetSystemPortalOverviewFromJSON, } from '../models/GetSystemPortalOverview';
 /**
  *
  */
@@ -145,6 +146,45 @@ export class SystemApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Creates request options for getSystemPortalOverview without sending the request
+     */
+    getSystemPortalOverviewRequestOpts(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 getSystemPortalOverview().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/system/portals/{portalId}/overview`;
+            urlPath = urlPath.replace('{portalId}', encodeURIComponent(String(requestParameters['portalId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Get detailed platform portal overview and usage statistics
+     */
+    getSystemPortalOverviewRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getSystemPortalOverviewRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => GetSystemPortalOverviewFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Get detailed platform portal overview and usage statistics
+     */
+    getSystemPortalOverview(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getSystemPortalOverviewRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates request options for getSystemPortals without sending the request
      */

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

@@ -0,0 +1,40 @@
+/**
+ * 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 { ReportCategory } from './ReportCategory';
+import type { ReportDefinition } from './ReportDefinition';
+/**
+ * Reports the caller may run in the selected portal.
+ * @export
+ * @interface GetReportCatalog
+ */
+export interface GetReportCatalog {
+    /**
+     *
+     * @type {Array<ReportCategory>}
+     * @memberof GetReportCatalog
+     */
+    categories: Array<ReportCategory>;
+    /**
+     *
+     * @type {Array<ReportDefinition>}
+     * @memberof GetReportCatalog
+     */
+    reports: Array<ReportDefinition>;
+}
+/**
+ * Check if a given object implements the GetReportCatalog interface.
+ */
+export declare function instanceOfGetReportCatalog(value: object): value is GetReportCatalog;
+export declare function GetReportCatalogFromJSON(json: any): GetReportCatalog;
+export declare function GetReportCatalogFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetReportCatalog;
+export declare function GetReportCatalogToJSON(json: any): GetReportCatalog;
+export declare function GetReportCatalogToJSONTyped(value?: GetReportCatalog | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetReportCatalog.js

@@ -0,0 +1,49 @@
+/* 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 { ReportCategoryFromJSON, ReportCategoryToJSON, } from './ReportCategory';
+import { ReportDefinitionFromJSON, ReportDefinitionToJSON, } from './ReportDefinition';
+/**
+ * Check if a given object implements the GetReportCatalog interface.
+ */
+export function instanceOfGetReportCatalog(value) {
+    if (!('categories' in value) || value['categories'] === undefined)
+        return false;
+    if (!('reports' in value) || value['reports'] === undefined)
+        return false;
+    return true;
+}
+export function GetReportCatalogFromJSON(json) {
+    return GetReportCatalogFromJSONTyped(json, false);
+}
+export function GetReportCatalogFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'categories': (json['categories'].map(ReportCategoryFromJSON)),
+        'reports': (json['reports'].map(ReportDefinitionFromJSON)),
+    };
+}
+export function GetReportCatalogToJSON(json) {
+    return GetReportCatalogToJSONTyped(json, false);
+}
+export function GetReportCatalogToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'categories': (value['categories'].map(ReportCategoryToJSON)),
+        'reports': (value['reports'].map(ReportDefinitionToJSON)),
+    };
+}

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

@@ -0,0 +1,84 @@
+/**
+ * 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 { ReportColumn } from './ReportColumn';
+import type { ReportSort } from './ReportSort';
+/**
+ *
+ * @export
+ * @interface GetReportQueryResult
+ */
+export interface GetReportQueryResult {
+    /**
+     *
+     * @type {string}
+     * @memberof GetReportQueryResult
+     */
+    reportKey: string;
+    /**
+     *
+     * @type {Array<ReportColumn>}
+     * @memberof GetReportQueryResult
+     */
+    columns: Array<ReportColumn>;
+    /**
+     * One object per row, keyed by column key.
+     * @type {Array<{ [key: string]: any; }>}
+     * @memberof GetReportQueryResult
+     */
+    rows: Array<{
+        [key: string]: any;
+    }>;
+    /**
+     *
+     * @type {ReportSort}
+     * @memberof GetReportQueryResult
+     */
+    sort: ReportSort;
+    /**
+     *
+     * @type {number}
+     * @memberof GetReportQueryResult
+     */
+    page: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetReportQueryResult
+     */
+    pageSize: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetReportQueryResult
+     */
+    totalItems: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetReportQueryResult
+     */
+    totalPages: number;
+    /**
+     * Unix timestamp in seconds.
+     * @type {number}
+     * @memberof GetReportQueryResult
+     */
+    generatedAt: number;
+}
+/**
+ * Check if a given object implements the GetReportQueryResult interface.
+ */
+export declare function instanceOfGetReportQueryResult(value: object): value is GetReportQueryResult;
+export declare function GetReportQueryResultFromJSON(json: any): GetReportQueryResult;
+export declare function GetReportQueryResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetReportQueryResult;
+export declare function GetReportQueryResultToJSON(json: any): GetReportQueryResult;
+export declare function GetReportQueryResultToJSONTyped(value?: GetReportQueryResult | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetReportQueryResult.js

@@ -0,0 +1,77 @@
+/* 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 { ReportColumnFromJSON, ReportColumnToJSON, } from './ReportColumn';
+import { ReportSortFromJSON, ReportSortToJSON, } from './ReportSort';
+/**
+ * Check if a given object implements the GetReportQueryResult interface.
+ */
+export function instanceOfGetReportQueryResult(value) {
+    if (!('reportKey' in value) || value['reportKey'] === undefined)
+        return false;
+    if (!('columns' in value) || value['columns'] === undefined)
+        return false;
+    if (!('rows' in value) || value['rows'] === undefined)
+        return false;
+    if (!('sort' in value) || value['sort'] === undefined)
+        return false;
+    if (!('page' in value) || value['page'] === undefined)
+        return false;
+    if (!('pageSize' in value) || value['pageSize'] === undefined)
+        return false;
+    if (!('totalItems' in value) || value['totalItems'] === undefined)
+        return false;
+    if (!('totalPages' in value) || value['totalPages'] === undefined)
+        return false;
+    if (!('generatedAt' in value) || value['generatedAt'] === undefined)
+        return false;
+    return true;
+}
+export function GetReportQueryResultFromJSON(json) {
+    return GetReportQueryResultFromJSONTyped(json, false);
+}
+export function GetReportQueryResultFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'reportKey': json['report_key'],
+        'columns': (json['columns'].map(ReportColumnFromJSON)),
+        'rows': json['rows'],
+        'sort': ReportSortFromJSON(json['sort']),
+        'page': json['page'],
+        'pageSize': json['page_size'],
+        'totalItems': json['total_items'],
+        'totalPages': json['total_pages'],
+        'generatedAt': json['generated_at'],
+    };
+}
+export function GetReportQueryResultToJSON(json) {
+    return GetReportQueryResultToJSONTyped(json, false);
+}
+export function GetReportQueryResultToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'report_key': value['reportKey'],
+        'columns': (value['columns'].map(ReportColumnToJSON)),
+        'rows': value['rows'],
+        'sort': ReportSortToJSON(value['sort']),
+        'page': value['page'],
+        'page_size': value['pageSize'],
+        'total_items': value['totalItems'],
+        'total_pages': value['totalPages'],
+        'generated_at': value['generatedAt'],
+    };
+}

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

@@ -0,0 +1,121 @@
+/**
+ * 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 { SystemPortalCourseStats } from './SystemPortalCourseStats';
+import type { SystemPortalLicense } from './SystemPortalLicense';
+import type { SystemPortalCertificateStats } from './SystemPortalCertificateStats';
+import type { SystemPortalStorageUsage } from './SystemPortalStorageUsage';
+import type { SystemPortalSupportStats } from './SystemPortalSupportStats';
+import type { GetPortal } from './GetPortal';
+import type { SystemPortalEnrollmentStats } from './SystemPortalEnrollmentStats';
+import type { SystemPortalActivityStats } from './SystemPortalActivityStats';
+import type { SystemPortalContentStats } from './SystemPortalContentStats';
+import type { SystemPortalHierarchy } from './SystemPortalHierarchy';
+import type { SystemPortalUserStats } from './SystemPortalUserStats';
+/**
+ * Detailed read-only overview of a single portal for platform administrators. All counts are scoped to the portal itself and exclude child portals. Timestamps are Unix epoch seconds (UTC).
+ * @export
+ * @interface GetSystemPortalOverview
+ */
+export interface GetSystemPortalOverview {
+    /**
+     *
+     * @type {GetPortal}
+     * @memberof GetSystemPortalOverview
+     */
+    portal: GetPortal;
+    /**
+     *
+     * @type {number}
+     * @memberof GetSystemPortalOverview
+     */
+    createdAt: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetSystemPortalOverview
+     */
+    updatedAt: number;
+    /**
+     * When these statistics were computed.
+     * @type {number}
+     * @memberof GetSystemPortalOverview
+     */
+    generatedAt: number;
+    /**
+     *
+     * @type {SystemPortalHierarchy}
+     * @memberof GetSystemPortalOverview
+     */
+    hierarchy: SystemPortalHierarchy;
+    /**
+     *
+     * @type {SystemPortalLicense}
+     * @memberof GetSystemPortalOverview
+     */
+    license: SystemPortalLicense;
+    /**
+     *
+     * @type {SystemPortalUserStats}
+     * @memberof GetSystemPortalOverview
+     */
+    users: SystemPortalUserStats;
+    /**
+     *
+     * @type {SystemPortalCourseStats}
+     * @memberof GetSystemPortalOverview
+     */
+    courses: SystemPortalCourseStats;
+    /**
+     *
+     * @type {SystemPortalEnrollmentStats}
+     * @memberof GetSystemPortalOverview
+     */
+    enrollments: SystemPortalEnrollmentStats;
+    /**
+     *
+     * @type {SystemPortalContentStats}
+     * @memberof GetSystemPortalOverview
+     */
+    content: SystemPortalContentStats;
+    /**
+     *
+     * @type {SystemPortalCertificateStats}
+     * @memberof GetSystemPortalOverview
+     */
+    certificates: SystemPortalCertificateStats;
+    /**
+     *
+     * @type {SystemPortalStorageUsage}
+     * @memberof GetSystemPortalOverview
+     */
+    storage: SystemPortalStorageUsage;
+    /**
+     *
+     * @type {SystemPortalActivityStats}
+     * @memberof GetSystemPortalOverview
+     */
+    activity: SystemPortalActivityStats;
+    /**
+     *
+     * @type {SystemPortalSupportStats}
+     * @memberof GetSystemPortalOverview
+     */
+    support: SystemPortalSupportStats;
+}
+/**
+ * Check if a given object implements the GetSystemPortalOverview interface.
+ */
+export declare function instanceOfGetSystemPortalOverview(value: object): value is GetSystemPortalOverview;
+export declare function GetSystemPortalOverviewFromJSON(json: any): GetSystemPortalOverview;
+export declare function GetSystemPortalOverviewFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetSystemPortalOverview;
+export declare function GetSystemPortalOverviewToJSON(json: any): GetSystemPortalOverview;
+export declare function GetSystemPortalOverviewToJSONTyped(value?: GetSystemPortalOverview | null, ignoreDiscriminator?: boolean): any;