@easyedu/js-lsm-api 1.130.0 → 1.132.0

package/docs/SystemPortalSupportStats.md

@@ -0,0 +1,40 @@
+
+# SystemPortalSupportStats
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`open` | number
+`inProgress` | number
+`closed` | number
+`total` | number
+
+## Example
+
+```typescript
+import type { SystemPortalSupportStats } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "open": null,
+  "inProgress": null,
+  "closed": null,
+  "total": null,
+} satisfies SystemPortalSupportStats
+
+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 SystemPortalSupportStats
+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/SystemPortalUserStats.md

@@ -0,0 +1,50 @@
+
+# SystemPortalUserStats
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`total` | number
+`enabled` | number
+`disabled` | number
+`newLast30Days` | number
+`activeLast7Days` | number
+`activeLast30Days` | number
+`pendingInvitations` | number
+`lastLoginAt` | number
+`byRole` | [Array<SystemPortalRoleCount>](SystemPortalRoleCount.md)
+
+## Example
+
+```typescript
+import type { SystemPortalUserStats } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "total": null,
+  "enabled": null,
+  "disabled": null,
+  "newLast30Days": null,
+  "activeLast7Days": null,
+  "activeLast30Days": null,
+  "pendingInvitations": null,
+  "lastLoginAt": null,
+  "byRole": null,
+} satisfies SystemPortalUserStats
+
+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 SystemPortalUserStats
+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/package.json

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

package/src/apis/ReportingApi.ts

@@ -28,6 +28,31 @@ import {
     GetPortalManagementDashboardFromJSON,
     GetPortalManagementDashboardToJSON,
 } from '../models/GetPortalManagementDashboard';
