@easyedu/js-lsm-api 1.114.0 → 1.116.0

package/dist/models/ZapierIntegration.js

@@ -0,0 +1,86 @@
+"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.instanceOfZapierIntegration = instanceOfZapierIntegration;
+exports.ZapierIntegrationFromJSON = ZapierIntegrationFromJSON;
+exports.ZapierIntegrationFromJSONTyped = ZapierIntegrationFromJSONTyped;
+exports.ZapierIntegrationToJSON = ZapierIntegrationToJSON;
+exports.ZapierIntegrationToJSONTyped = ZapierIntegrationToJSONTyped;
+/**
+ * Check if a given object implements the ZapierIntegration interface.
+ */
+function instanceOfZapierIntegration(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('portalId' in value) || value['portalId'] === undefined)
+        return false;
+    if (!('portalName' in value) || value['portalName'] === undefined)
+        return false;
+    if (!('portalSubdomain' in value) || value['portalSubdomain'] === undefined)
+        return false;
+    if (!('keyPrefix' in value) || value['keyPrefix'] === undefined)
+        return false;
+    if (!('permissionKeys' in value) || value['permissionKeys'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined)
+        return false;
+    return true;
+}
+function ZapierIntegrationFromJSON(json) {
+    return ZapierIntegrationFromJSONTyped(json, false);
+}
+function ZapierIntegrationFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'portalId': json['portal_id'],
+        'portalName': json['portal_name'],
+        'portalSubdomain': json['portal_subdomain'],
+        'keyPrefix': json['key_prefix'],
+        'permissionKeys': json['permission_keys'],
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+        'lastUsedAt': json['last_used_at'] == null ? undefined : json['last_used_at'],
+        'revokedAt': json['revoked_at'] == null ? undefined : json['revoked_at'],
+    };
+}
+function ZapierIntegrationToJSON(json) {
+    return ZapierIntegrationToJSONTyped(json, false);
+}
+function ZapierIntegrationToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'portal_id': value['portalId'],
+        'portal_name': value['portalName'],
+        'portal_subdomain': value['portalSubdomain'],
+        'key_prefix': value['keyPrefix'],
+        'permission_keys': value['permissionKeys'],
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+        'last_used_at': value['lastUsedAt'],
+        'revoked_at': value['revokedAt'],
+    };
+}

package/dist/models/ZapierShopifyCourseMapping.d.ts

@@ -0,0 +1,69 @@
+/**
+ * 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 type { ZapierCourse } from './ZapierCourse';
+/**
+ *
+ * @export
+ * @interface ZapierShopifyCourseMapping
+ */
+export interface ZapierShopifyCourseMapping {
+    /**
+     *
+     * @type {string}
+     * @memberof ZapierShopifyCourseMapping
+     */
+    id: string;
+    /**
+     * Normalized Shopify store domain, such as example.myshopify.com.
+     * @type {string}
+     * @memberof ZapierShopifyCourseMapping
+     */
+    shopDomain: string;
+    /**
+     * Shopify product variant ID.
+     * @type {string}
+     * @memberof ZapierShopifyCourseMapping
+     */
+    variantId: string;
+    /**
+     * Optional Shopify product ID for display and troubleshooting.
+     * @type {string}
+     * @memberof ZapierShopifyCourseMapping
+     */
+    productId?: string | null;
+    /**
+     *
+     * @type {ZapierCourse}
+     * @memberof ZapierShopifyCourseMapping
+     */
+    course: ZapierCourse;
+    /**
+     *
+     * @type {number}
+     * @memberof ZapierShopifyCourseMapping
+     */
+    createdAt: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ZapierShopifyCourseMapping
+     */
+    updatedAt: number;
+}
+/**
+ * Check if a given object implements the ZapierShopifyCourseMapping interface.
+ */
+export declare function instanceOfZapierShopifyCourseMapping(value: object): value is ZapierShopifyCourseMapping;
+export declare function ZapierShopifyCourseMappingFromJSON(json: any): ZapierShopifyCourseMapping;
+export declare function ZapierShopifyCourseMappingFromJSONTyped(json: any, ignoreDiscriminator: boolean): ZapierShopifyCourseMapping;
+export declare function ZapierShopifyCourseMappingToJSON(json: any): ZapierShopifyCourseMapping;
+export declare function ZapierShopifyCourseMappingToJSONTyped(value?: ZapierShopifyCourseMapping | null, ignoreDiscriminator?: boolean): any;

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/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

@@ -159,6 +159,11 @@ 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 './LearnerExperienceVersion';
 export * from './LibraryQuizCriteriaPreviewQuestion';
 export * from './LibraryQuizCriterion';
@@ -250,6 +255,13 @@ 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 './PostZapierUser';
 export * from './ProgressionGateError';
 export * from './ProgressionLockReason';
 export * from './PutAttemptAllowance';
@@ -287,6 +299,7 @@ export * from './PutRole';
 export * from './PutRolePermissions';
 export * from './PutSupportTicket';
 export * from './PutUser';
+export * from './PutZapierSetup';
 export * from './QuestionImportCommitResult';
 export * from './QuestionImportDraft';
 export * from './QuestionImportDuplicate';
@@ -307,3 +320,8 @@ 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 './ZapierUser';

package/dist/models/index.js

@@ -177,6 +177,11 @@ __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("./LearnerExperienceVersion"), exports);
 __exportStar(require("./LibraryQuizCriteriaPreviewQuestion"), exports);
 __exportStar(require("./LibraryQuizCriterion"), exports);
@@ -268,6 +273,13 @@ __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("./PostZapierUser"), exports);
 __exportStar(require("./ProgressionGateError"), exports);
 __exportStar(require("./ProgressionLockReason"), exports);
 __exportStar(require("./PutAttemptAllowance"), exports);
@@ -305,6 +317,7 @@ __exportStar(require("./PutRole"), exports);
 __exportStar(require("./PutRolePermissions"), exports);
 __exportStar(require("./PutSupportTicket"), exports);
 __exportStar(require("./PutUser"), exports);
+__exportStar(require("./PutZapierSetup"), exports);
 __exportStar(require("./QuestionImportCommitResult"), exports);
 __exportStar(require("./QuestionImportDraft"), exports);
 __exportStar(require("./QuestionImportDuplicate"), exports);
@@ -325,3 +338,8 @@ __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("./ZapierUser"), exports);

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/GetZapierMe.md

@@ -0,0 +1,44 @@
+
+# GetZapierMe
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`integrationId` | string
+`integrationName` | string
+`portalId` | string
+`portalName` | string
+`portalSubdomain` | string
+`permissionKeys` | Array<string>
+
+## Example
+
+```typescript
+import type { GetZapierMe } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "integrationId": null,
+  "integrationName": null,
+  "portalId": null,
+  "portalName": null,
+  "portalSubdomain": null,
+  "permissionKeys": null,
+} satisfies GetZapierMe
+
+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 GetZapierMe
+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/GetZapierSetup.md

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