@easyedu/js-lsm-api 1.114.0 → 1.116.0

package/src/models/PostZapierSetupResponse.ts

@@ -0,0 +1,83 @@
+/* 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 { ZapierIntegration } from './ZapierIntegration';
+import {
+    ZapierIntegrationFromJSON,
+    ZapierIntegrationFromJSONTyped,
+    ZapierIntegrationToJSON,
+    ZapierIntegrationToJSONTyped,
+} from './ZapierIntegration';
+
+/**
+ * A newly created Zapier connection. The API key is returned only once.
+ * @export
+ * @interface PostZapierSetupResponse
+ */
+export interface PostZapierSetupResponse {
+    /**
+     * 
+     * @type {ZapierIntegration}
+     * @memberof PostZapierSetupResponse
+     */
+    integration: ZapierIntegration;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostZapierSetupResponse
+     */
+    apiKey: string;
+}
+
+/**
+ * Check if a given object implements the PostZapierSetupResponse interface.
+ */
+export function instanceOfPostZapierSetupResponse(value: object): value is PostZapierSetupResponse {
+    if (!('integration' in value) || value['integration'] === undefined) return false;
+    if (!('apiKey' in value) || value['apiKey'] === undefined) return false;
+    return true;
+}
+
+export function PostZapierSetupResponseFromJSON(json: any): PostZapierSetupResponse {
+    return PostZapierSetupResponseFromJSONTyped(json, false);
+}
+
+export function PostZapierSetupResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostZapierSetupResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'integration': ZapierIntegrationFromJSON(json['integration']),
+        'apiKey': json['api_key'],
+    };
+}
+
+export function PostZapierSetupResponseToJSON(json: any): PostZapierSetupResponse {
+    return PostZapierSetupResponseToJSONTyped(json, false);
+}
+
+export function PostZapierSetupResponseToJSONTyped(value?: PostZapierSetupResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'integration': ZapierIntegrationToJSON(value['integration']),
+        'api_key': value['apiKey'],
+    };
+}
+

package/src/models/PostZapierShopifyCourseMapping.ts

@@ -0,0 +1,92 @@
+/* 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 PostZapierShopifyCourseMapping
+ */
+export interface PostZapierShopifyCourseMapping {
+    /**
+     * Shopify store domain, with or without https://.
+     * @type {string}
+     * @memberof PostZapierShopifyCourseMapping
+     */
+    shopDomain: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostZapierShopifyCourseMapping
+     */
+    variantId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostZapierShopifyCourseMapping
+     */
+    productId?: string | null;
+    /**
+     * Stable external Edaxu course ID.
+     * @type {string}
+     * @memberof PostZapierShopifyCourseMapping
+     */
+    courseId: string;
+}
+
+/**
+ * Check if a given object implements the PostZapierShopifyCourseMapping interface.
+ */
+export function instanceOfPostZapierShopifyCourseMapping(value: object): value is PostZapierShopifyCourseMapping {
+    if (!('shopDomain' in value) || value['shopDomain'] === undefined) return false;
+    if (!('variantId' in value) || value['variantId'] === undefined) return false;
+    if (!('courseId' in value) || value['courseId'] === undefined) return false;
+    return true;
+}
+
+export function PostZapierShopifyCourseMappingFromJSON(json: any): PostZapierShopifyCourseMapping {
+    return PostZapierShopifyCourseMappingFromJSONTyped(json, false);
+}
+
+export function PostZapierShopifyCourseMappingFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostZapierShopifyCourseMapping {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'shopDomain': json['shop_domain'],
+        'variantId': json['variant_id'],
+        'productId': json['product_id'] == null ? undefined : json['product_id'],
+        'courseId': json['course_id'],
+    };
+}
+
+export function PostZapierShopifyCourseMappingToJSON(json: any): PostZapierShopifyCourseMapping {
+    return PostZapierShopifyCourseMappingToJSONTyped(json, false);
+}
+
+export function PostZapierShopifyCourseMappingToJSONTyped(value?: PostZapierShopifyCourseMapping | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'shop_domain': value['shopDomain'],
+        'variant_id': value['variantId'],
+        'product_id': value['productId'],
+        'course_id': value['courseId'],
+    };
+}
+

