@easyedu/js-lsm-api 1.83.0 → 1.85.0

package/dist/esm/models/GetEmailDelivery.js

@@ -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.
+ */
+/**
+ * @export
+ */
+export const GetEmailDeliveryStatusEnum = {
+    Queued: 'queued',
+    Processing: 'processing',
+    Accepted: 'accepted',
+    Delivered: 'delivered',
+    Deferred: 'deferred',
+    Failed: 'failed',
+    Complained: 'complained'
+};
+/**
+ * Check if a given object implements the GetEmailDelivery interface.
+ */
+export function instanceOfGetEmailDelivery(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('templateKey' in value) || value['templateKey'] === undefined)
+        return false;
+    if (!('recipient' in value) || value['recipient'] === undefined)
+        return false;
+    if (!('isTest' in value) || value['isTest'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('attempts' in value) || value['attempts'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    return true;
+}
+export function GetEmailDeliveryFromJSON(json) {
+    return GetEmailDeliveryFromJSONTyped(json, false);
+}
+export function GetEmailDeliveryFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'templateKey': json['template_key'],
+        'templateVersionId': json['template_version_id'] == null ? undefined : json['template_version_id'],
+        'recipient': json['recipient'],
+        'isTest': json['is_test'],
+        'status': json['status'],
+        'attempts': json['attempts'],
+        'providerMessageId': json['provider_message_id'] == null ? undefined : json['provider_message_id'],
+        'lastErrorCode': json['last_error_code'] == null ? undefined : json['last_error_code'],
+        'lastErrorMessage': json['last_error_message'] == null ? undefined : json['last_error_message'],
+        'createdAt': json['created_at'],
+        'acceptedAt': json['accepted_at'] == null ? undefined : json['accepted_at'],
+        'deliveredAt': json['delivered_at'] == null ? undefined : json['delivered_at'],
+        'failedAt': json['failed_at'] == null ? undefined : json['failed_at'],
+    };
+}
+export function GetEmailDeliveryToJSON(json) {
+    return GetEmailDeliveryToJSONTyped(json, false);
+}
+export function GetEmailDeliveryToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'template_key': value['templateKey'],
+        'template_version_id': value['templateVersionId'],
+        'recipient': value['recipient'],
+        'is_test': value['isTest'],
+        'status': value['status'],
+        'attempts': value['attempts'],
+        'provider_message_id': value['providerMessageId'],
+        'last_error_code': value['lastErrorCode'],
+        'last_error_message': value['lastErrorMessage'],
+        'created_at': value['createdAt'],
+        'accepted_at': value['acceptedAt'],
+        'delivered_at': value['deliveredAt'],
+        'failed_at': value['failedAt'],
+    };
+}

