@easyedu/js-lsm-api 1.131.0 → 1.132.0

package/src/models/SystemPortalCertificateStats.ts

@@ -0,0 +1,93 @@
+/* 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 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 function instanceOfSystemPortalCertificateStats(value: object): value is SystemPortalCertificateStats {
+    if (!('active' in value) || value['active'] === undefined) return false;
+    if (!('revoked' in value) || value['revoked'] === undefined) return false;
+    if (!('issuedLast30Days' in value) || value['issuedLast30Days'] === undefined) return false;
+    if (!('expiringNext30Days' in value) || value['expiringNext30Days'] === undefined) return false;
+    return true;
+}
+
+export function SystemPortalCertificateStatsFromJSON(json: any): SystemPortalCertificateStats {
+    return SystemPortalCertificateStatsFromJSONTyped(json, false);
+}
+
+export function SystemPortalCertificateStatsFromJSONTyped(json: any, ignoreDiscriminator: boolean): SystemPortalCertificateStats {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'active': json['active'],
+        'revoked': json['revoked'],
+        'issuedLast30Days': json['issued_last_30_days'],
+        'expiringNext30Days': json['expiring_next_30_days'],
+    };
+}
+
+export function SystemPortalCertificateStatsToJSON(json: any): SystemPortalCertificateStats {
+    return SystemPortalCertificateStatsToJSONTyped(json, false);
+}
+
+export function SystemPortalCertificateStatsToJSONTyped(value?: SystemPortalCertificateStats | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'active': value['active'],
+        'revoked': value['revoked'],
+        'issued_last_30_days': value['issuedLast30Days'],
+        'expiring_next_30_days': value['expiringNext30Days'],
+    };
+}
+

package/src/models/SystemPortalContentStats.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';
+/**
+ * Non-archived Content Library items and active question bank entries owned by the portal.
+ * @export
+ * @interface SystemPortalContentStats
+ */
+export interface SystemPortalContentStats {
+    /**
+     * 
+     * @type {number}
+     * @memberof SystemPortalContentStats
+     */
+    libraryItems: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof SystemPortalContentStats
+     */
+    resources: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof SystemPortalContentStats
+     */
+    quizzes: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof SystemPortalContentStats
+     */
+    certificateTemplates: number;
+    /**
+     * Active, latest-version questions.
+     * @type {number}
+     * @memberof SystemPortalContentStats
+     */
+    questions: number;
+}
+
+/**
+ * Check if a given object implements the SystemPortalContentStats interface.
+ */
+export function instanceOfSystemPortalContentStats(value: object): value is SystemPortalContentStats {
+    if (!('libraryItems' in value) || value['libraryItems'] === undefined) return false;
+    if (!('resources' in value) || value['resources'] === undefined) return false;
+    if (!('quizzes' in value) || value['quizzes'] === undefined) return false;
+    if (!('certificateTemplates' in value) || value['certificateTemplates'] === undefined) return false;
+    if (!('questions' in value) || value['questions'] === undefined) return false;
+    return true;
+}
+
+export function SystemPortalContentStatsFromJSON(json: any): SystemPortalContentStats {
+    return SystemPortalContentStatsFromJSONTyped(json, false);
+}
+
+export function SystemPortalContentStatsFromJSONTyped(json: any, ignoreDiscriminator: boolean): SystemPortalContentStats {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'libraryItems': json['library_items'],
+        'resources': json['resources'],
+        'quizzes': json['quizzes'],
+        'certificateTemplates': json['certificate_templates'],
+        'questions': json['questions'],
+    };
+}
+
+export function SystemPortalContentStatsToJSON(json: any): SystemPortalContentStats {
+    return SystemPortalContentStatsToJSONTyped(json, false);
+}
+
+export function SystemPortalContentStatsToJSONTyped(value?: SystemPortalContentStats | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'library_items': value['libraryItems'],
+        'resources': value['resources'],
+        'quizzes': value['quizzes'],
+        'certificate_templates': value['certificateTemplates'],
+        'questions': value['questions'],
+    };
+}
+

package/src/models/SystemPortalCourseStats.ts

