@easyedu/js-lsm-api 1.130.0 → 1.131.0

package/.openapi-generator/FILES

@@ -148,6 +148,8 @@ docs/GetQuestionAnswerChoicesInner.md
 docs/GetQuestionList.md
 docs/GetQuestionListFilters.md
 docs/GetQuestionQuizzesInner.md
+docs/GetReportCatalog.md
+docs/GetReportQueryResult.md
 docs/GetResource.md
 docs/GetResourceList.md
 docs/GetResourceSession.md
@@ -296,6 +298,8 @@ docs/PostQuestionImportCommit.md
 docs/PostQuestionImportCommitItem.md
 docs/PostQuestionImportCommitResponse.md
 docs/PostQuestionImportParseResponse.md
+docs/PostReportExport.md
+docs/PostReportQuery.md
 docs/PostResetPassword.md
 docs/PostResource.md
 docs/PostResourceSessionActivityEvent.md
@@ -373,6 +377,13 @@ docs/QuestionImportPreviewImage.md
 docs/QuestionImportSource.md
 docs/QuestionImportSourceSummary.md
 docs/QuestionSelectionMethod.md
+docs/ReportCategory.md
+docs/ReportColumn.md
+docs/ReportDefinition.md
+docs/ReportFilterDefinition.md
+docs/ReportFilterOption.md
+docs/ReportFilters.md
+docs/ReportSort.md
 docs/ReportingApi.md
 docs/ResourceSessionEnvironment.md
 docs/ResourceSessionScormApiLogItem.md
@@ -570,6 +581,8 @@ src/models/GetQuestionAnswerChoicesInner.ts
 src/models/GetQuestionList.ts
 src/models/GetQuestionListFilters.ts
 src/models/GetQuestionQuizzesInner.ts
+src/models/GetReportCatalog.ts
+src/models/GetReportQueryResult.ts
 src/models/GetResource.ts
 src/models/GetResourceList.ts
 src/models/GetResourceSession.ts
@@ -711,6 +724,8 @@ src/models/PostQuestionImportCommit.ts
 src/models/PostQuestionImportCommitItem.ts
 src/models/PostQuestionImportCommitResponse.ts
 src/models/PostQuestionImportParseResponse.ts
+src/models/PostReportExport.ts
+src/models/PostReportQuery.ts
 src/models/PostResetPassword.ts
 src/models/PostResource.ts
 src/models/PostResourceSessionActivityEvent.ts
@@ -786,6 +801,13 @@ src/models/QuestionImportPreviewImage.ts
 src/models/QuestionImportSource.ts
 src/models/QuestionImportSourceSummary.ts
 src/models/QuestionSelectionMethod.ts
+src/models/ReportCategory.ts
+src/models/ReportColumn.ts
+src/models/ReportDefinition.ts
+src/models/ReportFilterDefinition.ts
+src/models/ReportFilterOption.ts
+src/models/ReportFilters.ts
+src/models/ReportSort.ts
 src/models/ResourceSessionEnvironment.ts
 src/models/ResourceSessionScormApiLogItem.ts
 src/models/ResourceType.ts

package/README.md

@@ -1,4 +1,4 @@
-# @easyedu/js-lsm-api@1.130.0
+# @easyedu/js-lsm-api@1.131.0
 
 A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
 
