@easyedu/js-lsm-api 1.79.0 → 1.81.0

package/src/models/GetRichTextAssetUpload.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 GetRichTextAssetUpload
+ */
+export interface GetRichTextAssetUpload {
+    /**
+     * Created pending asset ID
+     * @type {string}
+     * @memberof GetRichTextAssetUpload
+     */
+    assetId: string;
+    /**
+     * Presigned URL for direct upload
+     * @type {string}
+     * @memberof GetRichTextAssetUpload
+     */
+    uploadUrl: string;
+    /**
+     * Authenticated API URL that redirects to a signed asset URL once completed
+     * @type {string}
+     * @memberof GetRichTextAssetUpload
+     */
+    renderUrl: string;
+    /**
+     * Upload URL lifetime
+     * @type {number}
+     * @memberof GetRichTextAssetUpload
+     */
+    expiresInSeconds: number;
+}
+
+/**
+ * Check if a given object implements the GetRichTextAssetUpload interface.
+ */
+export function instanceOfGetRichTextAssetUpload(value: object): value is GetRichTextAssetUpload {
+    if (!('assetId' in value) || value['assetId'] === undefined) return false;
+    if (!('uploadUrl' in value) || value['uploadUrl'] === undefined) return false;
+    if (!('renderUrl' in value) || value['renderUrl'] === undefined) return false;
+    if (!('expiresInSeconds' in value) || value['expiresInSeconds'] === undefined) return false;
+    return true;
+}
+
+export function GetRichTextAssetUploadFromJSON(json: any): GetRichTextAssetUpload {
+    return GetRichTextAssetUploadFromJSONTyped(json, false);
+}
+
+export function GetRichTextAssetUploadFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetRichTextAssetUpload {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'assetId': json['asset_id'],
+        'uploadUrl': json['upload_url'],
+        'renderUrl': json['render_url'],
+        'expiresInSeconds': json['expires_in_seconds'],
+    };
+}
+
+export function GetRichTextAssetUploadToJSON(json: any): GetRichTextAssetUpload {
+    return GetRichTextAssetUploadToJSONTyped(json, false);
+}
+
+export function GetRichTextAssetUploadToJSONTyped(value?: GetRichTextAssetUpload | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'asset_id': value['assetId'],
+        'upload_url': value['uploadUrl'],
+        'render_url': value['renderUrl'],
+        'expires_in_seconds': value['expiresInSeconds'],
+    };
+}
+

package/src/models/GetUserCourseList.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 { GetUserCourseListItem } from './GetUserCourseListItem';
+import {
+    GetUserCourseListItemFromJSON,
+    GetUserCourseListItemFromJSONTyped,
+    GetUserCourseListItemToJSON,
+    GetUserCourseListItemToJSONTyped,
+} from './GetUserCourseListItem';
+
+/**
+ * A paginated list of courses the target user is enrolled in.
+ * @export
+ * @interface GetUserCourseList
+ */
+export interface GetUserCourseList {
+    /**
+     * The current page number
+     * @type {number}
+     * @memberof GetUserCourseList
+     */
+    page: number;
+    /**
+     * The number of items returned on this page
+     * @type {number}
+     * @memberof GetUserCourseList
+     */
+    pageSize: number;
+    /**
+     * The total number of pages
+     * @type {number}
+     * @memberof GetUserCourseList
+     */
+    totalPages: number;
+    /**
+     * The total number of courses after selecting one enrollment per course
+     * @type {number}
+     * @memberof GetUserCourseList
+     */
+    totalItems: number;
+    /**
+     * 
+     * @type {Array<GetUserCourseListItem>}
+     * @memberof GetUserCourseList
+     */
+    items: Array<GetUserCourseListItem>;
+}
+
+/**
+ * Check if a given object implements the GetUserCourseList interface.
+ */
+export function instanceOfGetUserCourseList(value: object): value is GetUserCourseList {
+    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: any): GetUserCourseList {
+    return GetUserCourseListFromJSONTyped(json, false);
+}
+
+export function GetUserCourseListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetUserCourseList {
+    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(GetUserCourseListItemFromJSON)),
+    };
+}
+
+export function GetUserCourseListToJSON(json: any): GetUserCourseList {
+    return GetUserCourseListToJSONTyped(json, false);
+}
+
+export function GetUserCourseListToJSONTyped(value?: GetUserCourseList | 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(GetUserCourseListItemToJSON)),
+    };
+}
+

