@d19n/youfibre-odin-sdk 1.0.312 → 1.0.314

package/README.md

@@ -347,7 +347,7 @@ This SDK includes **159** entities across **12** modules.
 
 ## Actions
 
-This SDK includes **499** actions.
+This SDK includes **500** actions.
 
 ### Action Types
 
@@ -1468,6 +1468,7 @@ This SDK includes **499** actions.
 | Action | Type | Event |
 |--------|------|-------|
 | `CreateTransactionalEmail` | CREATE | NotificationModule.Email.Create.CreateTransactionalEmail |
+| `UpdateEmail` | UPDATE | NotificationModule.Email.Update.UpdateEmail |
 | `UpdateSupportEmail` | UPDATE | NotificationModule.Email.Update.Update Support Email |
 
 #### WayleaveAudit

package/dist/actions-v2/CreateTransactionalEmailDto.d.ts

@@ -23,7 +23,7 @@ export interface CreateTransactionalEmailMessage extends OdinRecordCreatedEvent<
  * Properties for CreateTransactionalEmail action
  *
  * @property Required fields: 1
- * @property Optional fields: 16
+ * @property Optional fields: 17
  */
 export interface CreateTransactionalEmailProperties {
     /**
@@ -146,6 +146,13 @@ export interface CreateTransactionalEmailProperties {
      * @type {TEXT}
      */
     Subject?: string | null;
+    /**
+     * Status
+     *
+     * Status of the email in the process
+     * @type {ENUM}
+     */
+    Status?: string | null;
 }
 /**
  * CreateTransactionalEmail

package/dist/actions-v2/UpdateEmailDto.d.ts

@@ -0,0 +1,192 @@
+/**
+ * UpdateEmail Action DTO
+ *
+ * Update Email entity
+ *
+ * @module NotificationModule
+ * @entity Email
+ * @actionKey UpdateEmail
+ * @event 8443898e-c0db-4ce4-a0c4-4ae8e39d312f.NotificationModule.Email.Update.UpdateEmail
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
+/**
+ * RabbitMQ message payload for UpdateEmail updated events
+ *
+ * @event NotificationModule.Email.Update.UpdateEmail
+ */
+export interface UpdateEmailMessage extends OdinRecordUpdatedEvent<UpdateEmailDto, UpdateEmailProperties> {
+}
+/**
+ * Properties for UpdateEmail action
+ *
+ * @property Required fields: 1
+ * @property Optional fields: 17
+ */
+export interface UpdateEmailProperties {
+    /**
+     * Date
+     *
+     * Date field for Email records. Used by Communications team.
+     * @type {DATE_TIME}
+     * @required
+     */
+    Date: string;
+    /**
+     * Status
+     *
+     * Status of the email in the process
+     * @type {ENUM}
+     */
+    Status?: string | null;
+    /**
+     * Case
+     *
+     * Data field for Email records. Used by Communications team.
+     * @type {LOOKUP}
+     */
+    Case?: string | null;
+    /**
+     * SenderType
+     *
+     * Sender Type (Communications - Email)
+     * @type {ENUM}
+     */
+    SenderType?: string | null;
+    /**
+     * Bcc
+     *
+     * Blind Carbon Copy (Communications - Email)
+     * @type {TEXT}
+     */
+    Bcc?: string | null;
+    /**
+     * UpdatedAt
+     *
+     * When the email was updated (Communications - Email)
+     * @type {DATE_TIME}
+     */
+    UpdatedAt?: string | null;
+    /**
+     * Files
+     *
+     * email attachments (Communications - Email)
+     * @type {FILE_MULTIPLE}
+     */
+    Files?: undefined | null;
+    /**
+     * From
+     *
+     * Data field for Email records. Used by Communications team.
+     * @type {TEXT}
+     */
+    From?: string | null;
+    /**
+     * MessageId
+     *
+     * SMTP Message Id (Communications - Email)
+     * @type {TEXT}
+     */
+    MessageId?: string | null;
+    /**
+     * Message
+     *
+     * Data field for Email records. Used by Communications team.
+     * @type {TEXT}
+     */
+    Message?: string | null;
+    /**
+     * ParentMessageId
+     *
+     * Parent Message id (Communications - Email)
+     * @type {LOOKUP}
+     */
+    ParentMessageId?: string | null;
+    /**
+     * CreatedAt
+     *
+     * When the email was created (Communications - Email)
+     * @type {DATE_TIME}
+     */
+    CreatedAt?: string | null;
+    /**
+     * Envelope
+     *
+     * Data field for Email records. Used by Communications team.
+     * @type {JSON}
+     */
+    Envelope?: string | null;
+    /**
+     * InReplyTo
+     *
+     * In Reply To (Communications - Email)
+     * @type {TEXT}
+     */
+    InReplyTo?: string | null;
+    /**
+     * To
+     *
+     * Data field for Email records. Used by Communications team.
+     * @type {TEXT}
+     */
+    To?: string | null;
+    /**
+     * Cc
+     *
+     * Carbon Copy (Communications - Email)
+     * @type {TEXT}
+     */
+    Cc?: string | null;
+    /**
+     * FormattedMessage
+     *
+     * Formatted Message (Communications - Email)
+     * @type {HTML}
+     */
+    FormattedMessage?: string | null;
+    /**
+     * Subject
+     *
+     * Data field for Email records. Used by Communications team.
+     * @type {TEXT}
+     */
+    Subject?: string | null;
+}
+/**
+ * UpdateEmail
+ *
+ * Update Email entity
+ *
+ * @actionType UPDATE - Updates an existing Email record
+ * @module NotificationModule
+ * @entity Email
+ * @event NotificationModule.Email.Update.UpdateEmail
+ * @permission schema.action.updateemail.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+export declare class UpdateEmailDto extends OdinRecordUpdateDto<UpdateEmailProperties> {
+    /** Used by SDK generators to identify action type */
+    static readonly ACTION_TYPE = "UPDATE";
+    static readonly ACTION_KEY = "UpdateEmail";
+    static readonly MODULE_NAME = "NotificationModule";
+    static readonly ENTITIES: string[];
+    static readonly EVENT_NAME = "NotificationModule.Email.Update.UpdateEmail";
+    static readonly PERMISSION = "schema.action.updateemail.trigger";
+    /** Step metadata - entity this action targets */
+    static readonly STEP_ENTITY = "NotificationModule:Email";
+    static readonly STEP_SCHEMA_ID = "a3b4d6b7-0647-4202-90a6-036e3c87c5ae";
+    static readonly STEP_SCHEMA_ACTION_ID = "114cc01f-fa99-4c1d-86d5-a0d7d3bc284e";
+    static readonly AUTO_LINK_PARENT = false;
+    readonly actionName: string;
+    readonly schemaActionId: string;
+    readonly entity: string;
+    constructor(record: OdinRecord<any> | {
+        id: string;
+        entity: string;
+        type?: string;
+    }, properties: UpdateEmailProperties, options?: {
+        journeyId?: string;
+        stageKey?: string;
+    });
+}