package/src/models/PostZapierShopifyEnrollment.ts

@@ -0,0 +1,163 @@
+/* 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 PostZapierShopifyEnrollment
+ */
+export interface PostZapierShopifyEnrollment {
+    /**
+     * 
+     * @type {string}
+     * @memberof PostZapierShopifyEnrollment
+     */
+    shopDomain: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostZapierShopifyEnrollment
+     */
+    orderId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostZapierShopifyEnrollment
+     */
+    lineItemId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostZapierShopifyEnrollment
+     */
+    variantId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostZapierShopifyEnrollment
+     */
+    email: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostZapierShopifyEnrollment
+     */
+    firstName: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostZapierShopifyEnrollment
+     */
+    lastName: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof PostZapierShopifyEnrollment
+     */
+    enrollmentDateStart?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof PostZapierShopifyEnrollment
+     */
+    enrollmentDateEnd?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostZapierShopifyEnrollment
+     */
+    notes?: string | null;
+    /**
+     * 
+     * @type {PostZapierShopifyEnrollmentReEnrollmentModeEnum}
+     * @memberof PostZapierShopifyEnrollment
+     */
+    reEnrollmentMode?: PostZapierShopifyEnrollmentReEnrollmentModeEnum;
+}
+
+
+/**
+ * @export
+ */
+export const PostZapierShopifyEnrollmentReEnrollmentModeEnum = {
+    Restart: 'restart',
+    Resume: 'resume'
+} as const;
+export type PostZapierShopifyEnrollmentReEnrollmentModeEnum = typeof PostZapierShopifyEnrollmentReEnrollmentModeEnum[keyof typeof PostZapierShopifyEnrollmentReEnrollmentModeEnum];
+
+
+/**
+ * Check if a given object implements the PostZapierShopifyEnrollment interface.
+ */
+export function instanceOfPostZapierShopifyEnrollment(value: object): value is PostZapierShopifyEnrollment {
+    if (!('shopDomain' in value) || value['shopDomain'] === undefined) return false;
+    if (!('orderId' in value) || value['orderId'] === undefined) return false;
+    if (!('lineItemId' in value) || value['lineItemId'] === undefined) return false;
+    if (!('variantId' in value) || value['variantId'] === 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;
+    return true;
+}
+
+export function PostZapierShopifyEnrollmentFromJSON(json: any): PostZapierShopifyEnrollment {
+    return PostZapierShopifyEnrollmentFromJSONTyped(json, false);
+}
+
+export function PostZapierShopifyEnrollmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostZapierShopifyEnrollment {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'shopDomain': json['shop_domain'],
+        'orderId': json['order_id'],
+        'lineItemId': json['line_item_id'],
+        'variantId': json['variant_id'],
+        'email': json['email'],
+        'firstName': json['first_name'],
+        'lastName': json['last_name'],
+        'enrollmentDateStart': json['enrollment_date_start'] == null ? undefined : json['enrollment_date_start'],
+        'enrollmentDateEnd': json['enrollment_date_end'] == null ? undefined : json['enrollment_date_end'],
+        'notes': json['notes'] == null ? undefined : json['notes'],
+        'reEnrollmentMode': json['re_enrollment_mode'] == null ? undefined : json['re_enrollment_mode'],
+    };
+}
+
+export function PostZapierShopifyEnrollmentToJSON(json: any): PostZapierShopifyEnrollment {
+    return PostZapierShopifyEnrollmentToJSONTyped(json, false);
+}
+
+export function PostZapierShopifyEnrollmentToJSONTyped(value?: PostZapierShopifyEnrollment | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'shop_domain': value['shopDomain'],
+        'order_id': value['orderId'],
+        'line_item_id': value['lineItemId'],
+        'variant_id': value['variantId'],
+        'email': value['email'],
+        'first_name': value['firstName'],
+        'last_name': value['lastName'],
+        'enrollment_date_start': value['enrollmentDateStart'],
+        'enrollment_date_end': value['enrollmentDateEnd'],
+        'notes': value['notes'],
+        're_enrollment_mode': value['reEnrollmentMode'],
+    };
+}
+

