@easyedu/js-lsm-api 1.130.0 → 1.132.0

package/src/models/GetSystemPortalOverview.ts

@@ -0,0 +1,261 @@
+/* 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 { SystemPortalCourseStats } from './SystemPortalCourseStats';
+import {
+    SystemPortalCourseStatsFromJSON,
+    SystemPortalCourseStatsFromJSONTyped,
+    SystemPortalCourseStatsToJSON,
+    SystemPortalCourseStatsToJSONTyped,
+} from './SystemPortalCourseStats';
+import type { SystemPortalLicense } from './SystemPortalLicense';
+import {
+    SystemPortalLicenseFromJSON,
+    SystemPortalLicenseFromJSONTyped,
+    SystemPortalLicenseToJSON,
+    SystemPortalLicenseToJSONTyped,
+} from './SystemPortalLicense';
+import type { SystemPortalCertificateStats } from './SystemPortalCertificateStats';
+import {
+    SystemPortalCertificateStatsFromJSON,
+    SystemPortalCertificateStatsFromJSONTyped,
+    SystemPortalCertificateStatsToJSON,
+    SystemPortalCertificateStatsToJSONTyped,
+} from './SystemPortalCertificateStats';
+import type { SystemPortalStorageUsage } from './SystemPortalStorageUsage';
+import {
+    SystemPortalStorageUsageFromJSON,
+    SystemPortalStorageUsageFromJSONTyped,
+    SystemPortalStorageUsageToJSON,
+    SystemPortalStorageUsageToJSONTyped,
+} from './SystemPortalStorageUsage';
+import type { SystemPortalSupportStats } from './SystemPortalSupportStats';
+import {
+    SystemPortalSupportStatsFromJSON,
+    SystemPortalSupportStatsFromJSONTyped,
+    SystemPortalSupportStatsToJSON,
+    SystemPortalSupportStatsToJSONTyped,
+} from './SystemPortalSupportStats';
+import type { GetPortal } from './GetPortal';
+import {
+    GetPortalFromJSON,
+    GetPortalFromJSONTyped,
+    GetPortalToJSON,
+    GetPortalToJSONTyped,
+} from './GetPortal';
+import type { SystemPortalEnrollmentStats } from './SystemPortalEnrollmentStats';
+import {
+    SystemPortalEnrollmentStatsFromJSON,
+    SystemPortalEnrollmentStatsFromJSONTyped,
+    SystemPortalEnrollmentStatsToJSON,
+    SystemPortalEnrollmentStatsToJSONTyped,
+} from './SystemPortalEnrollmentStats';
+import type { SystemPortalActivityStats } from './SystemPortalActivityStats';
+import {
+    SystemPortalActivityStatsFromJSON,
+    SystemPortalActivityStatsFromJSONTyped,
+    SystemPortalActivityStatsToJSON,
+    SystemPortalActivityStatsToJSONTyped,
+} from './SystemPortalActivityStats';
+import type { SystemPortalContentStats } from './SystemPortalContentStats';
+import {
+    SystemPortalContentStatsFromJSON,
+    SystemPortalContentStatsFromJSONTyped,
+    SystemPortalContentStatsToJSON,
+    SystemPortalContentStatsToJSONTyped,
+} from './SystemPortalContentStats';
+import type { SystemPortalHierarchy } from './SystemPortalHierarchy';
+import {
+    SystemPortalHierarchyFromJSON,
+    SystemPortalHierarchyFromJSONTyped,
+    SystemPortalHierarchyToJSON,
+    SystemPortalHierarchyToJSONTyped,
+} from './SystemPortalHierarchy';
+import type { SystemPortalUserStats } from './SystemPortalUserStats';
+import {
+    SystemPortalUserStatsFromJSON,
+    SystemPortalUserStatsFromJSONTyped,
+    SystemPortalUserStatsToJSON,
+    SystemPortalUserStatsToJSONTyped,
+} from './SystemPortalUserStats';
+
+/**
+ * Detailed read-only overview of a single portal for platform administrators. All counts are scoped to the portal itself and exclude child portals. Timestamps are Unix epoch seconds (UTC).
+ * @export
+ * @interface GetSystemPortalOverview
+ */
+export interface GetSystemPortalOverview {
+    /**
+     * 
+     * @type {GetPortal}
+     * @memberof GetSystemPortalOverview
+     */
+    portal: GetPortal;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetSystemPortalOverview
+     */
+    createdAt: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetSystemPortalOverview
+     */
+    updatedAt: number;
+    /**
+     * When these statistics were computed.
+     * @type {number}
+     * @memberof GetSystemPortalOverview
+     */
+    generatedAt: number;
+    /**
+     * 
+     * @type {SystemPortalHierarchy}
+     * @memberof GetSystemPortalOverview
+     */
+    hierarchy: SystemPortalHierarchy;
+    /**
+     * 
+     * @type {SystemPortalLicense}
+     * @memberof GetSystemPortalOverview
+     */
+    license: SystemPortalLicense;
+    /**
+     * 
+     * @type {SystemPortalUserStats}
+     * @memberof GetSystemPortalOverview
+     */
+    users: SystemPortalUserStats;
+    /**
+     * 
+     * @type {SystemPortalCourseStats}
+     * @memberof GetSystemPortalOverview
+     */
+    courses: SystemPortalCourseStats;
+    /**
+     * 
+     * @type {SystemPortalEnrollmentStats}
+     * @memberof GetSystemPortalOverview
+     */
+    enrollments: SystemPortalEnrollmentStats;
+    /**
+     * 
+     * @type {SystemPortalContentStats}
+     * @memberof GetSystemPortalOverview
+     */
+    content: SystemPortalContentStats;
+    /**
+     * 
+     * @type {SystemPortalCertificateStats}
+     * @memberof GetSystemPortalOverview
+     */
+    certificates: SystemPortalCertificateStats;
+    /**
+     * 
+     * @type {SystemPortalStorageUsage}
+     * @memberof GetSystemPortalOverview
+     */
+    storage: SystemPortalStorageUsage;
+    /**
+     * 
+     * @type {SystemPortalActivityStats}
+     * @memberof GetSystemPortalOverview
+     */
+    activity: SystemPortalActivityStats;
+    /**
+     * 
+     * @type {SystemPortalSupportStats}
+     * @memberof GetSystemPortalOverview
+     */
+    support: SystemPortalSupportStats;
+}
+
+/**
+ * Check if a given object implements the GetSystemPortalOverview interface.
+ */
+export function instanceOfGetSystemPortalOverview(value: object): value is GetSystemPortalOverview {
+    if (!('portal' in value) || value['portal'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    if (!('generatedAt' in value) || value['generatedAt'] === undefined) return false;
+    if (!('hierarchy' in value) || value['hierarchy'] === undefined) return false;
+    if (!('license' in value) || value['license'] === undefined) return false;
+    if (!('users' in value) || value['users'] === undefined) return false;
+    if (!('courses' in value) || value['courses'] === undefined) return false;
+    if (!('enrollments' in value) || value['enrollments'] === undefined) return false;
+    if (!('content' in value) || value['content'] === undefined) return false;
+    if (!('certificates' in value) || value['certificates'] === undefined) return false;
+    if (!('storage' in value) || value['storage'] === undefined) return false;
+    if (!('activity' in value) || value['activity'] === undefined) return false;
+    if (!('support' in value) || value['support'] === undefined) return false;
+    return true;
+}
+
+export function GetSystemPortalOverviewFromJSON(json: any): GetSystemPortalOverview {
+    return GetSystemPortalOverviewFromJSONTyped(json, false);
+}
+
+export function GetSystemPortalOverviewFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetSystemPortalOverview {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'portal': GetPortalFromJSON(json['portal']),
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+        'generatedAt': json['generated_at'],
+        'hierarchy': SystemPortalHierarchyFromJSON(json['hierarchy']),
+        'license': SystemPortalLicenseFromJSON(json['license']),
+        'users': SystemPortalUserStatsFromJSON(json['users']),
+        'courses': SystemPortalCourseStatsFromJSON(json['courses']),
+        'enrollments': SystemPortalEnrollmentStatsFromJSON(json['enrollments']),
+        'content': SystemPortalContentStatsFromJSON(json['content']),
+        'certificates': SystemPortalCertificateStatsFromJSON(json['certificates']),
+        'storage': SystemPortalStorageUsageFromJSON(json['storage']),
+        'activity': SystemPortalActivityStatsFromJSON(json['activity']),
+        'support': SystemPortalSupportStatsFromJSON(json['support']),
+    };
+}
+
+export function GetSystemPortalOverviewToJSON(json: any): GetSystemPortalOverview {
+    return GetSystemPortalOverviewToJSONTyped(json, false);
+}
+
+export function GetSystemPortalOverviewToJSONTyped(value?: GetSystemPortalOverview | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'portal': GetPortalToJSON(value['portal']),
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+        'generated_at': value['generatedAt'],
+        'hierarchy': SystemPortalHierarchyToJSON(value['hierarchy']),
+        'license': SystemPortalLicenseToJSON(value['license']),
+        'users': SystemPortalUserStatsToJSON(value['users']),
+        'courses': SystemPortalCourseStatsToJSON(value['courses']),
+        'enrollments': SystemPortalEnrollmentStatsToJSON(value['enrollments']),
+        'content': SystemPortalContentStatsToJSON(value['content']),
+        'certificates': SystemPortalCertificateStatsToJSON(value['certificates']),
+        'storage': SystemPortalStorageUsageToJSON(value['storage']),
+        'activity': SystemPortalActivityStatsToJSON(value['activity']),
+        'support': SystemPortalSupportStatsToJSON(value['support']),
+    };
+}
+

