@easyedu/js-lsm-api 1.79.0 → 1.80.0

package/src/models/GetUserCourseListItemCourse.ts

@@ -0,0 +1,149 @@
+/* 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';
+/**
+ * Course fields for an enrolled user's course list item.
+ * @export
+ * @interface GetUserCourseListItemCourse
+ */
+export interface GetUserCourseListItemCourse {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetUserCourseListItemCourse
+     */
+    readonly id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetUserCourseListItemCourse
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetUserCourseListItemCourse
+     */
+    description: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetUserCourseListItemCourse
+     */
+    imageUrl: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof GetUserCourseListItemCourse
+     */
+    published: boolean;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetUserCourseListItemCourse
+     */
+    createdAt: number;
+    /**
+     * 
+     * @type {GetUserCourseListItemCourseAccessPolicyTypeEnum}
+     * @memberof GetUserCourseListItemCourse
+     */
+    accessPolicyType: GetUserCourseListItemCourseAccessPolicyTypeEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetUserCourseListItemCourse
+     */
+    accessDurationDays: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetUserCourseListItemCourse
+     */
+    accessFixedEndAt: number | null;
+}
+
+
+/**
+ * @export
+ */
+export const GetUserCourseListItemCourseAccessPolicyTypeEnum = {
+    DurationDays: 'duration_days',
+    FixedEndDate: 'fixed_end_date',
+    NeverExpires: 'never_expires'
+} as const;
+export type GetUserCourseListItemCourseAccessPolicyTypeEnum = typeof GetUserCourseListItemCourseAccessPolicyTypeEnum[keyof typeof GetUserCourseListItemCourseAccessPolicyTypeEnum];
+
+
+/**
+ * Check if a given object implements the GetUserCourseListItemCourse interface.
+ */
+export function instanceOfGetUserCourseListItemCourse(value: object): value is GetUserCourseListItemCourse {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('description' in value) || value['description'] === undefined) return false;
+    if (!('imageUrl' in value) || value['imageUrl'] === undefined) return false;
+    if (!('published' in value) || value['published'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('accessPolicyType' in value) || value['accessPolicyType'] === undefined) return false;
+    if (!('accessDurationDays' in value) || value['accessDurationDays'] === undefined) return false;
+    if (!('accessFixedEndAt' in value) || value['accessFixedEndAt'] === undefined) return false;
+    return true;
+}
+
+export function GetUserCourseListItemCourseFromJSON(json: any): GetUserCourseListItemCourse {
+    return GetUserCourseListItemCourseFromJSONTyped(json, false);
+}
+
+export function GetUserCourseListItemCourseFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetUserCourseListItemCourse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+        'imageUrl': json['image_url'],
+        'published': json['published'],
+        'createdAt': json['created_at'],
+        'accessPolicyType': json['access_policy_type'],
+        'accessDurationDays': json['access_duration_days'],
+        'accessFixedEndAt': json['access_fixed_end_at'],
+    };
+}
+
+export function GetUserCourseListItemCourseToJSON(json: any): GetUserCourseListItemCourse {
+    return GetUserCourseListItemCourseToJSONTyped(json, false);
+}
+
+export function GetUserCourseListItemCourseToJSONTyped(value?: Omit<GetUserCourseListItemCourse, 'id'> | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'description': value['description'],
+        'image_url': value['imageUrl'],
+        'published': value['published'],
+        'created_at': value['createdAt'],
+        'access_policy_type': value['accessPolicyType'],
+        'access_duration_days': value['accessDurationDays'],
+        'access_fixed_end_at': value['accessFixedEndAt'],
+    };
+}
+

package/src/models/GetUserCourseListItemEnrollment.ts

