@easyedu/js-lsm-api 1.84.0 → 1.85.0

package/src/models/GetEmailDelivery.ts

@@ -0,0 +1,192 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface GetEmailDelivery
+ */
+export interface GetEmailDelivery {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetEmailDelivery
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetEmailDelivery
+     */
+    templateKey: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetEmailDelivery
+     */
+    templateVersionId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetEmailDelivery
+     */
+    recipient: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof GetEmailDelivery
+     */
+    isTest: boolean;
+    /**
+     * 
+     * @type {GetEmailDeliveryStatusEnum}
+     * @memberof GetEmailDelivery
+     */
+    status: GetEmailDeliveryStatusEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetEmailDelivery
+     */
+    attempts: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetEmailDelivery
+     */
+    providerMessageId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetEmailDelivery
+     */
+    lastErrorCode?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetEmailDelivery
+     */
+    lastErrorMessage?: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetEmailDelivery
+     */
+    createdAt: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetEmailDelivery
+     */
+    acceptedAt?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetEmailDelivery
+     */
+    deliveredAt?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetEmailDelivery
+     */
+    failedAt?: number | null;
+}
+
+
+/**
+ * @export
+ */
+export const GetEmailDeliveryStatusEnum = {
+    Queued: 'queued',
+    Processing: 'processing',
+    Accepted: 'accepted',
+    Delivered: 'delivered',
+    Deferred: 'deferred',
+    Failed: 'failed',
+    Complained: 'complained'
+} as const;
+export type GetEmailDeliveryStatusEnum = typeof GetEmailDeliveryStatusEnum[keyof typeof GetEmailDeliveryStatusEnum];
+
+
+/**
+ * Check if a given object implements the GetEmailDelivery interface.
+ */
+export function instanceOfGetEmailDelivery(value: object): value is GetEmailDelivery {
+    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: any): GetEmailDelivery {
+    return GetEmailDeliveryFromJSONTyped(json, false);
+}
+
+export function GetEmailDeliveryFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetEmailDelivery {
+    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: any): GetEmailDelivery {
+    return GetEmailDeliveryToJSONTyped(json, false);
+}
+
+export function GetEmailDeliveryToJSONTyped(value?: GetEmailDelivery | null, ignoreDiscriminator: boolean = false): any {
+    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/src/models/GetEmailDeliveryList.ts

@@ -0,0 +1,101 @@
+/* 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 { mapValues } from '../runtime';
+import type { GetEmailDelivery } from './GetEmailDelivery';
+import {
+    GetEmailDeliveryFromJSON,
+    GetEmailDeliveryFromJSONTyped,
+    GetEmailDeliveryToJSON,
+    GetEmailDeliveryToJSONTyped,
+} 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 function instanceOfGetEmailDeliveryList(value: object): value is GetEmailDeliveryList {
+    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: any): GetEmailDeliveryList {
+    return GetEmailDeliveryListFromJSONTyped(json, false);
+}
+
+export function GetEmailDeliveryListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetEmailDeliveryList {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'items': ((json['items'] as Array<any>).map(GetEmailDeliveryFromJSON)),
+        'total': json['total'],
+        'page': json['page'],
+        'pageSize': json['page_size'],
+    };
+}
+
+export function GetEmailDeliveryListToJSON(json: any): GetEmailDeliveryList {
+    return GetEmailDeliveryListToJSONTyped(json, false);
+}
+
+export function GetEmailDeliveryListToJSONTyped(value?: GetEmailDeliveryList | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'items': ((value['items'] as Array<any>).map(GetEmailDeliveryToJSON)),
+        'total': value['total'],
+        'page': value['page'],
+        'page_size': value['pageSize'],
+    };
+}
+

package/src/models/GetEmailTemplate.ts

@@ -0,0 +1,137 @@
+/* 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 { mapValues } from '../runtime';
+import type { EmailTemplateDefinition } from './EmailTemplateDefinition';
+import {
+    EmailTemplateDefinitionFromJSON,
+    EmailTemplateDefinitionFromJSONTyped,
+    EmailTemplateDefinitionToJSON,
+    EmailTemplateDefinitionToJSONTyped,
+} from './EmailTemplateDefinition';
+import type { EmailTemplateVersion } from './EmailTemplateVersion';
+import {
+    EmailTemplateVersionFromJSON,
+    EmailTemplateVersionFromJSONTyped,
+    EmailTemplateVersionToJSON,
+    EmailTemplateVersionToJSONTyped,
+} 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 const GetEmailTemplateEffectiveSourceEnum = {
+    Portal: 'portal',
+    Ancestor: 'ancestor',
+    Platform: 'platform',
+    System: 'system'
+} as const;
+export type GetEmailTemplateEffectiveSourceEnum = typeof GetEmailTemplateEffectiveSourceEnum[keyof typeof GetEmailTemplateEffectiveSourceEnum];
+
+
+/**
+ * Check if a given object implements the GetEmailTemplate interface.
+ */
+export function instanceOfGetEmailTemplate(value: object): value is GetEmailTemplate {
+    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: any): GetEmailTemplate {
+    return GetEmailTemplateFromJSONTyped(json, false);
+}
+
+export function GetEmailTemplateFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetEmailTemplate {
+    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'] as Array<any>).map(EmailTemplateVersionFromJSON)),
+    };
+}
+
+export function GetEmailTemplateToJSON(json: any): GetEmailTemplate {
+    return GetEmailTemplateToJSONTyped(json, false);
+}
+
+export function GetEmailTemplateToJSONTyped(value?: GetEmailTemplate | null, ignoreDiscriminator: boolean = false): any {
+    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'] as Array<any>).map(EmailTemplateVersionToJSON)),
+    };
+}
+