package/src/models/PostReportExport.ts

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

package/src/models/PostReportQuery.ts

@@ -0,0 +1,104 @@
+/* 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 { ReportFilters } from './ReportFilters';
+import {
+    ReportFiltersFromJSON,
+    ReportFiltersFromJSONTyped,
+    ReportFiltersToJSON,
+    ReportFiltersToJSONTyped,
+} from './ReportFilters';
+import type { ReportSort } from './ReportSort';
+import {
+    ReportSortFromJSON,
+    ReportSortFromJSONTyped,
+    ReportSortToJSON,
+    ReportSortToJSONTyped,
+} 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 function instanceOfPostReportQuery(value: object): value is PostReportQuery {
+    return true;
+}
+
+export function PostReportQueryFromJSON(json: any): PostReportQuery {
+    return PostReportQueryFromJSONTyped(json, false);
+}
+
+export function PostReportQueryFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostReportQuery {
+    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: any): PostReportQuery {
+    return PostReportQueryToJSONTyped(json, false);
+}
+
+export function PostReportQueryToJSONTyped(value?: PostReportQuery | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'filters': ReportFiltersToJSON(value['filters']),
+        'sort': ReportSortToJSON(value['sort']),
+        'page': value['page'],
+        'page_size': value['pageSize'],
+    };
+}
+

package/src/models/ReportCategory.ts

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

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