@d19n/youfibre-odin-sdk 2.0.325 → 2.0.326

package/README.md

@@ -375,7 +375,7 @@ This SDK includes **187** entities across **12** modules.
 
 ## Actions
 
-This SDK includes **884** actions.
+This SDK includes **885** actions.
 
 ### Action Types
 
@@ -1433,6 +1433,7 @@ This SDK includes **884** actions.
 | `CreateRecontractOrderConfirmation` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateRecontractOrderConfirmation |
 | `CreateRecontractReminderEmail` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateRecontractReminderEmail |
 | `CreateRegisterInterestEmail` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateRegisterInterestEmail |
+| `CreateRollingContractSummary` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateRollingContractSummary |
 | `CreateServiceAppointmentConfirmation` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateServiceAppointmentConfirmation |
 | `CreateServiceAppointmentRescheduled` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateServiceAppointmentRescheduled |
 | `CreateServiceDeactivatedMandate` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateServiceDeactivatedMandate |

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

@@ -0,0 +1,135 @@
+/**
+ * CreateRollingContractSummary Action DTO
+ *
+ * OT-1870. Send the monthly rolling contract summary on the day a fixed term ends.
+ *
+ * @module NotificationModule
+ * @entity Email
+ * @entityType TRANSACTIONAL
+ * @actionKey CreateRollingContractSummary
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateRollingContractSummary
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+import { OdinRecordCreateDto, OdinRecordCreatedEvent } from '@d19n/odin-types/dist/core';
+/**
+ * RabbitMQ message payload for CreateRollingContractSummary created events
+ *
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateRollingContractSummary
+ */
+export interface CreateRollingContractSummaryMessage extends OdinRecordCreatedEvent<CreateRollingContractSummaryDto, CreateRollingContractSummaryProperties> {
+}
+/**
+ * Properties for CreateRollingContractSummary action
+ *
+ * @property Required fields: 0
+ * @property Optional fields: 10
+ */
+export interface CreateRollingContractSummaryProperties {
+    /**
+     * 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;
+}
+/**
+ * CreateRollingContractSummary
+ *
+ * OT-1870. Send the monthly rolling contract summary on the day a fixed term ends.
+ *
+ * @actionType CREATE - Creates a new Email record
+ * @module NotificationModule
+ * @entity Email
+ * @entityType TRANSACTIONAL (TRANSACTIONAL)
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateRollingContractSummary
+ * @permission schema.action.createrollingcontractsummary.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+export declare class CreateRollingContractSummaryDto extends OdinRecordCreateDto<CreateRollingContractSummaryProperties> {
+    /** Used by SDK generators to identify action type */
+    static readonly ACTION_TYPE = "CREATE";
+    static readonly ACTION_KEY = "CreateRollingContractSummary";
+    static readonly MODULE_NAME = "NotificationModule";
+    static readonly ENTITIES: string[];
+    static readonly ENTITY_TYPE = "TRANSACTIONAL";
+    static readonly EVENT_NAME = "k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateRollingContractSummary";
+    static readonly PERMISSION = "schema.action.createrollingcontractsummary.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 = "b3dd4243-df50-4187-a7f9-5a2f5e4e49c8";
+    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: CreateRollingContractSummaryProperties, options?: {
+        journeyId?: string;
+    });
+}

package/dist/actions-v2/CreateRollingContractSummaryDto.js

@@ -0,0 +1,59 @@
+"use strict";
+/**
+ * CreateRollingContractSummary Action DTO
+ *
+ * OT-1870. Send the monthly rolling contract summary on the day a fixed term ends.
+ *
+ * @module NotificationModule
+ * @entity Email
+ * @entityType TRANSACTIONAL
+ * @actionKey CreateRollingContractSummary
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateRollingContractSummary
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateRollingContractSummaryDto = void 0;
+const core_1 = require("@d19n/odin-types/dist/core");
+/**
+ * CreateRollingContractSummary
+ *
+ * OT-1870. Send the monthly rolling contract summary on the day a fixed term ends.
+ *
+ * @actionType CREATE - Creates a new Email record
+ * @module NotificationModule
+ * @entity Email
+ * @entityType TRANSACTIONAL (TRANSACTIONAL)
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateRollingContractSummary
+ * @permission schema.action.createrollingcontractsummary.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+class CreateRollingContractSummaryDto 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 = 'CreateRollingContractSummary';
+        this.schemaActionId = 'b3dd4243-df50-4187-a7f9-5a2f5e4e49c8';
+        this.entity = 'NotificationModule:Email';
+    }
+}
+exports.CreateRollingContractSummaryDto = CreateRollingContractSummaryDto;
+/** Used by SDK generators to identify action type */
+CreateRollingContractSummaryDto.ACTION_TYPE = 'CREATE';
+CreateRollingContractSummaryDto.ACTION_KEY = 'CreateRollingContractSummary';
+CreateRollingContractSummaryDto.MODULE_NAME = 'NotificationModule';
+CreateRollingContractSummaryDto.ENTITIES = ['Email'];
+CreateRollingContractSummaryDto.ENTITY_TYPE = 'TRANSACTIONAL';
+CreateRollingContractSummaryDto.EVENT_NAME = 'k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateRollingContractSummary';
+CreateRollingContractSummaryDto.PERMISSION = 'schema.action.createrollingcontractsummary.trigger';
+/** Step metadata - entity this action targets */
+CreateRollingContractSummaryDto.STEP_ENTITY = 'NotificationModule:Email';
+CreateRollingContractSummaryDto.STEP_SCHEMA_ID = 'cb37958c-d72f-44aa-975a-a8fae42b1b72';
+CreateRollingContractSummaryDto.STEP_SCHEMA_ACTION_ID = 'b3dd4243-df50-4187-a7f9-5a2f5e4e49c8';
+CreateRollingContractSummaryDto.STEP_SCHEMA_TYPE_ID = '14042940-a388-44c7-87fe-3a4105d92e94';
+CreateRollingContractSummaryDto.STEP_TYPE = 'TRANSACTIONAL';
+CreateRollingContractSummaryDto.AUTO_LINK_PARENT = true;

