@easyedu/js-lsm-api 1.115.0 → 1.117.0

package/dist/models/ZapierShopifyCourseMapping.js

@@ -0,0 +1,73 @@
+"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.instanceOfZapierShopifyCourseMapping = instanceOfZapierShopifyCourseMapping;
+exports.ZapierShopifyCourseMappingFromJSON = ZapierShopifyCourseMappingFromJSON;
+exports.ZapierShopifyCourseMappingFromJSONTyped = ZapierShopifyCourseMappingFromJSONTyped;
+exports.ZapierShopifyCourseMappingToJSON = ZapierShopifyCourseMappingToJSON;
+exports.ZapierShopifyCourseMappingToJSONTyped = ZapierShopifyCourseMappingToJSONTyped;
+const ZapierCourse_1 = require("./ZapierCourse");
+/**
+ * Check if a given object implements the ZapierShopifyCourseMapping interface.
+ */
+function instanceOfZapierShopifyCourseMapping(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('shopDomain' in value) || value['shopDomain'] === undefined)
+        return false;
+    if (!('variantId' in value) || value['variantId'] === undefined)
+        return false;
+    if (!('course' in value) || value['course'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined)
+        return false;
+    return true;
+}
+function ZapierShopifyCourseMappingFromJSON(json) {
+    return ZapierShopifyCourseMappingFromJSONTyped(json, false);
+}
+function ZapierShopifyCourseMappingFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'shopDomain': json['shop_domain'],
+        'variantId': json['variant_id'],
+        'productId': json['product_id'] == null ? undefined : json['product_id'],
+        'course': (0, ZapierCourse_1.ZapierCourseFromJSON)(json['course']),
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+    };
+}
+function ZapierShopifyCourseMappingToJSON(json) {
+    return ZapierShopifyCourseMappingToJSONTyped(json, false);
+}
+function ZapierShopifyCourseMappingToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'shop_domain': value['shopDomain'],
+        'variant_id': value['variantId'],
+        'product_id': value['productId'],
+        'course': (0, ZapierCourse_1.ZapierCourseToJSON)(value['course']),
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+    };
+}

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/ZapierUser.d.ts

@@ -0,0 +1,56 @@
+/**
+ * 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 ZapierUser
+ */
+export interface ZapierUser {
+    /**
+     * Stable external user ID.
+     * @type {string}
+     * @memberof ZapierUser
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ZapierUser
+     */
+    email: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ZapierUser
+     */
+    firstName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ZapierUser
+     */
+    lastName: string;
+    /**
+     * True when this request created and invited the learner.
+     * @type {boolean}
+     * @memberof ZapierUser
+     */
+    created: boolean;
+}
+/**
+ * Check if a given object implements the ZapierUser interface.
+ */
+export declare function instanceOfZapierUser(value: object): value is ZapierUser;
+export declare function ZapierUserFromJSON(json: any): ZapierUser;
+export declare function ZapierUserFromJSONTyped(json: any, ignoreDiscriminator: boolean): ZapierUser;
+export declare function ZapierUserToJSON(json: any): ZapierUser;
+export declare function ZapierUserToJSONTyped(value?: ZapierUser | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ZapierUser.js

@@ -0,0 +1,66 @@
+"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.instanceOfZapierUser = instanceOfZapierUser;
+exports.ZapierUserFromJSON = ZapierUserFromJSON;
+exports.ZapierUserFromJSONTyped = ZapierUserFromJSONTyped;
+exports.ZapierUserToJSON = ZapierUserToJSON;
+exports.ZapierUserToJSONTyped = ZapierUserToJSONTyped;
+/**
+ * Check if a given object implements the ZapierUser interface.
+ */
+function instanceOfZapierUser(value) {
+    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;
+    if (!('created' in value) || value['created'] === undefined)
+        return false;
+    return true;
+}
+function ZapierUserFromJSON(json) {
+    return ZapierUserFromJSONTyped(json, false);
+}
+function ZapierUserFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'email': json['email'],
+        'firstName': json['first_name'],
+        'lastName': json['last_name'],
+        'created': json['created'],
+    };
+}
+function ZapierUserToJSON(json) {
+    return ZapierUserToJSONTyped(json, false);
+}
+function ZapierUserToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'email': value['email'],
+        'first_name': value['firstName'],
+        'last_name': value['lastName'],
+        'created': value['created'],
+    };
+}

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';
@@ -159,8 +160,18 @@ export * from './GetUserCourseListItemCourse';
 export * from './GetUserCourseListItemEnrollment';
 export * from './GetUserCourseListItemProgress';
 export * from './GetUserRole';
