@easyedu/js-lsm-api 1.79.0 → 1.81.0

package/dist/esm/models/GetUserCourseList.js

@@ -0,0 +1,60 @@
+/* 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 { GetUserCourseListItemFromJSON, GetUserCourseListItemToJSON, } from './GetUserCourseListItem';
+/**
+ * Check if a given object implements the GetUserCourseList interface.
+ */
+export function instanceOfGetUserCourseList(value) {
+    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 GetUserCourseListFromJSON(json) {
+    return GetUserCourseListFromJSONTyped(json, false);
+}
+export function GetUserCourseListFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'page': json['page'],
+        'pageSize': json['pageSize'],
+        'totalPages': json['totalPages'],
+        'totalItems': json['totalItems'],
+        'items': (json['items'].map(GetUserCourseListItemFromJSON)),
+    };
+}
+export function GetUserCourseListToJSON(json) {
+    return GetUserCourseListToJSONTyped(json, false);
+}
+export function GetUserCourseListToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'page': value['page'],
+        'pageSize': value['pageSize'],
+        'totalPages': value['totalPages'],
+        'totalItems': value['totalItems'],
+        'items': (value['items'].map(GetUserCourseListItemToJSON)),
+    };
+}

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

@@ -0,0 +1,54 @@
+/**
+ * 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 { GetUserCourseListItemCourse } from './GetUserCourseListItemCourse';
+import type { GetUserCourseListItemEnrollment } from './GetUserCourseListItemEnrollment';
+import type { GetUserCourseListItemCertificate } from './GetUserCourseListItemCertificate';
+import type { GetUserCourseListItemProgress } from './GetUserCourseListItemProgress';
+/**
+ * A course the target user is enrolled in, grouped by course and selected enrollment.
+ * @export
+ * @interface GetUserCourseListItem
+ */
+export interface GetUserCourseListItem {
+    /**
+     *
+     * @type {GetUserCourseListItemCourse}
+     * @memberof GetUserCourseListItem
+     */
+    course: GetUserCourseListItemCourse;
+    /**
+     *
+     * @type {GetUserCourseListItemEnrollment}
+     * @memberof GetUserCourseListItem
+     */
+    enrollment: GetUserCourseListItemEnrollment;
+    /**
+     *
+     * @type {GetUserCourseListItemProgress}
+     * @memberof GetUserCourseListItem
+     */
+    progress: GetUserCourseListItemProgress;
+    /**
+     *
+     * @type {GetUserCourseListItemCertificate}
+     * @memberof GetUserCourseListItem
+     */
+    certificate: GetUserCourseListItemCertificate | null;
+}
+/**
+ * Check if a given object implements the GetUserCourseListItem interface.
+ */
+export declare function instanceOfGetUserCourseListItem(value: object): value is GetUserCourseListItem;
+export declare function GetUserCourseListItemFromJSON(json: any): GetUserCourseListItem;
+export declare function GetUserCourseListItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetUserCourseListItem;
+export declare function GetUserCourseListItemToJSON(json: any): GetUserCourseListItem;
+export declare function GetUserCourseListItemToJSONTyped(value?: GetUserCourseListItem | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetUserCourseListItem.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.
+ */
+import { GetUserCourseListItemCourseFromJSON, GetUserCourseListItemCourseToJSON, } from './GetUserCourseListItemCourse';
+import { GetUserCourseListItemEnrollmentFromJSON, GetUserCourseListItemEnrollmentToJSON, } from './GetUserCourseListItemEnrollment';
+import { GetUserCourseListItemCertificateFromJSON, GetUserCourseListItemCertificateToJSON, } from './GetUserCourseListItemCertificate';
+import { GetUserCourseListItemProgressFromJSON, GetUserCourseListItemProgressToJSON, } from './GetUserCourseListItemProgress';
+/**
+ * Check if a given object implements the GetUserCourseListItem interface.
+ */
+export function instanceOfGetUserCourseListItem(value) {
+    if (!('course' in value) || value['course'] === undefined)
+        return false;
+    if (!('enrollment' in value) || value['enrollment'] === undefined)
+        return false;
+    if (!('progress' in value) || value['progress'] === undefined)
+        return false;
+    if (!('certificate' in value) || value['certificate'] === undefined)
+        return false;
+    return true;
+}
+export function GetUserCourseListItemFromJSON(json) {
+    return GetUserCourseListItemFromJSONTyped(json, false);
+}
+export function GetUserCourseListItemFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'course': GetUserCourseListItemCourseFromJSON(json['course']),
+        'enrollment': GetUserCourseListItemEnrollmentFromJSON(json['enrollment']),
+        'progress': GetUserCourseListItemProgressFromJSON(json['progress']),
+        'certificate': GetUserCourseListItemCertificateFromJSON(json['certificate']),
+    };
+}
+export function GetUserCourseListItemToJSON(json) {
+    return GetUserCourseListItemToJSONTyped(json, false);
+}
+export function GetUserCourseListItemToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'course': GetUserCourseListItemCourseToJSON(value['course']),
+        'enrollment': GetUserCourseListItemEnrollmentToJSON(value['enrollment']),
+        'progress': GetUserCourseListItemProgressToJSON(value['progress']),
+        'certificate': GetUserCourseListItemCertificateToJSON(value['certificate']),
+    };
+}