package/src/models/GetUserCourseListItem.ts

@@ -0,0 +1,122 @@
+/* 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 { GetUserCourseListItemCourse } from './GetUserCourseListItemCourse';
+import {
+    GetUserCourseListItemCourseFromJSON,
+    GetUserCourseListItemCourseFromJSONTyped,
+    GetUserCourseListItemCourseToJSON,
+    GetUserCourseListItemCourseToJSONTyped,
+} from './GetUserCourseListItemCourse';
+import type { GetUserCourseListItemEnrollment } from './GetUserCourseListItemEnrollment';
+import {
+    GetUserCourseListItemEnrollmentFromJSON,
+    GetUserCourseListItemEnrollmentFromJSONTyped,
+    GetUserCourseListItemEnrollmentToJSON,
+    GetUserCourseListItemEnrollmentToJSONTyped,
+} from './GetUserCourseListItemEnrollment';
+import type { GetUserCourseListItemCertificate } from './GetUserCourseListItemCertificate';
+import {
+    GetUserCourseListItemCertificateFromJSON,
+    GetUserCourseListItemCertificateFromJSONTyped,
+    GetUserCourseListItemCertificateToJSON,
+    GetUserCourseListItemCertificateToJSONTyped,
+} from './GetUserCourseListItemCertificate';
+import type { GetUserCourseListItemProgress } from './GetUserCourseListItemProgress';
+import {
+    GetUserCourseListItemProgressFromJSON,
+    GetUserCourseListItemProgressFromJSONTyped,
+    GetUserCourseListItemProgressToJSON,
+    GetUserCourseListItemProgressToJSONTyped,
+} 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 function instanceOfGetUserCourseListItem(value: object): value is GetUserCourseListItem {
+    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: any): GetUserCourseListItem {
+    return GetUserCourseListItemFromJSONTyped(json, false);
+}
+
+export function GetUserCourseListItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetUserCourseListItem {
+    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: any): GetUserCourseListItem {
+    return GetUserCourseListItemToJSONTyped(json, false);
+}
+
+export function GetUserCourseListItemToJSONTyped(value?: GetUserCourseListItem | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'course': GetUserCourseListItemCourseToJSON(value['course']),
+        'enrollment': GetUserCourseListItemEnrollmentToJSON(value['enrollment']),
+        'progress': GetUserCourseListItemProgressToJSON(value['progress']),
+        'certificate': GetUserCourseListItemCertificateToJSON(value['certificate']),
+    };
+}
+

package/src/models/GetUserCourseListItemCertificate.ts

@@ -0,0 +1,124 @@
+/* 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';
+/**
+ * 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 const GetUserCourseListItemCertificateStatusEnum = {
+    Active: 'active',
+    Expired: 'expired',
+    Revoked: 'revoked'
+} as const;
+export type GetUserCourseListItemCertificateStatusEnum = typeof GetUserCourseListItemCertificateStatusEnum[keyof typeof GetUserCourseListItemCertificateStatusEnum];
+
+/**
+ * @export
+ */
+export const GetUserCourseListItemCertificateIssuanceReasonEnum = {
+    CourseCompletion: 'course_completion',
+    QuizPassed: 'quiz_passed',
+    Manual: 'manual'
+} as const;
+export type GetUserCourseListItemCertificateIssuanceReasonEnum = typeof GetUserCourseListItemCertificateIssuanceReasonEnum[keyof typeof GetUserCourseListItemCertificateIssuanceReasonEnum];
+
+
+/**
+ * Check if a given object implements the GetUserCourseListItemCertificate interface.
+ */
+export function instanceOfGetUserCourseListItemCertificate(value: object): value is GetUserCourseListItemCertificate {
+    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: any): GetUserCourseListItemCertificate {
+    return GetUserCourseListItemCertificateFromJSONTyped(json, false);
+}
+
+export function GetUserCourseListItemCertificateFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetUserCourseListItemCertificate {
+    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: any): GetUserCourseListItemCertificate {
+    return GetUserCourseListItemCertificateToJSONTyped(json, false);
+}
+
+export function GetUserCourseListItemCertificateToJSONTyped(value?: GetUserCourseListItemCertificate | null, ignoreDiscriminator: boolean = false): any {
+    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/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'],
+    };
+}
+