@easyedu/js-lsm-api 1.14.0 → 1.16.0

package/src/models/GetContentGrades.ts

@@ -0,0 +1,110 @@
+/* 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 { GetContentGradesItemsInner } from './GetContentGradesItemsInner';
+import {
+    GetContentGradesItemsInnerFromJSON,
+    GetContentGradesItemsInnerFromJSONTyped,
+    GetContentGradesItemsInnerToJSON,
+    GetContentGradesItemsInnerToJSONTyped,
+} from './GetContentGradesItemsInner';
+
+/**
+ * 
+ * @export
+ * @interface GetContentGrades
+ */
+export interface GetContentGrades {
+    /**
+     * The current page number
+     * @type {number}
+     * @memberof GetContentGrades
+     */
+    page: number;
+    /**
+     * The number of items per page
+     * @type {number}
+     * @memberof GetContentGrades
+     */
+    pageSize: number;
+    /**
+     * The total number of pages
+     * @type {number}
+     * @memberof GetContentGrades
+     */
+    totalPages: number;
+    /**
+     * The total number of items
+     * @type {number}
+     * @memberof GetContentGrades
+     */
+    totalItems: number;
+    /**
+     * 
+     * @type {Array<GetContentGradesItemsInner>}
+     * @memberof GetContentGrades
+     */
+    items: Array<GetContentGradesItemsInner>;
+}
+
+/**
+ * Check if a given object implements the GetContentGrades interface.
+ */
+export function instanceOfGetContentGrades(value: object): value is GetContentGrades {
+    if (!('page' in value) || value['page'] === undefined) return false;
+    if (!('pageSize' in value) || value['pageSize'] === undefined) return false;
+    if (!('totalPages' in value) || value['totalPages'] === undefined) return false;
+    if (!('totalItems' in value) || value['totalItems'] === undefined) return false;
+    if (!('items' in value) || value['items'] === undefined) return false;
+    return true;
+}
+
+export function GetContentGradesFromJSON(json: any): GetContentGrades {
+    return GetContentGradesFromJSONTyped(json, false);
+}
+
+export function GetContentGradesFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentGrades {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'page': json['page'],
+        'pageSize': json['pageSize'],
+        'totalPages': json['totalPages'],
+        'totalItems': json['totalItems'],
+        'items': ((json['items'] as Array<any>).map(GetContentGradesItemsInnerFromJSON)),
+    };
+}
+
+export function GetContentGradesToJSON(json: any): GetContentGrades {
+    return GetContentGradesToJSONTyped(json, false);
+}
+
+export function GetContentGradesToJSONTyped(value?: GetContentGrades | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'page': value['page'],
+        'pageSize': value['pageSize'],
+        'totalPages': value['totalPages'],
+        'totalItems': value['totalItems'],
+        'items': ((value['items'] as Array<any>).map(GetContentGradesItemsInnerToJSON)),
+    };
+}
+

package/src/models/GetContentGradesItemsInner.ts