+export * from './GetZapierCourses';
 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';
@@ -212,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';
@@ -252,8 +264,14 @@ export * from './PostSignupRequest';
 export * from './PostSignupRequestResponse';
 export * from './PostSupportTicket';
 export * from './PostSupportTicketComment';
+export * from './PostZapierEnrollment';
 export * from './PostZapierSetup';
 export * from './PostZapierSetupResponse';
+export * from './PostZapierShopifyCourseMapping';
+export * from './PostZapierShopifyEnrollment';
+export * from './PostZapierShopifyEnrollmentResponse';
+export * from './PostZapierSubscription';
+export * from './PostZapierUser';
 export * from './ProgressionGateError';
 export * from './ProgressionLockReason';
 export * from './PutAttemptAllowance';
@@ -270,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';
@@ -312,4 +331,9 @@ export * from './SupportTicketUser';
 export * from './UpdateSelectedPortalResponse';
 export * from './UpdateSelectedPortalResponseHostPortal';
 export * from './UpdateSelectedPortalResponseSelectedPortal';
+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);
@@ -177,8 +178,18 @@ __exportStar(require("./GetUserCourseListItemCourse"), exports);
 __exportStar(require("./GetUserCourseListItemEnrollment"), exports);
 __exportStar(require("./GetUserCourseListItemProgress"), exports);
 __exportStar(require("./GetUserRole"), exports);
+__exportStar(require("./GetZapierCourses"), exports);
 __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);
@@ -230,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);
@@ -270,8 +282,14 @@ __exportStar(require("./PostSignupRequest"), exports);
 __exportStar(require("./PostSignupRequestResponse"), exports);
 __exportStar(require("./PostSupportTicket"), exports);
 __exportStar(require("./PostSupportTicketComment"), exports);
+__exportStar(require("./PostZapierEnrollment"), exports);
 __exportStar(require("./PostZapierSetup"), exports);
 __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);
 __exportStar(require("./PutAttemptAllowance"), exports);
@@ -288,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);
@@ -330,4 +349,9 @@ __exportStar(require("./SupportTicketUser"), exports);
 __exportStar(require("./UpdateSelectedPortalResponse"), exports);
 __exportStar(require("./UpdateSelectedPortalResponseHostPortal"), exports);
 __exportStar(require("./UpdateSelectedPortalResponseSelectedPortal"), exports);
+__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)
+
+

package/docs/GetZapierCourses.md

@@ -0,0 +1,40 @@
+
+# GetZapierCourses
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`page` | number
+`pageSize` | number
+`totalItems` | number
+`items` | [Array<ZapierCourse>](ZapierCourse.md)
+
+## Example
+
+```typescript
+import type { GetZapierCourses } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "page": null,
+  "pageSize": null,
+  "totalItems": null,
+  "items": null,
+} satisfies GetZapierCourses
+
+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 GetZapierCourses
+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)
+
+

package/docs/GetZapierShopifyCourseMappings.md

@@ -0,0 +1,34 @@
+
+# GetZapierShopifyCourseMappings
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`items` | [Array<ZapierShopifyCourseMapping>](ZapierShopifyCourseMapping.md)
+
+## Example
+
+```typescript
+import type { GetZapierShopifyCourseMappings } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "items": null,
+} satisfies GetZapierShopifyCourseMappings
+
+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 GetZapierShopifyCourseMappings
+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)
+
+

package/docs/GetZapierUsers.md

@@ -0,0 +1,34 @@
+
+# GetZapierUsers
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`items` | [Array<ZapierUser>](ZapierUser.md)
+
+## Example
+
+```typescript
+import type { GetZapierUsers } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "items": null,
+} satisfies GetZapierUsers
+
+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 GetZapierUsers
+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)
+
+