@easyedu/js-lsm-api 1.115.0 → 1.117.0

package/dist/esm/models/PostZapierShopifyEnrollmentResponse.js

@@ -0,0 +1,54 @@
+/* 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 { ZapierUserFromJSON, ZapierUserToJSON, } from './ZapierUser';
+import { ZapierShopifyCourseMappingFromJSON, ZapierShopifyCourseMappingToJSON, } from './ZapierShopifyCourseMapping';
+import { ZapierEnrollmentFromJSON, ZapierEnrollmentToJSON, } from './ZapierEnrollment';
+/**
+ * Check if a given object implements the PostZapierShopifyEnrollmentResponse interface.
+ */
+export function instanceOfPostZapierShopifyEnrollmentResponse(value) {
+    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) {
+    return PostZapierShopifyEnrollmentResponseFromJSONTyped(json, false);
+}
+export function PostZapierShopifyEnrollmentResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'enrollment': ZapierEnrollmentFromJSON(json['enrollment']),
+        'user': ZapierUserFromJSON(json['user']),
+        'mapping': ZapierShopifyCourseMappingFromJSON(json['mapping']),
+    };
+}
+export function PostZapierShopifyEnrollmentResponseToJSON(json) {
+    return PostZapierShopifyEnrollmentResponseToJSONTyped(json, false);
+}
+export function PostZapierShopifyEnrollmentResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'enrollment': ZapierEnrollmentToJSON(value['enrollment']),
+        'user': ZapierUserToJSON(value['user']),
+        'mapping': ZapierShopifyCourseMappingToJSON(value['mapping']),
+    };
+}

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

@@ -0,0 +1,53 @@
+/**
+ * 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 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 declare const PostZapierSubscriptionEventTypeEnum: {
+    readonly ComEdaxuEnrollmentEnrolledV1: "com.edaxu.enrollment.enrolled.v1";
+    readonly ComEdaxuEnrollmentCompletedV1: "com.edaxu.enrollment.completed.v1";
+    readonly ComEdaxuCertificateIssuedV1: "com.edaxu.certificate.issued.v1";
+};
+export type PostZapierSubscriptionEventTypeEnum = typeof PostZapierSubscriptionEventTypeEnum[keyof typeof PostZapierSubscriptionEventTypeEnum];
+/**
+ * Check if a given object implements the PostZapierSubscription interface.
+ */
+export declare function instanceOfPostZapierSubscription(value: object): value is PostZapierSubscription;
+export declare function PostZapierSubscriptionFromJSON(json: any): PostZapierSubscription;
+export declare function PostZapierSubscriptionFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostZapierSubscription;
+export declare function PostZapierSubscriptionToJSON(json: any): PostZapierSubscription;
+export declare function PostZapierSubscriptionToJSONTyped(value?: PostZapierSubscription | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PostZapierSubscription.js

@@ -0,0 +1,57 @@
+/* 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 PostZapierSubscriptionEventTypeEnum = {
+    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 PostZapierSubscription interface.
+ */
+export function instanceOfPostZapierSubscription(value) {
+    if (!('eventType' in value) || value['eventType'] === undefined)
+        return false;
+    if (!('targetUrl' in value) || value['targetUrl'] === undefined)
+        return false;
+    return true;
+}
+export function PostZapierSubscriptionFromJSON(json) {
+    return PostZapierSubscriptionFromJSONTyped(json, false);
+}
+export function PostZapierSubscriptionFromJSONTyped(json, ignoreDiscriminator) {
+    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) {
+    return PostZapierSubscriptionToJSONTyped(json, false);
+}
+export function PostZapierSubscriptionToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'event_type': value['eventType'],
+        'target_url': value['targetUrl'],
+        'zap_id': value['zapId'],
+    };
+}

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

@@ -0,0 +1,44 @@
+/**
+ * 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 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 declare function instanceOfPostZapierUser(value: object): value is PostZapierUser;
+export declare function PostZapierUserFromJSON(json: any): PostZapierUser;
+export declare function PostZapierUserFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostZapierUser;
+export declare function PostZapierUserToJSON(json: any): PostZapierUser;
+export declare function PostZapierUserToJSONTyped(value?: PostZapierUser | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PostZapierUser.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 PostZapierUser interface.
+ */
+export function instanceOfPostZapierUser(value) {
+    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) {
+    return PostZapierUserFromJSONTyped(json, false);
+}
+export function PostZapierUserFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'email': json['email'],
+        'firstName': json['first_name'],
+        'lastName': json['last_name'],
+    };
+}
+export function PostZapierUserToJSON(json) {
+    return PostZapierUserToJSONTyped(json, false);
+}
+export function PostZapierUserToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'email': value['email'],
+        'first_name': value['firstName'],
+        'last_name': value['lastName'],
+    };
+}

