@easyedu/js-lsm-api 1.116.0 → 1.117.0

package/dist/models/PostZapierSubscription.d.ts

@@ -0,0 +1,53 @@
+/**
+ * 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 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 declare const PostZapierSubscriptionEventTypeEnum: {
+    readonly ComEdaxuEnrollmentEnrolledV1: "com.edaxu.enrollment.enrolled.v1";
+    readonly ComEdaxuEnrollmentCompletedV1: "com.edaxu.enrollment.completed.v1";
+    readonly ComEdaxuCertificateIssuedV1: "com.edaxu.certificate.issued.v1";
+};
+export type PostZapierSubscriptionEventTypeEnum = typeof PostZapierSubscriptionEventTypeEnum[keyof typeof PostZapierSubscriptionEventTypeEnum];
+/**
+ * Check if a given object implements the PostZapierSubscription interface.
+ */
+export declare function instanceOfPostZapierSubscription(value: object): value is PostZapierSubscription;
+export declare function PostZapierSubscriptionFromJSON(json: any): PostZapierSubscription;
+export declare function PostZapierSubscriptionFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostZapierSubscription;
+export declare function PostZapierSubscriptionToJSON(json: any): PostZapierSubscription;
+export declare function PostZapierSubscriptionToJSONTyped(value?: PostZapierSubscription | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PostZapierSubscription.js

@@ -0,0 +1,65 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PostZapierSubscriptionEventTypeEnum = void 0;
+exports.instanceOfPostZapierSubscription = instanceOfPostZapierSubscription;
+exports.PostZapierSubscriptionFromJSON = PostZapierSubscriptionFromJSON;
+exports.PostZapierSubscriptionFromJSONTyped = PostZapierSubscriptionFromJSONTyped;
+exports.PostZapierSubscriptionToJSON = PostZapierSubscriptionToJSON;
+exports.PostZapierSubscriptionToJSONTyped = PostZapierSubscriptionToJSONTyped;
+/**
+ * @export
+ */
+exports.PostZapierSubscriptionEventTypeEnum = {
+    ComEdaxuEnrollmentEnrolledV1: 'com.edaxu.enrollment.enrolled.v1',
+    ComEdaxuEnrollmentCompletedV1: 'com.edaxu.enrollment.completed.v1',
+    ComEdaxuCertificateIssuedV1: 'com.edaxu.certificate.issued.v1'
+};
+/**
+ * Check if a given object implements the PostZapierSubscription interface.
+ */
+function instanceOfPostZapierSubscription(value) {
+    if (!('eventType' in value) || value['eventType'] === undefined)
+        return false;
+    if (!('targetUrl' in value) || value['targetUrl'] === undefined)
+        return false;
+    return true;
+}
+function PostZapierSubscriptionFromJSON(json) {
+    return PostZapierSubscriptionFromJSONTyped(json, false);
+}
+function PostZapierSubscriptionFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'eventType': json['event_type'],
+        'targetUrl': json['target_url'],
+        'zapId': json['zap_id'] == null ? undefined : json['zap_id'],
+    };
+}
+function PostZapierSubscriptionToJSON(json) {
+    return PostZapierSubscriptionToJSONTyped(json, false);
+}
+function PostZapierSubscriptionToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'event_type': value['eventType'],
+        'target_url': value['targetUrl'],
+        'zap_id': value['zapId'],
+    };
+}

package/dist/models/PutCustomWebhookIntegration.d.ts