package/dist/esm/models/GetEmailDeliveryList.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 { GetEmailDelivery } from './GetEmailDelivery';
+/**
+ *
+ * @export
+ * @interface GetEmailDeliveryList
+ */
+export interface GetEmailDeliveryList {
+    /**
+     *
+     * @type {Array<GetEmailDelivery>}
+     * @memberof GetEmailDeliveryList
+     */
+    items: Array<GetEmailDelivery>;
+    /**
+     *
+     * @type {number}
+     * @memberof GetEmailDeliveryList
+     */
+    total: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetEmailDeliveryList
+     */
+    page: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetEmailDeliveryList
+     */
+    pageSize: number;
+}
+/**
+ * Check if a given object implements the GetEmailDeliveryList interface.
+ */
+export declare function instanceOfGetEmailDeliveryList(value: object): value is GetEmailDeliveryList;
+export declare function GetEmailDeliveryListFromJSON(json: any): GetEmailDeliveryList;
+export declare function GetEmailDeliveryListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetEmailDeliveryList;
+export declare function GetEmailDeliveryListToJSON(json: any): GetEmailDeliveryList;
+export declare function GetEmailDeliveryListToJSONTyped(value?: GetEmailDeliveryList | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetEmailDeliveryList.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 { GetEmailDeliveryFromJSON, GetEmailDeliveryToJSON, } from './GetEmailDelivery';
+/**
+ * Check if a given object implements the GetEmailDeliveryList interface.
+ */
+export function instanceOfGetEmailDeliveryList(value) {
+    if (!('items' in value) || value['items'] === undefined)
+        return false;
+    if (!('total' in value) || value['total'] === undefined)
+        return false;
+    if (!('page' in value) || value['page'] === undefined)
+        return false;
+    if (!('pageSize' in value) || value['pageSize'] === undefined)
+        return false;
+    return true;
+}
+export function GetEmailDeliveryListFromJSON(json) {
+    return GetEmailDeliveryListFromJSONTyped(json, false);
+}
+export function GetEmailDeliveryListFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'items': (json['items'].map(GetEmailDeliveryFromJSON)),
+        'total': json['total'],
+        'page': json['page'],
+        'pageSize': json['page_size'],
+    };
+}
+export function GetEmailDeliveryListToJSON(json) {
+    return GetEmailDeliveryListToJSONTyped(json, false);
+}
+export function GetEmailDeliveryListToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'items': (value['items'].map(GetEmailDeliveryToJSON)),
+        'total': value['total'],
+        'page': value['page'],
+        'page_size': value['pageSize'],
+    };
+}

package/dist/esm/models/GetEmailTemplate.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.
+ */
+import type { EmailTemplateDefinition } from './EmailTemplateDefinition';
+import type { EmailTemplateVersion } from './EmailTemplateVersion';
+/**
+ *
+ * @export
+ * @interface GetEmailTemplate
+ */
+export interface GetEmailTemplate {
+    /**
+     *
+     * @type {EmailTemplateDefinition}
+     * @memberof GetEmailTemplate
+     */
+    definition: EmailTemplateDefinition;
+    /**
+     *
+     * @type {GetEmailTemplateEffectiveSourceEnum}
+     * @memberof GetEmailTemplate
+     */
+    effectiveSource: GetEmailTemplateEffectiveSourceEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof GetEmailTemplate
+     */
+    effectiveSourcePortalId?: string | null;
+    /**
+     *
+     * @type {EmailTemplateVersion}
+     * @memberof GetEmailTemplate
+     */
+    effectiveVersion: EmailTemplateVersion;
+    /**
+     *
+     * @type {EmailTemplateVersion}
+     * @memberof GetEmailTemplate
+     */
+    draftVersion?: EmailTemplateVersion | null;
+    /**
+     *
+     * @type {Array<EmailTemplateVersion>}
+     * @memberof GetEmailTemplate
+     */
+    versions: Array<EmailTemplateVersion>;
+}
+/**
+ * @export
+ */
+export declare const GetEmailTemplateEffectiveSourceEnum: {
+    readonly Portal: "portal";
+    readonly Ancestor: "ancestor";
+    readonly Platform: "platform";
+    readonly System: "system";
+};
+export type GetEmailTemplateEffectiveSourceEnum = typeof GetEmailTemplateEffectiveSourceEnum[keyof typeof GetEmailTemplateEffectiveSourceEnum];
+/**
+ * Check if a given object implements the GetEmailTemplate interface.
+ */
+export declare function instanceOfGetEmailTemplate(value: object): value is GetEmailTemplate;
+export declare function GetEmailTemplateFromJSON(json: any): GetEmailTemplate;
+export declare function GetEmailTemplateFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetEmailTemplate;
+export declare function GetEmailTemplateToJSON(json: any): GetEmailTemplate;
+export declare function GetEmailTemplateToJSONTyped(value?: GetEmailTemplate | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetEmailTemplate.js

@@ -0,0 +1,70 @@
+/* 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 { EmailTemplateDefinitionFromJSON, EmailTemplateDefinitionToJSON, } from './EmailTemplateDefinition';
+import { EmailTemplateVersionFromJSON, EmailTemplateVersionToJSON, } from './EmailTemplateVersion';
+/**
+ * @export
+ */
+export const GetEmailTemplateEffectiveSourceEnum = {
+    Portal: 'portal',
+    Ancestor: 'ancestor',
+    Platform: 'platform',
+    System: 'system'
+};
+/**
+ * Check if a given object implements the GetEmailTemplate interface.
+ */
+export function instanceOfGetEmailTemplate(value) {
+    if (!('definition' in value) || value['definition'] === undefined)
+        return false;
+    if (!('effectiveSource' in value) || value['effectiveSource'] === undefined)
+        return false;
+    if (!('effectiveVersion' in value) || value['effectiveVersion'] === undefined)
+        return false;
+    if (!('versions' in value) || value['versions'] === undefined)
+        return false;
+    return true;
+}
+export function GetEmailTemplateFromJSON(json) {
+    return GetEmailTemplateFromJSONTyped(json, false);
+}
+export function GetEmailTemplateFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'definition': EmailTemplateDefinitionFromJSON(json['definition']),
+        'effectiveSource': json['effective_source'],
+        'effectiveSourcePortalId': json['effective_source_portal_id'] == null ? undefined : json['effective_source_portal_id'],
+        'effectiveVersion': EmailTemplateVersionFromJSON(json['effective_version']),
+        'draftVersion': json['draft_version'] == null ? undefined : EmailTemplateVersionFromJSON(json['draft_version']),
+        'versions': (json['versions'].map(EmailTemplateVersionFromJSON)),
+    };
+}
+export function GetEmailTemplateToJSON(json) {
+    return GetEmailTemplateToJSONTyped(json, false);
+}
+export function GetEmailTemplateToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'definition': EmailTemplateDefinitionToJSON(value['definition']),
+        'effective_source': value['effectiveSource'],
+        'effective_source_portal_id': value['effectiveSourcePortalId'],
+        'effective_version': EmailTemplateVersionToJSON(value['effectiveVersion']),
+        'draft_version': EmailTemplateVersionToJSON(value['draftVersion']),
+        'versions': (value['versions'].map(EmailTemplateVersionToJSON)),
+    };
+}