package/dist/esm/models/GetUserCourseListItemCertificate.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.
+ */
+/**
+ * Latest certificate for the learner and course, if one exists.
+ * @export
+ * @interface GetUserCourseListItemCertificate
+ */
+export interface GetUserCourseListItemCertificate {
+    /**
+     * The external ID of the certificate.
+     * @type {string}
+     * @memberof GetUserCourseListItemCertificate
+     */
+    id: string;
+    /**
+     * Derived certificate status. Active certificates with expires_at in the past are returned as expired.
+     * @type {GetUserCourseListItemCertificateStatusEnum}
+     * @memberof GetUserCourseListItemCertificate
+     */
+    status: GetUserCourseListItemCertificateStatusEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof GetUserCourseListItemCertificate
+     */
+    issuedAt: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetUserCourseListItemCertificate
+     */
+    expiresAt: number | null;
+    /**
+     *
+     * @type {GetUserCourseListItemCertificateIssuanceReasonEnum}
+     * @memberof GetUserCourseListItemCertificate
+     */
+    issuanceReason: GetUserCourseListItemCertificateIssuanceReasonEnum;
+}
+/**
+ * @export
+ */
+export declare const GetUserCourseListItemCertificateStatusEnum: {
+    readonly Active: "active";
+    readonly Expired: "expired";
+    readonly Revoked: "revoked";
+};
+export type GetUserCourseListItemCertificateStatusEnum = typeof GetUserCourseListItemCertificateStatusEnum[keyof typeof GetUserCourseListItemCertificateStatusEnum];
+/**
+ * @export
+ */
+export declare const GetUserCourseListItemCertificateIssuanceReasonEnum: {
+    readonly CourseCompletion: "course_completion";
+    readonly QuizPassed: "quiz_passed";
+    readonly Manual: "manual";
+};
+export type GetUserCourseListItemCertificateIssuanceReasonEnum = typeof GetUserCourseListItemCertificateIssuanceReasonEnum[keyof typeof GetUserCourseListItemCertificateIssuanceReasonEnum];
+/**
+ * Check if a given object implements the GetUserCourseListItemCertificate interface.
+ */
+export declare function instanceOfGetUserCourseListItemCertificate(value: object): value is GetUserCourseListItemCertificate;
+export declare function GetUserCourseListItemCertificateFromJSON(json: any): GetUserCourseListItemCertificate;
+export declare function GetUserCourseListItemCertificateFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetUserCourseListItemCertificate;
+export declare function GetUserCourseListItemCertificateToJSON(json: any): GetUserCourseListItemCertificate;
+export declare function GetUserCourseListItemCertificateToJSONTyped(value?: GetUserCourseListItemCertificate | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetUserCourseListItemCertificate.js

@@ -0,0 +1,75 @@
+/* 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 GetUserCourseListItemCertificateStatusEnum = {
+    Active: 'active',
+    Expired: 'expired',
+    Revoked: 'revoked'
+};
+/**
+ * @export
+ */
+export const GetUserCourseListItemCertificateIssuanceReasonEnum = {
+    CourseCompletion: 'course_completion',
+    QuizPassed: 'quiz_passed',
+    Manual: 'manual'
+};
+/**
+ * Check if a given object implements the GetUserCourseListItemCertificate interface.
+ */
+export function instanceOfGetUserCourseListItemCertificate(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('issuedAt' in value) || value['issuedAt'] === undefined)
+        return false;
+    if (!('expiresAt' in value) || value['expiresAt'] === undefined)
+        return false;
+    if (!('issuanceReason' in value) || value['issuanceReason'] === undefined)
+        return false;
+    return true;
+}
+export function GetUserCourseListItemCertificateFromJSON(json) {
+    return GetUserCourseListItemCertificateFromJSONTyped(json, false);
+}
+export function GetUserCourseListItemCertificateFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'status': json['status'],
+        'issuedAt': json['issued_at'],
+        'expiresAt': json['expires_at'],
+        'issuanceReason': json['issuance_reason'],
+    };
+}
+export function GetUserCourseListItemCertificateToJSON(json) {
+    return GetUserCourseListItemCertificateToJSONTyped(json, false);
+}
+export function GetUserCourseListItemCertificateToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'status': value['status'],
+        'issued_at': value['issuedAt'],
+        'expires_at': value['expiresAt'],
+        'issuance_reason': value['issuanceReason'],
+    };
+}

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

