@easyedu/js-lsm-api 1.116.0 → 1.117.0

package/dist/esm/models/IntegrationEvent.js

@@ -0,0 +1,92 @@
+/* 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 { IntegrationEventDataFromJSON, IntegrationEventDataToJSON, } from './IntegrationEventData';
+/**
+ * @export
+ */
+export const IntegrationEventSpecversionEnum = {
+    _10: '1.0'
+};
+/**
+ * @export
+ */
+export const IntegrationEventTypeEnum = {
+    ComEdaxuEnrollmentEnrolledV1: 'com.edaxu.enrollment.enrolled.v1',
+    ComEdaxuEnrollmentCompletedV1: 'com.edaxu.enrollment.completed.v1',
+    ComEdaxuCertificateIssuedV1: 'com.edaxu.certificate.issued.v1'
+};
+/**
+ * @export
+ */
+export const IntegrationEventDatacontenttypeEnum = {
+    ApplicationJson: 'application/json'
+};
+/**
+ * Check if a given object implements the IntegrationEvent interface.
+ */
+export function instanceOfIntegrationEvent(value) {
+    if (!('specversion' in value) || value['specversion'] === undefined)
+        return false;
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('source' in value) || value['source'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('time' in value) || value['time'] === undefined)
+        return false;
+    if (!('subject' in value) || value['subject'] === undefined)
+        return false;
+    if (!('datacontenttype' in value) || value['datacontenttype'] === undefined)
+        return false;
+    if (!('data' in value) || value['data'] === undefined)
+        return false;
+    return true;
+}
+export function IntegrationEventFromJSON(json) {
+    return IntegrationEventFromJSONTyped(json, false);
+}
+export function IntegrationEventFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'specversion': json['specversion'],
+        'id': json['id'],
+        'source': json['source'],
+        'type': json['type'],
+        'time': (new Date(json['time'])),
+        'subject': json['subject'],
+        'datacontenttype': json['datacontenttype'],
+        'data': IntegrationEventDataFromJSON(json['data']),
+    };
+}
+export function IntegrationEventToJSON(json) {
+    return IntegrationEventToJSONTyped(json, false);
+}
+export function IntegrationEventToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'specversion': value['specversion'],
+        'id': value['id'],
+        'source': value['source'],
+        'type': value['type'],
+        'time': value['time'].toISOString(),
+        'subject': value['subject'],
+        'datacontenttype': value['datacontenttype'],
+        'data': IntegrationEventDataToJSON(value['data']),
+    };
+}

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