package/src/models/PostZapierShopifyEnrollmentResponse.ts

@@ -0,0 +1,106 @@
+/* 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 { ZapierUser } from './ZapierUser';
+import {
+    ZapierUserFromJSON,
+    ZapierUserFromJSONTyped,
+    ZapierUserToJSON,
+    ZapierUserToJSONTyped,
+} from './ZapierUser';
+import type { ZapierShopifyCourseMapping } from './ZapierShopifyCourseMapping';
+import {
+    ZapierShopifyCourseMappingFromJSON,
+    ZapierShopifyCourseMappingFromJSONTyped,
+    ZapierShopifyCourseMappingToJSON,
+    ZapierShopifyCourseMappingToJSONTyped,
+} from './ZapierShopifyCourseMapping';
+import type { ZapierEnrollment } from './ZapierEnrollment';
+import {
+    ZapierEnrollmentFromJSON,
+    ZapierEnrollmentFromJSONTyped,
+    ZapierEnrollmentToJSON,
+    ZapierEnrollmentToJSONTyped,
+} from './ZapierEnrollment';
+
+/**
+ * 
+ * @export
+ * @interface PostZapierShopifyEnrollmentResponse
+ */
+export interface PostZapierShopifyEnrollmentResponse {
+    /**
+     * 
+     * @type {ZapierEnrollment}
+     * @memberof PostZapierShopifyEnrollmentResponse
+     */
+    enrollment: ZapierEnrollment;
+    /**
+     * 
+     * @type {ZapierUser}
+     * @memberof PostZapierShopifyEnrollmentResponse
+     */
+    user: ZapierUser;
+    /**
+     * 
+     * @type {ZapierShopifyCourseMapping}
+     * @memberof PostZapierShopifyEnrollmentResponse
+     */
+    mapping: ZapierShopifyCourseMapping;
+}
+
+/**
+ * Check if a given object implements the PostZapierShopifyEnrollmentResponse interface.
+ */
+export function instanceOfPostZapierShopifyEnrollmentResponse(value: object): value is PostZapierShopifyEnrollmentResponse {
+    if (!('enrollment' in value) || value['enrollment'] === undefined) return false;
+    if (!('user' in value) || value['user'] === undefined) return false;
+    if (!('mapping' in value) || value['mapping'] === undefined) return false;
+    return true;
+}
+
+export function PostZapierShopifyEnrollmentResponseFromJSON(json: any): PostZapierShopifyEnrollmentResponse {
+    return PostZapierShopifyEnrollmentResponseFromJSONTyped(json, false);
+}
+
+export function PostZapierShopifyEnrollmentResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostZapierShopifyEnrollmentResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'enrollment': ZapierEnrollmentFromJSON(json['enrollment']),
+        'user': ZapierUserFromJSON(json['user']),
+        'mapping': ZapierShopifyCourseMappingFromJSON(json['mapping']),
+    };
+}
+
+export function PostZapierShopifyEnrollmentResponseToJSON(json: any): PostZapierShopifyEnrollmentResponse {
+    return PostZapierShopifyEnrollmentResponseToJSONTyped(json, false);
+}
+
+export function PostZapierShopifyEnrollmentResponseToJSONTyped(value?: PostZapierShopifyEnrollmentResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'enrollment': ZapierEnrollmentToJSON(value['enrollment']),
+        'user': ZapierUserToJSON(value['user']),
+        'mapping': ZapierShopifyCourseMappingToJSON(value['mapping']),
+    };
+}
+