package/dist/entities-v2/Config.d.ts

@@ -23,12 +23,12 @@ export declare enum ConfigEntityTypes {
  * Use these constants instead of string literals for type safety
  */
 export declare enum ConfigPropertyKeys {
-    /** Data field for Config records. Used by Platform team. */
-    Test = "Test",
     /** the name of the app this config relates to (Platform - Config) */
     AppName = "AppName",
     /** object of { key: value } mappings (Platform - Config) */
-    Mappings = "Mappings"
+    Mappings = "Mappings",
+    /** Data field for Config records. Used by Platform team. */
+    Test = "Test"
 }
 /**
  * Properties for Config records
@@ -36,11 +36,6 @@ export declare enum ConfigPropertyKeys {
  * @see SchemaModule:Config
  */
 export interface ConfigProperties {
-    /** Data field for Config records. Used by Platform team.
-     *
-     * @type {TEXT}
-     */
-    Test: string;
     /** the name of the app this config relates to (Platform - Config)
      *
      * @type {TEXT}
@@ -51,6 +46,11 @@ export interface ConfigProperties {
      * @type {JSON}
      */
     Mappings: string;
+    /** Data field for Config records. Used by Platform team.
+     *
+     * @type {TEXT}
+     */
+    Test: string;
 }
 /**
  * Config entity from SchemaModule

package/dist/entities-v2/Config.js

@@ -28,12 +28,12 @@ var ConfigEntityTypes;
  */
 var ConfigPropertyKeys;
 (function (ConfigPropertyKeys) {
-    /** Data field for Config records. Used by Platform team. */
-    ConfigPropertyKeys["Test"] = "Test";
     /** the name of the app this config relates to (Platform - Config) */
     ConfigPropertyKeys["AppName"] = "AppName";
     /** object of { key: value } mappings (Platform - Config) */
     ConfigPropertyKeys["Mappings"] = "Mappings";
+    /** Data field for Config records. Used by Platform team. */
+    ConfigPropertyKeys["Test"] = "Test";
 })(ConfigPropertyKeys = exports.ConfigPropertyKeys || (exports.ConfigPropertyKeys = {}));
 /**
  * Config entity from SchemaModule

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

@@ -69,6 +69,7 @@ import { CreatePreContractOrderSummaryProperties } from '../actions-v2/CreatePre
 import { CreateRecontractOrderConfirmationProperties } from '../actions-v2/CreateRecontractOrderConfirmationDto';
 import { CreateRecontractReminderEmailProperties } from '../actions-v2/CreateRecontractReminderEmailDto';
 import { CreateRegisterInterestEmailProperties } from '../actions-v2/CreateRegisterInterestEmailDto';
+import { CreateRollingContractSummaryProperties } from '../actions-v2/CreateRollingContractSummaryDto';
 import { CreateServiceAppointmentConfirmationProperties } from '../actions-v2/CreateServiceAppointmentConfirmationDto';
 import { CreateServiceAppointmentRescheduledProperties } from '../actions-v2/CreateServiceAppointmentRescheduledDto';
 import { CreateServiceDeactivatedMandateProperties } from '../actions-v2/CreateServiceDeactivatedMandateDto';
@@ -1649,6 +1650,34 @@ export declare class EmailRecord<TProps = EmailProperties> {
         journeyId?: string;
         stageKey?: string;
     }): ActionBuilder;
+    /**
+     * CreateRollingContractSummary
+     *
+     * 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.createRollingContractSummary({ ... }).execute();
+     *
+     * // Dry run (for debugging)
+     * const payload = record.createRollingContractSummary({ ... }).dryRun();
+     * ```
+     */
+    createRollingContractSummary(properties?: CreateRollingContractSummaryProperties, options?: {
+        journeyId?: string;
+        stageKey?: string;
+    }): ActionBuilder;
     /**
      * CreateServiceAppointmentConfirmation
      *

package/dist/records-v2/EmailRecord.js

@@ -2075,6 +2075,42 @@ class EmailRecord {
         };
         return new ActionBuilder(this._provider, 'NotificationModule', 'Email', payload, () => { this._pendingLinks = []; });
     }
+    /**
+     * CreateRollingContractSummary
+     *
+     * 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.createRollingContractSummary({ ... }).execute();
+     *
+     * // Dry run (for debugging)
+     * const payload = record.createRollingContractSummary({ ... }).dryRun();
+     * ```
+     */
+    createRollingContractSummary(properties, options) {
+        const payload = {
+            entity: 'NotificationModule:Email',
+            type: 'TRANSACTIONAL',
+            actionName: 'CreateRollingContractSummary',
+            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 = []; });
+    }
     /**
      * CreateServiceAppointmentConfirmation
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@d19n/youfibre-odin-sdk",
-  "version": "2.0.325",
+  "version": "2.0.326",
   "description": "",
   "author": "@d19n",
   "license": "UNLICENSED",