@easyedu/js-lsm-api 1.84.0 → 1.85.0

package/dist/esm/models/PostEmailAssetComplete.js

@@ -0,0 +1,43 @@
+/* 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 PostEmailAssetComplete interface.
+ */
+export function instanceOfPostEmailAssetComplete(value) {
+    if (!('checksumSha256' in value) || value['checksumSha256'] === undefined)
+        return false;
+    return true;
+}
+export function PostEmailAssetCompleteFromJSON(json) {
+    return PostEmailAssetCompleteFromJSONTyped(json, false);
+}
+export function PostEmailAssetCompleteFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'checksumSha256': json['checksum_sha256'],
+    };
+}
+export function PostEmailAssetCompleteToJSON(json) {
+    return PostEmailAssetCompleteToJSONTyped(json, false);
+}
+export function PostEmailAssetCompleteToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'checksum_sha256': value['checksumSha256'],
+    };
+}

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

@@ -0,0 +1,54 @@
+/**
+ * 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 PostEmailAssetUpload
+ */
+export interface PostEmailAssetUpload {
+    /**
+     *
+     * @type {string}
+     * @memberof PostEmailAssetUpload
+     */
+    filename: string;
+    /**
+     *
+     * @type {PostEmailAssetUploadContentTypeEnum}
+     * @memberof PostEmailAssetUpload
+     */
+    contentType: PostEmailAssetUploadContentTypeEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof PostEmailAssetUpload
+     */
+    byteSize: number;
+}
+/**
+ * @export
+ */
+export declare const PostEmailAssetUploadContentTypeEnum: {
+    readonly ImagePng: "image/png";
+    readonly ImageJpeg: "image/jpeg";
+    readonly ImageWebp: "image/webp";
+    readonly ImageGif: "image/gif";
+};
+export type PostEmailAssetUploadContentTypeEnum = typeof PostEmailAssetUploadContentTypeEnum[keyof typeof PostEmailAssetUploadContentTypeEnum];
+/**
+ * Check if a given object implements the PostEmailAssetUpload interface.
+ */
+export declare function instanceOfPostEmailAssetUpload(value: object): value is PostEmailAssetUpload;
+export declare function PostEmailAssetUploadFromJSON(json: any): PostEmailAssetUpload;
+export declare function PostEmailAssetUploadFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostEmailAssetUpload;
+export declare function PostEmailAssetUploadToJSON(json: any): PostEmailAssetUpload;
+export declare function PostEmailAssetUploadToJSONTyped(value?: PostEmailAssetUpload | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PostEmailAssetUpload.js

@@ -0,0 +1,60 @@
+/* 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 PostEmailAssetUploadContentTypeEnum = {
+    ImagePng: 'image/png',
+    ImageJpeg: 'image/jpeg',
+    ImageWebp: 'image/webp',
+    ImageGif: 'image/gif'
+};
+/**
+ * Check if a given object implements the PostEmailAssetUpload interface.
+ */
+export function instanceOfPostEmailAssetUpload(value) {
+    if (!('filename' in value) || value['filename'] === undefined)
+        return false;
+    if (!('contentType' in value) || value['contentType'] === undefined)
+        return false;
+    if (!('byteSize' in value) || value['byteSize'] === undefined)
+        return false;
+    return true;
+}
+export function PostEmailAssetUploadFromJSON(json) {
+    return PostEmailAssetUploadFromJSONTyped(json, false);
+}
+export function PostEmailAssetUploadFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'filename': json['filename'],
+        'contentType': json['content_type'],
+        'byteSize': json['byte_size'],
+    };
+}
+export function PostEmailAssetUploadToJSON(json) {
+    return PostEmailAssetUploadToJSONTyped(json, false);
+}
+export function PostEmailAssetUploadToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'filename': value['filename'],
+        'content_type': value['contentType'],
+        'byte_size': value['byteSize'],
+    };
+}

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

