@d19n/youfibre-odin-sdk 2.0.246-beta.1 → 2.0.246-beta.2

package/README.md

@@ -360,7 +360,7 @@ This SDK includes **172** entities across **12** modules.
 
 ## Actions
 
-This SDK includes **759** actions.
+This SDK includes **760** actions.
 
 ### Action Types
 
@@ -1365,6 +1365,7 @@ This SDK includes **759** actions.
 | `CreatePreContractOrderSummary` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreatePreContractOrderSummary |
 | `CreateRecontractOrderConfirmation` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateRecontractOrderConfirmation |
 | `CreateRecontractReminderEmail` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateRecontractReminderEmail |
+| `CreateTransactionConfirmation` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateTransactionConfirmation |
 | `CreateTransactionalEmail` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateTransactionalEmail |
 | `SendDirectDebitCreatedEmail` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.SendDirectDebitCreatedEmail |
 | `SendDirectDebitFailedEmail` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.SendDirectDebitFailedEmail |

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

@@ -0,0 +1,135 @@
+/**
+ * CreateTransactionConfirmation Action DTO
+ *
+ * Send Transaction confirmation email
+ *
+ * @module NotificationModule
+ * @entity Email
+ * @entityType TRANSACTIONAL
+ * @actionKey CreateTransactionConfirmation
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateTransactionConfirmation
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+import { OdinRecordCreateDto, OdinRecordCreatedEvent } from '@d19n/odin-types/dist/core';
+/**
+ * RabbitMQ message payload for CreateTransactionConfirmation created events
+ *
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateTransactionConfirmation
+ */
+export interface CreateTransactionConfirmationMessage extends OdinRecordCreatedEvent<CreateTransactionConfirmationDto, CreateTransactionConfirmationProperties> {
+}
+/**
+ * Properties for CreateTransactionConfirmation action
+ *
+ * @property Required fields: 0
+ * @property Optional fields: 10
+ */
+export interface CreateTransactionConfirmationProperties {
+    /**
+     * Date
+     *
+     * Date field for Email records. Used by Communications team.
+     * @type {DATE_TIME}
+     */
+    Date?: string | null;
+    /**
+     * EmailingService
+     *
+     * The provider we use to send email (eg. Sendgrid)
+     * @type {ENUM}
+     */
+    EmailingService?: string | null;
+    /**
+     * ContactId
+     *
+     * The related Contact to send the email
+     * @type {LOOKUP}
+     */
+    ContactId?: string | null;
+    /**
+     * TemplateLabel
+     *
+     * The template label from email templates engine
+     * @type {TEXT}
+     */
+    TemplateLabel?: string | null;
+    /**
+     * MessageId
+     *
+     * SMTP Message Id (Communications - Email)
+     * @type {TEXT}
+     */
+    MessageId?: string | null;
+    /**
+     * EmailSenderId
+     *
+     * The Email Sender related entity
+     * @type {LOOKUP}
+     */
+    EmailSenderId?: string | null;
+    /**
+     * DynamicData
+     *
+     * Data will pass to emailing service (variables)
+     * @type {JSON}
+     */
+    DynamicData?: string | null;
+    /**
+     * Title
+     *
+     * Used for title
+     * @type {TEXT}
+     */
+    Title?: string | null;
+    /**
+     * Subject
+     *
+     * Data field for Email records. Used by Communications team.
+     * @type {TEXT}
+     */
+    Subject?: string | null;
+    /**
+     * To
+     *
+     * Data field for Email records. Used by Communications team.
+     * @type {TEXT}
+     */
+    To?: string | null;
+}
+/**
+ * CreateTransactionConfirmation
+ *
+ * Send Transaction confirmation email
+ *
+ * @actionType CREATE - Creates a new Email record
+ * @module NotificationModule
+ * @entity Email
+ * @entityType TRANSACTIONAL (TRANSACTIONAL)
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateTransactionConfirmation
+ * @permission schema.action.createtransactionconfirmation.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+export declare class CreateTransactionConfirmationDto extends OdinRecordCreateDto<CreateTransactionConfirmationProperties> {
+    /** Used by SDK generators to identify action type */
+    static readonly ACTION_TYPE = "CREATE";
+    static readonly ACTION_KEY = "CreateTransactionConfirmation";
+    static readonly MODULE_NAME = "NotificationModule";
+    static readonly ENTITIES: string[];
+    static readonly ENTITY_TYPE = "TRANSACTIONAL";
+    static readonly EVENT_NAME = "k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateTransactionConfirmation";
+    static readonly PERMISSION = "schema.action.createtransactionconfirmation.trigger";
+    /** Step metadata - entity this action targets */
+    static readonly STEP_ENTITY = "NotificationModule:Email";
+    static readonly STEP_SCHEMA_ID = "cb37958c-d72f-44aa-975a-a8fae42b1b72";
+    static readonly STEP_SCHEMA_ACTION_ID = "765a7221-8b00-4a18-ba99-9bd1023dd55d";
+    static readonly STEP_SCHEMA_TYPE_ID = "14042940-a388-44c7-87fe-3a4105d92e94";
+    static readonly STEP_TYPE = "TRANSACTIONAL";
+    static readonly AUTO_LINK_PARENT = true;
+    readonly actionName: string;
+    readonly schemaActionId: string;
+    readonly entity: string;
+    constructor(properties: CreateTransactionConfirmationProperties, options?: {
+        journeyId?: string;
+    });
+}

