@easyedu/js-lsm-api 1.116.0 → 1.118.0

package/src/models/CustomWebhookIntegration.ts

@@ -0,0 +1,143 @@
+/* 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 CustomWebhookIntegration
+ */
+export interface CustomWebhookIntegration {
+    /**
+     * 
+     * @type {string}
+     * @memberof CustomWebhookIntegration
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CustomWebhookIntegration
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CustomWebhookIntegration
+     */
+    targetUrl: string;
+    /**
+     * 
+     * @type {Set<CustomWebhookIntegrationEventTypesEnum>}
+     * @memberof CustomWebhookIntegration
+     */
+    eventTypes: Set<CustomWebhookIntegrationEventTypesEnum>;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof CustomWebhookIntegration
+     */
+    enabled: boolean;
+    /**
+     * True when an encrypted bearer token is configured. The token is never returned.
+     * @type {boolean}
+     * @memberof CustomWebhookIntegration
+     */
+    tokenConfigured: boolean;
+    /**
+     * 
+     * @type {Date}
+     * @memberof CustomWebhookIntegration
+     */
+    createdAt: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof CustomWebhookIntegration
+     */
+    updatedAt: Date;
+}
+
+
+/**
+ * @export
+ */
+export const CustomWebhookIntegrationEventTypesEnum = {
+    ComEdaxuEnrollmentEnrolledV1: 'com.edaxu.enrollment.enrolled.v1',
+    ComEdaxuEnrollmentCompletedV1: 'com.edaxu.enrollment.completed.v1',
+    ComEdaxuCertificateIssuedV1: 'com.edaxu.certificate.issued.v1',
+    ComEdaxuPortalUserInvitedV1: 'com.edaxu.portal.user_invited.v1',
+    ComEdaxuPortalUserJoinedV1: 'com.edaxu.portal.user_joined.v1'
+} as const;
+export type CustomWebhookIntegrationEventTypesEnum = typeof CustomWebhookIntegrationEventTypesEnum[keyof typeof CustomWebhookIntegrationEventTypesEnum];
+
+
+/**
+ * Check if a given object implements the CustomWebhookIntegration interface.
+ */
+export function instanceOfCustomWebhookIntegration(value: object): value is CustomWebhookIntegration {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('targetUrl' in value) || value['targetUrl'] === undefined) return false;
+    if (!('eventTypes' in value) || value['eventTypes'] === undefined) return false;
+    if (!('enabled' in value) || value['enabled'] === undefined) return false;
+    if (!('tokenConfigured' in value) || value['tokenConfigured'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    return true;
+}
+
+export function CustomWebhookIntegrationFromJSON(json: any): CustomWebhookIntegration {
+    return CustomWebhookIntegrationFromJSONTyped(json, false);
+}
+
+export function CustomWebhookIntegrationFromJSONTyped(json: any, ignoreDiscriminator: boolean): CustomWebhookIntegration {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'targetUrl': json['target_url'],
+        'eventTypes': new Set(json['event_types']),
+        'enabled': json['enabled'],
+        'tokenConfigured': json['token_configured'],
+        'createdAt': (new Date(json['created_at'])),
+        'updatedAt': (new Date(json['updated_at'])),
+    };
+}
+
+export function CustomWebhookIntegrationToJSON(json: any): CustomWebhookIntegration {
+    return CustomWebhookIntegrationToJSONTyped(json, false);
+}
+
+export function CustomWebhookIntegrationToJSONTyped(value?: CustomWebhookIntegration | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'target_url': value['targetUrl'],
+        'event_types': Array.from(value['eventTypes'] as Set<any>),
+        'enabled': value['enabled'],
+        'token_configured': value['tokenConfigured'],
+        'created_at': value['createdAt'].toISOString(),
+        'updated_at': value['updatedAt'].toISOString(),
+    };
+}
+

package/src/models/IntegrationEvent.ts