package/src/models/GetEmailTemplateList.ts

@@ -0,0 +1,74 @@
+/* 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 { mapValues } from '../runtime';
+import type { GetEmailTemplate } from './GetEmailTemplate';
+import {
+    GetEmailTemplateFromJSON,
+    GetEmailTemplateFromJSONTyped,
+    GetEmailTemplateToJSON,
+    GetEmailTemplateToJSONTyped,
+} 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 function instanceOfGetEmailTemplateList(value: object): value is GetEmailTemplateList {
+    if (!('items' in value) || value['items'] === undefined) return false;
+    return true;
+}
+
+export function GetEmailTemplateListFromJSON(json: any): GetEmailTemplateList {
+    return GetEmailTemplateListFromJSONTyped(json, false);
+}
+
+export function GetEmailTemplateListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetEmailTemplateList {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'items': ((json['items'] as Array<any>).map(GetEmailTemplateFromJSON)),
+    };
+}
+
+export function GetEmailTemplateListToJSON(json: any): GetEmailTemplateList {
+    return GetEmailTemplateListToJSONTyped(json, false);
+}
+
+export function GetEmailTemplateListToJSONTyped(value?: GetEmailTemplateList | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'items': ((value['items'] as Array<any>).map(GetEmailTemplateToJSON)),
+    };
+}
+

package/src/models/GetEmailTemplatePreview.ts

@@ -0,0 +1,84 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * 
+ * @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 function instanceOfGetEmailTemplatePreview(value: object): value is GetEmailTemplatePreview {
+    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: any): GetEmailTemplatePreview {
+    return GetEmailTemplatePreviewFromJSONTyped(json, false);
+}
+
+export function GetEmailTemplatePreviewFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetEmailTemplatePreview {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'subject': json['subject'],
+        'html': json['html'],
+        'text': json['text'],
+    };
+}
+
+export function GetEmailTemplatePreviewToJSON(json: any): GetEmailTemplatePreview {
+    return GetEmailTemplatePreviewToJSONTyped(json, false);
+}
+
+export function GetEmailTemplatePreviewToJSONTyped(value?: GetEmailTemplatePreview | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'subject': value['subject'],
+        'html': value['html'],
+        'text': value['text'],
+    };
+}
+

package/src/models/PostEmailAssetComplete.ts

@@ -0,0 +1,66 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface PostEmailAssetComplete
+ */
+export interface PostEmailAssetComplete {
+    /**
+     * 
+     * @type {string}
+     * @memberof PostEmailAssetComplete
+     */
+    checksumSha256: string;
+}
+
+/**
+ * Check if a given object implements the PostEmailAssetComplete interface.
+ */
+export function instanceOfPostEmailAssetComplete(value: object): value is PostEmailAssetComplete {
+    if (!('checksumSha256' in value) || value['checksumSha256'] === undefined) return false;
+    return true;
+}
+
+export function PostEmailAssetCompleteFromJSON(json: any): PostEmailAssetComplete {
+    return PostEmailAssetCompleteFromJSONTyped(json, false);
+}
+
+export function PostEmailAssetCompleteFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostEmailAssetComplete {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'checksumSha256': json['checksum_sha256'],
+    };
+}
+
+export function PostEmailAssetCompleteToJSON(json: any): PostEmailAssetComplete {
+    return PostEmailAssetCompleteToJSONTyped(json, false);
+}
+
+export function PostEmailAssetCompleteToJSONTyped(value?: PostEmailAssetComplete | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'checksum_sha256': value['checksumSha256'],
+    };
+}
+