@easyedu/js-lsm-api 1.115.0 → 1.117.0

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

@@ -0,0 +1,83 @@
+/**
+ * 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 CustomWebhookIntegration
+ */
+export interface CustomWebhookIntegration {
+    /**
+     *
+     * @type {string}
+     * @memberof CustomWebhookIntegration
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CustomWebhookIntegration
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CustomWebhookIntegration
+     */
+    targetUrl: string;
+    /**
+     *
+     * @type {Set<CustomWebhookIntegrationEventTypesEnum>}
+     * @memberof CustomWebhookIntegration
+     */
+    eventTypes: Set<CustomWebhookIntegrationEventTypesEnum>;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CustomWebhookIntegration
+     */
+    enabled: boolean;
+    /**
+     * True when an encrypted bearer token is configured. The token is never returned.
+     * @type {boolean}
+     * @memberof CustomWebhookIntegration
+     */
+    tokenConfigured: boolean;
+    /**
+     *
+     * @type {Date}
+     * @memberof CustomWebhookIntegration
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof CustomWebhookIntegration
+     */
+    updatedAt: Date;
+}
+/**
+ * @export
+ */
+export declare const CustomWebhookIntegrationEventTypesEnum: {
+    readonly ComEdaxuEnrollmentEnrolledV1: "com.edaxu.enrollment.enrolled.v1";
+    readonly ComEdaxuEnrollmentCompletedV1: "com.edaxu.enrollment.completed.v1";
+    readonly ComEdaxuCertificateIssuedV1: "com.edaxu.certificate.issued.v1";
+};
+export type CustomWebhookIntegrationEventTypesEnum = typeof CustomWebhookIntegrationEventTypesEnum[keyof typeof CustomWebhookIntegrationEventTypesEnum];
+/**
+ * Check if a given object implements the CustomWebhookIntegration interface.
+ */
+export declare function instanceOfCustomWebhookIntegration(value: object): value is CustomWebhookIntegration;
+export declare function CustomWebhookIntegrationFromJSON(json: any): CustomWebhookIntegration;
+export declare function CustomWebhookIntegrationFromJSONTyped(json: any, ignoreDiscriminator: boolean): CustomWebhookIntegration;
+export declare function CustomWebhookIntegrationToJSON(json: any): CustomWebhookIntegration;
+export declare function CustomWebhookIntegrationToJSONTyped(value?: CustomWebhookIntegration | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CustomWebhookIntegration.js

@@ -0,0 +1,79 @@
+/* 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 CustomWebhookIntegrationEventTypesEnum = {
+    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 CustomWebhookIntegration interface.
+ */
+export function instanceOfCustomWebhookIntegration(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('targetUrl' in value) || value['targetUrl'] === undefined)
+        return false;
+    if (!('eventTypes' in value) || value['eventTypes'] === undefined)
+        return false;
+    if (!('enabled' in value) || value['enabled'] === undefined)
+        return false;
+    if (!('tokenConfigured' in value) || value['tokenConfigured'] === 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 CustomWebhookIntegrationFromJSON(json) {
+    return CustomWebhookIntegrationFromJSONTyped(json, false);
+}
+export function CustomWebhookIntegrationFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'targetUrl': json['target_url'],
+        'eventTypes': new Set(json['event_types']),
+        'enabled': json['enabled'],
+        'tokenConfigured': json['token_configured'],
+        'createdAt': (new Date(json['created_at'])),
+        'updatedAt': (new Date(json['updated_at'])),
+    };
+}
+export function CustomWebhookIntegrationToJSON(json) {
+    return CustomWebhookIntegrationToJSONTyped(json, false);
+}
+export function CustomWebhookIntegrationToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'target_url': value['targetUrl'],
+        'event_types': Array.from(value['eventTypes']),
+        'enabled': value['enabled'],
+        'token_configured': value['tokenConfigured'],
+        'created_at': value['createdAt'].toISOString(),
+        'updated_at': value['updatedAt'].toISOString(),
+    };
+}

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

