@easyedu/js-lsm-api 1.130.0 → 1.131.0

package/dist/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/models/ReportColumn.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.ReportColumnTypeEnum = void 0;
+exports.instanceOfReportColumn = instanceOfReportColumn;
+exports.ReportColumnFromJSON = ReportColumnFromJSON;
+exports.ReportColumnFromJSONTyped = ReportColumnFromJSONTyped;
+exports.ReportColumnToJSON = ReportColumnToJSON;
+exports.ReportColumnToJSONTyped = ReportColumnToJSONTyped;
+/**
+ * @export
+ */
+exports.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.
+ */
+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;
+}
+function ReportColumnFromJSON(json) {
+    return ReportColumnFromJSONTyped(json, false);
+}
+function ReportColumnFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'key': json['key'],
+        'label': json['label'],
+        'type': json['type'],
+    };
+}
+function ReportColumnToJSON(json) {
+    return ReportColumnToJSONTyped(json, false);
+}
+function ReportColumnToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'key': value['key'],
+        'label': value['label'],
+        'type': value['type'],
+    };
+}

package/dist/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;

package/dist/models/ReportDefinition.js

@@ -0,0 +1,93 @@
+"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.ReportDefinitionCategoryEnum = void 0;
+exports.instanceOfReportDefinition = instanceOfReportDefinition;
+exports.ReportDefinitionFromJSON = ReportDefinitionFromJSON;
+exports.ReportDefinitionFromJSONTyped = ReportDefinitionFromJSONTyped;
+exports.ReportDefinitionToJSON = ReportDefinitionToJSON;
+exports.ReportDefinitionToJSONTyped = ReportDefinitionToJSONTyped;
+const ReportColumn_1 = require("./ReportColumn");
+const ReportFilterDefinition_1 = require("./ReportFilterDefinition");
+const ReportSort_1 = require("./ReportSort");
+/**
+ * @export
+ */
+exports.ReportDefinitionCategoryEnum = {
+    Learners: 'learners',
+    Content: 'content',
+    Tags: 'tags',
+    Managers: 'managers',
+    Compliance: 'compliance',
+    Trends: 'trends'
+};
+/**
+ * Check if a given object implements the ReportDefinition interface.
+ */
+function instanceOfReportDefinition(value) {
+    if (!('key' in value) || value['key'] === undefined)
+        return false;
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    if (!('description' in value) || value['description'] === undefined)
+        return false;
+    if (!('category' in value) || value['category'] === undefined)
+        return false;
+    if (!('permission' in value) || value['permission'] === undefined)
+        return false;
+    if (!('columns' in value) || value['columns'] === undefined)
+        return false;
+    if (!('filters' in value) || value['filters'] === undefined)
+        return false;
+    if (!('defaultSort' in value) || value['defaultSort'] === undefined)
+        return false;
+    return true;
+}
+function ReportDefinitionFromJSON(json) {
+    return ReportDefinitionFromJSONTyped(json, false);
+}
+function ReportDefinitionFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'key': json['key'],
+        'title': json['title'],
+        'description': json['description'],
+        'category': json['category'],
+        'permission': json['permission'],
+        'columns': (json['columns'].map(ReportColumn_1.ReportColumnFromJSON)),
+        'filters': (json['filters'].map(ReportFilterDefinition_1.ReportFilterDefinitionFromJSON)),
+        'defaultSort': (0, ReportSort_1.ReportSortFromJSON)(json['default_sort']),
+    };
+}
+function ReportDefinitionToJSON(json) {
+    return ReportDefinitionToJSONTyped(json, false);
+}
+function ReportDefinitionToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'key': value['key'],
+        'title': value['title'],
+        'description': value['description'],
+        'category': value['category'],
+        'permission': value['permission'],
+        'columns': (value['columns'].map(ReportColumn_1.ReportColumnToJSON)),
+        'filters': (value['filters'].map(ReportFilterDefinition_1.ReportFilterDefinitionToJSON)),
+        'default_sort': (0, ReportSort_1.ReportSortToJSON)(value['defaultSort']),
+    };
+}