package/dist/actions-v2/CreateTransactionConfirmationDto.js

@@ -0,0 +1,59 @@
+"use strict";
+/**
+ * CreateTransactionConfirmation Action DTO
+ *
+ * Send Transaction confirmation email
+ *
+ * @module NotificationModule
+ * @entity Email
+ * @entityType TRANSACTIONAL
+ * @actionKey CreateTransactionConfirmation
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateTransactionConfirmation
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateTransactionConfirmationDto = void 0;
+const core_1 = require("@d19n/odin-types/dist/core");
+/**
+ * CreateTransactionConfirmation
+ *
+ * Send Transaction confirmation email
+ *
+ * @actionType CREATE - Creates a new Email record
+ * @module NotificationModule
+ * @entity Email
+ * @entityType TRANSACTIONAL (TRANSACTIONAL)
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateTransactionConfirmation
+ * @permission schema.action.createtransactionconfirmation.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+class CreateTransactionConfirmationDto extends core_1.OdinRecordCreateDto {
+    constructor(properties, options) {
+        super({
+            entity: 'NotificationModule:Email',
+            type: 'TRANSACTIONAL',
+            properties,
+            journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
+        });
+        this.actionName = 'CreateTransactionConfirmation';
+        this.schemaActionId = '765a7221-8b00-4a18-ba99-9bd1023dd55d';
+        this.entity = 'NotificationModule:Email';
+    }
+}
+exports.CreateTransactionConfirmationDto = CreateTransactionConfirmationDto;
+/** Used by SDK generators to identify action type */
+CreateTransactionConfirmationDto.ACTION_TYPE = 'CREATE';
+CreateTransactionConfirmationDto.ACTION_KEY = 'CreateTransactionConfirmation';
+CreateTransactionConfirmationDto.MODULE_NAME = 'NotificationModule';
+CreateTransactionConfirmationDto.ENTITIES = ['Email'];
+CreateTransactionConfirmationDto.ENTITY_TYPE = 'TRANSACTIONAL';
+CreateTransactionConfirmationDto.EVENT_NAME = 'k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateTransactionConfirmation';
+CreateTransactionConfirmationDto.PERMISSION = 'schema.action.createtransactionconfirmation.trigger';
+/** Step metadata - entity this action targets */
+CreateTransactionConfirmationDto.STEP_ENTITY = 'NotificationModule:Email';
+CreateTransactionConfirmationDto.STEP_SCHEMA_ID = 'cb37958c-d72f-44aa-975a-a8fae42b1b72';
+CreateTransactionConfirmationDto.STEP_SCHEMA_ACTION_ID = '765a7221-8b00-4a18-ba99-9bd1023dd55d';
+CreateTransactionConfirmationDto.STEP_SCHEMA_TYPE_ID = '14042940-a388-44c7-87fe-3a4105d92e94';
+CreateTransactionConfirmationDto.STEP_TYPE = 'TRANSACTIONAL';
+CreateTransactionConfirmationDto.AUTO_LINK_PARENT = true;

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