@@ -0,0 +1,64 @@
+/**
+ * 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 PostEmailTemplatePreview
+ */
+export interface PostEmailTemplatePreview {
+    /**
+     *
+     * @type {string}
+     * @memberof PostEmailTemplatePreview
+     */
+    subjectTemplate: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PostEmailTemplatePreview
+     */
+    preheaderTemplate?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PostEmailTemplatePreview
+     */
+    fromNameTemplate?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PostEmailTemplatePreview
+     */
+    replyTo?: string | null;
+    /**
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof PostEmailTemplatePreview
+     */
+    designDocument: {
+        [key: string]: any;
+    };
+    /**
+     *
+     * @type {string}
+     * @memberof PostEmailTemplatePreview
+     */
+    changeNotes?: string | null;
+}
+/**
+ * Check if a given object implements the PostEmailTemplatePreview interface.
+ */
+export declare function instanceOfPostEmailTemplatePreview(value: object): value is PostEmailTemplatePreview;
+export declare function PostEmailTemplatePreviewFromJSON(json: any): PostEmailTemplatePreview;
+export declare function PostEmailTemplatePreviewFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostEmailTemplatePreview;
+export declare function PostEmailTemplatePreviewToJSON(json: any): PostEmailTemplatePreview;
+export declare function PostEmailTemplatePreviewToJSONTyped(value?: PostEmailTemplatePreview | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PostEmailTemplatePreview.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 PostEmailTemplatePreview interface.
+ */
+export function instanceOfPostEmailTemplatePreview(value) {
+    if (!('subjectTemplate' in value) || value['subjectTemplate'] === undefined)
+        return false;
+    if (!('designDocument' in value) || value['designDocument'] === undefined)
+        return false;
+    return true;
+}
+export function PostEmailTemplatePreviewFromJSON(json) {
+    return PostEmailTemplatePreviewFromJSONTyped(json, false);
+}
+export function PostEmailTemplatePreviewFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'subjectTemplate': json['subject_template'],
+        'preheaderTemplate': json['preheader_template'] == null ? undefined : json['preheader_template'],
+        'fromNameTemplate': json['from_name_template'] == null ? undefined : json['from_name_template'],
+        'replyTo': json['reply_to'] == null ? undefined : json['reply_to'],
+        'designDocument': json['design_document'],
+        'changeNotes': json['change_notes'] == null ? undefined : json['change_notes'],
+    };
+}
+export function PostEmailTemplatePreviewToJSON(json) {
+    return PostEmailTemplatePreviewToJSONTyped(json, false);
+}
+export function PostEmailTemplatePreviewToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'subject_template': value['subjectTemplate'],
+        'preheader_template': value['preheaderTemplate'],
+        'from_name_template': value['fromNameTemplate'],
+        'reply_to': value['replyTo'],
+        'design_document': value['designDocument'],
+        'change_notes': value['changeNotes'],
+    };
+}

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

@@ -0,0 +1,32 @@
+/**
+ * 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 PostEmailTemplateTestSend
+ */
+export interface PostEmailTemplateTestSend {
+    /**
+     *
+     * @type {string}
+     * @memberof PostEmailTemplateTestSend
+     */
+    recipient: string;
+}
+/**
+ * Check if a given object implements the PostEmailTemplateTestSend interface.
+ */
+export declare function instanceOfPostEmailTemplateTestSend(value: object): value is PostEmailTemplateTestSend;
+export declare function PostEmailTemplateTestSendFromJSON(json: any): PostEmailTemplateTestSend;
+export declare function PostEmailTemplateTestSendFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostEmailTemplateTestSend;
+export declare function PostEmailTemplateTestSendToJSON(json: any): PostEmailTemplateTestSend;
+export declare function PostEmailTemplateTestSendToJSONTyped(value?: PostEmailTemplateTestSend | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PostEmailTemplateTestSend.js

@@ -0,0 +1,43 @@
+/* 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 PostEmailTemplateTestSend interface.
+ */
+export function instanceOfPostEmailTemplateTestSend(value) {
+    if (!('recipient' in value) || value['recipient'] === undefined)
+        return false;
+    return true;
+}
+export function PostEmailTemplateTestSendFromJSON(json) {
+    return PostEmailTemplateTestSendFromJSONTyped(json, false);
+}
+export function PostEmailTemplateTestSendFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'recipient': json['recipient'],
+    };
+}
+export function PostEmailTemplateTestSendToJSON(json) {
+    return PostEmailTemplateTestSendToJSONTyped(json, false);
+}
+export function PostEmailTemplateTestSendToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'recipient': value['recipient'],
+    };
+}

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