@@ -0,0 +1,171 @@
+/* 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';
+/**
+ * Selected enrollment fields for an enrolled user's course list item.
+ * @export
+ * @interface GetUserCourseListItemEnrollment
+ */
+export interface GetUserCourseListItemEnrollment {
+    /**
+     * The external ID of the selected enrollment.
+     * @type {string}
+     * @memberof GetUserCourseListItemEnrollment
+     */
+    id: string;
+    /**
+     * 
+     * @type {GetUserCourseListItemEnrollmentStatusEnum}
+     * @memberof GetUserCourseListItemEnrollment
+     */
+    status: GetUserCourseListItemEnrollmentStatusEnum;
+    /**
+     * 
+     * @type {GetUserCourseListItemEnrollmentAccessStateEnum}
+     * @memberof GetUserCourseListItemEnrollment
+     */
+    accessState: GetUserCourseListItemEnrollmentAccessStateEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetUserCourseListItemEnrollment
+     */
+    daysUntilExpiry: number | null;
+    /**
+     * 
+     * @type {GetUserCourseListItemEnrollmentUserTypeEnum}
+     * @memberof GetUserCourseListItemEnrollment
+     */
+    userType: GetUserCourseListItemEnrollmentUserTypeEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetUserCourseListItemEnrollment
+     */
+    enrollmentDateStart: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetUserCourseListItemEnrollment
+     */
+    enrollmentDateEnd: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetUserCourseListItemEnrollment
+     */
+    completionDate: number | null;
+}
+
+
+/**
+ * @export
+ */
+export const GetUserCourseListItemEnrollmentStatusEnum = {
+    Enrolled: 'Enrolled',
+    InProgress: 'InProgress',
+    Completed: 'Completed',
+    Failed: 'Failed',
+    Expired: 'Expired',
+    Withdrawn: 'Withdrawn',
+    Removed: 'Removed',
+    Archived: 'Archived',
+    Suspended: 'Suspended'
+} as const;
+export type GetUserCourseListItemEnrollmentStatusEnum = typeof GetUserCourseListItemEnrollmentStatusEnum[keyof typeof GetUserCourseListItemEnrollmentStatusEnum];
+
+/**
+ * @export
+ */
+export const GetUserCourseListItemEnrollmentAccessStateEnum = {
+    Active: 'active',
+    CompletedReview: 'completed_review',
+    Expired: 'expired',
+    Suspended: 'suspended',
+    Failed: 'failed',
+    Withdrawn: 'withdrawn',
+    Removed: 'removed',
+    Archived: 'archived'
+} as const;
+export type GetUserCourseListItemEnrollmentAccessStateEnum = typeof GetUserCourseListItemEnrollmentAccessStateEnum[keyof typeof GetUserCourseListItemEnrollmentAccessStateEnum];
+
+/**
+ * @export
+ */
+export const GetUserCourseListItemEnrollmentUserTypeEnum = {
+    Student: 'Student',
+    Instructor: 'Instructor'
+} as const;
+export type GetUserCourseListItemEnrollmentUserTypeEnum = typeof GetUserCourseListItemEnrollmentUserTypeEnum[keyof typeof GetUserCourseListItemEnrollmentUserTypeEnum];
+
+
+/**
+ * Check if a given object implements the GetUserCourseListItemEnrollment interface.
+ */
+export function instanceOfGetUserCourseListItemEnrollment(value: object): value is GetUserCourseListItemEnrollment {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('accessState' in value) || value['accessState'] === undefined) return false;
+    if (!('daysUntilExpiry' in value) || value['daysUntilExpiry'] === undefined) return false;
+    if (!('userType' in value) || value['userType'] === undefined) return false;
+    if (!('enrollmentDateStart' in value) || value['enrollmentDateStart'] === undefined) return false;
+    if (!('enrollmentDateEnd' in value) || value['enrollmentDateEnd'] === undefined) return false;
+    if (!('completionDate' in value) || value['completionDate'] === undefined) return false;
+    return true;
+}
+
+export function GetUserCourseListItemEnrollmentFromJSON(json: any): GetUserCourseListItemEnrollment {
+    return GetUserCourseListItemEnrollmentFromJSONTyped(json, false);
+}
+
+export function GetUserCourseListItemEnrollmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetUserCourseListItemEnrollment {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'status': json['status'],
+        'accessState': json['access_state'],
+        'daysUntilExpiry': json['days_until_expiry'],
+        'userType': json['user_type'],
+        'enrollmentDateStart': json['enrollment_date_start'],
+        'enrollmentDateEnd': json['enrollment_date_end'],
+        'completionDate': json['completion_date'],
+    };
+}
+
+export function GetUserCourseListItemEnrollmentToJSON(json: any): GetUserCourseListItemEnrollment {
+    return GetUserCourseListItemEnrollmentToJSONTyped(json, false);
+}
+
+export function GetUserCourseListItemEnrollmentToJSONTyped(value?: GetUserCourseListItemEnrollment | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'status': value['status'],
+        'access_state': value['accessState'],
+        'days_until_expiry': value['daysUntilExpiry'],
+        'user_type': value['userType'],
+        'enrollment_date_start': value['enrollmentDateStart'],
+        'enrollment_date_end': value['enrollmentDateEnd'],
+        'completion_date': value['completionDate'],
+    };
+}
+

