@easyedu/js-lsm-api 1.116.0 → 1.118.0

package/src/models/IntegrationEventEnrollment.ts

@@ -0,0 +1,123 @@
+/* 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 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 const IntegrationEventEnrollmentOccurrenceEnum = {
+    Created: 'created',
+    Resumed: 'resumed',
+    Completed: 'completed'
+} as const;
+export type IntegrationEventEnrollmentOccurrenceEnum = typeof IntegrationEventEnrollmentOccurrenceEnum[keyof typeof IntegrationEventEnrollmentOccurrenceEnum];
+
+
+/**
+ * Check if a given object implements the IntegrationEventEnrollment interface.
+ */
+export function instanceOfIntegrationEventEnrollment(value: object): value is IntegrationEventEnrollment {
+    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: any): IntegrationEventEnrollment {
+    return IntegrationEventEnrollmentFromJSONTyped(json, false);
+}
+
+export function IntegrationEventEnrollmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): IntegrationEventEnrollment {
+    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: any): IntegrationEventEnrollment {
+    return IntegrationEventEnrollmentToJSONTyped(json, false);
+}
+
+export function IntegrationEventEnrollmentToJSONTyped(value?: IntegrationEventEnrollment | null, ignoreDiscriminator: boolean = false): any {
+    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/src/models/IntegrationEventInvitation.ts

@@ -0,0 +1,130 @@
+/* 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';
+
+/**
+ * Portal invitation lifecycle details for the affected user.
+ * @export
+ * @interface IntegrationEventInvitation
+ */
+export interface IntegrationEventInvitation {
+    /**
+     * Stable invitation ID.
+     * @type {string}
+     * @memberof IntegrationEventInvitation
+     */
+    id: string;
+    /**
+     * 
+     * @type {IntegrationEventInvitationStatusEnum}
+     * @memberof IntegrationEventInvitation
+     */
+    status: IntegrationEventInvitationStatusEnum;
+    /**
+     * 
+     * @type {Date}
+     * @memberof IntegrationEventInvitation
+     */
+    invitedAt: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof IntegrationEventInvitation
+     */
+    expiresAt: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof IntegrationEventInvitation
+     */
+    acceptedAt: Date | null;
+    /**
+     * 
+     * @type {IntegrationEventUser}
+     * @memberof IntegrationEventInvitation
+     */
+    invitedBy: IntegrationEventUser | null;
+}
+
+
+/**
+ * @export
+ */
+export const IntegrationEventInvitationStatusEnum = {
+    Pending: 'pending',
+    Accepted: 'accepted'
+} as const;
+export type IntegrationEventInvitationStatusEnum = typeof IntegrationEventInvitationStatusEnum[keyof typeof IntegrationEventInvitationStatusEnum];
+
+
+/**
+ * Check if a given object implements the IntegrationEventInvitation interface.
+ */
+export function instanceOfIntegrationEventInvitation(value: object): value is IntegrationEventInvitation {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('invitedAt' in value) || value['invitedAt'] === undefined) return false;
+    if (!('expiresAt' in value) || value['expiresAt'] === undefined) return false;
+    if (!('acceptedAt' in value) || value['acceptedAt'] === undefined) return false;
+    if (!('invitedBy' in value) || value['invitedBy'] === undefined) return false;
+    return true;
+}
+
+export function IntegrationEventInvitationFromJSON(json: any): IntegrationEventInvitation {
+    return IntegrationEventInvitationFromJSONTyped(json, false);
+}
+
+export function IntegrationEventInvitationFromJSONTyped(json: any, ignoreDiscriminator: boolean): IntegrationEventInvitation {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'status': json['status'],
+        'invitedAt': (new Date(json['invited_at'])),
+        'expiresAt': (new Date(json['expires_at'])),
+        'acceptedAt': (json['accepted_at'] == null ? null : new Date(json['accepted_at'])),
+        'invitedBy': IntegrationEventUserFromJSON(json['invited_by']),
+    };
+}
+
+export function IntegrationEventInvitationToJSON(json: any): IntegrationEventInvitation {
+    return IntegrationEventInvitationToJSONTyped(json, false);
+}
+
+export function IntegrationEventInvitationToJSONTyped(value?: IntegrationEventInvitation | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'status': value['status'],
+        'invited_at': value['invitedAt'].toISOString(),
+        'expires_at': value['expiresAt'].toISOString(),
+        'accepted_at': value['acceptedAt'] == null ? value['acceptedAt'] : value['acceptedAt'].toISOString(),
+        'invited_by': IntegrationEventUserToJSON(value['invitedBy']),
+    };
+}
+