@@ -0,0 +1,125 @@
+/* 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 { GetContentGradesItemsInnerUser } from './GetContentGradesItemsInnerUser';
+import {
+    GetContentGradesItemsInnerUserFromJSON,
+    GetContentGradesItemsInnerUserFromJSONTyped,
+    GetContentGradesItemsInnerUserToJSON,
+    GetContentGradesItemsInnerUserToJSONTyped,
+} from './GetContentGradesItemsInnerUser';
+
+/**
+ * 
+ * @export
+ * @interface GetContentGradesItemsInner
+ */
+export interface GetContentGradesItemsInner {
+    /**
+     * Content session external ID
+     * @type {string}
+     * @memberof GetContentGradesItemsInner
+     */
+    id?: string | null;
+    /**
+     * 
+     * @type {GetContentGradesItemsInnerUser}
+     * @memberof GetContentGradesItemsInner
+     */
+    user: GetContentGradesItemsInnerUser;
+    /**
+     * Content completion status
+     * @type {string}
+     * @memberof GetContentGradesItemsInner
+     */
+    completion: GetContentGradesItemsInnerCompletionEnum;
+    /**
+     * Content grade status
+     * @type {string}
+     * @memberof GetContentGradesItemsInner
+     */
+    gradeStatus: GetContentGradesItemsInnerGradeStatusEnum;
+}
+
+
+/**
+ * @export
+ */
+export const GetContentGradesItemsInnerCompletionEnum = {
+    NotAttempted: 'NotAttempted',
+    InProgress: 'InProgress',
+    Completed: 'Completed'
+} as const;
+export type GetContentGradesItemsInnerCompletionEnum = typeof GetContentGradesItemsInnerCompletionEnum[keyof typeof GetContentGradesItemsInnerCompletionEnum];
+
+/**
+ * @export
+ */
+export const GetContentGradesItemsInnerGradeStatusEnum = {
+    Ungraded: 'Ungraded',
+    Passed: 'Passed',
+    Failed: 'Failed',
+    PointsEarned: 'PointsEarned',
+    PercentageEarned: 'PercentageEarned',
+    NotApplicable: 'NotApplicable'
+} as const;
+export type GetContentGradesItemsInnerGradeStatusEnum = typeof GetContentGradesItemsInnerGradeStatusEnum[keyof typeof GetContentGradesItemsInnerGradeStatusEnum];
+
+
+/**
+ * Check if a given object implements the GetContentGradesItemsInner interface.
+ */
+export function instanceOfGetContentGradesItemsInner(value: object): value is GetContentGradesItemsInner {
+    if (!('user' in value) || value['user'] === undefined) return false;
+    if (!('completion' in value) || value['completion'] === undefined) return false;
+    if (!('gradeStatus' in value) || value['gradeStatus'] === undefined) return false;
+    return true;
+}
+
+export function GetContentGradesItemsInnerFromJSON(json: any): GetContentGradesItemsInner {
+    return GetContentGradesItemsInnerFromJSONTyped(json, false);
+}
+
+export function GetContentGradesItemsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentGradesItemsInner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'] == null ? undefined : json['id'],
+        'user': GetContentGradesItemsInnerUserFromJSON(json['user']),
+        'completion': json['completion'],
+        'gradeStatus': json['grade_status'],
+    };
+}
+
+export function GetContentGradesItemsInnerToJSON(json: any): GetContentGradesItemsInner {
+    return GetContentGradesItemsInnerToJSONTyped(json, false);
+}
+
+export function GetContentGradesItemsInnerToJSONTyped(value?: GetContentGradesItemsInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'user': GetContentGradesItemsInnerUserToJSON(value['user']),
+        'completion': value['completion'],
+        'grade_status': value['gradeStatus'],
+    };
+}
+

package/src/models/GetContentGradesItemsInnerUser.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 GetContentGradesItemsInnerUser
+ */
+export interface GetContentGradesItemsInnerUser {
+    /**
+     * User's first name
+     * @type {string}
+     * @memberof GetContentGradesItemsInnerUser
+     */
+    firstName: string;
+    /**
+     * User's last name
+     * @type {string}
+     * @memberof GetContentGradesItemsInnerUser
+     */
+    lastName: string;
+    /**
+     * User's external ID
+     * @type {string}
+     * @memberof GetContentGradesItemsInnerUser
+     */
+    userId: string;
+}
+
+/**
+ * Check if a given object implements the GetContentGradesItemsInnerUser interface.
+ */
+export function instanceOfGetContentGradesItemsInnerUser(value: object): value is GetContentGradesItemsInnerUser {
+    if (!('firstName' in value) || value['firstName'] === undefined) return false;
+    if (!('lastName' in value) || value['lastName'] === undefined) return false;
+    if (!('userId' in value) || value['userId'] === undefined) return false;
+    return true;
+}
+
+export function GetContentGradesItemsInnerUserFromJSON(json: any): GetContentGradesItemsInnerUser {
+    return GetContentGradesItemsInnerUserFromJSONTyped(json, false);
+}
+
+export function GetContentGradesItemsInnerUserFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentGradesItemsInnerUser {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'firstName': json['first_name'],
+        'lastName': json['last_name'],
+        'userId': json['user_id'],
+    };
+}
+
+export function GetContentGradesItemsInnerUserToJSON(json: any): GetContentGradesItemsInnerUser {
+    return GetContentGradesItemsInnerUserToJSONTyped(json, false);
+}
+
+export function GetContentGradesItemsInnerUserToJSONTyped(value?: GetContentGradesItemsInnerUser | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'first_name': value['firstName'],
+        'last_name': value['lastName'],
+        'user_id': value['userId'],
+    };
+}
+

package/src/models/GetContentInstructorBasicReporting.ts