@@ -0,0 +1,65 @@
+/**
+ * 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 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 declare const PutCustomWebhookIntegrationEventTypesEnum: {
+    readonly ComEdaxuEnrollmentEnrolledV1: "com.edaxu.enrollment.enrolled.v1";
+    readonly ComEdaxuEnrollmentCompletedV1: "com.edaxu.enrollment.completed.v1";
+    readonly ComEdaxuCertificateIssuedV1: "com.edaxu.certificate.issued.v1";
+};
+export type PutCustomWebhookIntegrationEventTypesEnum = typeof PutCustomWebhookIntegrationEventTypesEnum[keyof typeof PutCustomWebhookIntegrationEventTypesEnum];
+/**
+ * Check if a given object implements the PutCustomWebhookIntegration interface.
+ */
+export declare function instanceOfPutCustomWebhookIntegration(value: object): value is PutCustomWebhookIntegration;
+export declare function PutCustomWebhookIntegrationFromJSON(json: any): PutCustomWebhookIntegration;
+export declare function PutCustomWebhookIntegrationFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutCustomWebhookIntegration;
+export declare function PutCustomWebhookIntegrationToJSON(json: any): PutCustomWebhookIntegration;
+export declare function PutCustomWebhookIntegrationToJSONTyped(value?: PutCustomWebhookIntegration | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PutCustomWebhookIntegration.js

@@ -0,0 +1,65 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PutCustomWebhookIntegrationEventTypesEnum = void 0;
+exports.instanceOfPutCustomWebhookIntegration = instanceOfPutCustomWebhookIntegration;
+exports.PutCustomWebhookIntegrationFromJSON = PutCustomWebhookIntegrationFromJSON;
+exports.PutCustomWebhookIntegrationFromJSONTyped = PutCustomWebhookIntegrationFromJSONTyped;
+exports.PutCustomWebhookIntegrationToJSON = PutCustomWebhookIntegrationToJSON;
+exports.PutCustomWebhookIntegrationToJSONTyped = PutCustomWebhookIntegrationToJSONTyped;
+/**
+ * @export
+ */
+exports.PutCustomWebhookIntegrationEventTypesEnum = {
+    ComEdaxuEnrollmentEnrolledV1: 'com.edaxu.enrollment.enrolled.v1',
+    ComEdaxuEnrollmentCompletedV1: 'com.edaxu.enrollment.completed.v1',
+    ComEdaxuCertificateIssuedV1: 'com.edaxu.certificate.issued.v1'
+};
+/**
+ * Check if a given object implements the PutCustomWebhookIntegration interface.
+ */
+function instanceOfPutCustomWebhookIntegration(value) {
+    return true;
+}
+function PutCustomWebhookIntegrationFromJSON(json) {
+    return PutCustomWebhookIntegrationFromJSONTyped(json, false);
+}
+function PutCustomWebhookIntegrationFromJSONTyped(json, ignoreDiscriminator) {
+    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'],
+    };
+}
+function PutCustomWebhookIntegrationToJSON(json) {
+    return PutCustomWebhookIntegrationToJSONTyped(json, false);
+}
+function PutCustomWebhookIntegrationToJSONTyped(value, ignoreDiscriminator = false) {
+    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']),
+        'enabled': value['enabled'],
+    };
+}

package/dist/models/ZapierSubscription.d.ts

@@ -0,0 +1,53 @@
+/**
+ * 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 ZapierSubscription
+ */
+export interface ZapierSubscription {
+    /**
+     *
+     * @type {string}
+     * @memberof ZapierSubscription
+     */
+    id: string;
+    /**
+     *
+     * @type {ZapierSubscriptionEventTypeEnum}
+     * @memberof ZapierSubscription
+     */
+    eventType: ZapierSubscriptionEventTypeEnum;
+    /**
+     *
+     * @type {Date}
+     * @memberof ZapierSubscription
+     */
+    createdAt: Date;
+}
+/**
+ * @export
+ */
+export declare const ZapierSubscriptionEventTypeEnum: {
+    readonly ComEdaxuEnrollmentEnrolledV1: "com.edaxu.enrollment.enrolled.v1";
+    readonly ComEdaxuEnrollmentCompletedV1: "com.edaxu.enrollment.completed.v1";
+    readonly ComEdaxuCertificateIssuedV1: "com.edaxu.certificate.issued.v1";
+};
+export type ZapierSubscriptionEventTypeEnum = typeof ZapierSubscriptionEventTypeEnum[keyof typeof ZapierSubscriptionEventTypeEnum];
+/**
+ * Check if a given object implements the ZapierSubscription interface.
+ */
+export declare function instanceOfZapierSubscription(value: object): value is ZapierSubscription;
+export declare function ZapierSubscriptionFromJSON(json: any): ZapierSubscription;
+export declare function ZapierSubscriptionFromJSONTyped(json: any, ignoreDiscriminator: boolean): ZapierSubscription;
+export declare function ZapierSubscriptionToJSON(json: any): ZapierSubscription;
+export declare function ZapierSubscriptionToJSONTyped(value?: ZapierSubscription | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ZapierSubscription.js

@@ -0,0 +1,67 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ZapierSubscriptionEventTypeEnum = void 0;
+exports.instanceOfZapierSubscription = instanceOfZapierSubscription;
+exports.ZapierSubscriptionFromJSON = ZapierSubscriptionFromJSON;
+exports.ZapierSubscriptionFromJSONTyped = ZapierSubscriptionFromJSONTyped;
+exports.ZapierSubscriptionToJSON = ZapierSubscriptionToJSON;
+exports.ZapierSubscriptionToJSONTyped = ZapierSubscriptionToJSONTyped;
+/**
+ * @export
+ */
+exports.ZapierSubscriptionEventTypeEnum = {
+    ComEdaxuEnrollmentEnrolledV1: 'com.edaxu.enrollment.enrolled.v1',
+    ComEdaxuEnrollmentCompletedV1: 'com.edaxu.enrollment.completed.v1',
+    ComEdaxuCertificateIssuedV1: 'com.edaxu.certificate.issued.v1'
+};
+/**
+ * Check if a given object implements the ZapierSubscription interface.
+ */
+function instanceOfZapierSubscription(value) {
+    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;
+}
+function ZapierSubscriptionFromJSON(json) {
+    return ZapierSubscriptionFromJSONTyped(json, false);
+}
+function ZapierSubscriptionFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'eventType': json['event_type'],
+        'createdAt': (new Date(json['created_at'])),
+    };
+}
+function ZapierSubscriptionToJSON(json) {
+    return ZapierSubscriptionToJSONTyped(json, false);
+}
+function ZapierSubscriptionToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'event_type': value['eventType'],
+        'created_at': value['createdAt'].toISOString(),
+    };
+}