package/src/models/GetUserCourseListItemProgress.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';
+/**
+ * Learner progress for an enrolled user's course list item.
+ * @export
+ * @interface GetUserCourseListItemProgress
+ */
+export interface GetUserCourseListItemProgress {
+    /**
+     * Completed visible content divided by total visible content. Null when total content count is zero.
+     * @type {number}
+     * @memberof GetUserCourseListItemProgress
+     */
+    completionPercentage: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetUserCourseListItemProgress
+     */
+    completedContentCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetUserCourseListItemProgress
+     */
+    totalContentCount: number;
+}
+
+/**
+ * Check if a given object implements the GetUserCourseListItemProgress interface.
+ */
+export function instanceOfGetUserCourseListItemProgress(value: object): value is GetUserCourseListItemProgress {
+    if (!('completionPercentage' in value) || value['completionPercentage'] === undefined) return false;
+    if (!('completedContentCount' in value) || value['completedContentCount'] === undefined) return false;
+    if (!('totalContentCount' in value) || value['totalContentCount'] === undefined) return false;
+    return true;
+}
+
+export function GetUserCourseListItemProgressFromJSON(json: any): GetUserCourseListItemProgress {
+    return GetUserCourseListItemProgressFromJSONTyped(json, false);
+}
+
+export function GetUserCourseListItemProgressFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetUserCourseListItemProgress {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'completionPercentage': json['completion_percentage'],
+        'completedContentCount': json['completed_content_count'],
+        'totalContentCount': json['total_content_count'],
+    };
+}
+
+export function GetUserCourseListItemProgressToJSON(json: any): GetUserCourseListItemProgress {
+    return GetUserCourseListItemProgressToJSONTyped(json, false);
+}
+
+export function GetUserCourseListItemProgressToJSONTyped(value?: GetUserCourseListItemProgress | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'completion_percentage': value['completionPercentage'],
+        'completed_content_count': value['completedContentCount'],
+        'total_content_count': value['totalContentCount'],
+    };
+}
+

package/src/models/index.ts

@@ -155,6 +155,12 @@ export * from './GetSystemBillingList';
 export * from './GetSystemMetrics';
 export * from './GetUser';
 export * from './GetUserAvatarUpload';
+export * from './GetUserCourseList';
+export * from './GetUserCourseListItem';
+export * from './GetUserCourseListItemCertificate';
+export * from './GetUserCourseListItemCourse';
+export * from './GetUserCourseListItemEnrollment';
+export * from './GetUserCourseListItemProgress';
 export * from './GetUserQuizAttempts';
 export * from './GetUserQuizAttemptsAllOfAttempts';
 export * from './GetUserQuizAttemptsAllOfFilters';