@easyedu/js-lsm-api 1.131.0 → 1.132.0

package/dist/esm/models/SystemPortalRoleCount.js

@@ -0,0 +1,59 @@
+/* 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 SystemPortalRoleCountBaseTypeEnum = {
+    Owner: 'Owner',
+    Admin: 'Admin',
+    Instructor: 'Instructor',
+    Learner: 'Learner',
+    ClientSuperAdmin: 'ClientSuperAdmin',
+    ClientManager: 'ClientManager',
+    PortalClientAdministrator: 'PortalClientAdministrator'
+};
+/**
+ * Check if a given object implements the SystemPortalRoleCount interface.
+ */
+export function instanceOfSystemPortalRoleCount(value) {
+    if (!('baseType' in value) || value['baseType'] === undefined)
+        return false;
+    if (!('userCount' in value) || value['userCount'] === undefined)
+        return false;
+    return true;
+}
+export function SystemPortalRoleCountFromJSON(json) {
+    return SystemPortalRoleCountFromJSONTyped(json, false);
+}
+export function SystemPortalRoleCountFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'baseType': json['base_type'],
+        'userCount': json['user_count'],
+    };
+}
+export function SystemPortalRoleCountToJSON(json) {
+    return SystemPortalRoleCountToJSONTyped(json, false);
+}
+export function SystemPortalRoleCountToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'base_type': value['baseType'],
+        'user_count': value['userCount'],
+    };
+}

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

@@ -0,0 +1,74 @@
+/**
+ * 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.
+ */
+/**
+ * Stored object sizes attributed to the portal, in bytes, as recorded in the database at upload time. Pending and deleted uploads are excluded.
+ * @export
+ * @interface SystemPortalStorageUsage
+ */
+export interface SystemPortalStorageUsage {
+    /**
+     *
+     * @type {number}
+     * @memberof SystemPortalStorageUsage
+     */
+    totalBytes: number;
+    /**
+     * Uploaded Content Library resource files across all versions.
+     * @type {number}
+     * @memberof SystemPortalStorageUsage
+     */
+    contentLibraryBytes: number;
+    /**
+     *
+     * @type {number}
+     * @memberof SystemPortalStorageUsage
+     */
+    richTextAssetBytes: number;
+    /**
+     *
+     * @type {number}
+     * @memberof SystemPortalStorageUsage
+     */
+    emailAssetBytes: number;
+    /**
+     *
+     * @type {number}
+     * @memberof SystemPortalStorageUsage
+     */
+    certificateAssetBytes: number;
+    /**
+     * Generated certificate PDFs.
+     * @type {number}
+     * @memberof SystemPortalStorageUsage
+     */
+    certificateArtifactBytes: number;
+    /**
+     *
+     * @type {number}
+     * @memberof SystemPortalStorageUsage
+     */
+    supportAttachmentBytes: number;
+    /**
+     *
+     * @type {number}
+     * @memberof SystemPortalStorageUsage
+     */
+    courseExportBytes: number;
+}
+/**
+ * Check if a given object implements the SystemPortalStorageUsage interface.
+ */
+export declare function instanceOfSystemPortalStorageUsage(value: object): value is SystemPortalStorageUsage;
+export declare function SystemPortalStorageUsageFromJSON(json: any): SystemPortalStorageUsage;
+export declare function SystemPortalStorageUsageFromJSONTyped(json: any, ignoreDiscriminator: boolean): SystemPortalStorageUsage;
+export declare function SystemPortalStorageUsageToJSON(json: any): SystemPortalStorageUsage;
+export declare function SystemPortalStorageUsageToJSONTyped(value?: SystemPortalStorageUsage | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/SystemPortalStorageUsage.js

@@ -0,0 +1,71 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the SystemPortalStorageUsage interface.
+ */
+export function instanceOfSystemPortalStorageUsage(value) {
+    if (!('totalBytes' in value) || value['totalBytes'] === undefined)
+        return false;
+    if (!('contentLibraryBytes' in value) || value['contentLibraryBytes'] === undefined)
+        return false;
+    if (!('richTextAssetBytes' in value) || value['richTextAssetBytes'] === undefined)
+        return false;
+    if (!('emailAssetBytes' in value) || value['emailAssetBytes'] === undefined)
+        return false;
+    if (!('certificateAssetBytes' in value) || value['certificateAssetBytes'] === undefined)
+        return false;
+    if (!('certificateArtifactBytes' in value) || value['certificateArtifactBytes'] === undefined)
+        return false;
+    if (!('supportAttachmentBytes' in value) || value['supportAttachmentBytes'] === undefined)
+        return false;
+    if (!('courseExportBytes' in value) || value['courseExportBytes'] === undefined)
+        return false;
+    return true;
+}
+export function SystemPortalStorageUsageFromJSON(json) {
+    return SystemPortalStorageUsageFromJSONTyped(json, false);
+}
+export function SystemPortalStorageUsageFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'totalBytes': json['total_bytes'],
+        'contentLibraryBytes': json['content_library_bytes'],
+        'richTextAssetBytes': json['rich_text_asset_bytes'],
+        'emailAssetBytes': json['email_asset_bytes'],
+        'certificateAssetBytes': json['certificate_asset_bytes'],
+        'certificateArtifactBytes': json['certificate_artifact_bytes'],
+        'supportAttachmentBytes': json['support_attachment_bytes'],
+        'courseExportBytes': json['course_export_bytes'],
+    };
+}
+export function SystemPortalStorageUsageToJSON(json) {
+    return SystemPortalStorageUsageToJSONTyped(json, false);
+}
+export function SystemPortalStorageUsageToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'total_bytes': value['totalBytes'],
+        'content_library_bytes': value['contentLibraryBytes'],
+        'rich_text_asset_bytes': value['richTextAssetBytes'],
+        'email_asset_bytes': value['emailAssetBytes'],
+        'certificate_asset_bytes': value['certificateAssetBytes'],
+        'certificate_artifact_bytes': value['certificateArtifactBytes'],
+        'support_attachment_bytes': value['supportAttachmentBytes'],
+        'course_export_bytes': value['courseExportBytes'],
+    };
+}

