@easyedu/js-lsm-api 1.84.0 → 1.85.0

package/src/apis/index.ts

@@ -8,6 +8,7 @@ export * from './CourseApi';
 export * from './CourseCatalogApi';
 export * from './CourseShareApi';
 export * from './DispatchApi';
+export * from './EmailTemplateApi';
 export * from './ModuleApi';
 export * from './OtherApi';
 export * from './PlayerApi';

package/src/models/EmailTemplateDefinition.ts

@@ -0,0 +1,128 @@
+/* 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 { EmailTemplateVariable } from './EmailTemplateVariable';
+import {
+    EmailTemplateVariableFromJSON,
+    EmailTemplateVariableFromJSONTyped,
+    EmailTemplateVariableToJSON,
+    EmailTemplateVariableToJSONTyped,
+} from './EmailTemplateVariable';
+import type { EmailTemplateScope } from './EmailTemplateScope';
+import {
+    EmailTemplateScopeFromJSON,
+    EmailTemplateScopeFromJSONTyped,
+    EmailTemplateScopeToJSON,
+    EmailTemplateScopeToJSONTyped,
+} 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 function instanceOfEmailTemplateDefinition(value: object): value is EmailTemplateDefinition {
+    if (!('key' in value) || value['key'] === undefined) return false;
+    if (!('displayName' in value) || value['displayName'] === undefined) return false;
+    if (!('description' in value) || value['description'] === undefined) return false;
+    if (!('scope' in value) || value['scope'] === undefined) return false;
+    if (!('variables' in value) || value['variables'] === undefined) return false;
+    if (!('requiredBlockTypes' in value) || value['requiredBlockTypes'] === undefined) return false;
+    return true;
+}
+
+export function EmailTemplateDefinitionFromJSON(json: any): EmailTemplateDefinition {
+    return EmailTemplateDefinitionFromJSONTyped(json, false);
+}
+
+export function EmailTemplateDefinitionFromJSONTyped(json: any, ignoreDiscriminator: boolean): EmailTemplateDefinition {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'key': json['key'],
+        'displayName': json['display_name'],
+        'description': json['description'],
+        'scope': EmailTemplateScopeFromJSON(json['scope']),
+        'variables': ((json['variables'] as Array<any>).map(EmailTemplateVariableFromJSON)),
+        'requiredBlockTypes': json['required_block_types'],
+    };
+}
+
+export function EmailTemplateDefinitionToJSON(json: any): EmailTemplateDefinition {
+    return EmailTemplateDefinitionToJSONTyped(json, false);
+}
+
+export function EmailTemplateDefinitionToJSONTyped(value?: EmailTemplateDefinition | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'key': value['key'],
+        'display_name': value['displayName'],
+        'description': value['description'],
+        'scope': EmailTemplateScopeToJSON(value['scope']),
+        'variables': ((value['variables'] as Array<any>).map(EmailTemplateVariableToJSON)),
+        'required_block_types': value['requiredBlockTypes'],
+    };
+}
+

package/src/models/EmailTemplateScope.ts

@@ -0,0 +1,53 @@
+/* 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 EmailTemplateScope = {
+    PlatformOnly: 'platform_only',
+    PortalOverridable: 'portal_overridable'
+} as const;
+export type EmailTemplateScope = typeof EmailTemplateScope[keyof typeof EmailTemplateScope];
+
+
+export function instanceOfEmailTemplateScope(value: any): boolean {
+    for (const key in EmailTemplateScope) {
+        if (Object.prototype.hasOwnProperty.call(EmailTemplateScope, key)) {
+            if (EmailTemplateScope[key as keyof typeof EmailTemplateScope] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function EmailTemplateScopeFromJSON(json: any): EmailTemplateScope {
+    return EmailTemplateScopeFromJSONTyped(json, false);
+}
+
+export function EmailTemplateScopeFromJSONTyped(json: any, ignoreDiscriminator: boolean): EmailTemplateScope {
+    return json as EmailTemplateScope;
+}
+
+export function EmailTemplateScopeToJSON(value?: EmailTemplateScope | null): any {
+    return value as any;
+}
+
+export function EmailTemplateScopeToJSONTyped(value: any, ignoreDiscriminator: boolean): EmailTemplateScope {
+    return value as EmailTemplateScope;
+}
+

package/src/models/EmailTemplateVariable.ts

@@ -0,0 +1,105 @@
+/* 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 EmailTemplateVariable
+ */
+export interface EmailTemplateVariable {
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailTemplateVariable
+     */
+    key: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailTemplateVariable
+     */
+    description: string;
+    /**
+     * 
+     * @type {EmailTemplateVariableValueTypeEnum}
+     * @memberof EmailTemplateVariable
+     */
+    valueType: EmailTemplateVariableValueTypeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailTemplateVariable
+     */
+    sampleValue: string;
+}
+
+
+/**
+ * @export
+ */
+export const EmailTemplateVariableValueTypeEnum = {
+    String: 'string',
+    Url: 'url',
+    Datetime: 'datetime'
+} as const;
+export type EmailTemplateVariableValueTypeEnum = typeof EmailTemplateVariableValueTypeEnum[keyof typeof EmailTemplateVariableValueTypeEnum];
+
+
+/**
+ * Check if a given object implements the EmailTemplateVariable interface.
+ */
+export function instanceOfEmailTemplateVariable(value: object): value is EmailTemplateVariable {
+    if (!('key' in value) || value['key'] === undefined) return false;
+    if (!('description' in value) || value['description'] === undefined) return false;
+    if (!('valueType' in value) || value['valueType'] === undefined) return false;
+    if (!('sampleValue' in value) || value['sampleValue'] === undefined) return false;
+    return true;
+}
+
+export function EmailTemplateVariableFromJSON(json: any): EmailTemplateVariable {
+    return EmailTemplateVariableFromJSONTyped(json, false);
+}
+
+export function EmailTemplateVariableFromJSONTyped(json: any, ignoreDiscriminator: boolean): EmailTemplateVariable {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'key': json['key'],
+        'description': json['description'],
+        'valueType': json['value_type'],
+        'sampleValue': json['sample_value'],
+    };
+}
+
+export function EmailTemplateVariableToJSON(json: any): EmailTemplateVariable {
+    return EmailTemplateVariableToJSONTyped(json, false);
+}
+
+export function EmailTemplateVariableToJSONTyped(value?: EmailTemplateVariable | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'key': value['key'],
+        'description': value['description'],
+        'value_type': value['valueType'],
+        'sample_value': value['sampleValue'],
+    };
+}
+