@@ -0,0 +1,78 @@
+/**
+ * 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
+ * @interface IntegrationEventCertificate
+ */
+export interface IntegrationEventCertificate {
+    /**
+     * Stable external certificate ID.
+     * @type {string}
+     * @memberof IntegrationEventCertificate
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof IntegrationEventCertificate
+     */
+    status: string;
+    /**
+     *
+     * @type {IntegrationEventCertificateIssuanceTypeEnum}
+     * @memberof IntegrationEventCertificate
+     */
+    issuanceType: IntegrationEventCertificateIssuanceTypeEnum;
+    /**
+     *
+     * @type {Date}
+     * @memberof IntegrationEventCertificate
+     */
+    issuedAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof IntegrationEventCertificate
+     */
+    expiresAt: Date | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IntegrationEventCertificate
+     */
+    verificationUrl: string;
+    /**
+     *
+     * @type {string}
+     * @memberof IntegrationEventCertificate
+     */
+    enrollmentId: string | null;
+}
+/**
+ * @export
+ */
+export declare const IntegrationEventCertificateIssuanceTypeEnum: {
+    readonly Original: "original";
+    readonly Renewal: "renewal";
+    readonly Replacement: "replacement";
+    readonly Correction: "correction";
+};
+export type IntegrationEventCertificateIssuanceTypeEnum = typeof IntegrationEventCertificateIssuanceTypeEnum[keyof typeof IntegrationEventCertificateIssuanceTypeEnum];
+/**
+ * Check if a given object implements the IntegrationEventCertificate interface.
+ */
+export declare function instanceOfIntegrationEventCertificate(value: object): value is IntegrationEventCertificate;
+export declare function IntegrationEventCertificateFromJSON(json: any): IntegrationEventCertificate;
+export declare function IntegrationEventCertificateFromJSONTyped(json: any, ignoreDiscriminator: boolean): IntegrationEventCertificate;
+export declare function IntegrationEventCertificateToJSON(json: any): IntegrationEventCertificate;
+export declare function IntegrationEventCertificateToJSONTyped(value?: IntegrationEventCertificate | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/IntegrationEventCertificate.js

@@ -0,0 +1,76 @@
+/* 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 IntegrationEventCertificateIssuanceTypeEnum = {
+    Original: 'original',
+    Renewal: 'renewal',
+    Replacement: 'replacement',
+    Correction: 'correction'
+};
+/**
+ * Check if a given object implements the IntegrationEventCertificate interface.
+ */
+export function instanceOfIntegrationEventCertificate(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('issuanceType' in value) || value['issuanceType'] === undefined)
+        return false;
+    if (!('issuedAt' in value) || value['issuedAt'] === undefined)
+        return false;
+    if (!('expiresAt' in value) || value['expiresAt'] === undefined)
+        return false;
+    if (!('verificationUrl' in value) || value['verificationUrl'] === undefined)
+        return false;
+    if (!('enrollmentId' in value) || value['enrollmentId'] === undefined)
+        return false;
+    return true;
+}
+export function IntegrationEventCertificateFromJSON(json) {
+    return IntegrationEventCertificateFromJSONTyped(json, false);
+}
+export function IntegrationEventCertificateFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'status': json['status'],
+        'issuanceType': json['issuance_type'],
+        'issuedAt': (new Date(json['issued_at'])),
+        'expiresAt': (json['expires_at'] == null ? null : new Date(json['expires_at'])),
+        'verificationUrl': json['verification_url'],
+        'enrollmentId': json['enrollment_id'],
+    };
+}
+export function IntegrationEventCertificateToJSON(json) {
+    return IntegrationEventCertificateToJSONTyped(json, false);
+}
+export function IntegrationEventCertificateToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'status': value['status'],
+        'issuance_type': value['issuanceType'],
+        'issued_at': value['issuedAt'].toISOString(),
+        'expires_at': value['expiresAt'] == null ? value['expiresAt'] : value['expiresAt'].toISOString(),
+        'verification_url': value['verificationUrl'],
+        'enrollment_id': value['enrollmentId'],
+    };
+}

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

@@ -0,0 +1,38 @@
+/**
+ * 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
+ * @interface IntegrationEventCourse
+ */
+export interface IntegrationEventCourse {
+    /**
+     * Stable external course ID.
+     * @type {string}
+     * @memberof IntegrationEventCourse
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof IntegrationEventCourse
+     */
+    name: string;
+}
+/**
+ * Check if a given object implements the IntegrationEventCourse interface.
+ */
+export declare function instanceOfIntegrationEventCourse(value: object): value is IntegrationEventCourse;
+export declare function IntegrationEventCourseFromJSON(json: any): IntegrationEventCourse;
+export declare function IntegrationEventCourseFromJSONTyped(json: any, ignoreDiscriminator: boolean): IntegrationEventCourse;
+export declare function IntegrationEventCourseToJSON(json: any): IntegrationEventCourse;
+export declare function IntegrationEventCourseToJSONTyped(value?: IntegrationEventCourse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/IntegrationEventCourse.js

@@ -0,0 +1,47 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the IntegrationEventCourse interface.
+ */
+export function instanceOfIntegrationEventCourse(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    return true;
+}
+export function IntegrationEventCourseFromJSON(json) {
+    return IntegrationEventCourseFromJSONTyped(json, false);
+}
+export function IntegrationEventCourseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+    };
+}
+export function IntegrationEventCourseToJSON(json) {
+    return IntegrationEventCourseToJSONTyped(json, false);
+}
+export function IntegrationEventCourseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+    };
+}

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