@@ -0,0 +1,51 @@
+/**
+ * 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 { ZapierCourse } 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 declare function instanceOfGetZapierCourses(value: object): value is GetZapierCourses;
+export declare function GetZapierCoursesFromJSON(json: any): GetZapierCourses;
+export declare function GetZapierCoursesFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetZapierCourses;
+export declare function GetZapierCoursesToJSON(json: any): GetZapierCourses;
+export declare function GetZapierCoursesToJSONTyped(value?: GetZapierCourses | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetZapierCourses.js

@@ -0,0 +1,56 @@
+/* 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 { ZapierCourseFromJSON, ZapierCourseToJSON, } from './ZapierCourse';
+/**
+ * Check if a given object implements the GetZapierCourses interface.
+ */
+export function instanceOfGetZapierCourses(value) {
+    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) {
+    return GetZapierCoursesFromJSONTyped(json, false);
+}
+export function GetZapierCoursesFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'page': json['page'],
+        'pageSize': json['page_size'],
+        'totalItems': json['total_items'],
+        'items': (json['items'].map(ZapierCourseFromJSON)),
+    };
+}
+export function GetZapierCoursesToJSON(json) {
+    return GetZapierCoursesToJSONTyped(json, false);
+}
+export function GetZapierCoursesToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'page': value['page'],
+        'page_size': value['pageSize'],
+        'total_items': value['totalItems'],
+        'items': (value['items'].map(ZapierCourseToJSON)),
+    };
+}

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