@@ -0,0 +1,106 @@
+/* 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 { GetContentInstructorBasicReportingContentInfo } from './GetContentInstructorBasicReportingContentInfo';
+import {
+    GetContentInstructorBasicReportingContentInfoFromJSON,
+    GetContentInstructorBasicReportingContentInfoFromJSONTyped,
+    GetContentInstructorBasicReportingContentInfoToJSON,
+    GetContentInstructorBasicReportingContentInfoToJSONTyped,
+} from './GetContentInstructorBasicReportingContentInfo';
+import type { GetContentInstructorBasicReportingEngagement } from './GetContentInstructorBasicReportingEngagement';
+import {
+    GetContentInstructorBasicReportingEngagementFromJSON,
+    GetContentInstructorBasicReportingEngagementFromJSONTyped,
+    GetContentInstructorBasicReportingEngagementToJSON,
+    GetContentInstructorBasicReportingEngagementToJSONTyped,
+} from './GetContentInstructorBasicReportingEngagement';
+import type { GetContentInstructorBasicReportingPerformance } from './GetContentInstructorBasicReportingPerformance';
+import {
+    GetContentInstructorBasicReportingPerformanceFromJSON,
+    GetContentInstructorBasicReportingPerformanceFromJSONTyped,
+    GetContentInstructorBasicReportingPerformanceToJSON,
+    GetContentInstructorBasicReportingPerformanceToJSONTyped,
+} from './GetContentInstructorBasicReportingPerformance';
+
+/**
+ * 
+ * @export
+ * @interface GetContentInstructorBasicReporting
+ */
+export interface GetContentInstructorBasicReporting {
+    /**
+     * 
+     * @type {GetContentInstructorBasicReportingContentInfo}
+     * @memberof GetContentInstructorBasicReporting
+     */
+    contentInfo: GetContentInstructorBasicReportingContentInfo;
+    /**
+     * 
+     * @type {GetContentInstructorBasicReportingEngagement}
+     * @memberof GetContentInstructorBasicReporting
+     */
+    engagement: GetContentInstructorBasicReportingEngagement;
+    /**
+     * 
+     * @type {GetContentInstructorBasicReportingPerformance}
+     * @memberof GetContentInstructorBasicReporting
+     */
+    performance: GetContentInstructorBasicReportingPerformance;
+}
+
+/**
+ * Check if a given object implements the GetContentInstructorBasicReporting interface.
+ */
+export function instanceOfGetContentInstructorBasicReporting(value: object): value is GetContentInstructorBasicReporting {
+    if (!('contentInfo' in value) || value['contentInfo'] === undefined) return false;
+    if (!('engagement' in value) || value['engagement'] === undefined) return false;
+    if (!('performance' in value) || value['performance'] === undefined) return false;
+    return true;
+}
+
+export function GetContentInstructorBasicReportingFromJSON(json: any): GetContentInstructorBasicReporting {
+    return GetContentInstructorBasicReportingFromJSONTyped(json, false);
+}
+
+export function GetContentInstructorBasicReportingFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentInstructorBasicReporting {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'contentInfo': GetContentInstructorBasicReportingContentInfoFromJSON(json['content_info']),
+        'engagement': GetContentInstructorBasicReportingEngagementFromJSON(json['engagement']),
+        'performance': GetContentInstructorBasicReportingPerformanceFromJSON(json['performance']),
+    };
+}
+
+export function GetContentInstructorBasicReportingToJSON(json: any): GetContentInstructorBasicReporting {
+    return GetContentInstructorBasicReportingToJSONTyped(json, false);
+}
+
+export function GetContentInstructorBasicReportingToJSONTyped(value?: GetContentInstructorBasicReporting | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'content_info': GetContentInstructorBasicReportingContentInfoToJSON(value['contentInfo']),
+        'engagement': GetContentInstructorBasicReportingEngagementToJSON(value['engagement']),
+        'performance': GetContentInstructorBasicReportingPerformanceToJSON(value['performance']),
+    };
+}
+

package/src/models/GetContentInstructorBasicReportingContentInfo.ts

