@easyedu/js-lsm-api 1.130.0 → 1.131.0

package/dist/models/ReportFilters.d.ts

@@ -0,0 +1,105 @@
+/**
+ * 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.
+ */
+/**
+ * Report filters. Only filters listed in the report definition may be supplied; any other non-null filter is rejected with HTTP 400.
+ *
+ * @export
+ * @interface ReportFilters
+ */
+export interface ReportFilters {
+    /**
+     * Case-insensitive match against names, emails and titles.
+     * @type {string}
+     * @memberof ReportFilters
+     */
+    search?: string | null;
+    /**
+     * Role base type, such as Learner or ClientManager.
+     * @type {string}
+     * @memberof ReportFilters
+     */
+    userType?: string | null;
+    /**
+     * Case-insensitive match against the company user field.
+     * @type {string}
+     * @memberof ReportFilters
+     */
+    company?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ReportFilters
+     */
+    status?: string | null;
+    /**
+     * Limits the report to one team portal and its descendants.
+     * @type {string}
+     * @memberof ReportFilters
+     */
+    teamPortalId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ReportFilters
+     */
+    courseId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ReportFilters
+     */
+    tagId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ReportFilters
+     */
+    managerId?: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof ReportFilters
+     */
+    dateFrom?: Date | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof ReportFilters
+     */
+    dateTo?: Date | null;
+    /**
+     *
+     * @type {number}
+     * @memberof ReportFilters
+     */
+    inactiveDays?: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof ReportFilters
+     */
+    expiresWithinDays?: number | null;
+    /**
+     * Either yes or no.
+     * @type {string}
+     * @memberof ReportFilters
+     */
+    firstCourseStarted?: string | null;
+}
+/**
+ * Check if a given object implements the ReportFilters interface.
+ */
+export declare function instanceOfReportFilters(value: object): value is ReportFilters;
+export declare function ReportFiltersFromJSON(json: any): ReportFilters;
+export declare function ReportFiltersFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReportFilters;
+export declare function ReportFiltersToJSON(json: any): ReportFilters;
+export declare function ReportFiltersToJSONTyped(value?: ReportFilters | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ReportFilters.js

@@ -0,0 +1,72 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfReportFilters = instanceOfReportFilters;
+exports.ReportFiltersFromJSON = ReportFiltersFromJSON;
+exports.ReportFiltersFromJSONTyped = ReportFiltersFromJSONTyped;
+exports.ReportFiltersToJSON = ReportFiltersToJSON;
+exports.ReportFiltersToJSONTyped = ReportFiltersToJSONTyped;
+/**
+ * Check if a given object implements the ReportFilters interface.
+ */
+function instanceOfReportFilters(value) {
+    return true;
+}
+function ReportFiltersFromJSON(json) {
+    return ReportFiltersFromJSONTyped(json, false);
+}
+function ReportFiltersFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'search': json['search'] == null ? undefined : json['search'],
+        'userType': json['user_type'] == null ? undefined : json['user_type'],
+        'company': json['company'] == null ? undefined : json['company'],
+        'status': json['status'] == null ? undefined : json['status'],
+        'teamPortalId': json['team_portal_id'] == null ? undefined : json['team_portal_id'],
+        'courseId': json['course_id'] == null ? undefined : json['course_id'],
+        'tagId': json['tag_id'] == null ? undefined : json['tag_id'],
+        'managerId': json['manager_id'] == null ? undefined : json['manager_id'],
+        'dateFrom': json['date_from'] == null ? undefined : (new Date(json['date_from'])),
+        'dateTo': json['date_to'] == null ? undefined : (new Date(json['date_to'])),
+        'inactiveDays': json['inactive_days'] == null ? undefined : json['inactive_days'],
+        'expiresWithinDays': json['expires_within_days'] == null ? undefined : json['expires_within_days'],
+        'firstCourseStarted': json['first_course_started'] == null ? undefined : json['first_course_started'],
+    };
+}
+function ReportFiltersToJSON(json) {
+    return ReportFiltersToJSONTyped(json, false);
+}
+function ReportFiltersToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'search': value['search'],
+        'user_type': value['userType'],
+        'company': value['company'],
+        'status': value['status'],
+        'team_portal_id': value['teamPortalId'],
+        'course_id': value['courseId'],
+        'tag_id': value['tagId'],
+        'manager_id': value['managerId'],
+        'date_from': value['dateFrom'] == null ? value['dateFrom'] : value['dateFrom'].toISOString().substring(0, 10),
+        'date_to': value['dateTo'] == null ? value['dateTo'] : value['dateTo'].toISOString().substring(0, 10),
+        'inactive_days': value['inactiveDays'],
+        'expires_within_days': value['expiresWithinDays'],
+        'first_course_started': value['firstCourseStarted'],
+    };
+}

package/dist/models/ReportSort.d.ts