@@ -41,6 +41,7 @@ import { CreateOrderReferralReferrerQualifiedEmailProperties } from '../actions-
 import { CreatePreContractOrderSummaryProperties } from '../actions-v2/CreatePreContractOrderSummaryDto';
 import { CreateRecontractOrderConfirmationProperties } from '../actions-v2/CreateRecontractOrderConfirmationDto';
 import { CreateRecontractReminderEmailProperties } from '../actions-v2/CreateRecontractReminderEmailDto';
+import { CreateTransactionConfirmationProperties } from '../actions-v2/CreateTransactionConfirmationDto';
 import { CreateTransactionalEmailProperties } from '../actions-v2/CreateTransactionalEmailDto';
 import { SendDirectDebitCreatedEmailProperties } from '../actions-v2/SendDirectDebitCreatedEmailDto';
 import { SendDirectDebitFailedEmailProperties } from '../actions-v2/SendDirectDebitFailedEmailDto';
@@ -889,6 +890,34 @@ export declare class EmailRecord<TProps = EmailProperties> {
         journeyId?: string;
         stageKey?: string;
     }): ActionBuilder;
+    /**
+     * CreateTransactionConfirmation
+     *
+     * Creates a new Email record with the specified properties.
+     * Returns an ActionBuilder - call .execute() to create or .dryRun() for debugging.
+     *
+     * @remarks Record type: TRANSACTIONAL
+     *
+     * @param properties - The properties for the new record
+     * @param options - Optional settings
+     * @param options.journeyId - Associate with a journey
+     * @param options.stageKey - Set initial pipeline stage
+     * @returns ActionBuilder - call .execute() to create or .dryRun() for payload
+     *
+     * @example
+     * ```typescript
+     * // Create with properties
+     * const record = odinClient.emails.new();
+     * await record.createTransactionConfirmation({ ... }).execute();
+     *
+     * // Dry run (for debugging)
+     * const payload = record.createTransactionConfirmation({ ... }).dryRun();
+     * ```
+     */
+    createTransactionConfirmation(properties?: CreateTransactionConfirmationProperties, options?: {
+        journeyId?: string;
+        stageKey?: string;
+    }): ActionBuilder;
     /**
      * CreateTransactionalEmail
      *

package/dist/records-v2/EmailRecord.js

@@ -1142,6 +1142,42 @@ class EmailRecord {
         };
         return new ActionBuilder(this._provider, 'NotificationModule', 'Email', payload, () => { this._pendingLinks = []; });
     }
+    /**
+     * CreateTransactionConfirmation
+     *
+     * Creates a new Email record with the specified properties.
+     * Returns an ActionBuilder - call .execute() to create or .dryRun() for debugging.
+     *
+     * @remarks Record type: TRANSACTIONAL
+     *
+     * @param properties - The properties for the new record
+     * @param options - Optional settings
+     * @param options.journeyId - Associate with a journey
+     * @param options.stageKey - Set initial pipeline stage
+     * @returns ActionBuilder - call .execute() to create or .dryRun() for payload
+     *
+     * @example
+     * ```typescript
+     * // Create with properties
+     * const record = odinClient.emails.new();
+     * await record.createTransactionConfirmation({ ... }).execute();
+     *
+     * // Dry run (for debugging)
+     * const payload = record.createTransactionConfirmation({ ... }).dryRun();
+     * ```
+     */
+    createTransactionConfirmation(properties, options) {
+        const payload = {
+            entity: 'NotificationModule:Email',
+            type: 'TRANSACTIONAL',
+            actionName: 'CreateTransactionConfirmation',
+            properties: properties || {},
+            associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined,
+            journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
+            stageKey: options === null || options === void 0 ? void 0 : options.stageKey,
+        };
+        return new ActionBuilder(this._provider, 'NotificationModule', 'Email', payload, () => { this._pendingLinks = []; });
+    }
     /**
      * CreateTransactionalEmail
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@d19n/youfibre-odin-sdk",
-  "version": "2.0.246-beta.1",
+  "version": "2.0.246-beta.2",
   "description": "",
   "author": "@d19n",
   "license": "UNLICENSED",