@@ -0,0 +1,89 @@
+/**
+ * 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.
+ */
+/**
+ * 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 declare const GetUserCourseListItemCourseAccessPolicyTypeEnum: {
+    readonly DurationDays: "duration_days";
+    readonly FixedEndDate: "fixed_end_date";
+    readonly NeverExpires: "never_expires";
+};
+export type GetUserCourseListItemCourseAccessPolicyTypeEnum = typeof GetUserCourseListItemCourseAccessPolicyTypeEnum[keyof typeof GetUserCourseListItemCourseAccessPolicyTypeEnum];
+/**
+ * Check if a given object implements the GetUserCourseListItemCourse interface.
+ */
+export declare function instanceOfGetUserCourseListItemCourse(value: object): value is GetUserCourseListItemCourse;
+export declare function GetUserCourseListItemCourseFromJSON(json: any): GetUserCourseListItemCourse;
+export declare function GetUserCourseListItemCourseFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetUserCourseListItemCourse;
+export declare function GetUserCourseListItemCourseToJSON(json: any): GetUserCourseListItemCourse;
+export declare function GetUserCourseListItemCourseToJSONTyped(value?: Omit<GetUserCourseListItemCourse, 'id'> | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetUserCourseListItemCourse.js

@@ -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.
+ */
+/**
+ * @export
+ */
+export const GetUserCourseListItemCourseAccessPolicyTypeEnum = {
+    DurationDays: 'duration_days',
+    FixedEndDate: 'fixed_end_date',
+    NeverExpires: 'never_expires'
+};
+/**
+ * Check if a given object implements the GetUserCourseListItemCourse interface.
+ */
+export function instanceOfGetUserCourseListItemCourse(value) {
+    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) {
+    return GetUserCourseListItemCourseFromJSONTyped(json, false);
+}
+export function GetUserCourseListItemCourseFromJSONTyped(json, ignoreDiscriminator) {
+    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) {
+    return GetUserCourseListItemCourseToJSONTyped(json, false);
+}
+export function GetUserCourseListItemCourseToJSONTyped(value, ignoreDiscriminator = false) {
+    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/dist/esm/models/GetUserCourseListItemEnrollment.d.ts

@@ -0,0 +1,111 @@
+/**
+ * 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.
+ */
+/**
+ * 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 declare const GetUserCourseListItemEnrollmentStatusEnum: {
+    readonly Enrolled: "Enrolled";
+    readonly InProgress: "InProgress";
+    readonly Completed: "Completed";
+    readonly Failed: "Failed";
+    readonly Expired: "Expired";
+    readonly Withdrawn: "Withdrawn";
+    readonly Removed: "Removed";
+    readonly Archived: "Archived";
+    readonly Suspended: "Suspended";
+};
+export type GetUserCourseListItemEnrollmentStatusEnum = typeof GetUserCourseListItemEnrollmentStatusEnum[keyof typeof GetUserCourseListItemEnrollmentStatusEnum];
+/**
+ * @export
+ */
+export declare const GetUserCourseListItemEnrollmentAccessStateEnum: {
+    readonly Active: "active";
+    readonly CompletedReview: "completed_review";
+    readonly Expired: "expired";
+    readonly Suspended: "suspended";
+    readonly Failed: "failed";
+    readonly Withdrawn: "withdrawn";
+    readonly Removed: "removed";
+    readonly Archived: "archived";
+};
+export type GetUserCourseListItemEnrollmentAccessStateEnum = typeof GetUserCourseListItemEnrollmentAccessStateEnum[keyof typeof GetUserCourseListItemEnrollmentAccessStateEnum];
+/**
+ * @export
+ */
+export declare const GetUserCourseListItemEnrollmentUserTypeEnum: {
+    readonly Student: "Student";
+    readonly Instructor: "Instructor";
+};
+export type GetUserCourseListItemEnrollmentUserTypeEnum = typeof GetUserCourseListItemEnrollmentUserTypeEnum[keyof typeof GetUserCourseListItemEnrollmentUserTypeEnum];
+/**
+ * Check if a given object implements the GetUserCourseListItemEnrollment interface.
+ */
+export declare function instanceOfGetUserCourseListItemEnrollment(value: object): value is GetUserCourseListItemEnrollment;
+export declare function GetUserCourseListItemEnrollmentFromJSON(json: any): GetUserCourseListItemEnrollment;
+export declare function GetUserCourseListItemEnrollmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetUserCourseListItemEnrollment;
+export declare function GetUserCourseListItemEnrollmentToJSON(json: any): GetUserCourseListItemEnrollment;
+export declare function GetUserCourseListItemEnrollmentToJSONTyped(value?: GetUserCourseListItemEnrollment | null, ignoreDiscriminator?: boolean): any;