@easyedu/js-lsm-api 1.115.0 → 1.116.0

package/src/models/GetZapierCourses.ts

@@ -0,0 +1,101 @@
+/* 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 GetZapierCourses
+ */
+export interface GetZapierCourses {
+    /**
+     * 
+     * @type {number}
+     * @memberof GetZapierCourses
+     */
+    page: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetZapierCourses
+     */
+    pageSize: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetZapierCourses
+     */
+    totalItems: number;
+    /**
+     * 
+     * @type {Array<ZapierCourse>}
+     * @memberof GetZapierCourses
+     */
+    items: Array<ZapierCourse>;
+}
+
+/**
+ * Check if a given object implements the GetZapierCourses interface.
+ */
+export function instanceOfGetZapierCourses(value: object): value is GetZapierCourses {
+    if (!('page' in value) || value['page'] === undefined) return false;
+    if (!('pageSize' in value) || value['pageSize'] === undefined) return false;
+    if (!('totalItems' in value) || value['totalItems'] === undefined) return false;
+    if (!('items' in value) || value['items'] === undefined) return false;
+    return true;
+}
+
+export function GetZapierCoursesFromJSON(json: any): GetZapierCourses {
+    return GetZapierCoursesFromJSONTyped(json, false);
+}
+
+export function GetZapierCoursesFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetZapierCourses {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'page': json['page'],
+        'pageSize': json['page_size'],
+        'totalItems': json['total_items'],
+        'items': ((json['items'] as Array<any>).map(ZapierCourseFromJSON)),
+    };
+}
+
+export function GetZapierCoursesToJSON(json: any): GetZapierCourses {
+    return GetZapierCoursesToJSONTyped(json, false);
+}
+
+export function GetZapierCoursesToJSONTyped(value?: GetZapierCourses | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'page': value['page'],
+        'page_size': value['pageSize'],
+        'total_items': value['totalItems'],
+        'items': ((value['items'] as Array<any>).map(ZapierCourseToJSON)),
+    };
+}
+

package/src/models/GetZapierShopifyCourseMappings.ts

@@ -0,0 +1,74 @@
+/* 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 { ZapierShopifyCourseMapping } from './ZapierShopifyCourseMapping';
+import {
+    ZapierShopifyCourseMappingFromJSON,
+    ZapierShopifyCourseMappingFromJSONTyped,
+    ZapierShopifyCourseMappingToJSON,
+    ZapierShopifyCourseMappingToJSONTyped,
+} from './ZapierShopifyCourseMapping';
+
+/**
+ * 
+ * @export
+ * @interface GetZapierShopifyCourseMappings
+ */
+export interface GetZapierShopifyCourseMappings {
+    /**
+     * 
+     * @type {Array<ZapierShopifyCourseMapping>}
+     * @memberof GetZapierShopifyCourseMappings
+     */
+    items: Array<ZapierShopifyCourseMapping>;
+}
+
+/**
+ * Check if a given object implements the GetZapierShopifyCourseMappings interface.
+ */
+export function instanceOfGetZapierShopifyCourseMappings(value: object): value is GetZapierShopifyCourseMappings {
+    if (!('items' in value) || value['items'] === undefined) return false;
+    return true;
+}
+
+export function GetZapierShopifyCourseMappingsFromJSON(json: any): GetZapierShopifyCourseMappings {
+    return GetZapierShopifyCourseMappingsFromJSONTyped(json, false);
+}
+
+export function GetZapierShopifyCourseMappingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetZapierShopifyCourseMappings {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'items': ((json['items'] as Array<any>).map(ZapierShopifyCourseMappingFromJSON)),
+    };
+}
+
+export function GetZapierShopifyCourseMappingsToJSON(json: any): GetZapierShopifyCourseMappings {
+    return GetZapierShopifyCourseMappingsToJSONTyped(json, false);
+}
+
+export function GetZapierShopifyCourseMappingsToJSONTyped(value?: GetZapierShopifyCourseMappings | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'items': ((value['items'] as Array<any>).map(ZapierShopifyCourseMappingToJSON)),
+    };
+}
+

package/src/models/GetZapierUsers.ts