package/dist/esm/models/PutCustomWebhookIntegration.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 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 declare const PutCustomWebhookIntegrationEventTypesEnum: {
+    readonly ComEdaxuEnrollmentEnrolledV1: "com.edaxu.enrollment.enrolled.v1";
+    readonly ComEdaxuEnrollmentCompletedV1: "com.edaxu.enrollment.completed.v1";
+    readonly ComEdaxuCertificateIssuedV1: "com.edaxu.certificate.issued.v1";
+};
+export type PutCustomWebhookIntegrationEventTypesEnum = typeof PutCustomWebhookIntegrationEventTypesEnum[keyof typeof PutCustomWebhookIntegrationEventTypesEnum];
+/**
+ * Check if a given object implements the PutCustomWebhookIntegration interface.
+ */
+export declare function instanceOfPutCustomWebhookIntegration(value: object): value is PutCustomWebhookIntegration;
+export declare function PutCustomWebhookIntegrationFromJSON(json: any): PutCustomWebhookIntegration;
+export declare function PutCustomWebhookIntegrationFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutCustomWebhookIntegration;
+export declare function PutCustomWebhookIntegrationToJSON(json: any): PutCustomWebhookIntegration;
+export declare function PutCustomWebhookIntegrationToJSONTyped(value?: PutCustomWebhookIntegration | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PutCustomWebhookIntegration.js

@@ -0,0 +1,57 @@
+/* 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 PutCustomWebhookIntegrationEventTypesEnum = {
+    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 PutCustomWebhookIntegration interface.
+ */
+export function instanceOfPutCustomWebhookIntegration(value) {
+    return true;
+}
+export function PutCustomWebhookIntegrationFromJSON(json) {
+    return PutCustomWebhookIntegrationFromJSONTyped(json, false);
+}
+export function PutCustomWebhookIntegrationFromJSONTyped(json, ignoreDiscriminator) {
+    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) {
+    return PutCustomWebhookIntegrationToJSONTyped(json, false);
+}
+export function PutCustomWebhookIntegrationToJSONTyped(value, ignoreDiscriminator = false) {
+    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']),
+        'enabled': value['enabled'],
+    };
+}

package/dist/esm/models/ZapierCourse.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 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 declare function instanceOfZapierCourse(value: object): value is ZapierCourse;
+export declare function ZapierCourseFromJSON(json: any): ZapierCourse;
+export declare function ZapierCourseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ZapierCourse;
+export declare function ZapierCourseToJSON(json: any): ZapierCourse;
+export declare function ZapierCourseToJSONTyped(value?: ZapierCourse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ZapierCourse.js

@@ -0,0 +1,55 @@
+/* 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 ZapierCourse interface.
+ */
+export function instanceOfZapierCourse(value) {
+    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) {
+    return ZapierCourseFromJSONTyped(json, false);
+}
+export function ZapierCourseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+        'published': json['published'],
+    };
+}
+export function ZapierCourseToJSON(json) {
+    return ZapierCourseToJSONTyped(json, false);
+}
+export function ZapierCourseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'description': value['description'],
+        'published': value['published'],
+    };
+}

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

@@ -0,0 +1,74 @@
+/**
+ * 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 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 declare function instanceOfZapierEnrollment(value: object): value is ZapierEnrollment;
+export declare function ZapierEnrollmentFromJSON(json: any): ZapierEnrollment;
+export declare function ZapierEnrollmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): ZapierEnrollment;
+export declare function ZapierEnrollmentToJSON(json: any): ZapierEnrollment;
+export declare function ZapierEnrollmentToJSONTyped(value?: ZapierEnrollment | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ZapierEnrollment.js

@@ -0,0 +1,69 @@
+/* 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 ZapierEnrollment interface.
+ */
+export function instanceOfZapierEnrollment(value) {
+    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) {
+    return ZapierEnrollmentFromJSONTyped(json, false);
+}
+export function ZapierEnrollmentFromJSONTyped(json, ignoreDiscriminator) {
+    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) {
+    return ZapierEnrollmentToJSONTyped(json, false);
+}
+export function ZapierEnrollmentToJSONTyped(value, ignoreDiscriminator = false) {
+    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'],
+    };
+}