@@ -0,0 +1,111 @@
+/* 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 SystemPortalCourseStats
+ */
+export interface SystemPortalCourseStats {
+    /**
+     * Non-deleted courses owned by the portal.
+     * @type {number}
+     * @memberof SystemPortalCourseStats
+     */
+    total: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof SystemPortalCourseStats
+     */
+    published: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof SystemPortalCourseStats
+     */
+    unpublished: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof SystemPortalCourseStats
+     */
+    createdLast30Days: number;
+    /**
+     * Accepted course shares (mirror or clone) received by the portal.
+     * @type {number}
+     * @memberof SystemPortalCourseStats
+     */
+    sharedIn: number;
+    /**
+     * Accepted course shares the portal has granted to other portals.
+     * @type {number}
+     * @memberof SystemPortalCourseStats
+     */
+    sharedOut: number;
+}
+
+/**
+ * Check if a given object implements the SystemPortalCourseStats interface.
+ */
+export function instanceOfSystemPortalCourseStats(value: object): value is SystemPortalCourseStats {
+    if (!('total' in value) || value['total'] === undefined) return false;
+    if (!('published' in value) || value['published'] === undefined) return false;
+    if (!('unpublished' in value) || value['unpublished'] === undefined) return false;
+    if (!('createdLast30Days' in value) || value['createdLast30Days'] === undefined) return false;
+    if (!('sharedIn' in value) || value['sharedIn'] === undefined) return false;
+    if (!('sharedOut' in value) || value['sharedOut'] === undefined) return false;
+    return true;
+}
+
+export function SystemPortalCourseStatsFromJSON(json: any): SystemPortalCourseStats {
+    return SystemPortalCourseStatsFromJSONTyped(json, false);
+}
+
+export function SystemPortalCourseStatsFromJSONTyped(json: any, ignoreDiscriminator: boolean): SystemPortalCourseStats {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'total': json['total'],
+        'published': json['published'],
+        'unpublished': json['unpublished'],
+        'createdLast30Days': json['created_last_30_days'],
+        'sharedIn': json['shared_in'],
+        'sharedOut': json['shared_out'],
+    };
+}
+
+export function SystemPortalCourseStatsToJSON(json: any): SystemPortalCourseStats {
+    return SystemPortalCourseStatsToJSONTyped(json, false);
+}
+
+export function SystemPortalCourseStatsToJSONTyped(value?: SystemPortalCourseStats | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'total': value['total'],
+        'published': value['published'],
+        'unpublished': value['unpublished'],
+        'created_last_30_days': value['createdLast30Days'],
+        'shared_in': value['sharedIn'],
+        'shared_out': value['sharedOut'],
+    };
+}
+

package/src/models/SystemPortalEnrollmentStats.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';
+/**
+ * Learner (Student) enrollments in the portal.
+ * @export
+ * @interface SystemPortalEnrollmentStats
+ */
+export interface SystemPortalEnrollmentStats {
+    /**
+     * 
+     * @type {number}
+     * @memberof SystemPortalEnrollmentStats
+     */
+    total: number;
+    /**
+     * Enrolled, InProgress, or Suspended.
+     * @type {number}
+     * @memberof SystemPortalEnrollmentStats
+     */
+    active: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof SystemPortalEnrollmentStats
+     */
+    completed: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof SystemPortalEnrollmentStats
+     */
+    createdLast30Days: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof SystemPortalEnrollmentStats
+     */
+    completedLast30Days: number;
+}
+
+/**
+ * Check if a given object implements the SystemPortalEnrollmentStats interface.
+ */
+export function instanceOfSystemPortalEnrollmentStats(value: object): value is SystemPortalEnrollmentStats {
+    if (!('total' in value) || value['total'] === undefined) return false;
+    if (!('active' in value) || value['active'] === undefined) return false;
+    if (!('completed' in value) || value['completed'] === undefined) return false;
+    if (!('createdLast30Days' in value) || value['createdLast30Days'] === undefined) return false;
+    if (!('completedLast30Days' in value) || value['completedLast30Days'] === undefined) return false;
+    return true;
+}
+
+export function SystemPortalEnrollmentStatsFromJSON(json: any): SystemPortalEnrollmentStats {
+    return SystemPortalEnrollmentStatsFromJSONTyped(json, false);
+}
+
+export function SystemPortalEnrollmentStatsFromJSONTyped(json: any, ignoreDiscriminator: boolean): SystemPortalEnrollmentStats {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'total': json['total'],
+        'active': json['active'],
+        'completed': json['completed'],
+        'createdLast30Days': json['created_last_30_days'],
+        'completedLast30Days': json['completed_last_30_days'],
+    };
+}
+
+export function SystemPortalEnrollmentStatsToJSON(json: any): SystemPortalEnrollmentStats {
+    return SystemPortalEnrollmentStatsToJSONTyped(json, false);
+}
+
+export function SystemPortalEnrollmentStatsToJSONTyped(value?: SystemPortalEnrollmentStats | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'total': value['total'],
+        'active': value['active'],
+        'completed': value['completed'],
+        'created_last_30_days': value['createdLast30Days'],
+        'completed_last_30_days': value['completedLast30Days'],
+    };
+}
+