package/dist/actions-v2/UpdateEmailDto.js

@@ -0,0 +1,56 @@
+"use strict";
+/**
+ * UpdateEmail Action DTO
+ *
+ * Update Email entity
+ *
+ * @module NotificationModule
+ * @entity Email
+ * @actionKey UpdateEmail
+ * @event 8443898e-c0db-4ce4-a0c4-4ae8e39d312f.NotificationModule.Email.Update.UpdateEmail
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdateEmailDto = void 0;
+const core_1 = require("@d19n/odin-types/dist/core");
+/**
+ * UpdateEmail
+ *
+ * Update Email entity
+ *
+ * @actionType UPDATE - Updates an existing Email record
+ * @module NotificationModule
+ * @entity Email
+ * @event NotificationModule.Email.Update.UpdateEmail
+ * @permission schema.action.updateemail.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+class UpdateEmailDto extends core_1.OdinRecordUpdateDto {
+    constructor(record, properties, options) {
+        super({
+            id: record.id,
+            entity: record.entity,
+            type: record.type,
+            properties,
+            journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
+            stageKey: options === null || options === void 0 ? void 0 : options.stageKey,
+        });
+        this.actionName = 'UpdateEmail';
+        this.schemaActionId = '114cc01f-fa99-4c1d-86d5-a0d7d3bc284e';
+        this.entity = 'NotificationModule:Email';
+    }
+}
+exports.UpdateEmailDto = UpdateEmailDto;
+/** Used by SDK generators to identify action type */
+UpdateEmailDto.ACTION_TYPE = 'UPDATE';
+UpdateEmailDto.ACTION_KEY = 'UpdateEmail';
+UpdateEmailDto.MODULE_NAME = 'NotificationModule';
+UpdateEmailDto.ENTITIES = ['Email'];
+UpdateEmailDto.EVENT_NAME = 'NotificationModule.Email.Update.UpdateEmail';
+UpdateEmailDto.PERMISSION = 'schema.action.updateemail.trigger';
+/** Step metadata - entity this action targets */
+UpdateEmailDto.STEP_ENTITY = 'NotificationModule:Email';
+UpdateEmailDto.STEP_SCHEMA_ID = 'a3b4d6b7-0647-4202-90a6-036e3c87c5ae';
+UpdateEmailDto.STEP_SCHEMA_ACTION_ID = '114cc01f-fa99-4c1d-86d5-a0d7d3bc284e';
+UpdateEmailDto.AUTO_LINK_PARENT = false;