package/dist/models/ReportFilterDefinition.d.ts

@@ -0,0 +1,94 @@
+/**
+ * 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 { ReportFilterOption } from './ReportFilterOption';
+/**
+ * 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.
+ *
+ * @export
+ * @interface ReportFilterDefinition
+ */
+export interface ReportFilterDefinition {
+    /**
+     *
+     * @type {ReportFilterDefinitionKeyEnum}
+     * @memberof ReportFilterDefinition
+     */
+    key: ReportFilterDefinitionKeyEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof ReportFilterDefinition
+     */
+    label: string;
+    /**
+     *
+     * @type {ReportFilterDefinitionTypeEnum}
+     * @memberof ReportFilterDefinition
+     */
+    type: ReportFilterDefinitionTypeEnum;
+    /**
+     * Allowed values for select filters.
+     * @type {Array<ReportFilterOption>}
+     * @memberof ReportFilterDefinition
+     */
+    options: Array<ReportFilterOption>;
+    /**
+     * For date_range filters, the number of trailing days applied when neither date_from nor date_to is supplied. Null means no default date limit.
+     *
+     * @type {number}
+     * @memberof ReportFilterDefinition
+     */
+    defaultDays: number | null;
+    /**
+     * For number filters, the value applied when none is supplied.
+     * @type {number}
+     * @memberof ReportFilterDefinition
+     */
+    defaultValue: number | null;
+}
+/**
+ * @export
+ */
+export declare const ReportFilterDefinitionKeyEnum: {
+    readonly Search: "search";
+    readonly UserType: "user_type";
+    readonly Company: "company";
+    readonly Status: "status";
+    readonly TeamPortalId: "team_portal_id";
+    readonly CourseId: "course_id";
+    readonly TagId: "tag_id";
+    readonly ManagerId: "manager_id";
+    readonly DateRange: "date_range";
+    readonly InactiveDays: "inactive_days";
+    readonly ExpiresWithinDays: "expires_within_days";
+    readonly FirstCourseStarted: "first_course_started";
+};
+export type ReportFilterDefinitionKeyEnum = typeof ReportFilterDefinitionKeyEnum[keyof typeof ReportFilterDefinitionKeyEnum];
+/**
+ * @export
+ */
+export declare const ReportFilterDefinitionTypeEnum: {
+    readonly Search: "search";
+    readonly Text: "text";
+    readonly Select: "select";
+    readonly DateRange: "date_range";
+    readonly Number: "number";
+};
+export type ReportFilterDefinitionTypeEnum = typeof ReportFilterDefinitionTypeEnum[keyof typeof ReportFilterDefinitionTypeEnum];
+/**
+ * Check if a given object implements the ReportFilterDefinition interface.
+ */
+export declare function instanceOfReportFilterDefinition(value: object): value is ReportFilterDefinition;
+export declare function ReportFilterDefinitionFromJSON(json: any): ReportFilterDefinition;
+export declare function ReportFilterDefinitionFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReportFilterDefinition;
+export declare function ReportFilterDefinitionToJSON(json: any): ReportFilterDefinition;
+export declare function ReportFilterDefinitionToJSONTyped(value?: ReportFilterDefinition | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ReportFilterDefinition.js

@@ -0,0 +1,99 @@
+"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.ReportFilterDefinitionTypeEnum = exports.ReportFilterDefinitionKeyEnum = void 0;
+exports.instanceOfReportFilterDefinition = instanceOfReportFilterDefinition;
+exports.ReportFilterDefinitionFromJSON = ReportFilterDefinitionFromJSON;
+exports.ReportFilterDefinitionFromJSONTyped = ReportFilterDefinitionFromJSONTyped;
+exports.ReportFilterDefinitionToJSON = ReportFilterDefinitionToJSON;
+exports.ReportFilterDefinitionToJSONTyped = ReportFilterDefinitionToJSONTyped;
+const ReportFilterOption_1 = require("./ReportFilterOption");
+/**
+ * @export
+ */
+exports.ReportFilterDefinitionKeyEnum = {
+    Search: 'search',
+    UserType: 'user_type',
+    Company: 'company',
+    Status: 'status',
+    TeamPortalId: 'team_portal_id',
+    CourseId: 'course_id',
+    TagId: 'tag_id',
+    ManagerId: 'manager_id',
+    DateRange: 'date_range',
+    InactiveDays: 'inactive_days',
+    ExpiresWithinDays: 'expires_within_days',
+    FirstCourseStarted: 'first_course_started'
+};
+/**
+ * @export
+ */
+exports.ReportFilterDefinitionTypeEnum = {
+    Search: 'search',
+    Text: 'text',
+    Select: 'select',
+    DateRange: 'date_range',
+    Number: 'number'
+};
+/**
+ * Check if a given object implements the ReportFilterDefinition interface.
+ */
+function instanceOfReportFilterDefinition(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;
+    if (!('options' in value) || value['options'] === undefined)
+        return false;
+    if (!('defaultDays' in value) || value['defaultDays'] === undefined)
+        return false;
+    if (!('defaultValue' in value) || value['defaultValue'] === undefined)
+        return false;
+    return true;
+}
+function ReportFilterDefinitionFromJSON(json) {
+    return ReportFilterDefinitionFromJSONTyped(json, false);
+}
+function ReportFilterDefinitionFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'key': json['key'],
+        'label': json['label'],
+        'type': json['type'],
+        'options': (json['options'].map(ReportFilterOption_1.ReportFilterOptionFromJSON)),
+        'defaultDays': json['default_days'],
+        'defaultValue': json['default_value'],
+    };
+}
+function ReportFilterDefinitionToJSON(json) {
+    return ReportFilterDefinitionToJSONTyped(json, false);
+}
+function ReportFilterDefinitionToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'key': value['key'],
+        'label': value['label'],
+        'type': value['type'],
+        'options': (value['options'].map(ReportFilterOption_1.ReportFilterOptionToJSON)),
+        'default_days': value['defaultDays'],
+        'default_value': value['defaultValue'],
+    };
+}

