@easyedu/js-lsm-api 1.115.0 → 1.117.0

package/src/models/PutCustomWebhookIntegration.ts

@@ -0,0 +1,109 @@
+/* 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 PutCustomWebhookIntegration
+ */
+export interface PutCustomWebhookIntegration {
+    /**
+     * 
+     * @type {string}
+     * @memberof PutCustomWebhookIntegration
+     */
+    name?: string;
+    /**
+     * Public HTTPS endpoint that receives CloudEvents JSON payloads.
+     * @type {string}
+     * @memberof PutCustomWebhookIntegration
+     */
+    targetUrl?: string;
+    /**
+     * Replacement secret sent in the Authorization header as a Bearer token. Omit to keep the current token.
+     * @type {string}
+     * @memberof PutCustomWebhookIntegration
+     */
+    bearerToken?: string;
+    /**
+     * 
+     * @type {Set<PutCustomWebhookIntegrationEventTypesEnum>}
+     * @memberof PutCustomWebhookIntegration
+     */
+    eventTypes?: Set<PutCustomWebhookIntegrationEventTypesEnum>;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PutCustomWebhookIntegration
+     */
+    enabled?: boolean;
+}
+
+
+/**
+ * @export
+ */
+export const PutCustomWebhookIntegrationEventTypesEnum = {
+    ComEdaxuEnrollmentEnrolledV1: 'com.edaxu.enrollment.enrolled.v1',
+    ComEdaxuEnrollmentCompletedV1: 'com.edaxu.enrollment.completed.v1',
+    ComEdaxuCertificateIssuedV1: 'com.edaxu.certificate.issued.v1'
+} as const;
+export type PutCustomWebhookIntegrationEventTypesEnum = typeof PutCustomWebhookIntegrationEventTypesEnum[keyof typeof PutCustomWebhookIntegrationEventTypesEnum];
+
+
+/**
+ * Check if a given object implements the PutCustomWebhookIntegration interface.
+ */
+export function instanceOfPutCustomWebhookIntegration(value: object): value is PutCustomWebhookIntegration {
+    return true;
+}
+
+export function PutCustomWebhookIntegrationFromJSON(json: any): PutCustomWebhookIntegration {
+    return PutCustomWebhookIntegrationFromJSONTyped(json, false);
+}
+
+export function PutCustomWebhookIntegrationFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutCustomWebhookIntegration {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'] == null ? undefined : json['name'],
+        'targetUrl': json['target_url'] == null ? undefined : json['target_url'],
+        'bearerToken': json['bearer_token'] == null ? undefined : json['bearer_token'],
+        'eventTypes': json['event_types'] == null ? undefined : new Set(json['event_types']),
+        'enabled': json['enabled'] == null ? undefined : json['enabled'],
+    };
+}
+
+export function PutCustomWebhookIntegrationToJSON(json: any): PutCustomWebhookIntegration {
+    return PutCustomWebhookIntegrationToJSONTyped(json, false);
+}
+
+export function PutCustomWebhookIntegrationToJSONTyped(value?: PutCustomWebhookIntegration | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'target_url': value['targetUrl'],
+        'bearer_token': value['bearerToken'],
+        'event_types': value['eventTypes'] == null ? undefined : Array.from(value['eventTypes'] as Set<any>),
+        'enabled': value['enabled'],
+    };
+}
+

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

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

@@ -0,0 +1,96 @@
+/* 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 ZapierSubscription
+ */
+export interface ZapierSubscription {
+    /**
+     * 
+     * @type {string}
+     * @memberof ZapierSubscription
+     */
+    id: string;
+    /**
+     * 
+     * @type {ZapierSubscriptionEventTypeEnum}
+     * @memberof ZapierSubscription
+     */
+    eventType: ZapierSubscriptionEventTypeEnum;
+    /**
+     * 
+     * @type {Date}
+     * @memberof ZapierSubscription
+     */
+    createdAt: Date;
+}
+
+
+/**
+ * @export
+ */
+export const ZapierSubscriptionEventTypeEnum = {
+    ComEdaxuEnrollmentEnrolledV1: 'com.edaxu.enrollment.enrolled.v1',
+    ComEdaxuEnrollmentCompletedV1: 'com.edaxu.enrollment.completed.v1',
+    ComEdaxuCertificateIssuedV1: 'com.edaxu.certificate.issued.v1'
+} as const;
+export type ZapierSubscriptionEventTypeEnum = typeof ZapierSubscriptionEventTypeEnum[keyof typeof ZapierSubscriptionEventTypeEnum];
+
+
+/**
+ * Check if a given object implements the ZapierSubscription interface.
+ */
+export function instanceOfZapierSubscription(value: object): value is ZapierSubscription {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('eventType' in value) || value['eventType'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    return true;
+}
+
+export function ZapierSubscriptionFromJSON(json: any): ZapierSubscription {
+    return ZapierSubscriptionFromJSONTyped(json, false);
+}
+
+export function ZapierSubscriptionFromJSONTyped(json: any, ignoreDiscriminator: boolean): ZapierSubscription {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'eventType': json['event_type'],
+        'createdAt': (new Date(json['created_at'])),
+    };
+}
+
+export function ZapierSubscriptionToJSON(json: any): ZapierSubscription {
+    return ZapierSubscriptionToJSONTyped(json, false);
+}
+
+export function ZapierSubscriptionToJSONTyped(value?: ZapierSubscription | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'event_type': value['eventType'],
+        'created_at': value['createdAt'].toISOString(),
+    };
+}
+

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