@@ -0,0 +1,33 @@
+/**
+ * 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 { ZapierShopifyCourseMapping } 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 declare function instanceOfGetZapierShopifyCourseMappings(value: object): value is GetZapierShopifyCourseMappings;
+export declare function GetZapierShopifyCourseMappingsFromJSON(json: any): GetZapierShopifyCourseMappings;
+export declare function GetZapierShopifyCourseMappingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetZapierShopifyCourseMappings;
+export declare function GetZapierShopifyCourseMappingsToJSON(json: any): GetZapierShopifyCourseMappings;
+export declare function GetZapierShopifyCourseMappingsToJSONTyped(value?: GetZapierShopifyCourseMappings | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetZapierShopifyCourseMappings.js

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

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

@@ -0,0 +1,33 @@
+/**
+ * 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';
+/**
+ *
+ * @export
+ * @interface GetZapierUsers
+ */
+export interface GetZapierUsers {
+    /**
+     *
+     * @type {Array<ZapierUser>}
+     * @memberof GetZapierUsers
+     */
+    items: Array<ZapierUser>;
+}
+/**
+ * Check if a given object implements the GetZapierUsers interface.
+ */
+export declare function instanceOfGetZapierUsers(value: object): value is GetZapierUsers;
+export declare function GetZapierUsersFromJSON(json: any): GetZapierUsers;
+export declare function GetZapierUsersFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetZapierUsers;
+export declare function GetZapierUsersToJSON(json: any): GetZapierUsers;
+export declare function GetZapierUsersToJSONTyped(value?: GetZapierUsers | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetZapierUsers.js

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

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

@@ -0,0 +1,98 @@
+/**
+ * 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 { IntegrationEventData } from './IntegrationEventData';
+/**
+ * A CloudEvents 1.0 structured JSON event emitted by Edaxu.
+ * @export
+ * @interface IntegrationEvent
+ */
+export interface IntegrationEvent {
+    /**
+     *
+     * @type {IntegrationEventSpecversionEnum}
+     * @memberof IntegrationEvent
+     */
+    specversion: IntegrationEventSpecversionEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof IntegrationEvent
+     */
+    id: string;
+    /**
+     * Stable URI identifying the portal event source.
+     * @type {string}
+     * @memberof IntegrationEvent
+     */
+    source: string;
+    /**
+     *
+     * @type {IntegrationEventTypeEnum}
+     * @memberof IntegrationEvent
+     */
+    type: IntegrationEventTypeEnum;
+    /**
+     *
+     * @type {Date}
+     * @memberof IntegrationEvent
+     */
+    time: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof IntegrationEvent
+     */
+    subject: string;
+    /**
+     *
+     * @type {IntegrationEventDatacontenttypeEnum}
+     * @memberof IntegrationEvent
+     */
+    datacontenttype: IntegrationEventDatacontenttypeEnum;
+    /**
+     *
+     * @type {IntegrationEventData}
+     * @memberof IntegrationEvent
+     */
+    data: IntegrationEventData;
+}
+/**
+ * @export
+ */
+export declare const IntegrationEventSpecversionEnum: {
+    readonly _10: "1.0";
+};
+export type IntegrationEventSpecversionEnum = typeof IntegrationEventSpecversionEnum[keyof typeof IntegrationEventSpecversionEnum];
+/**
+ * @export
+ */
+export declare const IntegrationEventTypeEnum: {
+    readonly ComEdaxuEnrollmentEnrolledV1: "com.edaxu.enrollment.enrolled.v1";
+    readonly ComEdaxuEnrollmentCompletedV1: "com.edaxu.enrollment.completed.v1";
+    readonly ComEdaxuCertificateIssuedV1: "com.edaxu.certificate.issued.v1";
+};
+export type IntegrationEventTypeEnum = typeof IntegrationEventTypeEnum[keyof typeof IntegrationEventTypeEnum];
+/**
+ * @export
+ */
+export declare const IntegrationEventDatacontenttypeEnum: {
+    readonly ApplicationJson: "application/json";
+};
+export type IntegrationEventDatacontenttypeEnum = typeof IntegrationEventDatacontenttypeEnum[keyof typeof IntegrationEventDatacontenttypeEnum];
+/**
+ * Check if a given object implements the IntegrationEvent interface.
+ */
+export declare function instanceOfIntegrationEvent(value: object): value is IntegrationEvent;
+export declare function IntegrationEventFromJSON(json: any): IntegrationEvent;
+export declare function IntegrationEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): IntegrationEvent;
+export declare function IntegrationEventToJSON(json: any): IntegrationEvent;
+export declare function IntegrationEventToJSONTyped(value?: IntegrationEvent | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/IntegrationEvent.js

@@ -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 { IntegrationEventDataFromJSON, IntegrationEventDataToJSON, } from './IntegrationEventData';
+/**
+ * @export
+ */
+export const IntegrationEventSpecversionEnum = {
+    _10: '1.0'
+};
+/**
+ * @export
+ */
+export const IntegrationEventTypeEnum = {
+    ComEdaxuEnrollmentEnrolledV1: 'com.edaxu.enrollment.enrolled.v1',
+    ComEdaxuEnrollmentCompletedV1: 'com.edaxu.enrollment.completed.v1',
+    ComEdaxuCertificateIssuedV1: 'com.edaxu.certificate.issued.v1'
+};
+/**
+ * @export
+ */
+export const IntegrationEventDatacontenttypeEnum = {
+    ApplicationJson: 'application/json'
+};
+/**
+ * Check if a given object implements the IntegrationEvent interface.
+ */
+export function instanceOfIntegrationEvent(value) {
+    if (!('specversion' in value) || value['specversion'] === undefined)
+        return false;
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('source' in value) || value['source'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('time' in value) || value['time'] === undefined)
+        return false;
+    if (!('subject' in value) || value['subject'] === undefined)
+        return false;
+    if (!('datacontenttype' in value) || value['datacontenttype'] === undefined)
+        return false;
+    if (!('data' in value) || value['data'] === undefined)
+        return false;
+    return true;
+}
+export function IntegrationEventFromJSON(json) {
+    return IntegrationEventFromJSONTyped(json, false);
+}
+export function IntegrationEventFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'specversion': json['specversion'],
+        'id': json['id'],
+        'source': json['source'],
+        'type': json['type'],
+        'time': (new Date(json['time'])),
+        'subject': json['subject'],
+        'datacontenttype': json['datacontenttype'],
+        'data': IntegrationEventDataFromJSON(json['data']),
+    };
+}
+export function IntegrationEventToJSON(json) {
+    return IntegrationEventToJSONTyped(json, false);
+}
+export function IntegrationEventToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'specversion': value['specversion'],
+        'id': value['id'],
+        'source': value['source'],
+        'type': value['type'],
+        'time': value['time'].toISOString(),
+        'subject': value['subject'],
+        'datacontenttype': value['datacontenttype'],
+        'data': IntegrationEventDataToJSON(value['data']),
+    };
+}