package/dist/esm/models/SystemPortalSupportStats.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 SystemPortalSupportStats
+ */
+export interface SystemPortalSupportStats {
+    /**
+     *
+     * @type {number}
+     * @memberof SystemPortalSupportStats
+     */
+    open: number;
+    /**
+     *
+     * @type {number}
+     * @memberof SystemPortalSupportStats
+     */
+    inProgress: number;
+    /**
+     *
+     * @type {number}
+     * @memberof SystemPortalSupportStats
+     */
+    closed: number;
+    /**
+     *
+     * @type {number}
+     * @memberof SystemPortalSupportStats
+     */
+    total: number;
+}
+/**
+ * Check if a given object implements the SystemPortalSupportStats interface.
+ */
+export declare function instanceOfSystemPortalSupportStats(value: object): value is SystemPortalSupportStats;
+export declare function SystemPortalSupportStatsFromJSON(json: any): SystemPortalSupportStats;
+export declare function SystemPortalSupportStatsFromJSONTyped(json: any, ignoreDiscriminator: boolean): SystemPortalSupportStats;
+export declare function SystemPortalSupportStatsToJSON(json: any): SystemPortalSupportStats;
+export declare function SystemPortalSupportStatsToJSONTyped(value?: SystemPortalSupportStats | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/SystemPortalSupportStats.js

@@ -0,0 +1,55 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the SystemPortalSupportStats interface.
+ */
+export function instanceOfSystemPortalSupportStats(value) {
+    if (!('open' in value) || value['open'] === undefined)
+        return false;
+    if (!('inProgress' in value) || value['inProgress'] === undefined)
+        return false;
+    if (!('closed' in value) || value['closed'] === undefined)
+        return false;
+    if (!('total' in value) || value['total'] === undefined)
+        return false;
+    return true;
+}
+export function SystemPortalSupportStatsFromJSON(json) {
+    return SystemPortalSupportStatsFromJSONTyped(json, false);
+}
+export function SystemPortalSupportStatsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'open': json['open'],
+        'inProgress': json['in_progress'],
+        'closed': json['closed'],
+        'total': json['total'],
+    };
+}
+export function SystemPortalSupportStatsToJSON(json) {
+    return SystemPortalSupportStatsToJSONTyped(json, false);
+}
+export function SystemPortalSupportStatsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'open': value['open'],
+        'in_progress': value['inProgress'],
+        'closed': value['closed'],
+        'total': value['total'],
+    };
+}

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