@@ -0,0 +1,61 @@
+/**
+ * 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 { IntegrationEventLearner } from './IntegrationEventLearner';
+import type { IntegrationEventCertificate } from './IntegrationEventCertificate';
+import type { IntegrationEventEnrollment } from './IntegrationEventEnrollment';
+import type { IntegrationEventPortal } from './IntegrationEventPortal';
+import type { IntegrationEventCourse } from './IntegrationEventCourse';
+/**
+ *
+ * @export
+ * @interface IntegrationEventData
+ */
+export interface IntegrationEventData {
+    /**
+     *
+     * @type {IntegrationEventPortal}
+     * @memberof IntegrationEventData
+     */
+    portal: IntegrationEventPortal;
+    /**
+     *
+     * @type {IntegrationEventLearner}
+     * @memberof IntegrationEventData
+     */
+    learner: IntegrationEventLearner;
+    /**
+     *
+     * @type {IntegrationEventCourse}
+     * @memberof IntegrationEventData
+     */
+    course: IntegrationEventCourse;
+    /**
+     *
+     * @type {IntegrationEventEnrollment}
+     * @memberof IntegrationEventData
+     */
+    enrollment: IntegrationEventEnrollment | null;
+    /**
+     *
+     * @type {IntegrationEventCertificate}
+     * @memberof IntegrationEventData
+     */
+    certificate: IntegrationEventCertificate | null;
+}
+/**
+ * Check if a given object implements the IntegrationEventData interface.
+ */
+export declare function instanceOfIntegrationEventData(value: object): value is IntegrationEventData;
+export declare function IntegrationEventDataFromJSON(json: any): IntegrationEventData;
+export declare function IntegrationEventDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): IntegrationEventData;
+export declare function IntegrationEventDataToJSON(json: any): IntegrationEventData;
+export declare function IntegrationEventDataToJSONTyped(value?: IntegrationEventData | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/IntegrationEventData.js

@@ -0,0 +1,64 @@
+/* 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 { IntegrationEventLearnerFromJSON, IntegrationEventLearnerToJSON, } from './IntegrationEventLearner';
+import { IntegrationEventCertificateFromJSON, IntegrationEventCertificateToJSON, } from './IntegrationEventCertificate';
+import { IntegrationEventEnrollmentFromJSON, IntegrationEventEnrollmentToJSON, } from './IntegrationEventEnrollment';
+import { IntegrationEventPortalFromJSON, IntegrationEventPortalToJSON, } from './IntegrationEventPortal';
+import { IntegrationEventCourseFromJSON, IntegrationEventCourseToJSON, } from './IntegrationEventCourse';
+/**
+ * Check if a given object implements the IntegrationEventData interface.
+ */
+export function instanceOfIntegrationEventData(value) {
+    if (!('portal' in value) || value['portal'] === undefined)
+        return false;
+    if (!('learner' in value) || value['learner'] === undefined)
+        return false;
+    if (!('course' in value) || value['course'] === undefined)
+        return false;
+    if (!('enrollment' in value) || value['enrollment'] === undefined)
+        return false;
+    if (!('certificate' in value) || value['certificate'] === undefined)
+        return false;
+    return true;
+}
+export function IntegrationEventDataFromJSON(json) {
+    return IntegrationEventDataFromJSONTyped(json, false);
+}
+export function IntegrationEventDataFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'portal': IntegrationEventPortalFromJSON(json['portal']),
+        'learner': IntegrationEventLearnerFromJSON(json['learner']),
+        'course': IntegrationEventCourseFromJSON(json['course']),
+        'enrollment': IntegrationEventEnrollmentFromJSON(json['enrollment']),
+        'certificate': IntegrationEventCertificateFromJSON(json['certificate']),
+    };
+}
+export function IntegrationEventDataToJSON(json) {
+    return IntegrationEventDataToJSONTyped(json, false);
+}
+export function IntegrationEventDataToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'portal': IntegrationEventPortalToJSON(value['portal']),
+        'learner': IntegrationEventLearnerToJSON(value['learner']),
+        'course': IntegrationEventCourseToJSON(value['course']),
+        'enrollment': IntegrationEventEnrollmentToJSON(value['enrollment']),
+        'certificate': IntegrationEventCertificateToJSON(value['certificate']),
+    };
+}

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

