@easyedu/js-lsm-api 1.115.0 → 1.117.0

package/dist/esm/models/IntegrationEventPortal.js

@@ -0,0 +1,51 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the IntegrationEventPortal interface.
+ */
+export function instanceOfIntegrationEventPortal(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('subdomain' in value) || value['subdomain'] === undefined)
+        return false;
+    return true;
+}
+export function IntegrationEventPortalFromJSON(json) {
+    return IntegrationEventPortalFromJSONTyped(json, false);
+}
+export function IntegrationEventPortalFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'subdomain': json['subdomain'],
+    };
+}
+export function IntegrationEventPortalToJSON(json) {
+    return IntegrationEventPortalToJSONTyped(json, false);
+}
+export function IntegrationEventPortalToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'subdomain': value['subdomain'],
+    };
+}

package/dist/esm/models/PostCustomWebhookIntegration.d.ts

@@ -0,0 +1,65 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface PostCustomWebhookIntegration
+ */
+export interface PostCustomWebhookIntegration {
+    /**
+     *
+     * @type {string}
+     * @memberof PostCustomWebhookIntegration
+     */
+    name: string;
+    /**
+     * Public HTTPS endpoint that receives CloudEvents JSON payloads.
+     * @type {string}
+     * @memberof PostCustomWebhookIntegration
+     */
+    targetUrl: string;
+    /**
+     * Secret sent in the Authorization header as a Bearer token.
+     * @type {string}
+     * @memberof PostCustomWebhookIntegration
+     */
+    bearerToken: string;
+    /**
+     *
+     * @type {Set<PostCustomWebhookIntegrationEventTypesEnum>}
+     * @memberof PostCustomWebhookIntegration
+     */
+    eventTypes: Set<PostCustomWebhookIntegrationEventTypesEnum>;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PostCustomWebhookIntegration
+     */
+    enabled?: boolean;
+}
+/**
+ * @export
+ */
+export declare const PostCustomWebhookIntegrationEventTypesEnum: {
+    readonly ComEdaxuEnrollmentEnrolledV1: "com.edaxu.enrollment.enrolled.v1";
+    readonly ComEdaxuEnrollmentCompletedV1: "com.edaxu.enrollment.completed.v1";
+    readonly ComEdaxuCertificateIssuedV1: "com.edaxu.certificate.issued.v1";
+};
+export type PostCustomWebhookIntegrationEventTypesEnum = typeof PostCustomWebhookIntegrationEventTypesEnum[keyof typeof PostCustomWebhookIntegrationEventTypesEnum];
+/**
+ * Check if a given object implements the PostCustomWebhookIntegration interface.
+ */
+export declare function instanceOfPostCustomWebhookIntegration(value: object): value is PostCustomWebhookIntegration;
+export declare function PostCustomWebhookIntegrationFromJSON(json: any): PostCustomWebhookIntegration;
+export declare function PostCustomWebhookIntegrationFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostCustomWebhookIntegration;
+export declare function PostCustomWebhookIntegrationToJSON(json: any): PostCustomWebhookIntegration;
+export declare function PostCustomWebhookIntegrationToJSONTyped(value?: PostCustomWebhookIntegration | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PostCustomWebhookIntegration.js

@@ -0,0 +1,65 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const PostCustomWebhookIntegrationEventTypesEnum = {
+    ComEdaxuEnrollmentEnrolledV1: 'com.edaxu.enrollment.enrolled.v1',
+    ComEdaxuEnrollmentCompletedV1: 'com.edaxu.enrollment.completed.v1',
+    ComEdaxuCertificateIssuedV1: 'com.edaxu.certificate.issued.v1'
+};
+/**
+ * Check if a given object implements the PostCustomWebhookIntegration interface.
+ */
+export function instanceOfPostCustomWebhookIntegration(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('targetUrl' in value) || value['targetUrl'] === undefined)
+        return false;
+    if (!('bearerToken' in value) || value['bearerToken'] === undefined)
+        return false;
+    if (!('eventTypes' in value) || value['eventTypes'] === undefined)
+        return false;
+    return true;
+}
+export function PostCustomWebhookIntegrationFromJSON(json) {
+    return PostCustomWebhookIntegrationFromJSONTyped(json, false);
+}
+export function PostCustomWebhookIntegrationFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'targetUrl': json['target_url'],
+        'bearerToken': json['bearer_token'],
+        'eventTypes': new Set(json['event_types']),
+        'enabled': json['enabled'] == null ? undefined : json['enabled'],
+    };
+}
+export function PostCustomWebhookIntegrationToJSON(json) {
+    return PostCustomWebhookIntegrationToJSONTyped(json, false);
+}
+export function PostCustomWebhookIntegrationToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'target_url': value['targetUrl'],
+        'bearer_token': value['bearerToken'],
+        'event_types': Array.from(value['eventTypes']),
+        'enabled': value['enabled'],
+    };
+}

package/dist/esm/models/PostZapierEnrollment.d.ts

