@easyedu/js-lsm-api 1.79.0 → 1.80.0

package/dist/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;

package/dist/models/GetUserCourseListItemEnrollment.js

@@ -0,0 +1,113 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetUserCourseListItemEnrollmentUserTypeEnum = exports.GetUserCourseListItemEnrollmentAccessStateEnum = exports.GetUserCourseListItemEnrollmentStatusEnum = void 0;
+exports.instanceOfGetUserCourseListItemEnrollment = instanceOfGetUserCourseListItemEnrollment;
+exports.GetUserCourseListItemEnrollmentFromJSON = GetUserCourseListItemEnrollmentFromJSON;
+exports.GetUserCourseListItemEnrollmentFromJSONTyped = GetUserCourseListItemEnrollmentFromJSONTyped;
+exports.GetUserCourseListItemEnrollmentToJSON = GetUserCourseListItemEnrollmentToJSON;
+exports.GetUserCourseListItemEnrollmentToJSONTyped = GetUserCourseListItemEnrollmentToJSONTyped;
+/**
+ * @export
+ */
+exports.GetUserCourseListItemEnrollmentStatusEnum = {
+    Enrolled: 'Enrolled',
+    InProgress: 'InProgress',
+    Completed: 'Completed',
+    Failed: 'Failed',
+    Expired: 'Expired',
+    Withdrawn: 'Withdrawn',
+    Removed: 'Removed',
+    Archived: 'Archived',
+    Suspended: 'Suspended'
+};
+/**
+ * @export
+ */
+exports.GetUserCourseListItemEnrollmentAccessStateEnum = {
+    Active: 'active',
+    CompletedReview: 'completed_review',
+    Expired: 'expired',
+    Suspended: 'suspended',
+    Failed: 'failed',
+    Withdrawn: 'withdrawn',
+    Removed: 'removed',
+    Archived: 'archived'
+};
+/**
+ * @export
+ */
+exports.GetUserCourseListItemEnrollmentUserTypeEnum = {
+    Student: 'Student',
+    Instructor: 'Instructor'
+};
+/**
+ * Check if a given object implements the GetUserCourseListItemEnrollment interface.
+ */
+function instanceOfGetUserCourseListItemEnrollment(value) {
+    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;
+}
+function GetUserCourseListItemEnrollmentFromJSON(json) {
+    return GetUserCourseListItemEnrollmentFromJSONTyped(json, false);
+}
+function GetUserCourseListItemEnrollmentFromJSONTyped(json, ignoreDiscriminator) {
+    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'],
+    };
+}
+function GetUserCourseListItemEnrollmentToJSON(json) {
+    return GetUserCourseListItemEnrollmentToJSONTyped(json, false);
+}
+function GetUserCourseListItemEnrollmentToJSONTyped(value, ignoreDiscriminator = false) {
+    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/dist/models/GetUserCourseListItemProgress.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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.
+ */
+/**
+ * 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 declare function instanceOfGetUserCourseListItemProgress(value: object): value is GetUserCourseListItemProgress;
+export declare function GetUserCourseListItemProgressFromJSON(json: any): GetUserCourseListItemProgress;
+export declare function GetUserCourseListItemProgressFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetUserCourseListItemProgress;
+export declare function GetUserCourseListItemProgressToJSON(json: any): GetUserCourseListItemProgress;
+export declare function GetUserCourseListItemProgressToJSONTyped(value?: GetUserCourseListItemProgress | null, ignoreDiscriminator?: boolean): any;

package/dist/models/GetUserCourseListItemProgress.js

@@ -0,0 +1,58 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfGetUserCourseListItemProgress = instanceOfGetUserCourseListItemProgress;
+exports.GetUserCourseListItemProgressFromJSON = GetUserCourseListItemProgressFromJSON;
+exports.GetUserCourseListItemProgressFromJSONTyped = GetUserCourseListItemProgressFromJSONTyped;
+exports.GetUserCourseListItemProgressToJSON = GetUserCourseListItemProgressToJSON;
+exports.GetUserCourseListItemProgressToJSONTyped = GetUserCourseListItemProgressToJSONTyped;
+/**
+ * Check if a given object implements the GetUserCourseListItemProgress interface.
+ */
+function instanceOfGetUserCourseListItemProgress(value) {
+    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;
+}
+function GetUserCourseListItemProgressFromJSON(json) {
+    return GetUserCourseListItemProgressFromJSONTyped(json, false);
+}
+function GetUserCourseListItemProgressFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'completionPercentage': json['completion_percentage'],
+        'completedContentCount': json['completed_content_count'],
+        'totalContentCount': json['total_content_count'],
+    };
+}
+function GetUserCourseListItemProgressToJSON(json) {
+    return GetUserCourseListItemProgressToJSONTyped(json, false);
+}
+function GetUserCourseListItemProgressToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'completion_percentage': value['completionPercentage'],
+        'completed_content_count': value['completedContentCount'],
+        'total_content_count': value['totalContentCount'],
+    };
+}

package/dist/models/index.d.ts

@@ -153,6 +153,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';