package/dist/models/ReportFilterOption.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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 ReportFilterOption
+ */
+export interface ReportFilterOption {
+    /**
+     *
+     * @type {string}
+     * @memberof ReportFilterOption
+     */
+    value: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReportFilterOption
+     */
+    label: string;
+}
+/**
+ * Check if a given object implements the ReportFilterOption interface.
+ */
+export declare function instanceOfReportFilterOption(value: object): value is ReportFilterOption;
+export declare function ReportFilterOptionFromJSON(json: any): ReportFilterOption;
+export declare function ReportFilterOptionFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReportFilterOption;
+export declare function ReportFilterOptionToJSON(json: any): ReportFilterOption;
+export declare function ReportFilterOptionToJSONTyped(value?: ReportFilterOption | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ReportFilterOption.js

@@ -0,0 +1,54 @@
+"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.instanceOfReportFilterOption = instanceOfReportFilterOption;
+exports.ReportFilterOptionFromJSON = ReportFilterOptionFromJSON;
+exports.ReportFilterOptionFromJSONTyped = ReportFilterOptionFromJSONTyped;
+exports.ReportFilterOptionToJSON = ReportFilterOptionToJSON;
+exports.ReportFilterOptionToJSONTyped = ReportFilterOptionToJSONTyped;
+/**
+ * Check if a given object implements the ReportFilterOption interface.
+ */
+function instanceOfReportFilterOption(value) {
+    if (!('value' in value) || value['value'] === undefined)
+        return false;
+    if (!('label' in value) || value['label'] === undefined)
+        return false;
+    return true;
+}
+function ReportFilterOptionFromJSON(json) {
+    return ReportFilterOptionFromJSONTyped(json, false);
+}
+function ReportFilterOptionFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'value': json['value'],
+        'label': json['label'],
+    };
+}
+function ReportFilterOptionToJSON(json) {
+    return ReportFilterOptionToJSONTyped(json, false);
+}
+function ReportFilterOptionToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'value': value['value'],
+        'label': value['label'],
+    };
+}