package/src/models/EmailTemplateVersion.ts

@@ -0,0 +1,173 @@
+/* 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 EmailTemplateVersion
+ */
+export interface EmailTemplateVersion {
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailTemplateVersion
+     */
+    id: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof EmailTemplateVersion
+     */
+    versionNumber: number;
+    /**
+     * 
+     * @type {EmailTemplateVersionStatusEnum}
+     * @memberof EmailTemplateVersion
+     */
+    status: EmailTemplateVersionStatusEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailTemplateVersion
+     */
+    subjectTemplate: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailTemplateVersion
+     */
+    preheaderTemplate?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailTemplateVersion
+     */
+    fromNameTemplate?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailTemplateVersion
+     */
+    replyTo?: string | null;
+    /**
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof EmailTemplateVersion
+     */
+    designDocument: { [key: string]: any; };
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailTemplateVersion
+     */
+    changeNotes?: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof EmailTemplateVersion
+     */
+    createdAt: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof EmailTemplateVersion
+     */
+    updatedAt: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof EmailTemplateVersion
+     */
+    publishedAt?: number | null;
+}
+
+
+/**
+ * @export
+ */
+export const EmailTemplateVersionStatusEnum = {
+    Draft: 'draft',
+    Published: 'published',
+    Archived: 'archived',
+    System: 'system'
+} as const;
+export type EmailTemplateVersionStatusEnum = typeof EmailTemplateVersionStatusEnum[keyof typeof EmailTemplateVersionStatusEnum];
+
+
+/**
+ * Check if a given object implements the EmailTemplateVersion interface.
+ */
+export function instanceOfEmailTemplateVersion(value: object): value is EmailTemplateVersion {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('versionNumber' in value) || value['versionNumber'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('subjectTemplate' in value) || value['subjectTemplate'] === undefined) return false;
+    if (!('designDocument' in value) || value['designDocument'] === 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 EmailTemplateVersionFromJSON(json: any): EmailTemplateVersion {
+    return EmailTemplateVersionFromJSONTyped(json, false);
+}
+
+export function EmailTemplateVersionFromJSONTyped(json: any, ignoreDiscriminator: boolean): EmailTemplateVersion {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'versionNumber': json['version_number'],
+        'status': json['status'],
+        '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'],
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+        'publishedAt': json['published_at'] == null ? undefined : json['published_at'],
+    };
+}
+
+export function EmailTemplateVersionToJSON(json: any): EmailTemplateVersion {
+    return EmailTemplateVersionToJSONTyped(json, false);
+}
+
+export function EmailTemplateVersionToJSONTyped(value?: EmailTemplateVersion | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'version_number': value['versionNumber'],
+        'status': value['status'],
+        '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'],
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+        'published_at': value['publishedAt'],
+    };
+}
+

package/src/models/GetEmailAssetUpload.ts

@@ -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.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface GetEmailAssetUpload
+ */
+export interface GetEmailAssetUpload {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetEmailAssetUpload
+     */
+    assetId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetEmailAssetUpload
+     */
+    uploadUrl: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetEmailAssetUpload
+     */
+    publicUrl: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetEmailAssetUpload
+     */
+    status: string;
+}
+
+/**
+ * Check if a given object implements the GetEmailAssetUpload interface.
+ */
+export function instanceOfGetEmailAssetUpload(value: object): value is GetEmailAssetUpload {
+    if (!('assetId' in value) || value['assetId'] === undefined) return false;
+    if (!('uploadUrl' in value) || value['uploadUrl'] === undefined) return false;
+    if (!('publicUrl' in value) || value['publicUrl'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    return true;
+}
+
+export function GetEmailAssetUploadFromJSON(json: any): GetEmailAssetUpload {
+    return GetEmailAssetUploadFromJSONTyped(json, false);
+}
+
+export function GetEmailAssetUploadFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetEmailAssetUpload {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'assetId': json['asset_id'],
+        'uploadUrl': json['upload_url'],
+        'publicUrl': json['public_url'],
+        'status': json['status'],
+    };
+}
+
+export function GetEmailAssetUploadToJSON(json: any): GetEmailAssetUpload {
+    return GetEmailAssetUploadToJSONTyped(json, false);
+}
+
+export function GetEmailAssetUploadToJSONTyped(value?: GetEmailAssetUpload | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'asset_id': value['assetId'],
+        'upload_url': value['uploadUrl'],
+        'public_url': value['publicUrl'],
+        'status': value['status'],
+    };
+}
+