@easyedu/js-lsm-api 1.116.0 → 1.118.0

package/src/models/PostZapierSubscription.ts

@@ -0,0 +1,97 @@
+/* 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 PostZapierSubscription
+ */
+export interface PostZapierSubscription {
+    /**
+     * 
+     * @type {PostZapierSubscriptionEventTypeEnum}
+     * @memberof PostZapierSubscription
+     */
+    eventType: PostZapierSubscriptionEventTypeEnum;
+    /**
+     * Zapier REST Hook URL supplied as bundle.targetUrl.
+     * @type {string}
+     * @memberof PostZapierSubscription
+     */
+    targetUrl: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostZapierSubscription
+     */
+    zapId?: string | null;
+}
+
+
+/**
+ * @export
+ */
+export const PostZapierSubscriptionEventTypeEnum = {
+    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 PostZapierSubscriptionEventTypeEnum = typeof PostZapierSubscriptionEventTypeEnum[keyof typeof PostZapierSubscriptionEventTypeEnum];
+
+
+/**
+ * Check if a given object implements the PostZapierSubscription interface.
+ */
+export function instanceOfPostZapierSubscription(value: object): value is PostZapierSubscription {
+    if (!('eventType' in value) || value['eventType'] === undefined) return false;
+    if (!('targetUrl' in value) || value['targetUrl'] === undefined) return false;
+    return true;
+}
+
+export function PostZapierSubscriptionFromJSON(json: any): PostZapierSubscription {
+    return PostZapierSubscriptionFromJSONTyped(json, false);
+}
+
+export function PostZapierSubscriptionFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostZapierSubscription {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'eventType': json['event_type'],
+        'targetUrl': json['target_url'],
+        'zapId': json['zap_id'] == null ? undefined : json['zap_id'],
+    };
+}
+
+export function PostZapierSubscriptionToJSON(json: any): PostZapierSubscription {
+    return PostZapierSubscriptionToJSONTyped(json, false);
+}
+
+export function PostZapierSubscriptionToJSONTyped(value?: PostZapierSubscription | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'event_type': value['eventType'],
+        'target_url': value['targetUrl'],
+        'zap_id': value['zapId'],
+    };
+}
+

package/src/models/PutCustomWebhookIntegration.ts

@@ -0,0 +1,111 @@
+/* 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 PutCustomWebhookIntegration
+ */
+export interface PutCustomWebhookIntegration {
+    /**
+     * 
+     * @type {string}
+     * @memberof PutCustomWebhookIntegration
+     */
+    name?: string;
+    /**
+     * Public HTTPS endpoint that receives CloudEvents JSON payloads.
+     * @type {string}
+     * @memberof PutCustomWebhookIntegration
+     */
+    targetUrl?: string;
+    /**
+     * Replacement secret sent in the Authorization header as a Bearer token. Omit to keep the current token.
+     * @type {string}
+     * @memberof PutCustomWebhookIntegration
+     */
+    bearerToken?: string;
+    /**
+     * 
+     * @type {Set<PutCustomWebhookIntegrationEventTypesEnum>}
+     * @memberof PutCustomWebhookIntegration
+     */
+    eventTypes?: Set<PutCustomWebhookIntegrationEventTypesEnum>;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PutCustomWebhookIntegration
+     */
+    enabled?: boolean;
+}
+
+
+/**
+ * @export
+ */
+export const PutCustomWebhookIntegrationEventTypesEnum = {
+    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 PutCustomWebhookIntegrationEventTypesEnum = typeof PutCustomWebhookIntegrationEventTypesEnum[keyof typeof PutCustomWebhookIntegrationEventTypesEnum];
+
+
+/**
+ * Check if a given object implements the PutCustomWebhookIntegration interface.
+ */
+export function instanceOfPutCustomWebhookIntegration(value: object): value is PutCustomWebhookIntegration {
+    return true;
+}
+
+export function PutCustomWebhookIntegrationFromJSON(json: any): PutCustomWebhookIntegration {
+    return PutCustomWebhookIntegrationFromJSONTyped(json, false);
+}
+
+export function PutCustomWebhookIntegrationFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutCustomWebhookIntegration {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'] == null ? undefined : json['name'],
+        'targetUrl': json['target_url'] == null ? undefined : json['target_url'],
+        'bearerToken': json['bearer_token'] == null ? undefined : json['bearer_token'],
+        'eventTypes': json['event_types'] == null ? undefined : new Set(json['event_types']),
+        'enabled': json['enabled'] == null ? undefined : json['enabled'],
+    };
+}
+
+export function PutCustomWebhookIntegrationToJSON(json: any): PutCustomWebhookIntegration {
+    return PutCustomWebhookIntegrationToJSONTyped(json, false);
+}
+
+export function PutCustomWebhookIntegrationToJSONTyped(value?: PutCustomWebhookIntegration | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'target_url': value['targetUrl'],
+        'bearer_token': value['bearerToken'],
+        'event_types': value['eventTypes'] == null ? undefined : Array.from(value['eventTypes'] as Set<any>),
+        'enabled': value['enabled'],
+    };
+}
+