@@ -0,0 +1,64 @@
+/**
+ * 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 PutEmailTemplateDraft
+ */
+export interface PutEmailTemplateDraft {
+    /**
+     *
+     * @type {string}
+     * @memberof PutEmailTemplateDraft
+     */
+    subjectTemplate: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PutEmailTemplateDraft
+     */
+    preheaderTemplate?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PutEmailTemplateDraft
+     */
+    fromNameTemplate?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PutEmailTemplateDraft
+     */
+    replyTo?: string | null;
+    /**
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof PutEmailTemplateDraft
+     */
+    designDocument: {
+        [key: string]: any;
+    };
+    /**
+     *
+     * @type {string}
+     * @memberof PutEmailTemplateDraft
+     */
+    changeNotes?: string | null;
+}
+/**
+ * Check if a given object implements the PutEmailTemplateDraft interface.
+ */
+export declare function instanceOfPutEmailTemplateDraft(value: object): value is PutEmailTemplateDraft;
+export declare function PutEmailTemplateDraftFromJSON(json: any): PutEmailTemplateDraft;
+export declare function PutEmailTemplateDraftFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutEmailTemplateDraft;
+export declare function PutEmailTemplateDraftToJSON(json: any): PutEmailTemplateDraft;
+export declare function PutEmailTemplateDraftToJSONTyped(value?: PutEmailTemplateDraft | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PutEmailTemplateDraft.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 PutEmailTemplateDraft interface.
+ */
+export function instanceOfPutEmailTemplateDraft(value) {
+    if (!('subjectTemplate' in value) || value['subjectTemplate'] === undefined)
+        return false;
+    if (!('designDocument' in value) || value['designDocument'] === undefined)
+        return false;
+    return true;
+}
+export function PutEmailTemplateDraftFromJSON(json) {
+    return PutEmailTemplateDraftFromJSONTyped(json, false);
+}
+export function PutEmailTemplateDraftFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'subjectTemplate': json['subject_template'],
+        'preheaderTemplate': json['preheader_template'] == null ? undefined : json['preheader_template'],
+        'fromNameTemplate': json['from_name_template'] == null ? undefined : json['from_name_template'],
+        'replyTo': json['reply_to'] == null ? undefined : json['reply_to'],
+        'designDocument': json['design_document'],
+        'changeNotes': json['change_notes'] == null ? undefined : json['change_notes'],
+    };
+}
+export function PutEmailTemplateDraftToJSON(json) {
+    return PutEmailTemplateDraftToJSONTyped(json, false);
+}
+export function PutEmailTemplateDraftToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'subject_template': value['subjectTemplate'],
+        'preheader_template': value['preheaderTemplate'],
+        'from_name_template': value['fromNameTemplate'],
+        'reply_to': value['replyTo'],
+        'design_document': value['designDocument'],
+        'change_notes': value['changeNotes'],
+    };
+}

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

@@ -13,6 +13,10 @@ export * from './CriteriaBasedSelection';
 export * from './CriteriaBasedSelectionCriteria';
 export * from './CriteriaBasedSelectionDistribution';
 export * from './EffectiveCertificateConfig';
+export * from './EmailTemplateDefinition';
+export * from './EmailTemplateScope';
+export * from './EmailTemplateVariable';
+export * from './EmailTemplateVersion';
 export * from './Essay';
 export * from './Essay1';
 export * from './FillInBlank';
@@ -68,6 +72,12 @@ export * from './GetCourseVersionItemLaunch';
 export * from './GetCourseVersionItemSession';
 export * from './GetCourseVersionList';
 export * from './GetCourseVersionModule';
+export * from './GetEmailAssetUpload';
+export * from './GetEmailDelivery';
+export * from './GetEmailDeliveryList';
+export * from './GetEmailTemplate';
+export * from './GetEmailTemplateList';
+export * from './GetEmailTemplatePreview';
 export * from './GetManualQuestionSelectionItem';
 export * from './GetManualQuestionSelectionList';
 export * from './GetModule';
@@ -223,6 +233,10 @@ export * from './PostCourseVersionPublish';
 export * from './PostDuplicate';
 export * from './PostDuplicate1';
 export * from './PostDuplicate2';