+import {
+    type GetReportCatalog,
+    GetReportCatalogFromJSON,
+    GetReportCatalogToJSON,
+} from '../models/GetReportCatalog';
+import {
+    type GetReportQueryResult,
+    GetReportQueryResultFromJSON,
+    GetReportQueryResultToJSON,
+} from '../models/GetReportQueryResult';
+import {
+    type PostReportExport,
+    PostReportExportFromJSON,
+    PostReportExportToJSON,
+} from '../models/PostReportExport';
+import {
+    type PostReportQuery,
+    PostReportQueryFromJSON,
+    PostReportQueryToJSON,
+} from '../models/PostReportQuery';
+
+export interface ExportReportRequest {
+    reportKey: string;
+    postReportExport: PostReportExport;
+}
 
 export interface GetCourseVersionReportingRequest {
     courseId: string;
@@ -44,11 +69,71 @@ export interface GetPortalManagementDashboardRequest {
     days?: number;
 }
 
+export interface QueryReportRequest {
+    reportKey: string;
+    postReportQuery: PostReportQuery;
+}
+
 /**
  * 
  */
 export class ReportingApi extends runtime.BaseAPI {
 
+    /**
+     * Creates request options for exportReport without sending the request
+     */
+    async exportReportRequestOpts(requestParameters: ExportReportRequest): Promise<runtime.RequestOpts> {
+        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: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        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
+     */
+    async exportReportRaw(requestParameters: ExportReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>> {
+        const requestOptions = await this.exportReportRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.BlobApiResponse(response);
+    }
+
+    /**
+     * Export all rows of a report as CSV or XLSX
+     */
+    async exportReport(requestParameters: ExportReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob> {
+        const response = await this.exportReportRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for getCourseVersionReporting without sending the request
      */
@@ -204,4 +289,100 @@ export class ReportingApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for getReportCatalog without sending the request
+     */
+    async getReportCatalogRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        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
+     */
+    async getReportCatalogRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetReportCatalog>> {
+        const requestOptions = await this.getReportCatalogRequestOpts();
+        const response = await 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
+     */
+    async getReportCatalog(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetReportCatalog> {
+        const response = await this.getReportCatalogRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for queryReport without sending the request
+     */
+    async queryReportRequestOpts(requestParameters: QueryReportRequest): Promise<runtime.RequestOpts> {
+        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: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        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
+     */
+    async queryReportRaw(requestParameters: QueryReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetReportQueryResult>> {
+        const requestOptions = await this.queryReportRequestOpts(requestParameters);
+        const response = await 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
+     */
+    async queryReport(requestParameters: QueryReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetReportQueryResult> {
+        const response = await this.queryReportRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
 }

package/src/apis/SystemApi.ts

@@ -38,6 +38,11 @@ import {
     GetSystemMetricsFromJSON,
     GetSystemMetricsToJSON,
 } from '../models/GetSystemMetrics';
+import {
+    type GetSystemPortalOverview,
+    GetSystemPortalOverviewFromJSON,
+    GetSystemPortalOverviewToJSON,
+} from '../models/GetSystemPortalOverview';
 
 export interface GetSystemBillingRequest {
     page?: number;
@@ -48,6 +53,10 @@ export interface GetSystemPortalRequest {
     portalId: string;
 }
 
+export interface GetSystemPortalOverviewRequest {
+    portalId: string;
+}
+
 export interface GetSystemPortalsRequest {
     page?: number;
     pageSize?: number;
@@ -190,6 +199,51 @@ export class SystemApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for getSystemPortalOverview without sending the request
+     */
+    async getSystemPortalOverviewRequestOpts(requestParameters: GetSystemPortalOverviewRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['portalId'] == null) {
+            throw new runtime.RequiredError(
+                'portalId',
+                'Required parameter "portalId" was null or undefined when calling getSystemPortalOverview().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        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
+     */
+    async getSystemPortalOverviewRaw(requestParameters: GetSystemPortalOverviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSystemPortalOverview>> {
+        const requestOptions = await this.getSystemPortalOverviewRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetSystemPortalOverviewFromJSON(jsonValue));
+    }
+
+    /**
+     * Get detailed platform portal overview and usage statistics
+     */
+    async getSystemPortalOverview(requestParameters: GetSystemPortalOverviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSystemPortalOverview> {
+        const response = await this.getSystemPortalOverviewRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for getSystemPortals without sending the request
      */

package/src/models/GetReportCatalog.ts

@@ -0,0 +1,90 @@
+/* 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 { ReportCategory } from './ReportCategory';
+import {
+    ReportCategoryFromJSON,
+    ReportCategoryFromJSONTyped,
+    ReportCategoryToJSON,
+    ReportCategoryToJSONTyped,
+} from './ReportCategory';
+import type { ReportDefinition } from './ReportDefinition';
+import {
+    ReportDefinitionFromJSON,
+    ReportDefinitionFromJSONTyped,
+    ReportDefinitionToJSON,
+    ReportDefinitionToJSONTyped,
+} 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 function instanceOfGetReportCatalog(value: object): value is GetReportCatalog {
+    if (!('categories' in value) || value['categories'] === undefined) return false;
+    if (!('reports' in value) || value['reports'] === undefined) return false;
+    return true;
+}
+
+export function GetReportCatalogFromJSON(json: any): GetReportCatalog {
+    return GetReportCatalogFromJSONTyped(json, false);
+}
+
+export function GetReportCatalogFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetReportCatalog {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'categories': ((json['categories'] as Array<any>).map(ReportCategoryFromJSON)),
+        'reports': ((json['reports'] as Array<any>).map(ReportDefinitionFromJSON)),
+    };
+}
+
+export function GetReportCatalogToJSON(json: any): GetReportCatalog {
+    return GetReportCatalogToJSONTyped(json, false);
+}
+
+export function GetReportCatalogToJSONTyped(value?: GetReportCatalog | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'categories': ((value['categories'] as Array<any>).map(ReportCategoryToJSON)),
+        'reports': ((value['reports'] as Array<any>).map(ReportDefinitionToJSON)),
+    };
+}
+

package/src/models/GetReportQueryResult.ts

@@ -0,0 +1,153 @@
+/* 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 { ReportColumn } from './ReportColumn';
+import {
+    ReportColumnFromJSON,
+    ReportColumnFromJSONTyped,
+    ReportColumnToJSON,
+    ReportColumnToJSONTyped,
+} from './ReportColumn';
+import type { ReportSort } from './ReportSort';
+import {
+    ReportSortFromJSON,
+    ReportSortFromJSONTyped,
+    ReportSortToJSON,
+    ReportSortToJSONTyped,
+} 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 function instanceOfGetReportQueryResult(value: object): value is GetReportQueryResult {
+    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: any): GetReportQueryResult {
+    return GetReportQueryResultFromJSONTyped(json, false);
+}
+
+export function GetReportQueryResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetReportQueryResult {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'reportKey': json['report_key'],
+        'columns': ((json['columns'] as Array<any>).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: any): GetReportQueryResult {
+    return GetReportQueryResultToJSONTyped(json, false);
+}
+
+export function GetReportQueryResultToJSONTyped(value?: GetReportQueryResult | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'report_key': value['reportKey'],
+        'columns': ((value['columns'] as Array<any>).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'],
+    };
+}
+