package/dist/models/index.js

@@ -171,6 +171,12 @@ __exportStar(require("./GetSystemBillingList"), exports);
 __exportStar(require("./GetSystemMetrics"), exports);
 __exportStar(require("./GetUser"), exports);
 __exportStar(require("./GetUserAvatarUpload"), exports);
+__exportStar(require("./GetUserCourseList"), exports);
+__exportStar(require("./GetUserCourseListItem"), exports);
+__exportStar(require("./GetUserCourseListItemCertificate"), exports);
+__exportStar(require("./GetUserCourseListItemCourse"), exports);
+__exportStar(require("./GetUserCourseListItemEnrollment"), exports);
+__exportStar(require("./GetUserCourseListItemProgress"), exports);
 __exportStar(require("./GetUserQuizAttempts"), exports);
 __exportStar(require("./GetUserQuizAttemptsAllOfAttempts"), exports);
 __exportStar(require("./GetUserQuizAttemptsAllOfFilters"), exports);

package/docs/GetUserCourseList.md

@@ -0,0 +1,43 @@
+
+# GetUserCourseList
+
+A paginated list of courses the target user is enrolled in.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`page` | number
+`pageSize` | number
+`totalPages` | number
+`totalItems` | number
+`items` | [Array<GetUserCourseListItem>](GetUserCourseListItem.md)
+
+## Example
+
+```typescript
+import type { GetUserCourseList } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "page": null,
+  "pageSize": null,
+  "totalPages": null,
+  "totalItems": null,
+  "items": null,
+} satisfies GetUserCourseList
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetUserCourseList
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GetUserCourseListItem.md

@@ -0,0 +1,41 @@
+
+# GetUserCourseListItem
+
+A course the target user is enrolled in, grouped by course and selected enrollment.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`course` | [GetUserCourseListItemCourse](GetUserCourseListItemCourse.md)
+`enrollment` | [GetUserCourseListItemEnrollment](GetUserCourseListItemEnrollment.md)
+`progress` | [GetUserCourseListItemProgress](GetUserCourseListItemProgress.md)
+`certificate` | [GetUserCourseListItemCertificate](GetUserCourseListItemCertificate.md)
+
+## Example
+
+```typescript
+import type { GetUserCourseListItem } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "course": null,
+  "enrollment": null,
+  "progress": null,
+  "certificate": null,
+} satisfies GetUserCourseListItem
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetUserCourseListItem
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GetUserCourseListItemCertificate.md

@@ -0,0 +1,43 @@
+
+# GetUserCourseListItemCertificate
+
+Latest certificate for the learner and course, if one exists.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`status` | string
+`issuedAt` | number
+`expiresAt` | number
+`issuanceReason` | string
+
+## Example
+
+```typescript
+import type { GetUserCourseListItemCertificate } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "status": null,
+  "issuedAt": null,
+  "expiresAt": null,
+  "issuanceReason": null,
+} satisfies GetUserCourseListItemCertificate
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetUserCourseListItemCertificate
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GetUserCourseListItemCourse.md

@@ -0,0 +1,51 @@
+
+# GetUserCourseListItemCourse
+
+Course fields for an enrolled user\'s course list item.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`description` | string
+`imageUrl` | string
+`published` | boolean
+`createdAt` | number
+`accessPolicyType` | string
+`accessDurationDays` | number
+`accessFixedEndAt` | number
+
+## Example
+
+```typescript
+import type { GetUserCourseListItemCourse } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "description": null,
+  "imageUrl": null,
+  "published": null,
+  "createdAt": null,
+  "accessPolicyType": null,
+  "accessDurationDays": null,
+  "accessFixedEndAt": null,
+} satisfies GetUserCourseListItemCourse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetUserCourseListItemCourse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GetUserCourseListItemEnrollment.md

@@ -0,0 +1,49 @@
+
+# GetUserCourseListItemEnrollment
+
+Selected enrollment fields for an enrolled user\'s course list item.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`status` | string
+`accessState` | string
+`daysUntilExpiry` | number
+`userType` | string
+`enrollmentDateStart` | number
+`enrollmentDateEnd` | number
+`completionDate` | number
+
+## Example
+
+```typescript
+import type { GetUserCourseListItemEnrollment } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "status": null,
+  "accessState": null,
+  "daysUntilExpiry": null,
+  "userType": null,
+  "enrollmentDateStart": null,
+  "enrollmentDateEnd": null,
+  "completionDate": null,
+} satisfies GetUserCourseListItemEnrollment
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetUserCourseListItemEnrollment
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GetUserCourseListItemProgress.md

@@ -0,0 +1,39 @@
+
+# GetUserCourseListItemProgress
+
+Learner progress for an enrolled user\'s course list item.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`completionPercentage` | number
+`completedContentCount` | number
+`totalContentCount` | number
+
+## Example
+
+```typescript
+import type { GetUserCourseListItemProgress } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "completionPercentage": null,
+  "completedContentCount": null,
+  "totalContentCount": null,
+} satisfies GetUserCourseListItemProgress
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetUserCourseListItemProgress
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+