@@ -0,0 +1,167 @@
+/* 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 { IntegrationEventData } from './IntegrationEventData';
+import {
+    IntegrationEventDataFromJSON,
+    IntegrationEventDataFromJSONTyped,
+    IntegrationEventDataToJSON,
+    IntegrationEventDataToJSONTyped,
+} from './IntegrationEventData';
+
+/**
+ * A CloudEvents 1.0 structured JSON event emitted by Edaxu.
+ * @export
+ * @interface IntegrationEvent
+ */
+export interface IntegrationEvent {
+    /**
+     * 
+     * @type {IntegrationEventSpecversionEnum}
+     * @memberof IntegrationEvent
+     */
+    specversion: IntegrationEventSpecversionEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof IntegrationEvent
+     */
+    id: string;
+    /**
+     * Stable URI identifying the portal event source.
+     * @type {string}
+     * @memberof IntegrationEvent
+     */
+    source: string;
+    /**
+     * 
+     * @type {IntegrationEventTypeEnum}
+     * @memberof IntegrationEvent
+     */
+    type: IntegrationEventTypeEnum;
+    /**
+     * 
+     * @type {Date}
+     * @memberof IntegrationEvent
+     */
+    time: Date;
+    /**
+     * 
+     * @type {string}
+     * @memberof IntegrationEvent
+     */
+    subject: string;
+    /**
+     * 
+     * @type {IntegrationEventDatacontenttypeEnum}
+     * @memberof IntegrationEvent
+     */
+    datacontenttype: IntegrationEventDatacontenttypeEnum;
+    /**
+     * 
+     * @type {IntegrationEventData}
+     * @memberof IntegrationEvent
+     */
+    data: IntegrationEventData;
+}
+
+
+/**
+ * @export
+ */
+export const IntegrationEventSpecversionEnum = {
+    _10: '1.0'
+} as const;
+export type IntegrationEventSpecversionEnum = typeof IntegrationEventSpecversionEnum[keyof typeof IntegrationEventSpecversionEnum];
+
+/**
+ * @export
+ */
+export const IntegrationEventTypeEnum = {
+    ComEdaxuEnrollmentEnrolledV1: 'com.edaxu.enrollment.enrolled.v1',
+    ComEdaxuEnrollmentCompletedV1: 'com.edaxu.enrollment.completed.v1',
+    ComEdaxuCertificateIssuedV1: 'com.edaxu.certificate.issued.v1',
+    ComEdaxuPortalUserInvitedV1: 'com.edaxu.portal.user_invited.v1',
+    ComEdaxuPortalUserJoinedV1: 'com.edaxu.portal.user_joined.v1'
+} as const;
+export type IntegrationEventTypeEnum = typeof IntegrationEventTypeEnum[keyof typeof IntegrationEventTypeEnum];
+
+/**
+ * @export
+ */
+export const IntegrationEventDatacontenttypeEnum = {
+    ApplicationJson: 'application/json'
+} as const;
+export type IntegrationEventDatacontenttypeEnum = typeof IntegrationEventDatacontenttypeEnum[keyof typeof IntegrationEventDatacontenttypeEnum];
+
+
+/**
+ * Check if a given object implements the IntegrationEvent interface.
+ */
+export function instanceOfIntegrationEvent(value: object): value is IntegrationEvent {
+    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: any): IntegrationEvent {
+    return IntegrationEventFromJSONTyped(json, false);
+}
+
+export function IntegrationEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): IntegrationEvent {
+    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: any): IntegrationEvent {
+    return IntegrationEventToJSONTyped(json, false);
+}
+
+export function IntegrationEventToJSONTyped(value?: IntegrationEvent | null, ignoreDiscriminator: boolean = false): any {
+    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/src/models/IntegrationEventCertificate.ts

@@ -0,0 +1,133 @@
+/* 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 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 const IntegrationEventCertificateIssuanceTypeEnum = {
+    Original: 'original',
+    Renewal: 'renewal',
+    Replacement: 'replacement',
+    Correction: 'correction'
+} as const;
+export type IntegrationEventCertificateIssuanceTypeEnum = typeof IntegrationEventCertificateIssuanceTypeEnum[keyof typeof IntegrationEventCertificateIssuanceTypeEnum];
+
+
+/**
+ * Check if a given object implements the IntegrationEventCertificate interface.
+ */
+export function instanceOfIntegrationEventCertificate(value: object): value is IntegrationEventCertificate {
+    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: any): IntegrationEventCertificate {
+    return IntegrationEventCertificateFromJSONTyped(json, false);
+}
+
+export function IntegrationEventCertificateFromJSONTyped(json: any, ignoreDiscriminator: boolean): IntegrationEventCertificate {
+    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: any): IntegrationEventCertificate {
+    return IntegrationEventCertificateToJSONTyped(json, false);
+}
+
+export function IntegrationEventCertificateToJSONTyped(value?: IntegrationEventCertificate | null, ignoreDiscriminator: boolean = false): any {
+    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/src/models/IntegrationEventCourse.ts

@@ -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.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @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 function instanceOfIntegrationEventCourse(value: object): value is IntegrationEventCourse {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function IntegrationEventCourseFromJSON(json: any): IntegrationEventCourse {
+    return IntegrationEventCourseFromJSONTyped(json, false);
+}
+
+export function IntegrationEventCourseFromJSONTyped(json: any, ignoreDiscriminator: boolean): IntegrationEventCourse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+    };
+}
+
+export function IntegrationEventCourseToJSON(json: any): IntegrationEventCourse {
+    return IntegrationEventCourseToJSONTyped(json, false);
+}
+
+export function IntegrationEventCourseToJSONTyped(value?: IntegrationEventCourse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+    };
+}
+

package/src/models/IntegrationEventData.ts

