@easyedu/js-lsm-api 1.130.0 → 1.131.0

package/dist/esm/models/index.js

@@ -135,6 +135,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';
@@ -276,6 +278,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';
@@ -351,6 +355,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/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/models/GetReportCatalog.js

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

package/dist/models/GetReportQueryResult.d.ts

@@ -0,0 +1,84 @@
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { ReportColumn } from './ReportColumn';
+import type { ReportSort } from './ReportSort';
+/**
+ *
+ * @export
+ * @interface GetReportQueryResult
+ */
+export interface GetReportQueryResult {
+    /**
+     *
+     * @type {string}
+     * @memberof GetReportQueryResult
+     */
+    reportKey: string;
+    /**
+     *
+     * @type {Array<ReportColumn>}
+     * @memberof GetReportQueryResult
+     */
+    columns: Array<ReportColumn>;
+    /**
+     * One object per row, keyed by column key.
+     * @type {Array<{ [key: string]: any; }>}
+     * @memberof GetReportQueryResult
+     */
+    rows: Array<{
+        [key: string]: any;
+    }>;
+    /**
+     *
+     * @type {ReportSort}
+     * @memberof GetReportQueryResult
+     */
+    sort: ReportSort;
+    /**
+     *
+     * @type {number}
+     * @memberof GetReportQueryResult
+     */
+    page: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetReportQueryResult
+     */
+    pageSize: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetReportQueryResult
+     */
+    totalItems: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetReportQueryResult
+     */
+    totalPages: number;
+    /**
+     * Unix timestamp in seconds.
+     * @type {number}
+     * @memberof GetReportQueryResult
+     */
+    generatedAt: number;
+}
+/**
+ * Check if a given object implements the GetReportQueryResult interface.
+ */
+export declare function instanceOfGetReportQueryResult(value: object): value is GetReportQueryResult;
+export declare function GetReportQueryResultFromJSON(json: any): GetReportQueryResult;
+export declare function GetReportQueryResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetReportQueryResult;
+export declare function GetReportQueryResultToJSON(json: any): GetReportQueryResult;
+export declare function GetReportQueryResultToJSONTyped(value?: GetReportQueryResult | null, ignoreDiscriminator?: boolean): any;

package/dist/models/GetReportQueryResult.js

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

package/dist/models/PostReportExport.d.ts

@@ -0,0 +1,54 @@
+/**
+ * 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 { ReportFilters } from './ReportFilters';
+import type { ReportSort } from './ReportSort';
+/**
+ *
+ * @export
+ * @interface PostReportExport
+ */
+export interface PostReportExport {
+    /**
+     *
+     * @type {ReportFilters}
+     * @memberof PostReportExport
+     */
+    filters?: ReportFilters;
+    /**
+     *
+     * @type {ReportSort}
+     * @memberof PostReportExport
+     */
+    sort?: ReportSort;
+    /**
+     *
+     * @type {PostReportExportFormatEnum}
+     * @memberof PostReportExport
+     */
+    format: PostReportExportFormatEnum;
+}
+/**
+ * @export
+ */
+export declare const PostReportExportFormatEnum: {
+    readonly Csv: "csv";
+    readonly Xlsx: "xlsx";
+};
+export type PostReportExportFormatEnum = typeof PostReportExportFormatEnum[keyof typeof PostReportExportFormatEnum];
+/**
+ * Check if a given object implements the PostReportExport interface.
+ */
+export declare function instanceOfPostReportExport(value: object): value is PostReportExport;
+export declare function PostReportExportFromJSON(json: any): PostReportExport;
+export declare function PostReportExportFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostReportExport;
+export declare function PostReportExportToJSON(json: any): PostReportExport;
+export declare function PostReportExportToJSONTyped(value?: PostReportExport | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PostReportExport.js

@@ -0,0 +1,64 @@
+"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.PostReportExportFormatEnum = void 0;
+exports.instanceOfPostReportExport = instanceOfPostReportExport;
+exports.PostReportExportFromJSON = PostReportExportFromJSON;
+exports.PostReportExportFromJSONTyped = PostReportExportFromJSONTyped;
+exports.PostReportExportToJSON = PostReportExportToJSON;
+exports.PostReportExportToJSONTyped = PostReportExportToJSONTyped;
+const ReportFilters_1 = require("./ReportFilters");
+const ReportSort_1 = require("./ReportSort");
+/**
+ * @export
+ */
+exports.PostReportExportFormatEnum = {
+    Csv: 'csv',
+    Xlsx: 'xlsx'
+};
+/**
+ * Check if a given object implements the PostReportExport interface.
+ */
+function instanceOfPostReportExport(value) {
+    if (!('format' in value) || value['format'] === undefined)
+        return false;
+    return true;
+}
+function PostReportExportFromJSON(json) {
+    return PostReportExportFromJSONTyped(json, false);
+}
+function PostReportExportFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'filters': json['filters'] == null ? undefined : (0, ReportFilters_1.ReportFiltersFromJSON)(json['filters']),
+        'sort': json['sort'] == null ? undefined : (0, ReportSort_1.ReportSortFromJSON)(json['sort']),
+        'format': json['format'],
+    };
+}
+function PostReportExportToJSON(json) {
+    return PostReportExportToJSONTyped(json, false);
+}
+function PostReportExportToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'filters': (0, ReportFilters_1.ReportFiltersToJSON)(value['filters']),
+        'sort': (0, ReportSort_1.ReportSortToJSON)(value['sort']),
+        'format': value['format'],
+    };
+}

package/dist/models/PostReportQuery.d.ts