package/dist/esm/models/GetEmailTemplateList.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 { GetEmailTemplate } from './GetEmailTemplate';
+/**
+ *
+ * @export
+ * @interface GetEmailTemplateList
+ */
+export interface GetEmailTemplateList {
+    /**
+     *
+     * @type {Array<GetEmailTemplate>}
+     * @memberof GetEmailTemplateList
+     */
+    items: Array<GetEmailTemplate>;
+}
+/**
+ * Check if a given object implements the GetEmailTemplateList interface.
+ */
+export declare function instanceOfGetEmailTemplateList(value: object): value is GetEmailTemplateList;
+export declare function GetEmailTemplateListFromJSON(json: any): GetEmailTemplateList;
+export declare function GetEmailTemplateListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetEmailTemplateList;
+export declare function GetEmailTemplateListToJSON(json: any): GetEmailTemplateList;
+export declare function GetEmailTemplateListToJSONTyped(value?: GetEmailTemplateList | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetEmailTemplateList.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 { GetEmailTemplateFromJSON, GetEmailTemplateToJSON, } from './GetEmailTemplate';
+/**
+ * Check if a given object implements the GetEmailTemplateList interface.
+ */
+export function instanceOfGetEmailTemplateList(value) {
+    if (!('items' in value) || value['items'] === undefined)
+        return false;
+    return true;
+}
+export function GetEmailTemplateListFromJSON(json) {
+    return GetEmailTemplateListFromJSONTyped(json, false);
+}
+export function GetEmailTemplateListFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'items': (json['items'].map(GetEmailTemplateFromJSON)),
+    };
+}
+export function GetEmailTemplateListToJSON(json) {
+    return GetEmailTemplateListToJSONTyped(json, false);
+}
+export function GetEmailTemplateListToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'items': (value['items'].map(GetEmailTemplateToJSON)),
+    };
+}