@@ -0,0 +1,170 @@
+/* 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 { IntegrationEventUser } from './IntegrationEventUser';
+import {
+    IntegrationEventUserFromJSON,
+    IntegrationEventUserFromJSONTyped,
+    IntegrationEventUserToJSON,
+    IntegrationEventUserToJSONTyped,
+} from './IntegrationEventUser';
+import type { IntegrationEventLearner } from './IntegrationEventLearner';
+import {
+    IntegrationEventLearnerFromJSON,
+    IntegrationEventLearnerFromJSONTyped,
+    IntegrationEventLearnerToJSON,
+    IntegrationEventLearnerToJSONTyped,
+} from './IntegrationEventLearner';
+import type { IntegrationEventCertificate } from './IntegrationEventCertificate';
+import {
+    IntegrationEventCertificateFromJSON,
+    IntegrationEventCertificateFromJSONTyped,
+    IntegrationEventCertificateToJSON,
+    IntegrationEventCertificateToJSONTyped,
+} from './IntegrationEventCertificate';
+import type { IntegrationEventEnrollment } from './IntegrationEventEnrollment';
+import {
+    IntegrationEventEnrollmentFromJSON,
+    IntegrationEventEnrollmentFromJSONTyped,
+    IntegrationEventEnrollmentToJSON,
+    IntegrationEventEnrollmentToJSONTyped,
+} from './IntegrationEventEnrollment';
+import type { IntegrationEventPortal } from './IntegrationEventPortal';
+import {
+    IntegrationEventPortalFromJSON,
+    IntegrationEventPortalFromJSONTyped,
+    IntegrationEventPortalToJSON,
+    IntegrationEventPortalToJSONTyped,
+} from './IntegrationEventPortal';
+import type { IntegrationEventCourse } from './IntegrationEventCourse';
+import {
+    IntegrationEventCourseFromJSON,
+    IntegrationEventCourseFromJSONTyped,
+    IntegrationEventCourseToJSON,
+    IntegrationEventCourseToJSONTyped,
+} from './IntegrationEventCourse';
+import type { IntegrationEventInvitation } from './IntegrationEventInvitation';
+import {
+    IntegrationEventInvitationFromJSON,
+    IntegrationEventInvitationFromJSONTyped,
+    IntegrationEventInvitationToJSON,
+    IntegrationEventInvitationToJSONTyped,
+} from './IntegrationEventInvitation';
+
+/**
+ * 
+ * @export
+ * @interface IntegrationEventData
+ */
+export interface IntegrationEventData {
+    /**
+     * 
+     * @type {IntegrationEventPortal}
+     * @memberof IntegrationEventData
+     */
+    portal: IntegrationEventPortal;
+    /**
+     * 
+     * @type {IntegrationEventLearner}
+     * @memberof IntegrationEventData
+     */
+    learner: IntegrationEventLearner | null;
+    /**
+     * 
+     * @type {IntegrationEventUser}
+     * @memberof IntegrationEventData
+     */
+    user: IntegrationEventUser | null;
+    /**
+     * 
+     * @type {IntegrationEventCourse}
+     * @memberof IntegrationEventData
+     */
+    course: IntegrationEventCourse | null;
+    /**
+     * 
+     * @type {IntegrationEventEnrollment}
+     * @memberof IntegrationEventData
+     */
+    enrollment: IntegrationEventEnrollment | null;
+    /**
+     * 
+     * @type {IntegrationEventCertificate}
+     * @memberof IntegrationEventData
+     */
+    certificate: IntegrationEventCertificate | null;
+    /**
+     * 
+     * @type {IntegrationEventInvitation}
+     * @memberof IntegrationEventData
+     */
+    invitation: IntegrationEventInvitation | null;
+}
+
+/**
+ * Check if a given object implements the IntegrationEventData interface.
+ */
+export function instanceOfIntegrationEventData(value: object): value is IntegrationEventData {
+    if (!('portal' in value) || value['portal'] === undefined) return false;
+    if (!('learner' in value) || value['learner'] === undefined) return false;
+    if (!('user' in value) || value['user'] === 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;
+    if (!('invitation' in value) || value['invitation'] === undefined) return false;
+    return true;
+}
+
+export function IntegrationEventDataFromJSON(json: any): IntegrationEventData {
+    return IntegrationEventDataFromJSONTyped(json, false);
+}
+
+export function IntegrationEventDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): IntegrationEventData {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'portal': IntegrationEventPortalFromJSON(json['portal']),
+        'learner': IntegrationEventLearnerFromJSON(json['learner']),
+        'user': IntegrationEventUserFromJSON(json['user']),
+        'course': IntegrationEventCourseFromJSON(json['course']),
+        'enrollment': IntegrationEventEnrollmentFromJSON(json['enrollment']),
+        'certificate': IntegrationEventCertificateFromJSON(json['certificate']),
+        'invitation': IntegrationEventInvitationFromJSON(json['invitation']),
+    };
+}
+
+export function IntegrationEventDataToJSON(json: any): IntegrationEventData {
+    return IntegrationEventDataToJSONTyped(json, false);
+}
+
+export function IntegrationEventDataToJSONTyped(value?: IntegrationEventData | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'portal': IntegrationEventPortalToJSON(value['portal']),
+        'learner': IntegrationEventLearnerToJSON(value['learner']),
+        'user': IntegrationEventUserToJSON(value['user']),
+        'course': IntegrationEventCourseToJSON(value['course']),
+        'enrollment': IntegrationEventEnrollmentToJSON(value['enrollment']),
+        'certificate': IntegrationEventCertificateToJSON(value['certificate']),
+        'invitation': IntegrationEventInvitationToJSON(value['invitation']),
+    };
+}
+