@@ -0,0 +1,81 @@
+/**
+ * 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 { SystemPortalRoleCount } from './SystemPortalRoleCount';
+/**
+ *
+ * @export
+ * @interface SystemPortalUserStats
+ */
+export interface SystemPortalUserStats {
+    /**
+     * Distinct users holding at least one active role in the portal.
+     * @type {number}
+     * @memberof SystemPortalUserStats
+     */
+    total: number;
+    /**
+     *
+     * @type {number}
+     * @memberof SystemPortalUserStats
+     */
+    enabled: number;
+    /**
+     *
+     * @type {number}
+     * @memberof SystemPortalUserStats
+     */
+    disabled: number;
+    /**
+     * Users whose earliest active role in the portal was assigned in the last 30 days.
+     * @type {number}
+     * @memberof SystemPortalUserStats
+     */
+    newLast30Days: number;
+    /**
+     * Distinct users who logged in to the portal in the last 7 days.
+     * @type {number}
+     * @memberof SystemPortalUserStats
+     */
+    activeLast7Days: number;
+    /**
+     *
+     * @type {number}
+     * @memberof SystemPortalUserStats
+     */
+    activeLast30Days: number;
+    /**
+     *
+     * @type {number}
+     * @memberof SystemPortalUserStats
+     */
+    pendingInvitations: number;
+    /**
+     *
+     * @type {number}
+     * @memberof SystemPortalUserStats
+     */
+    lastLoginAt?: number | null;
+    /**
+     * Distinct users per role base type. A user with several roles is counted once per base type.
+     * @type {Array<SystemPortalRoleCount>}
+     * @memberof SystemPortalUserStats
+     */
+    byRole: Array<SystemPortalRoleCount>;
+}
+/**
+ * Check if a given object implements the SystemPortalUserStats interface.
+ */
+export declare function instanceOfSystemPortalUserStats(value: object): value is SystemPortalUserStats;
+export declare function SystemPortalUserStatsFromJSON(json: any): SystemPortalUserStats;
+export declare function SystemPortalUserStatsFromJSONTyped(json: any, ignoreDiscriminator: boolean): SystemPortalUserStats;
+export declare function SystemPortalUserStatsToJSON(json: any): SystemPortalUserStats;
+export declare function SystemPortalUserStatsToJSONTyped(value?: SystemPortalUserStats | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/SystemPortalUserStats.js

@@ -0,0 +1,74 @@
+/* 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 { SystemPortalRoleCountFromJSON, SystemPortalRoleCountToJSON, } from './SystemPortalRoleCount';
+/**
+ * Check if a given object implements the SystemPortalUserStats interface.
+ */
+export function instanceOfSystemPortalUserStats(value) {
+    if (!('total' in value) || value['total'] === undefined)
+        return false;
+    if (!('enabled' in value) || value['enabled'] === undefined)
+        return false;
+    if (!('disabled' in value) || value['disabled'] === undefined)
+        return false;
+    if (!('newLast30Days' in value) || value['newLast30Days'] === undefined)
+        return false;
+    if (!('activeLast7Days' in value) || value['activeLast7Days'] === undefined)
+        return false;
+    if (!('activeLast30Days' in value) || value['activeLast30Days'] === undefined)
+        return false;
+    if (!('pendingInvitations' in value) || value['pendingInvitations'] === undefined)
+        return false;
+    if (!('byRole' in value) || value['byRole'] === undefined)
+        return false;
+    return true;
+}
+export function SystemPortalUserStatsFromJSON(json) {
+    return SystemPortalUserStatsFromJSONTyped(json, false);
+}
+export function SystemPortalUserStatsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'total': json['total'],
+        'enabled': json['enabled'],
+        'disabled': json['disabled'],
+        'newLast30Days': json['new_last_30_days'],
+        'activeLast7Days': json['active_last_7_days'],
+        'activeLast30Days': json['active_last_30_days'],
+        'pendingInvitations': json['pending_invitations'],
+        'lastLoginAt': json['last_login_at'] == null ? undefined : json['last_login_at'],
+        'byRole': (json['by_role'].map(SystemPortalRoleCountFromJSON)),
+    };
+}
+export function SystemPortalUserStatsToJSON(json) {
+    return SystemPortalUserStatsToJSONTyped(json, false);
+}
+export function SystemPortalUserStatsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'total': value['total'],
+        'enabled': value['enabled'],
+        'disabled': value['disabled'],
+        'new_last_30_days': value['newLast30Days'],
+        'active_last_7_days': value['activeLast7Days'],
+        'active_last_30_days': value['activeLast30Days'],
+        'pending_invitations': value['pendingInvitations'],
+        'last_login_at': value['lastLoginAt'],
+        'by_role': (value['byRole'].map(SystemPortalRoleCountToJSON)),
+    };
+}

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