+export * from './PostEmailAssetComplete';
+export * from './PostEmailAssetUpload';
+export * from './PostEmailTemplatePreview';
+export * from './PostEmailTemplateTestSend';
 export * from './PostLogin';
 export * from './PostManualQuestionSelection';
 export * from './PostMessage';
@@ -276,6 +290,7 @@ export * from './PutCourse';
 export * from './PutCourseCatalog';
 export * from './PutCourseEnrollment';
 export * from './PutCourseVersionItem';
+export * from './PutEmailTemplateDraft';
 export * from './PutModule';
 export * from './PutModuleReorder';
 export * from './PutPortalBranding';

package/dist/esm/models/index.js

@@ -15,6 +15,10 @@ export * from './CriteriaBasedSelection';
 export * from './CriteriaBasedSelectionCriteria';
 export * from './CriteriaBasedSelectionDistribution';
 export * from './EffectiveCertificateConfig';
+export * from './EmailTemplateDefinition';
+export * from './EmailTemplateScope';
+export * from './EmailTemplateVariable';
+export * from './EmailTemplateVersion';
 export * from './Essay';
 export * from './Essay1';
 export * from './FillInBlank';
@@ -70,6 +74,12 @@ export * from './GetCourseVersionItemLaunch';
 export * from './GetCourseVersionItemSession';
 export * from './GetCourseVersionList';
 export * from './GetCourseVersionModule';
+export * from './GetEmailAssetUpload';
+export * from './GetEmailDelivery';
+export * from './GetEmailDeliveryList';
+export * from './GetEmailTemplate';
+export * from './GetEmailTemplateList';
+export * from './GetEmailTemplatePreview';
 export * from './GetManualQuestionSelectionItem';
 export * from './GetManualQuestionSelectionList';
 export * from './GetModule';
@@ -225,6 +235,10 @@ export * from './PostCourseVersionPublish';
 export * from './PostDuplicate';
 export * from './PostDuplicate1';
 export * from './PostDuplicate2';
+export * from './PostEmailAssetComplete';
+export * from './PostEmailAssetUpload';
+export * from './PostEmailTemplatePreview';
+export * from './PostEmailTemplateTestSend';
 export * from './PostLogin';
 export * from './PostManualQuestionSelection';
 export * from './PostMessage';
@@ -278,6 +292,7 @@ export * from './PutCourse';
 export * from './PutCourseCatalog';
 export * from './PutCourseEnrollment';
 export * from './PutCourseVersionItem';
+export * from './PutEmailTemplateDraft';
 export * from './PutModule';
 export * from './PutModuleReorder';
 export * from './PutPortalBranding';

package/dist/models/EmailTemplateDefinition.d.ts

@@ -0,0 +1,64 @@
+/**
+ * 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 { EmailTemplateVariable } from './EmailTemplateVariable';
+import type { EmailTemplateScope } from './EmailTemplateScope';
+/**
+ *
+ * @export
+ * @interface EmailTemplateDefinition
+ */
+export interface EmailTemplateDefinition {
+    /**
+     *
+     * @type {string}
+     * @memberof EmailTemplateDefinition
+     */
+    key: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EmailTemplateDefinition
+     */
+    displayName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EmailTemplateDefinition
+     */
+    description: string;
+    /**
+     *
+     * @type {EmailTemplateScope}
+     * @memberof EmailTemplateDefinition
+     */
+    scope: EmailTemplateScope;
+    /**
+     *
+     * @type {Array<EmailTemplateVariable>}
+     * @memberof EmailTemplateDefinition
+     */
+    variables: Array<EmailTemplateVariable>;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof EmailTemplateDefinition
+     */
+    requiredBlockTypes: Array<string>;
+}
+/**
+ * Check if a given object implements the EmailTemplateDefinition interface.
+ */
+export declare function instanceOfEmailTemplateDefinition(value: object): value is EmailTemplateDefinition;
+export declare function EmailTemplateDefinitionFromJSON(json: any): EmailTemplateDefinition;
+export declare function EmailTemplateDefinitionFromJSONTyped(json: any, ignoreDiscriminator: boolean): EmailTemplateDefinition;
+export declare function EmailTemplateDefinitionToJSON(json: any): EmailTemplateDefinition;
+export declare function EmailTemplateDefinitionToJSONTyped(value?: EmailTemplateDefinition | null, ignoreDiscriminator?: boolean): any;