package/src/models/SystemPortalHierarchy.ts

@@ -0,0 +1,82 @@
+/* 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 SystemPortalHierarchy
+ */
+export interface SystemPortalHierarchy {
+    /**
+     * 
+     * @type {string}
+     * @memberof SystemPortalHierarchy
+     */
+    parentPortalId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof SystemPortalHierarchy
+     */
+    parentPortalName?: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof SystemPortalHierarchy
+     */
+    childPortalCount: number;
+}
+
+/**
+ * Check if a given object implements the SystemPortalHierarchy interface.
+ */
+export function instanceOfSystemPortalHierarchy(value: object): value is SystemPortalHierarchy {
+    if (!('childPortalCount' in value) || value['childPortalCount'] === undefined) return false;
+    return true;
+}
+
+export function SystemPortalHierarchyFromJSON(json: any): SystemPortalHierarchy {
+    return SystemPortalHierarchyFromJSONTyped(json, false);
+}
+
+export function SystemPortalHierarchyFromJSONTyped(json: any, ignoreDiscriminator: boolean): SystemPortalHierarchy {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'parentPortalId': json['parent_portal_id'] == null ? undefined : json['parent_portal_id'],
+        'parentPortalName': json['parent_portal_name'] == null ? undefined : json['parent_portal_name'],
+        'childPortalCount': json['child_portal_count'],
+    };
+}
+
+export function SystemPortalHierarchyToJSON(json: any): SystemPortalHierarchy {
+    return SystemPortalHierarchyToJSONTyped(json, false);
+}
+
+export function SystemPortalHierarchyToJSONTyped(value?: SystemPortalHierarchy | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'parent_portal_id': value['parentPortalId'],
+        'parent_portal_name': value['parentPortalName'],
+        'child_portal_count': value['childPortalCount'],
+    };
+}
+

package/src/models/SystemPortalLicense.ts

@@ -0,0 +1,111 @@
+/* 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 SystemPortalLicense
+ */
+export interface SystemPortalLicense {
+    /**
+     * 
+     * @type {SystemPortalLicenseStateEnum}
+     * @memberof SystemPortalLicense
+     */
+    state: SystemPortalLicenseStateEnum;
+    /**
+     * Maximum active learner seats. Null means unlimited.
+     * @type {number}
+     * @memberof SystemPortalLicense
+     */
+    seatLimit?: number | null;
+    /**
+     * Active learner enrollments (Enrolled, InProgress, Suspended) counted against the seat limit.
+     * @type {number}
+     * @memberof SystemPortalLicense
+     */
+    seatsUsed: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof SystemPortalLicense
+     */
+    licenseStartAt?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof SystemPortalLicense
+     */
+    licenseEndAt?: number | null;
+}
+
+
+/**
+ * @export
+ */
+export const SystemPortalLicenseStateEnum = {
+    Active: 'active',
+    Suspended: 'suspended',
+    Expired: 'expired'
+} as const;
+export type SystemPortalLicenseStateEnum = typeof SystemPortalLicenseStateEnum[keyof typeof SystemPortalLicenseStateEnum];
+
+
+/**
+ * Check if a given object implements the SystemPortalLicense interface.
+ */
+export function instanceOfSystemPortalLicense(value: object): value is SystemPortalLicense {
+    if (!('state' in value) || value['state'] === undefined) return false;
+    if (!('seatsUsed' in value) || value['seatsUsed'] === undefined) return false;
+    return true;
+}
+
+export function SystemPortalLicenseFromJSON(json: any): SystemPortalLicense {
+    return SystemPortalLicenseFromJSONTyped(json, false);
+}
+
+export function SystemPortalLicenseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SystemPortalLicense {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'state': json['state'],
+        'seatLimit': json['seat_limit'] == null ? undefined : json['seat_limit'],
+        'seatsUsed': json['seats_used'],
+        'licenseStartAt': json['license_start_at'] == null ? undefined : json['license_start_at'],
+        'licenseEndAt': json['license_end_at'] == null ? undefined : json['license_end_at'],
+    };
+}
+
+export function SystemPortalLicenseToJSON(json: any): SystemPortalLicense {
+    return SystemPortalLicenseToJSONTyped(json, false);
+}
+
+export function SystemPortalLicenseToJSONTyped(value?: SystemPortalLicense | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'state': value['state'],
+        'seat_limit': value['seatLimit'],
+        'seats_used': value['seatsUsed'],
+        'license_start_at': value['licenseStartAt'],
+        'license_end_at': value['licenseEndAt'],
+    };
+}
+

package/src/models/SystemPortalRoleCount.ts

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