@@ -0,0 +1,101 @@
+/* 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 GetContentInstructorBasicReportingContentInfo
+ */
+export interface GetContentInstructorBasicReportingContentInfo {
+    /**
+     * Content external ID
+     * @type {string}
+     * @memberof GetContentInstructorBasicReportingContentInfo
+     */
+    contentId: string;
+    /**
+     * Type of content
+     * @type {string}
+     * @memberof GetContentInstructorBasicReportingContentInfo
+     */
+    contentType: GetContentInstructorBasicReportingContentInfoContentTypeEnum;
+    /**
+     * Content title
+     * @type {string}
+     * @memberof GetContentInstructorBasicReportingContentInfo
+     */
+    title?: string | null;
+}
+
+
+/**
+ * @export
+ */
+export const GetContentInstructorBasicReportingContentInfoContentTypeEnum = {
+    Scorm: 'Scorm',
+    Video: 'Video',
+    Audio: 'Audio',
+    Image: 'Image',
+    Text: 'Text',
+    Link: 'Link',
+    File: 'File',
+    Pdf: 'Pdf',
+    Quiz: 'Quiz'
+} as const;
+export type GetContentInstructorBasicReportingContentInfoContentTypeEnum = typeof GetContentInstructorBasicReportingContentInfoContentTypeEnum[keyof typeof GetContentInstructorBasicReportingContentInfoContentTypeEnum];
+
+
+/**
+ * Check if a given object implements the GetContentInstructorBasicReportingContentInfo interface.
+ */
+export function instanceOfGetContentInstructorBasicReportingContentInfo(value: object): value is GetContentInstructorBasicReportingContentInfo {
+    if (!('contentId' in value) || value['contentId'] === undefined) return false;
+    if (!('contentType' in value) || value['contentType'] === undefined) return false;
+    return true;
+}
+
+export function GetContentInstructorBasicReportingContentInfoFromJSON(json: any): GetContentInstructorBasicReportingContentInfo {
+    return GetContentInstructorBasicReportingContentInfoFromJSONTyped(json, false);
+}
+
+export function GetContentInstructorBasicReportingContentInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentInstructorBasicReportingContentInfo {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'contentId': json['content_id'],
+        'contentType': json['content_type'],
+        'title': json['title'] == null ? undefined : json['title'],
+    };
+}
+
+export function GetContentInstructorBasicReportingContentInfoToJSON(json: any): GetContentInstructorBasicReportingContentInfo {
+    return GetContentInstructorBasicReportingContentInfoToJSONTyped(json, false);
+}
+
+export function GetContentInstructorBasicReportingContentInfoToJSONTyped(value?: GetContentInstructorBasicReportingContentInfo | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'content_id': value['contentId'],
+        'content_type': value['contentType'],
+        'title': value['title'],
+    };
+}
+

package/src/models/GetContentInstructorBasicReportingEngagement.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 GetContentInstructorBasicReportingEngagement
+ */
+export interface GetContentInstructorBasicReportingEngagement {
+    /**
+     * Average time spent by students on this content in hours
+     * @type {number}
+     * @memberof GetContentInstructorBasicReportingEngagement
+     */
+    avgTimeSpentHours: number | null;
+    /**
+     * Number of students who completed the content
+     * @type {number}
+     * @memberof GetContentInstructorBasicReportingEngagement
+     */
+    studentsCompletedCount: number;
+    /**
+     * Number of students currently in progress
+     * @type {number}
+     * @memberof GetContentInstructorBasicReportingEngagement
+     */
+    studentsInProgressCount: number;
+    /**
+     * Number of students who have not started
+     * @type {number}
+     * @memberof GetContentInstructorBasicReportingEngagement
+     */
+    studentsNotStartedCount: number;
+    /**
+     * Total number of enrolled students
+     * @type {number}
+     * @memberof GetContentInstructorBasicReportingEngagement
+     */
+    totalStudentsCount: number;
+}
+
+/**
+ * Check if a given object implements the GetContentInstructorBasicReportingEngagement interface.
+ */
+export function instanceOfGetContentInstructorBasicReportingEngagement(value: object): value is GetContentInstructorBasicReportingEngagement {
+    if (!('avgTimeSpentHours' in value) || value['avgTimeSpentHours'] === undefined) return false;
+    if (!('studentsCompletedCount' in value) || value['studentsCompletedCount'] === undefined) return false;
+    if (!('studentsInProgressCount' in value) || value['studentsInProgressCount'] === undefined) return false;
+    if (!('studentsNotStartedCount' in value) || value['studentsNotStartedCount'] === undefined) return false;
+    if (!('totalStudentsCount' in value) || value['totalStudentsCount'] === undefined) return false;
+    return true;
+}
+
+export function GetContentInstructorBasicReportingEngagementFromJSON(json: any): GetContentInstructorBasicReportingEngagement {
+    return GetContentInstructorBasicReportingEngagementFromJSONTyped(json, false);
+}
+
+export function GetContentInstructorBasicReportingEngagementFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentInstructorBasicReportingEngagement {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'avgTimeSpentHours': json['avg_time_spent_hours'],
+        'studentsCompletedCount': json['students_completed_count'],
+        'studentsInProgressCount': json['students_in_progress_count'],
+        'studentsNotStartedCount': json['students_not_started_count'],
+        'totalStudentsCount': json['total_students_count'],
+    };
+}
+
+export function GetContentInstructorBasicReportingEngagementToJSON(json: any): GetContentInstructorBasicReportingEngagement {
+    return GetContentInstructorBasicReportingEngagementToJSONTyped(json, false);
+}
+
+export function GetContentInstructorBasicReportingEngagementToJSONTyped(value?: GetContentInstructorBasicReportingEngagement | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'avg_time_spent_hours': value['avgTimeSpentHours'],
+        'students_completed_count': value['studentsCompletedCount'],
+        'students_in_progress_count': value['studentsInProgressCount'],
+        'students_not_started_count': value['studentsNotStartedCount'],
+        'total_students_count': value['totalStudentsCount'],
+    };
+}
+