@@ -0,0 +1,46 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface ReportSort
+ */
+export interface ReportSort {
+    /**
+     * A column key from the report definition.
+     * @type {string}
+     * @memberof ReportSort
+     */
+    column: string;
+    /**
+     *
+     * @type {ReportSortDirectionEnum}
+     * @memberof ReportSort
+     */
+    direction: ReportSortDirectionEnum;
+}
+/**
+ * @export
+ */
+export declare const ReportSortDirectionEnum: {
+    readonly Asc: "asc";
+    readonly Desc: "desc";
+};
+export type ReportSortDirectionEnum = typeof ReportSortDirectionEnum[keyof typeof ReportSortDirectionEnum];
+/**
+ * Check if a given object implements the ReportSort interface.
+ */
+export declare function instanceOfReportSort(value: object): value is ReportSort;
+export declare function ReportSortFromJSON(json: any): ReportSort;
+export declare function ReportSortFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReportSort;
+export declare function ReportSortToJSON(json: any): ReportSort;
+export declare function ReportSortToJSONTyped(value?: ReportSort | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ReportSort.js

@@ -0,0 +1,62 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReportSortDirectionEnum = void 0;
+exports.instanceOfReportSort = instanceOfReportSort;
+exports.ReportSortFromJSON = ReportSortFromJSON;
+exports.ReportSortFromJSONTyped = ReportSortFromJSONTyped;
+exports.ReportSortToJSON = ReportSortToJSON;
+exports.ReportSortToJSONTyped = ReportSortToJSONTyped;
+/**
+ * @export
+ */
+exports.ReportSortDirectionEnum = {
+    Asc: 'asc',
+    Desc: 'desc'
+};
+/**
+ * Check if a given object implements the ReportSort interface.
+ */
+function instanceOfReportSort(value) {
+    if (!('column' in value) || value['column'] === undefined)
+        return false;
+    if (!('direction' in value) || value['direction'] === undefined)
+        return false;
+    return true;
+}
+function ReportSortFromJSON(json) {
+    return ReportSortFromJSONTyped(json, false);
+}
+function ReportSortFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'column': json['column'],
+        'direction': json['direction'],
+    };
+}
+function ReportSortToJSON(json) {
+    return ReportSortToJSONTyped(json, false);
+}
+function ReportSortToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'column': value['column'],
+        'direction': value['direction'],
+    };
+}

package/dist/models/index.d.ts

@@ -133,6 +133,8 @@ export * from './GetQuestionAnswerChoicesInner';
 export * from './GetQuestionList';
 export * from './GetQuestionListFilters';
 export * from './GetQuestionQuizzesInner';
+export * from './GetReportCatalog';
+export * from './GetReportQueryResult';
 export * from './GetResource';
 export * from './GetResourceList';
 export * from './GetResourceSession';
@@ -274,6 +276,8 @@ export * from './PostQuestionImportCommit';
 export * from './PostQuestionImportCommitItem';
 export * from './PostQuestionImportCommitResponse';
 export * from './PostQuestionImportParseResponse';
+export * from './PostReportExport';
+export * from './PostReportQuery';
 export * from './PostResetPassword';
 export * from './PostResource';
 export * from './PostResourceSessionActivityEvent';
@@ -349,6 +353,13 @@ export * from './QuestionImportPreviewImage';
 export * from './QuestionImportSource';
 export * from './QuestionImportSourceSummary';
 export * from './QuestionSelectionMethod';
+export * from './ReportCategory';
+export * from './ReportColumn';
+export * from './ReportDefinition';
+export * from './ReportFilterDefinition';
+export * from './ReportFilterOption';
+export * from './ReportFilters';
+export * from './ReportSort';
 export * from './ResourceSessionEnvironment';
 export * from './ResourceSessionScormApiLogItem';
 export * from './ResourceType';

package/dist/models/index.js

@@ -151,6 +151,8 @@ __exportStar(require("./GetQuestionAnswerChoicesInner"), exports);
 __exportStar(require("./GetQuestionList"), exports);
 __exportStar(require("./GetQuestionListFilters"), exports);
 __exportStar(require("./GetQuestionQuizzesInner"), exports);
+__exportStar(require("./GetReportCatalog"), exports);
+__exportStar(require("./GetReportQueryResult"), exports);
 __exportStar(require("./GetResource"), exports);
 __exportStar(require("./GetResourceList"), exports);
 __exportStar(require("./GetResourceSession"), exports);
@@ -292,6 +294,8 @@ __exportStar(require("./PostQuestionImportCommit"), exports);
 __exportStar(require("./PostQuestionImportCommitItem"), exports);
 __exportStar(require("./PostQuestionImportCommitResponse"), exports);
 __exportStar(require("./PostQuestionImportParseResponse"), exports);
+__exportStar(require("./PostReportExport"), exports);
+__exportStar(require("./PostReportQuery"), exports);
 __exportStar(require("./PostResetPassword"), exports);
 __exportStar(require("./PostResource"), exports);
 __exportStar(require("./PostResourceSessionActivityEvent"), exports);