@@ -364,9 +364,12 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 *QuestionApi* | [**putQuestion**](docs/QuestionApi.md#putquestion) | **PUT** /questions/{questionId} | Create the next version of a question
 *QuestionImportApi* | [**postQuestionImportCommit**](docs/QuestionImportApi.md#postquestionimportcommit) | **POST** /question-imports/commit | Validate and atomically create, version, or skip approved question drafts
 *QuestionImportApi* | [**postQuestionImportParse**](docs/QuestionImportApi.md#postquestionimportparse) | **POST** /question-imports/parse | Parse a question document into stateless review drafts
+*ReportingApi* | [**exportReport**](docs/ReportingApi.md#exportreport) | **POST** /reporting/reports/{reportKey}/export | Export all rows of a report as CSV or XLSX
 *ReportingApi* | [**getCourseVersionReporting**](docs/ReportingApi.md#getcourseversionreporting) | **GET** /courses/{courseId}/versions/{courseVersionId}/reporting | Get instructor reporting for one explicit course version
 *ReportingApi* | [**getCourseVersionSectionReporting**](docs/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
 *ReportingApi* | [**getPortalManagementDashboard**](docs/ReportingApi.md#getportalmanagementdashboard) | **GET** /reporting/portal/dashboard | Get the selected portal\'s management dashboard reporting
+*ReportingApi* | [**getReportCatalog**](docs/ReportingApi.md#getreportcatalog) | **GET** /reporting/reports | List the reports the caller can run in the selected portal
+*ReportingApi* | [**queryReport**](docs/ReportingApi.md#queryreport) | **POST** /reporting/reports/{reportKey}/query | Run a report and return one page of rows
 *RichTextApi* | [**getRichTextAsset**](docs/RichTextApi.md#getrichtextasset) | **GET** /rich-text/assets/{assetId} | Redirect to a signed rich text asset URL
 *RichTextApi* | [**postRichTextAssetComplete**](docs/RichTextApi.md#postrichtextassetcomplete) | **POST** /rich-text/assets/{assetId}/complete | Complete a pending rich text asset upload
 *RichTextApi* | [**postRichTextAssetUpload**](docs/RichTextApi.md#postrichtextassetupload) | **POST** /rich-text/assets/uploads | Create a pending rich text asset upload
@@ -550,6 +553,8 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 - [GetQuestionList](docs/GetQuestionList.md)
 - [GetQuestionListFilters](docs/GetQuestionListFilters.md)
 - [GetQuestionQuizzesInner](docs/GetQuestionQuizzesInner.md)
+- [GetReportCatalog](docs/GetReportCatalog.md)
+- [GetReportQueryResult](docs/GetReportQueryResult.md)
 - [GetResource](docs/GetResource.md)
 - [GetResourceList](docs/GetResourceList.md)
 - [GetResourceSession](docs/GetResourceSession.md)
@@ -691,6 +696,8 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 - [PostQuestionImportCommitItem](docs/PostQuestionImportCommitItem.md)
 - [PostQuestionImportCommitResponse](docs/PostQuestionImportCommitResponse.md)
 - [PostQuestionImportParseResponse](docs/PostQuestionImportParseResponse.md)
+- [PostReportExport](docs/PostReportExport.md)
+- [PostReportQuery](docs/PostReportQuery.md)
 - [PostResetPassword](docs/PostResetPassword.md)
 - [PostResource](docs/PostResource.md)
 - [PostResourceSessionActivityEvent](docs/PostResourceSessionActivityEvent.md)
@@ -766,6 +773,13 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 - [QuestionImportSource](docs/QuestionImportSource.md)
 - [QuestionImportSourceSummary](docs/QuestionImportSourceSummary.md)
 - [QuestionSelectionMethod](docs/QuestionSelectionMethod.md)
+- [ReportCategory](docs/ReportCategory.md)
+- [ReportColumn](docs/ReportColumn.md)
+- [ReportDefinition](docs/ReportDefinition.md)
+- [ReportFilterDefinition](docs/ReportFilterDefinition.md)
+- [ReportFilterOption](docs/ReportFilterOption.md)
+- [ReportFilters](docs/ReportFilters.md)
+- [ReportSort](docs/ReportSort.md)
 - [ResourceSessionEnvironment](docs/ResourceSessionEnvironment.md)
 - [ResourceSessionScormApiLogItem](docs/ResourceSessionScormApiLogItem.md)
 - [ResourceType](docs/ResourceType.md)
@@ -804,7 +818,7 @@ and is automatically generated by the
 [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: `1.0.0`
-- Package version: `1.130.0`
+- Package version: `1.131.0`
 - Generator version: `7.22.0`
 - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
 

package/dist/apis/ReportingApi.d.ts

@@ -13,6 +13,14 @@ import * as runtime from '../runtime';
 import { type GetCourseVersionReporting } from '../models/GetCourseVersionReporting';
 import { type GetCourseVersionSectionReporting } from '../models/GetCourseVersionSectionReporting';
 import { type GetPortalManagementDashboard } from '../models/GetPortalManagementDashboard';
+import { type GetReportCatalog } from '../models/GetReportCatalog';
+import { type GetReportQueryResult } from '../models/GetReportQueryResult';
+import { type PostReportExport } from '../models/PostReportExport';
+import { type PostReportQuery } from '../models/PostReportQuery';
+export interface ExportReportRequest {
+    reportKey: string;
+    postReportExport: PostReportExport;
+}
 export interface GetCourseVersionReportingRequest {
     courseId: string;
     courseVersionId: string;
@@ -25,10 +33,26 @@ export interface GetCourseVersionSectionReportingRequest {
 export interface GetPortalManagementDashboardRequest {
     days?: number;
 }
+export interface QueryReportRequest {
+    reportKey: string;
+    postReportQuery: PostReportQuery;
+}
 /**
  *
  */
 export declare class ReportingApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for exportReport without sending the request
+     */
+    exportReportRequestOpts(requestParameters: ExportReportRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Export all rows of a report as CSV or XLSX
+     */
+    exportReportRaw(requestParameters: ExportReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
+    /**
+     * Export all rows of a report as CSV or XLSX
+     */
+    exportReport(requestParameters: ExportReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
     /**
      * Creates request options for getCourseVersionReporting without sending the request
      */
@@ -65,4 +89,32 @@ export declare class ReportingApi extends runtime.BaseAPI {
      * Get the selected portal\'s management dashboard reporting
      */
     getPortalManagementDashboard(requestParameters?: GetPortalManagementDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalManagementDashboard>;
+    /**
+     * Creates request options for getReportCatalog without sending the request
+     */
+    getReportCatalogRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * 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?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetReportCatalog>>;
+    /**
+     * 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?: RequestInit | runtime.InitOverrideFunction): Promise<GetReportCatalog>;
+    /**
+     * Creates request options for queryReport without sending the request
+     */
+    queryReportRequestOpts(requestParameters: QueryReportRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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: QueryReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetReportQueryResult>>;
+    /**
+     * 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: QueryReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetReportQueryResult>;
 }

package/dist/apis/ReportingApi.js

@@ -27,10 +27,58 @@ const runtime = require("../runtime");
 const GetCourseVersionReporting_1 = require("../models/GetCourseVersionReporting");
 const GetCourseVersionSectionReporting_1 = require("../models/GetCourseVersionSectionReporting");
 const GetPortalManagementDashboard_1 = require("../models/GetPortalManagementDashboard");
+const GetReportCatalog_1 = require("../models/GetReportCatalog");
+const GetReportQueryResult_1 = require("../models/GetReportQueryResult");
+const PostReportExport_1 = require("../models/PostReportExport");
+const PostReportQuery_1 = require("../models/PostReportQuery");
 /**
  *
  */
 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: (0, PostReportExport_1.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
      */
@@ -159,5 +207,88 @@ 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) => (0, GetReportCatalog_1.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: (0, PostReportQuery_1.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) => (0, GetReportQueryResult_1.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();
+        });
+    }
 }
 exports.ReportingApi = ReportingApi;

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

@@ -13,6 +13,14 @@ import * as runtime from '../runtime';
 import { type GetCourseVersionReporting } from '../models/GetCourseVersionReporting';
 import { type GetCourseVersionSectionReporting } from '../models/GetCourseVersionSectionReporting';
 import { type GetPortalManagementDashboard } from '../models/GetPortalManagementDashboard';
+import { type GetReportCatalog } from '../models/GetReportCatalog';
+import { type GetReportQueryResult } from '../models/GetReportQueryResult';
+import { type PostReportExport } from '../models/PostReportExport';
+import { type PostReportQuery } from '../models/PostReportQuery';
+export interface ExportReportRequest {
+    reportKey: string;
+    postReportExport: PostReportExport;
+}
 export interface GetCourseVersionReportingRequest {
     courseId: string;
     courseVersionId: string;
@@ -25,10 +33,26 @@ export interface GetCourseVersionSectionReportingRequest {
 export interface GetPortalManagementDashboardRequest {
     days?: number;
 }
+export interface QueryReportRequest {
+    reportKey: string;
+    postReportQuery: PostReportQuery;
+}
 /**
  *
  */
 export declare class ReportingApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for exportReport without sending the request
+     */
+    exportReportRequestOpts(requestParameters: ExportReportRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Export all rows of a report as CSV or XLSX
+     */
+    exportReportRaw(requestParameters: ExportReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
+    /**
+     * Export all rows of a report as CSV or XLSX
+     */
+    exportReport(requestParameters: ExportReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
     /**
      * Creates request options for getCourseVersionReporting without sending the request
      */
@@ -65,4 +89,32 @@ export declare class ReportingApi extends runtime.BaseAPI {
      * Get the selected portal\'s management dashboard reporting
      */
     getPortalManagementDashboard(requestParameters?: GetPortalManagementDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalManagementDashboard>;
+    /**
+     * Creates request options for getReportCatalog without sending the request
+     */
+    getReportCatalogRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * 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?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetReportCatalog>>;
+    /**
+     * 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?: RequestInit | runtime.InitOverrideFunction): Promise<GetReportCatalog>;
+    /**
+     * Creates request options for queryReport without sending the request
+     */
+    queryReportRequestOpts(requestParameters: QueryReportRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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: QueryReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetReportQueryResult>>;
+    /**
+     * 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: QueryReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetReportQueryResult>;
 }

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/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)),
+    };
+}