@@ -0,0 +1,52 @@
+/**
+ * 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 { ReportFilters } from './ReportFilters';
+import type { ReportSort } from './ReportSort';
+/**
+ *
+ * @export
+ * @interface PostReportQuery
+ */
+export interface PostReportQuery {
+    /**
+     *
+     * @type {ReportFilters}
+     * @memberof PostReportQuery
+     */
+    filters?: ReportFilters;
+    /**
+     *
+     * @type {ReportSort}
+     * @memberof PostReportQuery
+     */
+    sort?: ReportSort;
+    /**
+     *
+     * @type {number}
+     * @memberof PostReportQuery
+     */
+    page?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof PostReportQuery
+     */
+    pageSize?: number;
+}
+/**
+ * Check if a given object implements the PostReportQuery interface.
+ */
+export declare function instanceOfPostReportQuery(value: object): value is PostReportQuery;
+export declare function PostReportQueryFromJSON(json: any): PostReportQuery;
+export declare function PostReportQueryFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostReportQuery;
+export declare function PostReportQueryToJSON(json: any): PostReportQuery;
+export declare function PostReportQueryToJSONTyped(value?: PostReportQuery | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PostReportQuery.js

@@ -0,0 +1,56 @@
+"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.instanceOfPostReportQuery = instanceOfPostReportQuery;
+exports.PostReportQueryFromJSON = PostReportQueryFromJSON;
+exports.PostReportQueryFromJSONTyped = PostReportQueryFromJSONTyped;
+exports.PostReportQueryToJSON = PostReportQueryToJSON;
+exports.PostReportQueryToJSONTyped = PostReportQueryToJSONTyped;
+const ReportFilters_1 = require("./ReportFilters");
+const ReportSort_1 = require("./ReportSort");
+/**
+ * Check if a given object implements the PostReportQuery interface.
+ */
+function instanceOfPostReportQuery(value) {
+    return true;
+}
+function PostReportQueryFromJSON(json) {
+    return PostReportQueryFromJSONTyped(json, false);
+}
+function PostReportQueryFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'filters': json['filters'] == null ? undefined : (0, ReportFilters_1.ReportFiltersFromJSON)(json['filters']),
+        'sort': json['sort'] == null ? undefined : (0, ReportSort_1.ReportSortFromJSON)(json['sort']),
+        'page': json['page'] == null ? undefined : json['page'],
+        'pageSize': json['page_size'] == null ? undefined : json['page_size'],
+    };
+}
+function PostReportQueryToJSON(json) {
+    return PostReportQueryToJSONTyped(json, false);
+}
+function PostReportQueryToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'filters': (0, ReportFilters_1.ReportFiltersToJSON)(value['filters']),
+        'sort': (0, ReportSort_1.ReportSortToJSON)(value['sort']),
+        'page': value['page'],
+        'page_size': value['pageSize'],
+    };
+}

package/dist/models/ReportCategory.d.ts

@@ -0,0 +1,50 @@
+/**
+ * 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 ReportCategory
+ */
+export interface ReportCategory {
+    /**
+     *
+     * @type {ReportCategoryKeyEnum}
+     * @memberof ReportCategory
+     */
+    key: ReportCategoryKeyEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof ReportCategory
+     */
+    label: string;
+}
+/**
+ * @export
+ */
+export declare const ReportCategoryKeyEnum: {
+    readonly Learners: "learners";
+    readonly Content: "content";
+    readonly Tags: "tags";
+    readonly Managers: "managers";
+    readonly Compliance: "compliance";
+    readonly Trends: "trends";
+};
+export type ReportCategoryKeyEnum = typeof ReportCategoryKeyEnum[keyof typeof ReportCategoryKeyEnum];
+/**
+ * Check if a given object implements the ReportCategory interface.
+ */
+export declare function instanceOfReportCategory(value: object): value is ReportCategory;
+export declare function ReportCategoryFromJSON(json: any): ReportCategory;
+export declare function ReportCategoryFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReportCategory;
+export declare function ReportCategoryToJSON(json: any): ReportCategory;
+export declare function ReportCategoryToJSONTyped(value?: ReportCategory | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ReportCategory.js

@@ -0,0 +1,66 @@
+"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.ReportCategoryKeyEnum = void 0;
+exports.instanceOfReportCategory = instanceOfReportCategory;
+exports.ReportCategoryFromJSON = ReportCategoryFromJSON;
+exports.ReportCategoryFromJSONTyped = ReportCategoryFromJSONTyped;
+exports.ReportCategoryToJSON = ReportCategoryToJSON;
+exports.ReportCategoryToJSONTyped = ReportCategoryToJSONTyped;
+/**
+ * @export
+ */
+exports.ReportCategoryKeyEnum = {
+    Learners: 'learners',
+    Content: 'content',
+    Tags: 'tags',
+    Managers: 'managers',
+    Compliance: 'compliance',
+    Trends: 'trends'
+};
+/**
+ * Check if a given object implements the ReportCategory interface.
+ */
+function instanceOfReportCategory(value) {
+    if (!('key' in value) || value['key'] === undefined)
+        return false;
+    if (!('label' in value) || value['label'] === undefined)
+        return false;
+    return true;
+}
+function ReportCategoryFromJSON(json) {
+    return ReportCategoryFromJSONTyped(json, false);
+}
+function ReportCategoryFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'key': json['key'],
+        'label': json['label'],
+    };
+}
+function ReportCategoryToJSON(json) {
+    return ReportCategoryToJSONTyped(json, false);
+}
+function ReportCategoryToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'key': value['key'],
+        'label': value['label'],
+    };
+}