@@ -0,0 +1,76 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @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 declare const PostZapierEnrollmentReEnrollmentModeEnum: {
+    readonly Restart: "restart";
+    readonly Resume: "resume";
+};
+export type PostZapierEnrollmentReEnrollmentModeEnum = typeof PostZapierEnrollmentReEnrollmentModeEnum[keyof typeof PostZapierEnrollmentReEnrollmentModeEnum];
+/**
+ * Check if a given object implements the PostZapierEnrollment interface.
+ */
+export declare function instanceOfPostZapierEnrollment(value: object): value is PostZapierEnrollment;
+export declare function PostZapierEnrollmentFromJSON(json: any): PostZapierEnrollment;
+export declare function PostZapierEnrollmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostZapierEnrollment;
+export declare function PostZapierEnrollmentToJSON(json: any): PostZapierEnrollment;
+export declare function PostZapierEnrollmentToJSONTyped(value?: PostZapierEnrollment | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PostZapierEnrollment.js

@@ -0,0 +1,64 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const PostZapierEnrollmentReEnrollmentModeEnum = {
+    Restart: 'restart',
+    Resume: 'resume'
+};
+/**
+ * Check if a given object implements the PostZapierEnrollment interface.
+ */
+export function instanceOfPostZapierEnrollment(value) {
+    if (!('courseId' in value) || value['courseId'] === undefined)
+        return false;
+    if (!('userId' in value) || value['userId'] === undefined)
+        return false;
+    return true;
+}
+export function PostZapierEnrollmentFromJSON(json) {
+    return PostZapierEnrollmentFromJSONTyped(json, false);
+}
+export function PostZapierEnrollmentFromJSONTyped(json, ignoreDiscriminator) {
+    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) {
+    return PostZapierEnrollmentToJSONTyped(json, false);
+}
+export function PostZapierEnrollmentToJSONTyped(value, ignoreDiscriminator = false) {
+    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/dist/esm/models/PostZapierShopifyCourseMapping.d.ts

@@ -0,0 +1,50 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @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 declare function instanceOfPostZapierShopifyCourseMapping(value: object): value is PostZapierShopifyCourseMapping;
+export declare function PostZapierShopifyCourseMappingFromJSON(json: any): PostZapierShopifyCourseMapping;
+export declare function PostZapierShopifyCourseMappingFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostZapierShopifyCourseMapping;
+export declare function PostZapierShopifyCourseMappingToJSON(json: any): PostZapierShopifyCourseMapping;
+export declare function PostZapierShopifyCourseMappingToJSONTyped(value?: PostZapierShopifyCourseMapping | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PostZapierShopifyCourseMapping.js

@@ -0,0 +1,53 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the PostZapierShopifyCourseMapping interface.
+ */
+export function instanceOfPostZapierShopifyCourseMapping(value) {
+    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) {
+    return PostZapierShopifyCourseMappingFromJSONTyped(json, false);
+}
+export function PostZapierShopifyCourseMappingFromJSONTyped(json, ignoreDiscriminator) {
+    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) {
+    return PostZapierShopifyCourseMappingToJSONTyped(json, false);
+}
+export function PostZapierShopifyCourseMappingToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'shop_domain': value['shopDomain'],
+        'variant_id': value['variantId'],
+        'product_id': value['productId'],
+        'course_id': value['courseId'],
+    };
+}

package/dist/esm/models/PostZapierShopifyEnrollment.d.ts

@@ -0,0 +1,100 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @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 declare const PostZapierShopifyEnrollmentReEnrollmentModeEnum: {
+    readonly Restart: "restart";
+    readonly Resume: "resume";
+};
+export type PostZapierShopifyEnrollmentReEnrollmentModeEnum = typeof PostZapierShopifyEnrollmentReEnrollmentModeEnum[keyof typeof PostZapierShopifyEnrollmentReEnrollmentModeEnum];
+/**
+ * Check if a given object implements the PostZapierShopifyEnrollment interface.
+ */
+export declare function instanceOfPostZapierShopifyEnrollment(value: object): value is PostZapierShopifyEnrollment;
+export declare function PostZapierShopifyEnrollmentFromJSON(json: any): PostZapierShopifyEnrollment;
+export declare function PostZapierShopifyEnrollmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostZapierShopifyEnrollment;
+export declare function PostZapierShopifyEnrollmentToJSON(json: any): PostZapierShopifyEnrollment;
+export declare function PostZapierShopifyEnrollmentToJSONTyped(value?: PostZapierShopifyEnrollment | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PostZapierShopifyEnrollment.js

@@ -0,0 +1,82 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const PostZapierShopifyEnrollmentReEnrollmentModeEnum = {
+    Restart: 'restart',
+    Resume: 'resume'
+};
+/**
+ * Check if a given object implements the PostZapierShopifyEnrollment interface.
+ */
+export function instanceOfPostZapierShopifyEnrollment(value) {
+    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) {
+    return PostZapierShopifyEnrollmentFromJSONTyped(json, false);
+}
+export function PostZapierShopifyEnrollmentFromJSONTyped(json, ignoreDiscriminator) {
+    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) {
+    return PostZapierShopifyEnrollmentToJSONTyped(json, false);
+}
+export function PostZapierShopifyEnrollmentToJSONTyped(value, ignoreDiscriminator = false) {
+    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/dist/esm/models/PostZapierShopifyEnrollmentResponse.d.ts

@@ -0,0 +1,47 @@
+/**
+ * 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 type { ZapierUser } from './ZapierUser';
+import type { ZapierShopifyCourseMapping } from './ZapierShopifyCourseMapping';
+import type { ZapierEnrollment } 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 declare function instanceOfPostZapierShopifyEnrollmentResponse(value: object): value is PostZapierShopifyEnrollmentResponse;
+export declare function PostZapierShopifyEnrollmentResponseFromJSON(json: any): PostZapierShopifyEnrollmentResponse;
+export declare function PostZapierShopifyEnrollmentResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostZapierShopifyEnrollmentResponse;
+export declare function PostZapierShopifyEnrollmentResponseToJSON(json: any): PostZapierShopifyEnrollmentResponse;
+export declare function PostZapierShopifyEnrollmentResponseToJSONTyped(value?: PostZapierShopifyEnrollmentResponse | null, ignoreDiscriminator?: boolean): any;