@easyedu/js-lsm-api 1.130.0 → 1.131.0

package/docs/ReportFilterOption.md

@@ -0,0 +1,36 @@
+
+# ReportFilterOption
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`value` | string
+`label` | string
+
+## Example
+
+```typescript
+import type { ReportFilterOption } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "value": null,
+  "label": null,
+} satisfies ReportFilterOption
+
+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 ReportFilterOption
+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/ReportFilters.md

@@ -0,0 +1,59 @@
+
+# ReportFilters
+
+Report filters. Only filters listed in the report definition may be supplied; any other non-null filter is rejected with HTTP 400. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`search` | string
+`userType` | string
+`company` | string
+`status` | string
+`teamPortalId` | string
+`courseId` | string
+`tagId` | string
+`managerId` | string
+`dateFrom` | Date
+`dateTo` | Date
+`inactiveDays` | number
+`expiresWithinDays` | number
+`firstCourseStarted` | string
+
+## Example
+
+```typescript
+import type { ReportFilters } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "search": null,
+  "userType": null,
+  "company": null,
+  "status": null,
+  "teamPortalId": null,
+  "courseId": null,
+  "tagId": null,
+  "managerId": null,
+  "dateFrom": null,
+  "dateTo": null,
+  "inactiveDays": null,
+  "expiresWithinDays": null,
+  "firstCourseStarted": null,
+} satisfies ReportFilters
+
+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 ReportFilters
+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/ReportSort.md

@@ -0,0 +1,36 @@
+
+# ReportSort
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`column` | string
+`direction` | string
+
+## Example
+
+```typescript
+import type { ReportSort } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "column": null,
+  "direction": null,
+} satisfies ReportSort
+
+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 ReportSort
+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/ReportingApi.md

@@ -4,12 +4,87 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
+| [**exportReport**](ReportingApi.md#exportreport) | **POST** /reporting/reports/{reportKey}/export | Export all rows of a report as CSV or XLSX |
 | [**getCourseVersionReporting**](ReportingApi.md#getcourseversionreporting) | **GET** /courses/{courseId}/versions/{courseVersionId}/reporting | Get instructor reporting for one explicit course version |
 | [**getCourseVersionSectionReporting**](ReportingApi.md#getcourseversionsectionreporting) | **GET** /courses/{courseId}/versions/{courseVersionId}/sections/{sectionId}/reporting | Get instructor reporting for one section and its descendants in an explicit course version |
 | [**getPortalManagementDashboard**](ReportingApi.md#getportalmanagementdashboard) | **GET** /reporting/portal/dashboard | Get the selected portal\'s management dashboard reporting |
+| [**getReportCatalog**](ReportingApi.md#getreportcatalog) | **GET** /reporting/reports | List the reports the caller can run in the selected portal |
+| [**queryReport**](ReportingApi.md#queryreport) | **POST** /reporting/reports/{reportKey}/query | Run a report and return one page of rows |
 
 
 
+## exportReport
+
+> Blob exportReport(reportKey, postReportExport)
+
+Export all rows of a report as CSV or XLSX
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReportingApi,
+} from '@easyedu/js-lsm-api';
+import type { ExportReportRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ReportingApi();
+
+  const body = {
+    // string
+    reportKey: reportKey_example,
+    // PostReportExport
+    postReportExport: ...,
+  } satisfies ExportReportRequest;
+
+  try {
+    const data = await api.exportReport(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **reportKey** | `string` |  | [Defaults to `undefined`] |
+| **postReportExport** | [PostReportExport](PostReportExport.md) |  | |
+
+### Return type
+
+**Blob**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `text/csv`, `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Report file |  -  |
+| **400** | Unsupported filter, invalid filter value, or unknown sort column |  -  |
+| **403** | Missing the report\'s permission |  -  |
+| **404** | Unknown report |  -  |
+| **422** | The export exceeds the maximum row count; narrow the filters |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## getCourseVersionReporting
 
 > GetCourseVersionReporting getCourseVersionReporting(courseId, courseVersionId)
@@ -216,3 +291,135 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
+
+## getReportCatalog
+
+> GetReportCatalog getReportCatalog()
+
+List the reports the caller can run in the selected portal
+
+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. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReportingApi,
+} from '@easyedu/js-lsm-api';
+import type { GetReportCatalogRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ReportingApi();
+
+  try {
+    const data = await api.getReportCatalog();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetReportCatalog**](GetReportCatalog.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Report catalog |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## queryReport
+
+> GetReportQueryResult queryReport(reportKey, postReportQuery)
+
+Run a report and return one page of rows
+
+Read-only. POST is used because filters vary per report. Results are scoped to the selected portal and its team portals. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReportingApi,
+} from '@easyedu/js-lsm-api';
+import type { QueryReportRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ReportingApi();
+
+  const body = {
+    // string
+    reportKey: reportKey_example,
+    // PostReportQuery
+    postReportQuery: ...,
+  } satisfies QueryReportRequest;
+
+  try {
+    const data = await api.queryReport(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **reportKey** | `string` |  | [Defaults to `undefined`] |
+| **postReportQuery** | [PostReportQuery](PostReportQuery.md) |  | |
+
+### Return type
+
+[**GetReportQueryResult**](GetReportQueryResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | One page of report rows |  -  |
+| **400** | Unsupported filter, invalid filter value, or unknown sort column |  -  |
+| **403** | Missing the report\'s permission |  -  |
+| **404** | Unknown report |  -  |
+
+[[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.131.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/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)),
+    };
+}
+