package/src/models/ZapierSubscription.ts

@@ -0,0 +1,98 @@
+/* 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 ZapierSubscription
+ */
+export interface ZapierSubscription {
+    /**
+     * 
+     * @type {string}
+     * @memberof ZapierSubscription
+     */
+    id: string;
+    /**
+     * 
+     * @type {ZapierSubscriptionEventTypeEnum}
+     * @memberof ZapierSubscription
+     */
+    eventType: ZapierSubscriptionEventTypeEnum;
+    /**
+     * 
+     * @type {Date}
+     * @memberof ZapierSubscription
+     */
+    createdAt: Date;
+}
+
+
+/**
+ * @export
+ */
+export const ZapierSubscriptionEventTypeEnum = {
+    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 ZapierSubscriptionEventTypeEnum = typeof ZapierSubscriptionEventTypeEnum[keyof typeof ZapierSubscriptionEventTypeEnum];
+
+
+/**
+ * Check if a given object implements the ZapierSubscription interface.
+ */
+export function instanceOfZapierSubscription(value: object): value is ZapierSubscription {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('eventType' in value) || value['eventType'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    return true;
+}
+
+export function ZapierSubscriptionFromJSON(json: any): ZapierSubscription {
+    return ZapierSubscriptionFromJSONTyped(json, false);
+}
+
+export function ZapierSubscriptionFromJSONTyped(json: any, ignoreDiscriminator: boolean): ZapierSubscription {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'eventType': json['event_type'],
+        'createdAt': (new Date(json['created_at'])),
+    };
+}
+
+export function ZapierSubscriptionToJSON(json: any): ZapierSubscription {
+    return ZapierSubscriptionToJSONTyped(json, false);
+}
+
+export function ZapierSubscriptionToJSONTyped(value?: ZapierSubscription | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'event_type': value['eventType'],
+        'created_at': value['createdAt'].toISOString(),
+    };
+}
+

package/src/models/index.ts

@@ -42,6 +42,7 @@ export * from './CourseCatalog';
 export * from './CourseProgressionMode';
 export * from './CourseShare';
 export * from './CourseShareAcceptError';
+export * from './CustomWebhookIntegration';
 export * from './EffectiveCertificateConfig';
 export * from './EmailTemplateDefinition';
 export * from './EmailTemplateScope';
@@ -166,6 +167,15 @@ export * from './GetZapierMe';
 export * from './GetZapierSetup';
 export * from './GetZapierShopifyCourseMappings';
 export * from './GetZapierUsers';
+export * from './IntegrationEvent';
+export * from './IntegrationEventCertificate';
+export * from './IntegrationEventCourse';
+export * from './IntegrationEventData';
+export * from './IntegrationEventEnrollment';
+export * from './IntegrationEventInvitation';
+export * from './IntegrationEventLearner';
+export * from './IntegrationEventPortal';
+export * from './IntegrationEventUser';
 export * from './LearnerExperienceVersion';
 export * from './LibraryQuizCriteriaPreviewQuestion';
 export * from './LibraryQuizCriterion';
@@ -217,6 +227,7 @@ export * from './PostCourseVersionItemSession';
 export * from './PostCourseVersionPublish';
 export * from './PostCourseVersionSection';
 export * from './PostCourseVersionSectionDuplicate';
+export * from './PostCustomWebhookIntegration';
 export * from './PostDuplicate';
 export * from './PostEmailAssetComplete';
 export * from './PostEmailAssetUpload';
@@ -263,6 +274,7 @@ export * from './PostZapierSetupResponse';
 export * from './PostZapierShopifyCourseMapping';
 export * from './PostZapierShopifyEnrollment';
 export * from './PostZapierShopifyEnrollmentResponse';
+export * from './PostZapierSubscription';
 export * from './PostZapierUser';
 export * from './ProgressionGateError';
 export * from './ProgressionLockReason';
@@ -280,6 +292,7 @@ export * from './PutCourseVersionDraft';
 export * from './PutCourseVersionItem';
 export * from './PutCourseVersionOutlineEntryMove';
 export * from './PutCourseVersionSection';
+export * from './PutCustomWebhookIntegration';
 export * from './PutEmailTemplateDraft';
 export * from './PutLearnerExperienceDraft';
 export * from './PutLibraryQuiz';
@@ -326,4 +339,5 @@ export * from './ZapierCourse';
 export * from './ZapierEnrollment';
 export * from './ZapierIntegration';
 export * from './ZapierShopifyCourseMapping';
+export * from './ZapierSubscription';
 export * from './ZapierUser';