package/src/models/PostZapierUser.ts

@@ -0,0 +1,84 @@
+/* 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 PostZapierUser
+ */
+export interface PostZapierUser {
+    /**
+     * 
+     * @type {string}
+     * @memberof PostZapierUser
+     */
+    email: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostZapierUser
+     */
+    firstName: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostZapierUser
+     */
+    lastName: string;
+}
+
+/**
+ * Check if a given object implements the PostZapierUser interface.
+ */
+export function instanceOfPostZapierUser(value: object): value is PostZapierUser {
+    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;
+    return true;
+}
+
+export function PostZapierUserFromJSON(json: any): PostZapierUser {
+    return PostZapierUserFromJSONTyped(json, false);
+}
+
+export function PostZapierUserFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostZapierUser {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'email': json['email'],
+        'firstName': json['first_name'],
+        'lastName': json['last_name'],
+    };
+}
+
+export function PostZapierUserToJSON(json: any): PostZapierUser {
+    return PostZapierUserToJSONTyped(json, false);
+}
+
+export function PostZapierUserToJSONTyped(value?: PostZapierUser | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'email': value['email'],
+        'first_name': value['firstName'],
+        'last_name': value['lastName'],
+    };
+}
+

package/src/models/PutZapierSetup.ts

@@ -0,0 +1,73 @@
+/* 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 PutZapierSetup
+ */
+export interface PutZapierSetup {
+    /**
+     * 
+     * @type {string}
+     * @memberof PutZapierSetup
+     */
+    name?: string;
+    /**
+     * 
+     * @type {Set<string>}
+     * @memberof PutZapierSetup
+     */
+    permissionKeys?: Set<string>;
+}
+
+/**
+ * Check if a given object implements the PutZapierSetup interface.
+ */
+export function instanceOfPutZapierSetup(value: object): value is PutZapierSetup {
+    return true;
+}
+
+export function PutZapierSetupFromJSON(json: any): PutZapierSetup {
+    return PutZapierSetupFromJSONTyped(json, false);
+}
+
+export function PutZapierSetupFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutZapierSetup {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'] == null ? undefined : json['name'],
+        'permissionKeys': json['permission_keys'] == null ? undefined : new Set(json['permission_keys']),
+    };
+}
+
+export function PutZapierSetupToJSON(json: any): PutZapierSetup {
+    return PutZapierSetupToJSONTyped(json, false);
+}
+
+export function PutZapierSetupToJSONTyped(value?: PutZapierSetup | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'permission_keys': value['permissionKeys'] == null ? undefined : Array.from(value['permissionKeys'] as Set<any>),
+    };
+}
+

package/src/models/ZapierCourse.ts

@@ -0,0 +1,93 @@
+/* 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 ZapierCourse
+ */
+export interface ZapierCourse {
+    /**
+     * Stable external course ID.
+     * @type {string}
+     * @memberof ZapierCourse
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ZapierCourse
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ZapierCourse
+     */
+    description: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ZapierCourse
+     */
+    published: boolean;
+}
+
+/**
+ * Check if a given object implements the ZapierCourse interface.
+ */
+export function instanceOfZapierCourse(value: object): value is ZapierCourse {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('description' in value) || value['description'] === undefined) return false;
+    if (!('published' in value) || value['published'] === undefined) return false;
+    return true;
+}
+
+export function ZapierCourseFromJSON(json: any): ZapierCourse {
+    return ZapierCourseFromJSONTyped(json, false);
+}
+
+export function ZapierCourseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ZapierCourse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+        'published': json['published'],
+    };
+}
+
+export function ZapierCourseToJSON(json: any): ZapierCourse {
+    return ZapierCourseToJSONTyped(json, false);
+}
+
+export function ZapierCourseToJSONTyped(value?: ZapierCourse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'description': value['description'],
+        'published': value['published'],
+    };
+}
+