package/dist/esm/models/GetEmailTemplatePreview.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 GetEmailTemplatePreview
+ */
+export interface GetEmailTemplatePreview {
+    /**
+     *
+     * @type {string}
+     * @memberof GetEmailTemplatePreview
+     */
+    subject: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetEmailTemplatePreview
+     */
+    html: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetEmailTemplatePreview
+     */
+    text: string;
+}
+/**
+ * Check if a given object implements the GetEmailTemplatePreview interface.
+ */
+export declare function instanceOfGetEmailTemplatePreview(value: object): value is GetEmailTemplatePreview;
+export declare function GetEmailTemplatePreviewFromJSON(json: any): GetEmailTemplatePreview;
+export declare function GetEmailTemplatePreviewFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetEmailTemplatePreview;
+export declare function GetEmailTemplatePreviewToJSON(json: any): GetEmailTemplatePreview;
+export declare function GetEmailTemplatePreviewToJSONTyped(value?: GetEmailTemplatePreview | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetEmailTemplatePreview.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 GetEmailTemplatePreview interface.
+ */
+export function instanceOfGetEmailTemplatePreview(value) {
+    if (!('subject' in value) || value['subject'] === undefined)
+        return false;
+    if (!('html' in value) || value['html'] === undefined)
+        return false;
+    if (!('text' in value) || value['text'] === undefined)
+        return false;
+    return true;
+}
+export function GetEmailTemplatePreviewFromJSON(json) {
+    return GetEmailTemplatePreviewFromJSONTyped(json, false);
+}
+export function GetEmailTemplatePreviewFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'subject': json['subject'],
+        'html': json['html'],
+        'text': json['text'],
+    };
+}
+export function GetEmailTemplatePreviewToJSON(json) {
+    return GetEmailTemplatePreviewToJSONTyped(json, false);
+}
+export function GetEmailTemplatePreviewToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'subject': value['subject'],
+        'html': value['html'],
+        'text': value['text'],
+    };
+}

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

@@ -0,0 +1,118 @@
+/**
+ * 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 { GetContentLibraryVersion } from './GetContentLibraryVersion';
+import type { ResourceType } from './ResourceType';
+/**
+ *
+ * @export
+ * @interface GetResource
+ */
+export interface GetResource {
+    /**
+     *
+     * @type {string}
+     * @memberof GetResource
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetResource
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetResource
+     */
+    description: string;
+    /**
+     *
+     * @type {ResourceType}
+     * @memberof GetResource
+     */
+    resourceType: ResourceType;
+    /**
+     *
+     * @type {string}
+     * @memberof GetResource
+     */
+    ownerId: string;
+    /**
+     *
+     * @type {GetContentLibraryVersion}
+     * @memberof GetResource
+     */
+    latestPublishedVersion?: GetContentLibraryVersion | null;
+    /**
+     *
+     * @type {GetContentLibraryVersion}
+     * @memberof GetResource
+     */
+    draftVersion?: GetContentLibraryVersion | null;
+    /**
+     *
+     * @type {Array<GetContentLibraryVersion>}
+     * @memberof GetResource
+     */
+    versions: Array<GetContentLibraryVersion>;
+    /**
+     *
+     * @type {number}
+     * @memberof GetResource
+     */
+    publishedCourseCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetResource
+     */
+    draftCourseCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetResource
+     */
+    historicalCourseCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetResource
+     */
+    activeLearnerCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetResource
+     */
+    createdAt: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetResource
+     */
+    updatedAt: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetResource
+     */
+    archivedAt?: number | null;
+}
+/**
+ * Check if a given object implements the GetResource interface.
+ */
+export declare function instanceOfGetResource(value: object): value is GetResource;
+export declare function GetResourceFromJSON(json: any): GetResource;
+export declare function GetResourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetResource;
+export declare function GetResourceToJSON(json: any): GetResource;
+export declare function GetResourceToJSONTyped(value?: GetResource | null, ignoreDiscriminator?: boolean): any;