package/src/models/IntegrationEventLearner.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 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 function instanceOfIntegrationEventLearner(value: object): value is IntegrationEventLearner {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('email' in value) || value['email'] === undefined) return false;
+    if (!('firstName' in value) || value['firstName'] === undefined) return false;
+    if (!('lastName' in value) || value['lastName'] === undefined) return false;
+    return true;
+}
+
+export function IntegrationEventLearnerFromJSON(json: any): IntegrationEventLearner {
+    return IntegrationEventLearnerFromJSONTyped(json, false);
+}
+
+export function IntegrationEventLearnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): IntegrationEventLearner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'email': json['email'],
+        'firstName': json['first_name'],
+        'lastName': json['last_name'],
+    };
+}
+
+export function IntegrationEventLearnerToJSON(json: any): IntegrationEventLearner {
+    return IntegrationEventLearnerToJSONTyped(json, false);
+}
+
+export function IntegrationEventLearnerToJSONTyped(value?: IntegrationEventLearner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'email': value['email'],
+        'first_name': value['firstName'],
+        'last_name': value['lastName'],
+    };
+}
+

package/src/models/IntegrationEventPortal.ts

@@ -0,0 +1,84 @@
+/* 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 IntegrationEventPortal
+ */
+export interface IntegrationEventPortal {
+    /**
+     * Stable external portal ID.
+     * @type {string}
+     * @memberof IntegrationEventPortal
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IntegrationEventPortal
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IntegrationEventPortal
+     */
+    subdomain: string;
+}
+
+/**
+ * Check if a given object implements the IntegrationEventPortal interface.
+ */
+export function instanceOfIntegrationEventPortal(value: object): value is IntegrationEventPortal {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('subdomain' in value) || value['subdomain'] === undefined) return false;
+    return true;
+}
+
+export function IntegrationEventPortalFromJSON(json: any): IntegrationEventPortal {
+    return IntegrationEventPortalFromJSONTyped(json, false);
+}
+
+export function IntegrationEventPortalFromJSONTyped(json: any, ignoreDiscriminator: boolean): IntegrationEventPortal {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'subdomain': json['subdomain'],
+    };
+}
+
+export function IntegrationEventPortalToJSON(json: any): IntegrationEventPortal {
+    return IntegrationEventPortalToJSONTyped(json, false);
+}
+
+export function IntegrationEventPortalToJSONTyped(value?: IntegrationEventPortal | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'subdomain': value['subdomain'],
+    };
+}
+

