@easyedu/js-lsm-api 1.123.0 → 1.125.0

package/src/apis/ReportingApi.ts

@@ -23,6 +23,11 @@ import {
     GetCourseVersionSectionReportingFromJSON,
     GetCourseVersionSectionReportingToJSON,
 } from '../models/GetCourseVersionSectionReporting';
+import {
+    type GetPortalManagementDashboard,
+    GetPortalManagementDashboardFromJSON,
+    GetPortalManagementDashboardToJSON,
+} from '../models/GetPortalManagementDashboard';
 
 export interface GetCourseVersionReportingRequest {
     courseId: string;
@@ -35,6 +40,10 @@ export interface GetCourseVersionSectionReportingRequest {
     sectionId: string;
 }
 
+export interface GetPortalManagementDashboardRequest {
+    days?: number;
+}
+
 /**
  * 
  */
@@ -154,4 +163,45 @@ export class ReportingApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for getPortalManagementDashboard without sending the request
+     */
+    async getPortalManagementDashboardRequestOpts(requestParameters: GetPortalManagementDashboardRequest): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        if (requestParameters['days'] != null) {
+            queryParameters['days'] = requestParameters['days'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/reporting/portal/dashboard`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get the selected portal\'s management dashboard reporting
+     */
+    async getPortalManagementDashboardRaw(requestParameters: GetPortalManagementDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortalManagementDashboard>> {
+        const requestOptions = await this.getPortalManagementDashboardRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetPortalManagementDashboardFromJSON(jsonValue));
+    }
+
+    /**
+     * Get the selected portal\'s management dashboard reporting
+     */
+    async getPortalManagementDashboard(requestParameters: GetPortalManagementDashboardRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalManagementDashboard> {
+        const response = await this.getPortalManagementDashboardRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
 }

package/src/models/GetPortalManagementDashboard.ts

@@ -0,0 +1,156 @@
+/* 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 { GetPortalManagementDashboardTopCourse } from './GetPortalManagementDashboardTopCourse';
+import {
+    GetPortalManagementDashboardTopCourseFromJSON,
+    GetPortalManagementDashboardTopCourseFromJSONTyped,
+    GetPortalManagementDashboardTopCourseToJSON,
+    GetPortalManagementDashboardTopCourseToJSONTyped,
+} from './GetPortalManagementDashboardTopCourse';
+import type { GetPortalManagementDashboardEnrollmentStatus } from './GetPortalManagementDashboardEnrollmentStatus';
+import {
+    GetPortalManagementDashboardEnrollmentStatusFromJSON,
+    GetPortalManagementDashboardEnrollmentStatusFromJSONTyped,
+    GetPortalManagementDashboardEnrollmentStatusToJSON,
+    GetPortalManagementDashboardEnrollmentStatusToJSONTyped,
+} from './GetPortalManagementDashboardEnrollmentStatus';
+import type { GetPortalManagementDashboardSummary } from './GetPortalManagementDashboardSummary';
+import {
+    GetPortalManagementDashboardSummaryFromJSON,
+    GetPortalManagementDashboardSummaryFromJSONTyped,
+    GetPortalManagementDashboardSummaryToJSON,
+    GetPortalManagementDashboardSummaryToJSONTyped,
+} from './GetPortalManagementDashboardSummary';
+import type { GetPortalManagementDashboardActivityDay } from './GetPortalManagementDashboardActivityDay';
+import {
+    GetPortalManagementDashboardActivityDayFromJSON,
+    GetPortalManagementDashboardActivityDayFromJSONTyped,
+    GetPortalManagementDashboardActivityDayToJSON,
+    GetPortalManagementDashboardActivityDayToJSONTyped,
+} from './GetPortalManagementDashboardActivityDay';
+import type { GetPortalManagementDashboardAttention } from './GetPortalManagementDashboardAttention';
+import {
+    GetPortalManagementDashboardAttentionFromJSON,
+    GetPortalManagementDashboardAttentionFromJSONTyped,
+    GetPortalManagementDashboardAttentionToJSON,
+    GetPortalManagementDashboardAttentionToJSONTyped,
+} from './GetPortalManagementDashboardAttention';
+
+/**
+ * 
+ * @export
+ * @interface GetPortalManagementDashboard
+ */
+export interface GetPortalManagementDashboard {
+    /**
+     * 
+     * @type {number}
+     * @memberof GetPortalManagementDashboard
+     */
+    rangeDays: number;
+    /**
+     * Unix timestamp in seconds.
+     * @type {number}
+     * @memberof GetPortalManagementDashboard
+     */
+    generatedAt: number;
+    /**
+     * 
+     * @type {GetPortalManagementDashboardSummary}
+     * @memberof GetPortalManagementDashboard
+     */
+    summary: GetPortalManagementDashboardSummary;
+    /**
+     * 
+     * @type {GetPortalManagementDashboardEnrollmentStatus}
+     * @memberof GetPortalManagementDashboard
+     */
+    enrollmentStatus: GetPortalManagementDashboardEnrollmentStatus;
+    /**
+     * 
+     * @type {Array<GetPortalManagementDashboardActivityDay>}
+     * @memberof GetPortalManagementDashboard
+     */
+    activity: Array<GetPortalManagementDashboardActivityDay>;
+    /**
+     * 
+     * @type {Array<GetPortalManagementDashboardTopCourse>}
+     * @memberof GetPortalManagementDashboard
+     */
+    topCourses: Array<GetPortalManagementDashboardTopCourse>;
+    /**
+     * 
+     * @type {GetPortalManagementDashboardAttention}
+     * @memberof GetPortalManagementDashboard
+     */
+    attention: GetPortalManagementDashboardAttention;
+}
+
+/**
+ * Check if a given object implements the GetPortalManagementDashboard interface.
+ */
+export function instanceOfGetPortalManagementDashboard(value: object): value is GetPortalManagementDashboard {
+    if (!('rangeDays' in value) || value['rangeDays'] === undefined) return false;
+    if (!('generatedAt' in value) || value['generatedAt'] === undefined) return false;
+    if (!('summary' in value) || value['summary'] === undefined) return false;
+    if (!('enrollmentStatus' in value) || value['enrollmentStatus'] === undefined) return false;
+    if (!('activity' in value) || value['activity'] === undefined) return false;
+    if (!('topCourses' in value) || value['topCourses'] === undefined) return false;
+    if (!('attention' in value) || value['attention'] === undefined) return false;
+    return true;
+}
+
+export function GetPortalManagementDashboardFromJSON(json: any): GetPortalManagementDashboard {
+    return GetPortalManagementDashboardFromJSONTyped(json, false);
+}
+
+export function GetPortalManagementDashboardFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPortalManagementDashboard {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'rangeDays': json['range_days'],
+        'generatedAt': json['generated_at'],
+        'summary': GetPortalManagementDashboardSummaryFromJSON(json['summary']),
+        'enrollmentStatus': GetPortalManagementDashboardEnrollmentStatusFromJSON(json['enrollment_status']),
+        'activity': ((json['activity'] as Array<any>).map(GetPortalManagementDashboardActivityDayFromJSON)),
+        'topCourses': ((json['top_courses'] as Array<any>).map(GetPortalManagementDashboardTopCourseFromJSON)),
+        'attention': GetPortalManagementDashboardAttentionFromJSON(json['attention']),
+    };
+}
+
+export function GetPortalManagementDashboardToJSON(json: any): GetPortalManagementDashboard {
+    return GetPortalManagementDashboardToJSONTyped(json, false);
+}
+
+export function GetPortalManagementDashboardToJSONTyped(value?: GetPortalManagementDashboard | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'range_days': value['rangeDays'],
+        'generated_at': value['generatedAt'],
+        'summary': GetPortalManagementDashboardSummaryToJSON(value['summary']),
+        'enrollment_status': GetPortalManagementDashboardEnrollmentStatusToJSON(value['enrollmentStatus']),
+        'activity': ((value['activity'] as Array<any>).map(GetPortalManagementDashboardActivityDayToJSON)),
+        'top_courses': ((value['topCourses'] as Array<any>).map(GetPortalManagementDashboardTopCourseToJSON)),
+        'attention': GetPortalManagementDashboardAttentionToJSON(value['attention']),
+    };
+}
+

package/src/models/GetPortalManagementDashboardActivityDay.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 GetPortalManagementDashboardActivityDay
+ */
+export interface GetPortalManagementDashboardActivityDay {
+    /**
+     * 
+     * @type {Date}
+     * @memberof GetPortalManagementDashboardActivityDay
+     */
+    date: Date;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetPortalManagementDashboardActivityDay
+     */
+    activeLearnerCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetPortalManagementDashboardActivityDay
+     */
+    loginCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetPortalManagementDashboardActivityDay
+     */
+    completionCount: number;
+}
+
+/**
+ * Check if a given object implements the GetPortalManagementDashboardActivityDay interface.
+ */
+export function instanceOfGetPortalManagementDashboardActivityDay(value: object): value is GetPortalManagementDashboardActivityDay {
+    if (!('date' in value) || value['date'] === undefined) return false;
+    if (!('activeLearnerCount' in value) || value['activeLearnerCount'] === undefined) return false;
+    if (!('loginCount' in value) || value['loginCount'] === undefined) return false;
+    if (!('completionCount' in value) || value['completionCount'] === undefined) return false;
+    return true;
+}
+
+export function GetPortalManagementDashboardActivityDayFromJSON(json: any): GetPortalManagementDashboardActivityDay {
+    return GetPortalManagementDashboardActivityDayFromJSONTyped(json, false);
+}
+
+export function GetPortalManagementDashboardActivityDayFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPortalManagementDashboardActivityDay {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'date': (new Date(json['date'])),
+        'activeLearnerCount': json['active_learner_count'],
+        'loginCount': json['login_count'],
+        'completionCount': json['completion_count'],
+    };
+}
+
+export function GetPortalManagementDashboardActivityDayToJSON(json: any): GetPortalManagementDashboardActivityDay {
+    return GetPortalManagementDashboardActivityDayToJSONTyped(json, false);
+}
+
+export function GetPortalManagementDashboardActivityDayToJSONTyped(value?: GetPortalManagementDashboardActivityDay | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'date': value['date'].toISOString().substring(0,10),
+        'active_learner_count': value['activeLearnerCount'],
+        'login_count': value['loginCount'],
+        'completion_count': value['completionCount'],
+    };
+}
+

package/src/models/GetPortalManagementDashboardAttention.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';
+/**
+ * 
+ * @export
+ * @interface GetPortalManagementDashboardAttention
+ */
+export interface GetPortalManagementDashboardAttention {
+    /**
+     * 
+     * @type {number}
+     * @memberof GetPortalManagementDashboardAttention
+     */
+    notStartedEnrollmentCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetPortalManagementDashboardAttention
+     */
+    inactiveLearnerCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetPortalManagementDashboardAttention
+     */
+    expiringEnrollmentCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetPortalManagementDashboardAttention
+     */
+    expiringCertificateCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetPortalManagementDashboardAttention
+     */
+    draftCourseCount: number;
+}
+
+/**
+ * Check if a given object implements the GetPortalManagementDashboardAttention interface.
+ */
+export function instanceOfGetPortalManagementDashboardAttention(value: object): value is GetPortalManagementDashboardAttention {
+    if (!('notStartedEnrollmentCount' in value) || value['notStartedEnrollmentCount'] === undefined) return false;
+    if (!('inactiveLearnerCount' in value) || value['inactiveLearnerCount'] === undefined) return false;
+    if (!('expiringEnrollmentCount' in value) || value['expiringEnrollmentCount'] === undefined) return false;
+    if (!('expiringCertificateCount' in value) || value['expiringCertificateCount'] === undefined) return false;
+    if (!('draftCourseCount' in value) || value['draftCourseCount'] === undefined) return false;
+    return true;
+}
+
+export function GetPortalManagementDashboardAttentionFromJSON(json: any): GetPortalManagementDashboardAttention {
+    return GetPortalManagementDashboardAttentionFromJSONTyped(json, false);
+}
+
+export function GetPortalManagementDashboardAttentionFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPortalManagementDashboardAttention {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'notStartedEnrollmentCount': json['not_started_enrollment_count'],
+        'inactiveLearnerCount': json['inactive_learner_count'],
+        'expiringEnrollmentCount': json['expiring_enrollment_count'],
+        'expiringCertificateCount': json['expiring_certificate_count'],
+        'draftCourseCount': json['draft_course_count'],
+    };
+}
+
+export function GetPortalManagementDashboardAttentionToJSON(json: any): GetPortalManagementDashboardAttention {
+    return GetPortalManagementDashboardAttentionToJSONTyped(json, false);
+}
+
+export function GetPortalManagementDashboardAttentionToJSONTyped(value?: GetPortalManagementDashboardAttention | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'not_started_enrollment_count': value['notStartedEnrollmentCount'],
+        'inactive_learner_count': value['inactiveLearnerCount'],
+        'expiring_enrollment_count': value['expiringEnrollmentCount'],
+        'expiring_certificate_count': value['expiringCertificateCount'],
+        'draft_course_count': value['draftCourseCount'],
+    };
+}
+

package/src/models/GetPortalManagementDashboardEnrollmentStatus.ts

@@ -0,0 +1,84 @@
+/* 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 GetPortalManagementDashboardEnrollmentStatus
+ */
+export interface GetPortalManagementDashboardEnrollmentStatus {
+    /**
+     * 
+     * @type {number}
+     * @memberof GetPortalManagementDashboardEnrollmentStatus
+     */
+    notStartedCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetPortalManagementDashboardEnrollmentStatus
+     */
+    inProgressCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetPortalManagementDashboardEnrollmentStatus
+     */
+    completedCount: number;
+}
+
+/**
+ * Check if a given object implements the GetPortalManagementDashboardEnrollmentStatus interface.
+ */
+export function instanceOfGetPortalManagementDashboardEnrollmentStatus(value: object): value is GetPortalManagementDashboardEnrollmentStatus {
+    if (!('notStartedCount' in value) || value['notStartedCount'] === undefined) return false;
+    if (!('inProgressCount' in value) || value['inProgressCount'] === undefined) return false;
+    if (!('completedCount' in value) || value['completedCount'] === undefined) return false;
+    return true;
+}
+
+export function GetPortalManagementDashboardEnrollmentStatusFromJSON(json: any): GetPortalManagementDashboardEnrollmentStatus {
+    return GetPortalManagementDashboardEnrollmentStatusFromJSONTyped(json, false);
+}
+
+export function GetPortalManagementDashboardEnrollmentStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPortalManagementDashboardEnrollmentStatus {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'notStartedCount': json['not_started_count'],
+        'inProgressCount': json['in_progress_count'],
+        'completedCount': json['completed_count'],
+    };
+}
+
+export function GetPortalManagementDashboardEnrollmentStatusToJSON(json: any): GetPortalManagementDashboardEnrollmentStatus {
+    return GetPortalManagementDashboardEnrollmentStatusToJSONTyped(json, false);
+}
+
+export function GetPortalManagementDashboardEnrollmentStatusToJSONTyped(value?: GetPortalManagementDashboardEnrollmentStatus | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'not_started_count': value['notStartedCount'],
+        'in_progress_count': value['inProgressCount'],
+        'completed_count': value['completedCount'],
+    };
+}
+

package/src/models/GetPortalManagementDashboardSummary.ts

@@ -0,0 +1,129 @@
+/* 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 GetPortalManagementDashboardSummary
+ */
+export interface GetPortalManagementDashboardSummary {
+    /**
+     * 
+     * @type {number}
+     * @memberof GetPortalManagementDashboardSummary
+     */
+    learnerCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetPortalManagementDashboardSummary
+     */
+    activeLearnerCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetPortalManagementDashboardSummary
+     */
+    activeEnrollmentCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetPortalManagementDashboardSummary
+     */
+    completionRatePercentage: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetPortalManagementDashboardSummary
+     */
+    courseCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetPortalManagementDashboardSummary
+     */
+    publishedCourseCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetPortalManagementDashboardSummary
+     */
+    draftCourseCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetPortalManagementDashboardSummary
+     */
+    loginsToday: number;
+}
+
+/**
+ * Check if a given object implements the GetPortalManagementDashboardSummary interface.
+ */
+export function instanceOfGetPortalManagementDashboardSummary(value: object): value is GetPortalManagementDashboardSummary {
+    if (!('learnerCount' in value) || value['learnerCount'] === undefined) return false;
+    if (!('activeLearnerCount' in value) || value['activeLearnerCount'] === undefined) return false;
+    if (!('activeEnrollmentCount' in value) || value['activeEnrollmentCount'] === undefined) return false;
+    if (!('completionRatePercentage' in value) || value['completionRatePercentage'] === undefined) return false;
+    if (!('courseCount' in value) || value['courseCount'] === undefined) return false;
+    if (!('publishedCourseCount' in value) || value['publishedCourseCount'] === undefined) return false;
+    if (!('draftCourseCount' in value) || value['draftCourseCount'] === undefined) return false;
+    if (!('loginsToday' in value) || value['loginsToday'] === undefined) return false;
+    return true;
+}
+
+export function GetPortalManagementDashboardSummaryFromJSON(json: any): GetPortalManagementDashboardSummary {
+    return GetPortalManagementDashboardSummaryFromJSONTyped(json, false);
+}
+
+export function GetPortalManagementDashboardSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPortalManagementDashboardSummary {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'learnerCount': json['learner_count'],
+        'activeLearnerCount': json['active_learner_count'],
+        'activeEnrollmentCount': json['active_enrollment_count'],
+        'completionRatePercentage': json['completion_rate_percentage'],
+        'courseCount': json['course_count'],
+        'publishedCourseCount': json['published_course_count'],
+        'draftCourseCount': json['draft_course_count'],
+        'loginsToday': json['logins_today'],
+    };
+}
+
+export function GetPortalManagementDashboardSummaryToJSON(json: any): GetPortalManagementDashboardSummary {
+    return GetPortalManagementDashboardSummaryToJSONTyped(json, false);
+}
+
+export function GetPortalManagementDashboardSummaryToJSONTyped(value?: GetPortalManagementDashboardSummary | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'learner_count': value['learnerCount'],
+        'active_learner_count': value['activeLearnerCount'],
+        'active_enrollment_count': value['activeEnrollmentCount'],
+        'completion_rate_percentage': value['completionRatePercentage'],
+        'course_count': value['courseCount'],
+        'published_course_count': value['publishedCourseCount'],
+        'draft_course_count': value['draftCourseCount'],
+        'logins_today': value['loginsToday'],
+    };
+}
+