@easyedu/js-lsm-api 1.130.0 → 1.131.0

package/dist/esm/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/esm/models/GetReportQueryResult.js

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

package/dist/esm/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/esm/models/PostReportExport.js

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

package/dist/esm/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/esm/models/PostReportQuery.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 { ReportFiltersFromJSON, ReportFiltersToJSON, } from './ReportFilters';
+import { ReportSortFromJSON, ReportSortToJSON, } from './ReportSort';
+/**
+ * Check if a given object implements the PostReportQuery interface.
+ */
+export function instanceOfPostReportQuery(value) {
+    return true;
+}
+export function PostReportQueryFromJSON(json) {
+    return PostReportQueryFromJSONTyped(json, false);
+}
+export function PostReportQueryFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'filters': json['filters'] == null ? undefined : ReportFiltersFromJSON(json['filters']),
+        'sort': json['sort'] == null ? undefined : ReportSortFromJSON(json['sort']),
+        'page': json['page'] == null ? undefined : json['page'],
+        'pageSize': json['page_size'] == null ? undefined : json['page_size'],
+    };
+}
+export function PostReportQueryToJSON(json) {
+    return PostReportQueryToJSONTyped(json, false);
+}
+export function PostReportQueryToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'filters': ReportFiltersToJSON(value['filters']),
+        'sort': ReportSortToJSON(value['sort']),
+        'page': value['page'],
+        'page_size': value['pageSize'],
+    };
+}

package/dist/esm/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/esm/models/ReportCategory.js

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

package/dist/esm/models/ReportColumn.d.ts

@@ -0,0 +1,59 @@
+/**
+ * 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.
+ */
+/**
+ * One column in a report result. Row objects are keyed by column key.
+ * @export
+ * @interface ReportColumn
+ */
+export interface ReportColumn {
+    /**
+     *
+     * @type {string}
+     * @memberof ReportColumn
+     */
+    key: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReportColumn
+     */
+    label: string;
+    /**
+     * Value format. text, email and status are strings; number, percent and hours are numbers (percent is 0-100); date is an ISO 8601 calendar date; tags is an array of tag names.
+     *
+     * @type {ReportColumnTypeEnum}
+     * @memberof ReportColumn
+     */
+    type: ReportColumnTypeEnum;
+}
+/**
+ * @export
+ */
+export declare const ReportColumnTypeEnum: {
+    readonly Text: "text";
+    readonly Email: "email";
+    readonly Status: "status";
+    readonly Number: "number";
+    readonly Percent: "percent";
+    readonly Hours: "hours";
+    readonly Date: "date";
+    readonly Tags: "tags";
+};
+export type ReportColumnTypeEnum = typeof ReportColumnTypeEnum[keyof typeof ReportColumnTypeEnum];
+/**
+ * Check if a given object implements the ReportColumn interface.
+ */
+export declare function instanceOfReportColumn(value: object): value is ReportColumn;
+export declare function ReportColumnFromJSON(json: any): ReportColumn;
+export declare function ReportColumnFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReportColumn;
+export declare function ReportColumnToJSON(json: any): ReportColumn;
+export declare function ReportColumnToJSONTyped(value?: ReportColumn | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ReportColumn.js

@@ -0,0 +1,64 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const ReportColumnTypeEnum = {
+    Text: 'text',
+    Email: 'email',
+    Status: 'status',
+    Number: 'number',
+    Percent: 'percent',
+    Hours: 'hours',
+    Date: 'date',
+    Tags: 'tags'
+};
+/**
+ * Check if a given object implements the ReportColumn interface.
+ */
+export function instanceOfReportColumn(value) {
+    if (!('key' in value) || value['key'] === undefined)
+        return false;
+    if (!('label' in value) || value['label'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    return true;
+}
+export function ReportColumnFromJSON(json) {
+    return ReportColumnFromJSONTyped(json, false);
+}
+export function ReportColumnFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'key': json['key'],
+        'label': json['label'],
+        'type': json['type'],
+    };
+}
+export function ReportColumnToJSON(json) {
+    return ReportColumnToJSONTyped(json, false);
+}
+export function ReportColumnToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'key': value['key'],
+        'label': value['label'],
+        'type': value['type'],
+    };
+}

package/dist/esm/models/ReportDefinition.d.ts

@@ -0,0 +1,89 @@
+/**
+ * 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 { ReportFilterDefinition } from './ReportFilterDefinition';
+import type { ReportSort } from './ReportSort';
+/**
+ *
+ * @export
+ * @interface ReportDefinition
+ */
+export interface ReportDefinition {
+    /**
+     * Stable report identifier used in query and export paths.
+     * @type {string}
+     * @memberof ReportDefinition
+     */
+    key: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReportDefinition
+     */
+    title: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReportDefinition
+     */
+    description: string;
+    /**
+     *
+     * @type {ReportDefinitionCategoryEnum}
+     * @memberof ReportDefinition
+     */
+    category: ReportDefinitionCategoryEnum;
+    /**
+     * Permission required to run the report.
+     * @type {string}
+     * @memberof ReportDefinition
+     */
+    permission: string;
+    /**
+     *
+     * @type {Array<ReportColumn>}
+     * @memberof ReportDefinition
+     */
+    columns: Array<ReportColumn>;
+    /**
+     *
+     * @type {Array<ReportFilterDefinition>}
+     * @memberof ReportDefinition
+     */
+    filters: Array<ReportFilterDefinition>;
+    /**
+     *
+     * @type {ReportSort}
+     * @memberof ReportDefinition
+     */
+    defaultSort: ReportSort;
+}
+/**
+ * @export
+ */
+export declare const ReportDefinitionCategoryEnum: {
+    readonly Learners: "learners";
+    readonly Content: "content";
+    readonly Tags: "tags";
+    readonly Managers: "managers";
+    readonly Compliance: "compliance";
+    readonly Trends: "trends";
+};
+export type ReportDefinitionCategoryEnum = typeof ReportDefinitionCategoryEnum[keyof typeof ReportDefinitionCategoryEnum];
+/**
+ * Check if a given object implements the ReportDefinition interface.
+ */
+export declare function instanceOfReportDefinition(value: object): value is ReportDefinition;
+export declare function ReportDefinitionFromJSON(json: any): ReportDefinition;
+export declare function ReportDefinitionFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReportDefinition;
+export declare function ReportDefinitionToJSON(json: any): ReportDefinition;
+export declare function ReportDefinitionToJSONTyped(value?: ReportDefinition | null, ignoreDiscriminator?: boolean): any;