@@ -0,0 +1,71 @@
+/**
+ * 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
+ * @interface IntegrationEventEnrollment
+ */
+export interface IntegrationEventEnrollment {
+    /**
+     * Stable external enrollment ID.
+     * @type {string}
+     * @memberof IntegrationEventEnrollment
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof IntegrationEventEnrollment
+     */
+    status: string;
+    /**
+     *
+     * @type {IntegrationEventEnrollmentOccurrenceEnum}
+     * @memberof IntegrationEventEnrollment
+     */
+    occurrence: IntegrationEventEnrollmentOccurrenceEnum;
+    /**
+     *
+     * @type {Date}
+     * @memberof IntegrationEventEnrollment
+     */
+    enrollmentDateStart: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof IntegrationEventEnrollment
+     */
+    enrollmentDateEnd: Date | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof IntegrationEventEnrollment
+     */
+    completedAt: Date | null;
+}
+/**
+ * @export
+ */
+export declare const IntegrationEventEnrollmentOccurrenceEnum: {
+    readonly Created: "created";
+    readonly Resumed: "resumed";
+    readonly Completed: "completed";
+};
+export type IntegrationEventEnrollmentOccurrenceEnum = typeof IntegrationEventEnrollmentOccurrenceEnum[keyof typeof IntegrationEventEnrollmentOccurrenceEnum];
+/**
+ * Check if a given object implements the IntegrationEventEnrollment interface.
+ */
+export declare function instanceOfIntegrationEventEnrollment(value: object): value is IntegrationEventEnrollment;
+export declare function IntegrationEventEnrollmentFromJSON(json: any): IntegrationEventEnrollment;
+export declare function IntegrationEventEnrollmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): IntegrationEventEnrollment;
+export declare function IntegrationEventEnrollmentToJSON(json: any): IntegrationEventEnrollment;
+export declare function IntegrationEventEnrollmentToJSONTyped(value?: IntegrationEventEnrollment | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/IntegrationEventEnrollment.js

@@ -0,0 +1,71 @@
+/* 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 IntegrationEventEnrollmentOccurrenceEnum = {
+    Created: 'created',
+    Resumed: 'resumed',
+    Completed: 'completed'
+};
+/**
+ * Check if a given object implements the IntegrationEventEnrollment interface.
+ */
+export function instanceOfIntegrationEventEnrollment(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('occurrence' in value) || value['occurrence'] === undefined)
+        return false;
+    if (!('enrollmentDateStart' in value) || value['enrollmentDateStart'] === undefined)
+        return false;
+    if (!('enrollmentDateEnd' in value) || value['enrollmentDateEnd'] === undefined)
+        return false;
+    if (!('completedAt' in value) || value['completedAt'] === undefined)
+        return false;
+    return true;
+}
+export function IntegrationEventEnrollmentFromJSON(json) {
+    return IntegrationEventEnrollmentFromJSONTyped(json, false);
+}
+export function IntegrationEventEnrollmentFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'status': json['status'],
+        'occurrence': json['occurrence'],
+        'enrollmentDateStart': (new Date(json['enrollment_date_start'])),
+        'enrollmentDateEnd': (json['enrollment_date_end'] == null ? null : new Date(json['enrollment_date_end'])),
+        'completedAt': (json['completed_at'] == null ? null : new Date(json['completed_at'])),
+    };
+}
+export function IntegrationEventEnrollmentToJSON(json) {
+    return IntegrationEventEnrollmentToJSONTyped(json, false);
+}
+export function IntegrationEventEnrollmentToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'status': value['status'],
+        'occurrence': value['occurrence'],
+        'enrollment_date_start': value['enrollmentDateStart'].toISOString(),
+        'enrollment_date_end': value['enrollmentDateEnd'] == null ? value['enrollmentDateEnd'] : value['enrollmentDateEnd'].toISOString(),
+        'completed_at': value['completedAt'] == null ? value['completedAt'] : value['completedAt'].toISOString(),
+    };
+}

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

@@ -0,0 +1,50 @@
+/**
+ * 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
+ * @interface IntegrationEventLearner
+ */
+export interface IntegrationEventLearner {
+    /**
+     * Stable external learner ID.
+     * @type {string}
+     * @memberof IntegrationEventLearner
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof IntegrationEventLearner
+     */
+    email: string;
+    /**
+     *
+     * @type {string}
+     * @memberof IntegrationEventLearner
+     */
+    firstName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof IntegrationEventLearner
+     */
+    lastName: string;
+}
+/**
+ * Check if a given object implements the IntegrationEventLearner interface.
+ */
+export declare function instanceOfIntegrationEventLearner(value: object): value is IntegrationEventLearner;
+export declare function IntegrationEventLearnerFromJSON(json: any): IntegrationEventLearner;
+export declare function IntegrationEventLearnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): IntegrationEventLearner;
+export declare function IntegrationEventLearnerToJSON(json: any): IntegrationEventLearner;
+export declare function IntegrationEventLearnerToJSONTyped(value?: IntegrationEventLearner | null, ignoreDiscriminator?: boolean): any;