package/src/models/IntegrationEventUser.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';
+/**
+ * User affected by a portal membership lifecycle event.
+ * @export
+ * @interface IntegrationEventUser
+ */
+export interface IntegrationEventUser {
+    /**
+     * Stable external user ID.
+     * @type {string}
+     * @memberof IntegrationEventUser
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IntegrationEventUser
+     */
+    email: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IntegrationEventUser
+     */
+    firstName: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IntegrationEventUser
+     */
+    lastName: string;
+}
+
+/**
+ * Check if a given object implements the IntegrationEventUser interface.
+ */
+export function instanceOfIntegrationEventUser(value: object): value is IntegrationEventUser {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('email' in value) || value['email'] === undefined) return false;
+    if (!('firstName' in value) || value['firstName'] === undefined) return false;
+    if (!('lastName' in value) || value['lastName'] === undefined) return false;
+    return true;
+}
+
+export function IntegrationEventUserFromJSON(json: any): IntegrationEventUser {
+    return IntegrationEventUserFromJSONTyped(json, false);
+}
+
+export function IntegrationEventUserFromJSONTyped(json: any, ignoreDiscriminator: boolean): IntegrationEventUser {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'email': json['email'],
+        'firstName': json['first_name'],
+        'lastName': json['last_name'],
+    };
+}
+
+export function IntegrationEventUserToJSON(json: any): IntegrationEventUser {
+    return IntegrationEventUserToJSONTyped(json, false);
+}
+
+export function IntegrationEventUserToJSONTyped(value?: IntegrationEventUser | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'email': value['email'],
+        'first_name': value['firstName'],
+        'last_name': value['lastName'],
+    };
+}
+

package/src/models/PostCustomWebhookIntegration.ts

@@ -0,0 +1,115 @@
+/* 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 PostCustomWebhookIntegration
+ */
+export interface PostCustomWebhookIntegration {
+    /**
+     * 
+     * @type {string}
+     * @memberof PostCustomWebhookIntegration
+     */
+    name: string;
+    /**
+     * Public HTTPS endpoint that receives CloudEvents JSON payloads.
+     * @type {string}
+     * @memberof PostCustomWebhookIntegration
+     */
+    targetUrl: string;
+    /**
+     * Secret sent in the Authorization header as a Bearer token.
+     * @type {string}
+     * @memberof PostCustomWebhookIntegration
+     */
+    bearerToken: string;
+    /**
+     * 
+     * @type {Set<PostCustomWebhookIntegrationEventTypesEnum>}
+     * @memberof PostCustomWebhookIntegration
+     */
+    eventTypes: Set<PostCustomWebhookIntegrationEventTypesEnum>;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PostCustomWebhookIntegration
+     */
+    enabled?: boolean;
+}
+
+
+/**
+ * @export
+ */
+export const PostCustomWebhookIntegrationEventTypesEnum = {
+    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 PostCustomWebhookIntegrationEventTypesEnum = typeof PostCustomWebhookIntegrationEventTypesEnum[keyof typeof PostCustomWebhookIntegrationEventTypesEnum];
+
+
+/**
+ * Check if a given object implements the PostCustomWebhookIntegration interface.
+ */
+export function instanceOfPostCustomWebhookIntegration(value: object): value is PostCustomWebhookIntegration {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('targetUrl' in value) || value['targetUrl'] === undefined) return false;
+    if (!('bearerToken' in value) || value['bearerToken'] === undefined) return false;
+    if (!('eventTypes' in value) || value['eventTypes'] === undefined) return false;
+    return true;
+}
+
+export function PostCustomWebhookIntegrationFromJSON(json: any): PostCustomWebhookIntegration {
+    return PostCustomWebhookIntegrationFromJSONTyped(json, false);
+}
+
+export function PostCustomWebhookIntegrationFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostCustomWebhookIntegration {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'targetUrl': json['target_url'],
+        'bearerToken': json['bearer_token'],
+        'eventTypes': new Set(json['event_types']),
+        'enabled': json['enabled'] == null ? undefined : json['enabled'],
+    };
+}
+
+export function PostCustomWebhookIntegrationToJSON(json: any): PostCustomWebhookIntegration {
+    return PostCustomWebhookIntegrationToJSONTyped(json, false);
+}
+
+export function PostCustomWebhookIntegrationToJSONTyped(value?: PostCustomWebhookIntegration | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'target_url': value['targetUrl'],
+        'bearer_token': value['bearerToken'],
+        'event_types': Array.from(value['eventTypes'] as Set<any>),
+        'enabled': value['enabled'],
+    };
+}
+