package/dist/records-v2/EmailRecord.d.ts

@@ -21,6 +21,7 @@ import { IOdinProvider } from '@d19n/odin-sdk-generator/dist/odin-sdk-types';
 import { RecordLinkManager } from '@d19n/odin-sdk-generator/dist/record-link-manager';
 import { EmailProperties, SupportEmailProperties, TransactionalEmailProperties } from '../entities-v2/Email';
 import { CreateTransactionalEmailProperties } from '../actions-v2/CreateTransactionalEmailDto';
+import { UpdateEmailProperties } from '../actions-v2/UpdateEmailDto';
 import { UpdateSupportEmailProperties } from '../actions-v2/UpdateSupportEmailDto';
 import { UserRecord } from './UserRecord';
 import { CaseRecord } from './CaseRecord';
@@ -229,6 +230,28 @@ export declare class EmailRecord<TProps = EmailProperties> {
         journeyId?: string;
         stageKey?: string;
     }): Promise<IDbRecordCreateUpdateRes[]>;
+    /**
+     * UpdateEmail
+     *
+     * Updates this Email record with the specified properties.
+     *
+     * @param properties - Required properties for this action
+     * @param options - Optional settings
+     * @param options.journeyId - Associate with a journey
+     * @param options.stageKey - Transition to pipeline stage
+     * @returns The updated record(s)
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * const record = await odinClient.emails.get(id);
+     * await record.updateEmail({ ... });
+     * ```
+     */
+    updateEmail(properties: UpdateEmailProperties, options?: {
+        journeyId?: string;
+        stageKey?: string;
+    }): Promise<IDbRecordCreateUpdateRes[]>;
     /**
      * Update Support Email
      *

package/dist/records-v2/EmailRecord.js

@@ -316,6 +316,34 @@ class EmailRecord {
     // ============================================
     // UPDATE ACTIONS (require existing record)
     // ============================================
+    /**
+     * UpdateEmail
+     *
+     * Updates this Email record with the specified properties.
+     *
+     * @param properties - Required properties for this action
+     * @param options - Optional settings
+     * @param options.journeyId - Associate with a journey
+     * @param options.stageKey - Transition to pipeline stage
+     * @returns The updated record(s)
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * const record = await odinClient.emails.get(id);
+     * await record.updateEmail({ ... });
+     * ```
+     */
+    updateEmail(properties, options) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!((_a = this._record) === null || _a === void 0 ? void 0 : _a.id))
+                throw new Error('updateEmail requires an existing record. Use accessor.get() first.');
+            const result = yield this._provider._applyAction('NotificationModule', 'Email', Object.assign({ id: this._record.id, entity: this._record.entity, type: this._record.type, actionName: 'UpdateEmail', properties, associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined }, options));
+            this._pendingLinks = [];
+            return result;
+        });
+    }
     /**
      * Update Support Email
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@d19n/youfibre-odin-sdk",
-  "version": "1.0.312",
+  "version": "1.0.314",
   "description": "",
   "author": "@d19n",
   "license": "UNLICENSED",
@@ -11,7 +11,7 @@
     "typescript": "4.8.4"
   },
   "dependencies": {
-    "@d19n/odin-sdk-generator": "^3.0.206",
+    "@d19n/odin-sdk-generator": "^3.0.207",
     "@d19n/odin-types": "^3.0.23",
     "@d19n/youfibre-odin-sdk": "^1.0.219"
   },