@@ -0,0 +1,74 @@
+/* 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';
+
+/**
+ * 
+ * @export
+ * @interface GetZapierUsers
+ */
+export interface GetZapierUsers {
+    /**
+     * 
+     * @type {Array<ZapierUser>}
+     * @memberof GetZapierUsers
+     */
+    items: Array<ZapierUser>;
+}
+
+/**
+ * Check if a given object implements the GetZapierUsers interface.
+ */
+export function instanceOfGetZapierUsers(value: object): value is GetZapierUsers {
+    if (!('items' in value) || value['items'] === undefined) return false;
+    return true;
+}
+
+export function GetZapierUsersFromJSON(json: any): GetZapierUsers {
+    return GetZapierUsersFromJSONTyped(json, false);
+}
+
+export function GetZapierUsersFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetZapierUsers {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'items': ((json['items'] as Array<any>).map(ZapierUserFromJSON)),
+    };
+}
+
+export function GetZapierUsersToJSON(json: any): GetZapierUsers {
+    return GetZapierUsersToJSONTyped(json, false);
+}
+
+export function GetZapierUsersToJSONTyped(value?: GetZapierUsers | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'items': ((value['items'] as Array<any>).map(ZapierUserToJSON)),
+    };
+}
+

package/src/models/PostZapierEnrollment.ts

@@ -0,0 +1,126 @@
+/* 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 PostZapierEnrollment
+ */
+export interface PostZapierEnrollment {
+    /**
+     * 
+     * @type {string}
+     * @memberof PostZapierEnrollment
+     */
+    courseId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostZapierEnrollment
+     */
+    userId: string;
+    /**
+     * Stable source event ID used to make retries safe.
+     * @type {string}
+     * @memberof PostZapierEnrollment
+     */
+    idempotencyKey?: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof PostZapierEnrollment
+     */
+    enrollmentDateStart?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof PostZapierEnrollment
+     */
+    enrollmentDateEnd?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostZapierEnrollment
+     */
+    notes?: string | null;
+    /**
+     * 
+     * @type {PostZapierEnrollmentReEnrollmentModeEnum}
+     * @memberof PostZapierEnrollment
+     */
+    reEnrollmentMode?: PostZapierEnrollmentReEnrollmentModeEnum;
+}
+
+
+/**
+ * @export
+ */
+export const PostZapierEnrollmentReEnrollmentModeEnum = {
+    Restart: 'restart',
+    Resume: 'resume'
+} as const;
+export type PostZapierEnrollmentReEnrollmentModeEnum = typeof PostZapierEnrollmentReEnrollmentModeEnum[keyof typeof PostZapierEnrollmentReEnrollmentModeEnum];
+
+
+/**
+ * Check if a given object implements the PostZapierEnrollment interface.
+ */
+export function instanceOfPostZapierEnrollment(value: object): value is PostZapierEnrollment {
+    if (!('courseId' in value) || value['courseId'] === undefined) return false;
+    if (!('userId' in value) || value['userId'] === undefined) return false;
+    return true;
+}
+
+export function PostZapierEnrollmentFromJSON(json: any): PostZapierEnrollment {
+    return PostZapierEnrollmentFromJSONTyped(json, false);
+}
+
+export function PostZapierEnrollmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostZapierEnrollment {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'courseId': json['course_id'],
+        'userId': json['user_id'],
+        'idempotencyKey': json['idempotency_key'] == null ? undefined : json['idempotency_key'],
+        '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 PostZapierEnrollmentToJSON(json: any): PostZapierEnrollment {
+    return PostZapierEnrollmentToJSONTyped(json, false);
+}
+
+export function PostZapierEnrollmentToJSONTyped(value?: PostZapierEnrollment | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'course_id': value['courseId'],
+        'user_id': value['userId'],
+        'idempotency_key': value['idempotencyKey'],
+        'enrollment_date_start': value['enrollmentDateStart'],
+        'enrollment_date_end': value['enrollmentDateEnd'],
+        'notes': value['notes'],
+        're_enrollment_mode': value['reEnrollmentMode'],
+    };
+}
+

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'],
+    };
+}
+