@easyedu/js-lsm-api 1.130.0 → 1.132.0

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'],
+    };
+}

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/SystemPortalActivityStats.d.ts

@@ -0,0 +1,56 @@
+/**
+ * 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 SystemPortalActivityStats
+ */
+export interface SystemPortalActivityStats {
+    /**
+     *
+     * @type {number}
+     * @memberof SystemPortalActivityStats
+     */
+    loginsLast30Days: number;
+    /**
+     * Active learning time recorded in the portal over the last 30 days.
+     * @type {number}
+     * @memberof SystemPortalActivityStats
+     */
+    learningSecondsLast30Days: number;
+    /**
+     *
+     * @type {number}
+     * @memberof SystemPortalActivityStats
+     */
+    chatRequestsLast30Days: number;
+    /**
+     *
+     * @type {number}
+     * @memberof SystemPortalActivityStats
+     */
+    chatTokensLast30Days: number;
+    /**
+     *
+     * @type {number}
+     * @memberof SystemPortalActivityStats
+     */
+    lastLearningActivityAt?: number | null;
+}
+/**
+ * Check if a given object implements the SystemPortalActivityStats interface.
+ */
+export declare function instanceOfSystemPortalActivityStats(value: object): value is SystemPortalActivityStats;
+export declare function SystemPortalActivityStatsFromJSON(json: any): SystemPortalActivityStats;
+export declare function SystemPortalActivityStatsFromJSONTyped(json: any, ignoreDiscriminator: boolean): SystemPortalActivityStats;
+export declare function SystemPortalActivityStatsToJSON(json: any): SystemPortalActivityStats;
+export declare function SystemPortalActivityStatsToJSONTyped(value?: SystemPortalActivityStats | null, ignoreDiscriminator?: boolean): any;

package/dist/models/SystemPortalActivityStats.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.instanceOfSystemPortalActivityStats = instanceOfSystemPortalActivityStats;
+exports.SystemPortalActivityStatsFromJSON = SystemPortalActivityStatsFromJSON;
+exports.SystemPortalActivityStatsFromJSONTyped = SystemPortalActivityStatsFromJSONTyped;
+exports.SystemPortalActivityStatsToJSON = SystemPortalActivityStatsToJSON;
+exports.SystemPortalActivityStatsToJSONTyped = SystemPortalActivityStatsToJSONTyped;
+/**
+ * Check if a given object implements the SystemPortalActivityStats interface.
+ */
+function instanceOfSystemPortalActivityStats(value) {
+    if (!('loginsLast30Days' in value) || value['loginsLast30Days'] === undefined)
+        return false;
+    if (!('learningSecondsLast30Days' in value) || value['learningSecondsLast30Days'] === undefined)
+        return false;
+    if (!('chatRequestsLast30Days' in value) || value['chatRequestsLast30Days'] === undefined)
+        return false;
+    if (!('chatTokensLast30Days' in value) || value['chatTokensLast30Days'] === undefined)
+        return false;
+    return true;
+}
+function SystemPortalActivityStatsFromJSON(json) {
+    return SystemPortalActivityStatsFromJSONTyped(json, false);
+}
+function SystemPortalActivityStatsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'loginsLast30Days': json['logins_last_30_days'],
+        'learningSecondsLast30Days': json['learning_seconds_last_30_days'],
+        'chatRequestsLast30Days': json['chat_requests_last_30_days'],
+        'chatTokensLast30Days': json['chat_tokens_last_30_days'],
+        'lastLearningActivityAt': json['last_learning_activity_at'] == null ? undefined : json['last_learning_activity_at'],
+    };
+}
+function SystemPortalActivityStatsToJSON(json) {
+    return SystemPortalActivityStatsToJSONTyped(json, false);
+}
+function SystemPortalActivityStatsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'logins_last_30_days': value['loginsLast30Days'],
+        'learning_seconds_last_30_days': value['learningSecondsLast30Days'],
+        'chat_requests_last_30_days': value['chatRequestsLast30Days'],
+        'chat_tokens_last_30_days': value['chatTokensLast30Days'],
+        'last_learning_activity_at': value['lastLearningActivityAt'],
+    };
+}

package/dist/models/SystemPortalCertificateStats.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 SystemPortalCertificateStats
+ */
+export interface SystemPortalCertificateStats {
+    /**
+     *
+     * @type {number}
+     * @memberof SystemPortalCertificateStats
+     */
+    active: number;
+    /**
+     *
+     * @type {number}
+     * @memberof SystemPortalCertificateStats
+     */
+    revoked: number;
+    /**
+     *
+     * @type {number}
+     * @memberof SystemPortalCertificateStats
+     */
+    issuedLast30Days: number;
+    /**
+     *
+     * @type {number}
+     * @memberof SystemPortalCertificateStats
+     */
+    expiringNext30Days: number;
+}
+/**
+ * Check if a given object implements the SystemPortalCertificateStats interface.
+ */
+export declare function instanceOfSystemPortalCertificateStats(value: object): value is SystemPortalCertificateStats;
+export declare function SystemPortalCertificateStatsFromJSON(json: any): SystemPortalCertificateStats;
+export declare function SystemPortalCertificateStatsFromJSONTyped(json: any, ignoreDiscriminator: boolean): SystemPortalCertificateStats;
+export declare function SystemPortalCertificateStatsToJSON(json: any): SystemPortalCertificateStats;
+export declare function SystemPortalCertificateStatsToJSONTyped(value?: SystemPortalCertificateStats | null, ignoreDiscriminator?: boolean): any;