@easyedu/js-lsm-api 1.129.0 → 1.131.0

package/src/models/ReportColumn.ts

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

package/src/models/ReportDefinition.ts

@@ -0,0 +1,166 @@
+/* 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 { mapValues } from '../runtime';
+import type { ReportColumn } from './ReportColumn';
+import {
+    ReportColumnFromJSON,
+    ReportColumnFromJSONTyped,
+    ReportColumnToJSON,
+    ReportColumnToJSONTyped,
+} from './ReportColumn';
+import type { ReportFilterDefinition } from './ReportFilterDefinition';
+import {
+    ReportFilterDefinitionFromJSON,
+    ReportFilterDefinitionFromJSONTyped,
+    ReportFilterDefinitionToJSON,
+    ReportFilterDefinitionToJSONTyped,
+} from './ReportFilterDefinition';
+import type { ReportSort } from './ReportSort';
+import {
+    ReportSortFromJSON,
+    ReportSortFromJSONTyped,
+    ReportSortToJSON,
+    ReportSortToJSONTyped,
+} 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 const ReportDefinitionCategoryEnum = {
+    Learners: 'learners',
+    Content: 'content',
+    Tags: 'tags',
+    Managers: 'managers',
+    Compliance: 'compliance',
+    Trends: 'trends'
+} as const;
+export type ReportDefinitionCategoryEnum = typeof ReportDefinitionCategoryEnum[keyof typeof ReportDefinitionCategoryEnum];
+
+
+/**
+ * Check if a given object implements the ReportDefinition interface.
+ */
+export function instanceOfReportDefinition(value: object): value is ReportDefinition {
+    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;
+}
+
+export function ReportDefinitionFromJSON(json: any): ReportDefinition {
+    return ReportDefinitionFromJSONTyped(json, false);
+}
+
+export function ReportDefinitionFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReportDefinition {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'key': json['key'],
+        'title': json['title'],
+        'description': json['description'],
+        'category': json['category'],
+        'permission': json['permission'],
+        'columns': ((json['columns'] as Array<any>).map(ReportColumnFromJSON)),
+        'filters': ((json['filters'] as Array<any>).map(ReportFilterDefinitionFromJSON)),
+        'defaultSort': ReportSortFromJSON(json['default_sort']),
+    };
+}
+
+export function ReportDefinitionToJSON(json: any): ReportDefinition {
+    return ReportDefinitionToJSONTyped(json, false);
+}
+
+export function ReportDefinitionToJSONTyped(value?: ReportDefinition | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'key': value['key'],
+        'title': value['title'],
+        'description': value['description'],
+        'category': value['category'],
+        'permission': value['permission'],
+        'columns': ((value['columns'] as Array<any>).map(ReportColumnToJSON)),
+        'filters': ((value['filters'] as Array<any>).map(ReportFilterDefinitionToJSON)),
+        'default_sort': ReportSortToJSON(value['defaultSort']),
+    };
+}
+

package/src/models/ReportFilterDefinition.ts

@@ -0,0 +1,154 @@
+/* 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 { mapValues } from '../runtime';
+import type { ReportFilterOption } from './ReportFilterOption';
+import {
+    ReportFilterOptionFromJSON,
+    ReportFilterOptionFromJSONTyped,
+    ReportFilterOptionToJSON,
+    ReportFilterOptionToJSONTyped,
+} 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 const 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'
+} as const;
+export type ReportFilterDefinitionKeyEnum = typeof ReportFilterDefinitionKeyEnum[keyof typeof ReportFilterDefinitionKeyEnum];
+
+/**
+ * @export
+ */
+export const ReportFilterDefinitionTypeEnum = {
+    Search: 'search',
+    Text: 'text',
+    Select: 'select',
+    DateRange: 'date_range',
+    Number: 'number'
+} as const;
+export type ReportFilterDefinitionTypeEnum = typeof ReportFilterDefinitionTypeEnum[keyof typeof ReportFilterDefinitionTypeEnum];
+
+
+/**
+ * Check if a given object implements the ReportFilterDefinition interface.
+ */
+export function instanceOfReportFilterDefinition(value: object): value is ReportFilterDefinition {
+    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;
+}
+
+export function ReportFilterDefinitionFromJSON(json: any): ReportFilterDefinition {
+    return ReportFilterDefinitionFromJSONTyped(json, false);
+}
+
+export function ReportFilterDefinitionFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReportFilterDefinition {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'key': json['key'],
+        'label': json['label'],
+        'type': json['type'],
+        'options': ((json['options'] as Array<any>).map(ReportFilterOptionFromJSON)),
+        'defaultDays': json['default_days'],
+        'defaultValue': json['default_value'],
+    };
+}
+
+export function ReportFilterDefinitionToJSON(json: any): ReportFilterDefinition {
+    return ReportFilterDefinitionToJSONTyped(json, false);
+}
+
+export function ReportFilterDefinitionToJSONTyped(value?: ReportFilterDefinition | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'key': value['key'],
+        'label': value['label'],
+        'type': value['type'],
+        'options': ((value['options'] as Array<any>).map(ReportFilterOptionToJSON)),
+        'default_days': value['defaultDays'],
+        'default_value': value['defaultValue'],
+    };
+}
+

package/src/models/ReportFilterOption.ts

@@ -0,0 +1,75 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * 
+ * @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 function instanceOfReportFilterOption(value: object): value is ReportFilterOption {
+    if (!('value' in value) || value['value'] === undefined) return false;
+    if (!('label' in value) || value['label'] === undefined) return false;
+    return true;
+}
+
+export function ReportFilterOptionFromJSON(json: any): ReportFilterOption {
+    return ReportFilterOptionFromJSONTyped(json, false);
+}
+
+export function ReportFilterOptionFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReportFilterOption {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'value': json['value'],
+        'label': json['label'],
+    };
+}
+
+export function ReportFilterOptionToJSON(json: any): ReportFilterOption {
+    return ReportFilterOptionToJSONTyped(json, false);
+}
+
+export function ReportFilterOptionToJSONTyped(value?: ReportFilterOption | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'value': value['value'],
+        'label': value['label'],
+    };
+}
+

package/src/models/ReportFilters.ts

@@ -0,0 +1,162 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * 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 function instanceOfReportFilters(value: object): value is ReportFilters {
+    return true;
+}
+
+export function ReportFiltersFromJSON(json: any): ReportFilters {
+    return ReportFiltersFromJSONTyped(json, false);
+}
+
+export function ReportFiltersFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReportFilters {
+    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'],
+    };
+}
+
+export function ReportFiltersToJSON(json: any): ReportFilters {
+    return ReportFiltersToJSONTyped(json, false);
+}
+
+export function ReportFiltersToJSONTyped(value?: ReportFilters | null, ignoreDiscriminator: boolean = false): any {
+    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'],
+    };
+}
+