@easyedu/js-lsm-api 1.115.0 → 1.117.0

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

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/PostZapierSubscription.ts

@@ -0,0 +1,95 @@
+/* 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 PostZapierSubscription
+ */
+export interface PostZapierSubscription {
+    /**
+     * 
+     * @type {PostZapierSubscriptionEventTypeEnum}
+     * @memberof PostZapierSubscription
+     */
+    eventType: PostZapierSubscriptionEventTypeEnum;
+    /**
+     * Zapier REST Hook URL supplied as bundle.targetUrl.
+     * @type {string}
+     * @memberof PostZapierSubscription
+     */
+    targetUrl: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostZapierSubscription
+     */
+    zapId?: string | null;
+}
+
+
+/**
+ * @export
+ */
+export const PostZapierSubscriptionEventTypeEnum = {
+    ComEdaxuEnrollmentEnrolledV1: 'com.edaxu.enrollment.enrolled.v1',
+    ComEdaxuEnrollmentCompletedV1: 'com.edaxu.enrollment.completed.v1',
+    ComEdaxuCertificateIssuedV1: 'com.edaxu.certificate.issued.v1'
+} as const;
+export type PostZapierSubscriptionEventTypeEnum = typeof PostZapierSubscriptionEventTypeEnum[keyof typeof PostZapierSubscriptionEventTypeEnum];
+
+
+/**
+ * Check if a given object implements the PostZapierSubscription interface.
+ */
+export function instanceOfPostZapierSubscription(value: object): value is PostZapierSubscription {
+    if (!('eventType' in value) || value['eventType'] === undefined) return false;
+    if (!('targetUrl' in value) || value['targetUrl'] === undefined) return false;
+    return true;
+}
+
+export function PostZapierSubscriptionFromJSON(json: any): PostZapierSubscription {
+    return PostZapierSubscriptionFromJSONTyped(json, false);
+}
+
+export function PostZapierSubscriptionFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostZapierSubscription {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'eventType': json['event_type'],
+        'targetUrl': json['target_url'],
+        'zapId': json['zap_id'] == null ? undefined : json['zap_id'],
+    };
+}
+
+export function PostZapierSubscriptionToJSON(json: any): PostZapierSubscription {
+    return PostZapierSubscriptionToJSONTyped(json, false);
+}
+
+export function PostZapierSubscriptionToJSONTyped(value?: PostZapierSubscription | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'event_type': value['eventType'],
+        'target_url': value['targetUrl'],
+        'zap_id': value['zapId'],
+    };
+}
+

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