@easyedu/js-lsm-api 1.114.0 → 1.116.0

package/src/models/ZapierEnrollment.ts

@@ -0,0 +1,128 @@
+/* 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 ZapierEnrollment
+ */
+export interface ZapierEnrollment {
+    /**
+     * 
+     * @type {string}
+     * @memberof ZapierEnrollment
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ZapierEnrollment
+     */
+    courseId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ZapierEnrollment
+     */
+    userId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ZapierEnrollment
+     */
+    status: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof ZapierEnrollment
+     */
+    enrollmentDateStart: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ZapierEnrollment
+     */
+    enrollmentDateEnd?: number | null;
+    /**
+     * True when this request created or resumed an enrollment.
+     * @type {boolean}
+     * @memberof ZapierEnrollment
+     */
+    created: boolean;
+    /**
+     * True when a previous result was returned for a retried source event.
+     * @type {boolean}
+     * @memberof ZapierEnrollment
+     */
+    idempotentReplay: boolean;
+}
+
+/**
+ * Check if a given object implements the ZapierEnrollment interface.
+ */
+export function instanceOfZapierEnrollment(value: object): value is ZapierEnrollment {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('courseId' in value) || value['courseId'] === undefined) return false;
+    if (!('userId' in value) || value['userId'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('enrollmentDateStart' in value) || value['enrollmentDateStart'] === undefined) return false;
+    if (!('created' in value) || value['created'] === undefined) return false;
+    if (!('idempotentReplay' in value) || value['idempotentReplay'] === undefined) return false;
+    return true;
+}
+
+export function ZapierEnrollmentFromJSON(json: any): ZapierEnrollment {
+    return ZapierEnrollmentFromJSONTyped(json, false);
+}
+
+export function ZapierEnrollmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): ZapierEnrollment {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'courseId': json['course_id'],
+        'userId': json['user_id'],
+        'status': json['status'],
+        'enrollmentDateStart': json['enrollment_date_start'],
+        'enrollmentDateEnd': json['enrollment_date_end'] == null ? undefined : json['enrollment_date_end'],
+        'created': json['created'],
+        'idempotentReplay': json['idempotent_replay'],
+    };
+}
+
+export function ZapierEnrollmentToJSON(json: any): ZapierEnrollment {
+    return ZapierEnrollmentToJSONTyped(json, false);
+}
+
+export function ZapierEnrollmentToJSONTyped(value?: ZapierEnrollment | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'course_id': value['courseId'],
+        'user_id': value['userId'],
+        'status': value['status'],
+        'enrollment_date_start': value['enrollmentDateStart'],
+        'enrollment_date_end': value['enrollmentDateEnd'],
+        'created': value['created'],
+        'idempotent_replay': value['idempotentReplay'],
+    };
+}
+

package/src/models/ZapierIntegration.ts

@@ -0,0 +1,154 @@
+/* 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';
+/**
+ * A portal-scoped Zapier connection. The API key secret is never included here.
+ * @export
+ * @interface ZapierIntegration
+ */
+export interface ZapierIntegration {
+    /**
+     * 
+     * @type {string}
+     * @memberof ZapierIntegration
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ZapierIntegration
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ZapierIntegration
+     */
+    portalId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ZapierIntegration
+     */
+    portalName: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ZapierIntegration
+     */
+    portalSubdomain: string;
+    /**
+     * Non-secret prefix used to identify the key.
+     * @type {string}
+     * @memberof ZapierIntegration
+     */
+    keyPrefix: string;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof ZapierIntegration
+     */
+    permissionKeys: Array<string>;
+    /**
+     * Unix epoch timestamp
+     * @type {number}
+     * @memberof ZapierIntegration
+     */
+    createdAt: number;
+    /**
+     * Unix epoch timestamp
+     * @type {number}
+     * @memberof ZapierIntegration
+     */
+    updatedAt: number;
+    /**
+     * Unix epoch timestamp
+     * @type {number}
+     * @memberof ZapierIntegration
+     */
+    lastUsedAt?: number | null;
+    /**
+     * Unix epoch timestamp
+     * @type {number}
+     * @memberof ZapierIntegration
+     */
+    revokedAt?: number | null;
+}
+
+/**
+ * Check if a given object implements the ZapierIntegration interface.
+ */
+export function instanceOfZapierIntegration(value: object): value is ZapierIntegration {
+    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;
+}
+
+export function ZapierIntegrationFromJSON(json: any): ZapierIntegration {
+    return ZapierIntegrationFromJSONTyped(json, false);
+}
+
+export function ZapierIntegrationFromJSONTyped(json: any, ignoreDiscriminator: boolean): ZapierIntegration {
+    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'],
+    };
+}
+
+export function ZapierIntegrationToJSON(json: any): ZapierIntegration {
+    return ZapierIntegrationToJSONTyped(json, false);
+}
+
+export function ZapierIntegrationToJSONTyped(value?: ZapierIntegration | null, ignoreDiscriminator: boolean = false): any {
+    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/src/models/ZapierShopifyCourseMapping.ts

@@ -0,0 +1,127 @@
+/* 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 { ZapierCourse } from './ZapierCourse';
+import {
+    ZapierCourseFromJSON,
+    ZapierCourseFromJSONTyped,
+    ZapierCourseToJSON,
+    ZapierCourseToJSONTyped,
+} 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 function instanceOfZapierShopifyCourseMapping(value: object): value is ZapierShopifyCourseMapping {
+    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;
+}
+
+export function ZapierShopifyCourseMappingFromJSON(json: any): ZapierShopifyCourseMapping {
+    return ZapierShopifyCourseMappingFromJSONTyped(json, false);
+}
+
+export function ZapierShopifyCourseMappingFromJSONTyped(json: any, ignoreDiscriminator: boolean): ZapierShopifyCourseMapping {
+    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': ZapierCourseFromJSON(json['course']),
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+    };
+}
+
+export function ZapierShopifyCourseMappingToJSON(json: any): ZapierShopifyCourseMapping {
+    return ZapierShopifyCourseMappingToJSONTyped(json, false);
+}
+
+export function ZapierShopifyCourseMappingToJSONTyped(value?: ZapierShopifyCourseMapping | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'shop_domain': value['shopDomain'],
+        'variant_id': value['variantId'],
+        'product_id': value['productId'],
+        'course': ZapierCourseToJSON(value['course']),
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+    };
+}
+

package/src/models/ZapierUser.ts

@@ -0,0 +1,102 @@
+/* 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 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 function instanceOfZapierUser(value: object): value is ZapierUser {
+    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;
+}
+
+export function ZapierUserFromJSON(json: any): ZapierUser {
+    return ZapierUserFromJSONTyped(json, false);
+}
+
+export function ZapierUserFromJSONTyped(json: any, ignoreDiscriminator: boolean): ZapierUser {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'email': json['email'],
+        'firstName': json['first_name'],
+        'lastName': json['last_name'],
+        'created': json['created'],
+    };
+}
+
+export function ZapierUserToJSON(json: any): ZapierUser {
+    return ZapierUserToJSONTyped(json, false);
+}
+
+export function ZapierUserToJSONTyped(value?: ZapierUser | 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'],
+        'created': value['created'],
+    };
+}
+

package/src/models/index.ts

@@ -161,6 +161,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';
@@ -252,6 +257,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';
@@ -289,6 +301,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';
@@ -309,3 +322,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';