@@ -367,6 +371,13 @@ __exportStar(require("./QuestionImportPreviewImage"), exports);
 __exportStar(require("./QuestionImportSource"), exports);
 __exportStar(require("./QuestionImportSourceSummary"), exports);
 __exportStar(require("./QuestionSelectionMethod"), exports);
+__exportStar(require("./ReportCategory"), exports);
+__exportStar(require("./ReportColumn"), exports);
+__exportStar(require("./ReportDefinition"), exports);
+__exportStar(require("./ReportFilterDefinition"), exports);
+__exportStar(require("./ReportFilterOption"), exports);
+__exportStar(require("./ReportFilters"), exports);
+__exportStar(require("./ReportSort"), exports);
 __exportStar(require("./ResourceSessionEnvironment"), exports);
 __exportStar(require("./ResourceSessionScormApiLogItem"), exports);
 __exportStar(require("./ResourceType"), exports);

package/docs/GetReportCatalog.md

@@ -0,0 +1,37 @@
+
+# GetReportCatalog
+
+Reports the caller may run in the selected portal.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`categories` | [Array<ReportCategory>](ReportCategory.md)
+`reports` | [Array<ReportDefinition>](ReportDefinition.md)
+
+## Example
+
+```typescript
+import type { GetReportCatalog } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "categories": null,
+  "reports": null,
+} satisfies GetReportCatalog
+
+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 GetReportCatalog
+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/GetReportQueryResult.md

@@ -0,0 +1,50 @@
+
+# GetReportQueryResult
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`reportKey` | string
+`columns` | [Array<ReportColumn>](ReportColumn.md)
+`rows` | Array<{ [key: string]: any; }>
+`sort` | [ReportSort](ReportSort.md)
+`page` | number
+`pageSize` | number
+`totalItems` | number
+`totalPages` | number
+`generatedAt` | number
+
+## Example
+
+```typescript
+import type { GetReportQueryResult } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "reportKey": null,
+  "columns": null,
+  "rows": null,
+  "sort": null,
+  "page": null,
+  "pageSize": null,
+  "totalItems": null,
+  "totalPages": null,
+  "generatedAt": null,
+} satisfies GetReportQueryResult
+
+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 GetReportQueryResult
+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/PostReportExport.md

@@ -0,0 +1,38 @@
+
+# PostReportExport
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`filters` | [ReportFilters](ReportFilters.md)
+`sort` | [ReportSort](ReportSort.md)
+`format` | string
+
+## Example
+
+```typescript
+import type { PostReportExport } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "filters": null,
+  "sort": null,
+  "format": null,
+} satisfies PostReportExport
+
+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 PostReportExport
+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/PostReportQuery.md

@@ -0,0 +1,40 @@
+
+# PostReportQuery
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`filters` | [ReportFilters](ReportFilters.md)
+`sort` | [ReportSort](ReportSort.md)
+`page` | number
+`pageSize` | number
+
+## Example
+
+```typescript
+import type { PostReportQuery } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "filters": null,
+  "sort": null,
+  "page": null,
+  "pageSize": null,
+} satisfies PostReportQuery
+
+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 PostReportQuery
+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/ReportCategory.md

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

@@ -0,0 +1,39 @@
+
+# ReportColumn
+
+One column in a report result. Row objects are keyed by column key.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`key` | string
+`label` | string
+`type` | string
+
+## Example
+
+```typescript
+import type { ReportColumn } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "key": null,
+  "label": null,
+  "type": null,
+} satisfies ReportColumn
+
+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 ReportColumn
+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/ReportDefinition.md

@@ -0,0 +1,48 @@
+
+# ReportDefinition
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`key` | string
+`title` | string
+`description` | string
+`category` | string
+`permission` | string
+`columns` | [Array<ReportColumn>](ReportColumn.md)
+`filters` | [Array<ReportFilterDefinition>](ReportFilterDefinition.md)
+`defaultSort` | [ReportSort](ReportSort.md)
+
+## Example
+
+```typescript
+import type { ReportDefinition } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "key": null,
+  "title": null,
+  "description": null,
+  "category": null,
+  "permission": null,
+  "columns": null,
+  "filters": null,
+  "defaultSort": null,
+} satisfies ReportDefinition
+
+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 ReportDefinition
+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/ReportFilterDefinition.md

@@ -0,0 +1,45 @@
+
+# ReportFilterDefinition
+
+A filter accepted by a report. The key names the matching property in ReportFilters; a date_range filter maps to date_from and date_to. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`key` | string
+`label` | string
+`type` | string
+`options` | [Array<ReportFilterOption>](ReportFilterOption.md)
+`defaultDays` | number
+`defaultValue` | number
+
+## Example
+
+```typescript
+import type { ReportFilterDefinition } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "key": null,
+  "label": null,
+  "type": null,
+  "options": null,
+  "defaultDays": null,
+  "defaultValue": null,
+} satisfies ReportFilterDefinition
+
+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 ReportFilterDefinition
+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)
+
+