package/dist/models/index.d.ts

@@ -40,6 +40,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';
@@ -164,6 +165,13 @@ 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 './IntegrationEventLearner';
+export * from './IntegrationEventPortal';
 export * from './LearnerExperienceVersion';
 export * from './LibraryQuizCriteriaPreviewQuestion';
 export * from './LibraryQuizCriterion';
@@ -215,6 +223,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';
@@ -261,6 +270,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';
@@ -278,6 +288,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';
@@ -324,4 +335,5 @@ export * from './ZapierCourse';
 export * from './ZapierEnrollment';
 export * from './ZapierIntegration';
 export * from './ZapierShopifyCourseMapping';
+export * from './ZapierSubscription';
 export * from './ZapierUser';

package/dist/models/index.js

@@ -58,6 +58,7 @@ __exportStar(require("./CourseCatalog"), exports);
 __exportStar(require("./CourseProgressionMode"), exports);
 __exportStar(require("./CourseShare"), exports);
 __exportStar(require("./CourseShareAcceptError"), exports);
+__exportStar(require("./CustomWebhookIntegration"), exports);
 __exportStar(require("./EffectiveCertificateConfig"), exports);
 __exportStar(require("./EmailTemplateDefinition"), exports);
 __exportStar(require("./EmailTemplateScope"), exports);
@@ -182,6 +183,13 @@ __exportStar(require("./GetZapierMe"), exports);
 __exportStar(require("./GetZapierSetup"), exports);
 __exportStar(require("./GetZapierShopifyCourseMappings"), exports);
 __exportStar(require("./GetZapierUsers"), exports);
+__exportStar(require("./IntegrationEvent"), exports);
+__exportStar(require("./IntegrationEventCertificate"), exports);
+__exportStar(require("./IntegrationEventCourse"), exports);
+__exportStar(require("./IntegrationEventData"), exports);
+__exportStar(require("./IntegrationEventEnrollment"), exports);
+__exportStar(require("./IntegrationEventLearner"), exports);
+__exportStar(require("./IntegrationEventPortal"), exports);
 __exportStar(require("./LearnerExperienceVersion"), exports);
 __exportStar(require("./LibraryQuizCriteriaPreviewQuestion"), exports);
 __exportStar(require("./LibraryQuizCriterion"), exports);
@@ -233,6 +241,7 @@ __exportStar(require("./PostCourseVersionItemSession"), exports);
 __exportStar(require("./PostCourseVersionPublish"), exports);
 __exportStar(require("./PostCourseVersionSection"), exports);
 __exportStar(require("./PostCourseVersionSectionDuplicate"), exports);
+__exportStar(require("./PostCustomWebhookIntegration"), exports);
 __exportStar(require("./PostDuplicate"), exports);
 __exportStar(require("./PostEmailAssetComplete"), exports);
 __exportStar(require("./PostEmailAssetUpload"), exports);
@@ -279,6 +288,7 @@ __exportStar(require("./PostZapierSetupResponse"), exports);
 __exportStar(require("./PostZapierShopifyCourseMapping"), exports);
 __exportStar(require("./PostZapierShopifyEnrollment"), exports);
 __exportStar(require("./PostZapierShopifyEnrollmentResponse"), exports);
+__exportStar(require("./PostZapierSubscription"), exports);
 __exportStar(require("./PostZapierUser"), exports);
 __exportStar(require("./ProgressionGateError"), exports);
 __exportStar(require("./ProgressionLockReason"), exports);
@@ -296,6 +306,7 @@ __exportStar(require("./PutCourseVersionDraft"), exports);
 __exportStar(require("./PutCourseVersionItem"), exports);
 __exportStar(require("./PutCourseVersionOutlineEntryMove"), exports);
 __exportStar(require("./PutCourseVersionSection"), exports);
+__exportStar(require("./PutCustomWebhookIntegration"), exports);
 __exportStar(require("./PutEmailTemplateDraft"), exports);
 __exportStar(require("./PutLearnerExperienceDraft"), exports);
 __exportStar(require("./PutLibraryQuiz"), exports);
@@ -342,4 +353,5 @@ __exportStar(require("./ZapierCourse"), exports);
 __exportStar(require("./ZapierEnrollment"), exports);
 __exportStar(require("./ZapierIntegration"), exports);
 __exportStar(require("./ZapierShopifyCourseMapping"), exports);
+__exportStar(require("./ZapierSubscription"), exports);
 __exportStar(require("./ZapierUser"), exports);

package/docs/CustomWebhookIntegration.md

@@ -0,0 +1,48 @@
+
+# CustomWebhookIntegration
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`targetUrl` | string
+`eventTypes` | Set<string>
+`enabled` | boolean
+`tokenConfigured` | boolean
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { CustomWebhookIntegration } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "targetUrl": null,
+  "eventTypes": null,
+  "enabled": null,
+  "tokenConfigured": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies CustomWebhookIntegration
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CustomWebhookIntegration
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+