@@ -165,6 +165,7 @@ export * from './GetSupportTicketList';
 export * from './GetSystemBillingItem';
 export * from './GetSystemBillingList';
 export * from './GetSystemMetrics';
+export * from './GetSystemPortalOverview';
 export * from './GetUser';
 export * from './GetUserAvatarUpload';
 export * from './GetUserCourseList';
@@ -376,6 +377,17 @@ export * from './ScormSetValueRequest';
 export * from './ScormSetValueResponse';
 export * from './ScormTerminateResponse';
 export * from './SupportTicketUser';
+export * from './SystemPortalActivityStats';
+export * from './SystemPortalCertificateStats';
+export * from './SystemPortalContentStats';
+export * from './SystemPortalCourseStats';
+export * from './SystemPortalEnrollmentStats';
+export * from './SystemPortalHierarchy';
+export * from './SystemPortalLicense';
+export * from './SystemPortalRoleCount';
+export * from './SystemPortalStorageUsage';
+export * from './SystemPortalSupportStats';
+export * from './SystemPortalUserStats';
 export * from './UpdateSelectedPortalResponse';
 export * from './UpdateSelectedPortalResponseHostPortal';
 export * from './UpdateSelectedPortalResponseSelectedPortal';

package/dist/esm/models/index.js

@@ -167,6 +167,7 @@ export * from './GetSupportTicketList';
 export * from './GetSystemBillingItem';
 export * from './GetSystemBillingList';
 export * from './GetSystemMetrics';
+export * from './GetSystemPortalOverview';
 export * from './GetUser';
 export * from './GetUserAvatarUpload';
 export * from './GetUserCourseList';
@@ -378,6 +379,17 @@ export * from './ScormSetValueRequest';
 export * from './ScormSetValueResponse';
 export * from './ScormTerminateResponse';
 export * from './SupportTicketUser';
+export * from './SystemPortalActivityStats';
+export * from './SystemPortalCertificateStats';
+export * from './SystemPortalContentStats';
+export * from './SystemPortalCourseStats';
+export * from './SystemPortalEnrollmentStats';
+export * from './SystemPortalHierarchy';
+export * from './SystemPortalLicense';
+export * from './SystemPortalRoleCount';
+export * from './SystemPortalStorageUsage';
+export * from './SystemPortalSupportStats';
+export * from './SystemPortalUserStats';
 export * from './UpdateSelectedPortalResponse';
 export * from './UpdateSelectedPortalResponseHostPortal';
 export * from './UpdateSelectedPortalResponseSelectedPortal';

package/dist/models/GetSystemPortalOverview.d.ts

@@ -0,0 +1,121 @@
+/**
+ * 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 { SystemPortalCourseStats } from './SystemPortalCourseStats';
+import type { SystemPortalLicense } from './SystemPortalLicense';
+import type { SystemPortalCertificateStats } from './SystemPortalCertificateStats';
+import type { SystemPortalStorageUsage } from './SystemPortalStorageUsage';
+import type { SystemPortalSupportStats } from './SystemPortalSupportStats';
+import type { GetPortal } from './GetPortal';
+import type { SystemPortalEnrollmentStats } from './SystemPortalEnrollmentStats';
+import type { SystemPortalActivityStats } from './SystemPortalActivityStats';
+import type { SystemPortalContentStats } from './SystemPortalContentStats';
+import type { SystemPortalHierarchy } from './SystemPortalHierarchy';
+import type { SystemPortalUserStats } 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 declare function instanceOfGetSystemPortalOverview(value: object): value is GetSystemPortalOverview;
+export declare function GetSystemPortalOverviewFromJSON(json: any): GetSystemPortalOverview;
+export declare function GetSystemPortalOverviewFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetSystemPortalOverview;
+export declare function GetSystemPortalOverviewToJSON(json: any): GetSystemPortalOverview;
+export declare function GetSystemPortalOverviewToJSONTyped(value?: GetSystemPortalOverview | null, ignoreDiscriminator?: boolean): any;