@d19n/youfibre-odin-sdk 1.0.354 → 1.0.355

package/README.md

@@ -351,7 +351,7 @@ This SDK includes **163** entities across **12** modules.
 
 ## Actions
 
-This SDK includes **538** actions.
+This SDK includes **539** actions.
 
 ### Action Types
 
@@ -1117,6 +1117,7 @@ This SDK includes **538** actions.
 | Action | Type | Event |
 |--------|------|-------|
 | `CreateContact` | CREATE | k1.t-hEOJjsDb.CrmModule.Contact.Create.CreateContact |
+| `CreateContactFromBrsk` | CREATE | k1.t-hEOJjsDb.CrmModule.Contact.Create.CreateContactFromBrsk |
 | `UpdateAdditionalCare` | UPDATE | k1.t-hEOJjsDb.CrmModule.Contact.Update.UpdateAdditionalCare |
 | `UpdateContact` | UPDATE | k1.t-hEOJjsDb.CrmModule.Contact.Update.UpdateContact |
 | `UpdateReferralCode` | UPDATE | k1.t-hEOJjsDb.CrmModule.Contact.Update.UpdateReferralCode |

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

@@ -0,0 +1,107 @@
+/**
+ * CreateContactFromBrsk Action DTO
+ *
+ * CreateContactFromBrsk
+ *
+ * @module CrmModule
+ * @entity Contact
+ * @actionKey CreateContactFromBrsk
+ * @event k1.t-hEOJjsDb.CrmModule.Contact.Create.CreateContactFromBrsk
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+import { OdinRecordCreateDto, OdinRecordCreatedEvent } from '@d19n/odin-types/dist/core';
+/**
+ * RabbitMQ message payload for CreateContactFromBrsk created events
+ *
+ * @event k1.t-hEOJjsDb.CrmModule.Contact.Create.CreateContactFromBrsk
+ */
+export interface CreateContactFromBrskMessage extends OdinRecordCreatedEvent<CreateContactFromBrskDto, CreateContactFromBrskProperties> {
+}
+/**
+ * Properties for CreateContactFromBrsk action
+ *
+ * @property Required fields: 0
+ * @property Optional fields: 7
+ */
+export interface CreateContactFromBrskProperties {
+    /**
+     * External Reference
+     *
+     * External Reference
+     * @type {TEXT}
+     */
+    ExternalReference?: string | null;
+    /**
+     * email address
+     *
+     * Contacts Email Address (Sales - Contact)
+     * @type {EMAIL}
+     */
+    EmailAddress?: string | null;
+    /**
+     * first name
+     *
+     * Contacts First Name (Sales - Contact)
+     * @type {TEXT}
+     */
+    FirstName?: string | null;
+    /**
+     * last name
+     *
+     * Contacts Last Name (Sales - Contact)
+     * @type {TEXT}
+     */
+    LastName?: string | null;
+    /**
+     * phone
+     *
+     * Phone number (Sales - Contact)
+     * @type {PHONE_NUMBER}
+     */
+    Phone?: string | null;
+    /**
+     * Additional Care Required?
+     *
+     * Marks if the customer requires additional care (Ofcom vulnerable customer handling). (Sales - Contact)
+     * @type {BOOLEAN}
+     */
+    AdditionalCareRequired?: boolean | null;
+    /**
+     * I am happy to hear from YouFibre by email, WhatsApp and SMS about YouFibre’s broadband packages and any special offers. I am aware that I can opt-out at any time. For details on how we manage your data, please see our privacy policy.
+     *
+     * Marketing Consent (Sales - Contact)
+     * @type {BOOLEAN}
+     */
+    MarketingConsent?: boolean | null;
+}
+/**
+ * CreateContactFromBrsk
+ *
+ * @actionType CREATE - Creates a new Contact record
+ * @module CrmModule
+ * @entity Contact
+ * @event k1.t-hEOJjsDb.CrmModule.Contact.Create.CreateContactFromBrsk
+ * @permission schema.action.createcontactfrombrsk.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+export declare class CreateContactFromBrskDto extends OdinRecordCreateDto<CreateContactFromBrskProperties> {
+    /** Used by SDK generators to identify action type */
+    static readonly ACTION_TYPE = "CREATE";
+    static readonly ACTION_KEY = "CreateContactFromBrsk";
+    static readonly MODULE_NAME = "CrmModule";
+    static readonly ENTITIES: string[];
+    static readonly EVENT_NAME = "k1.t-hEOJjsDb.CrmModule.Contact.Create.CreateContactFromBrsk";
+    static readonly PERMISSION = "schema.action.createcontactfrombrsk.trigger";
+    /** Step metadata - entity this action targets */
+    static readonly STEP_ENTITY = "CrmModule:Contact";
+    static readonly STEP_SCHEMA_ID = "ff4313f0-9929-4481-bdf4-c90ff9624014";
+    static readonly STEP_SCHEMA_ACTION_ID = "d559c9ed-5798-4eb9-b315-3e0a602283a7";
+    static readonly AUTO_LINK_PARENT = true;
+    readonly actionName: string;
+    readonly schemaActionId: string;
+    readonly entity: string;
+    constructor(properties: CreateContactFromBrskProperties, options?: {
+        journeyId?: string;
+    });
+}

package/dist/actions-v2/CreateContactFromBrskDto.js

@@ -0,0 +1,52 @@
+"use strict";
+/**
+ * CreateContactFromBrsk Action DTO
+ *
+ * CreateContactFromBrsk
+ *
+ * @module CrmModule
+ * @entity Contact
+ * @actionKey CreateContactFromBrsk
+ * @event k1.t-hEOJjsDb.CrmModule.Contact.Create.CreateContactFromBrsk
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateContactFromBrskDto = void 0;
+const core_1 = require("@d19n/odin-types/dist/core");
+/**
+ * CreateContactFromBrsk
+ *
+ * @actionType CREATE - Creates a new Contact record
+ * @module CrmModule
+ * @entity Contact
+ * @event k1.t-hEOJjsDb.CrmModule.Contact.Create.CreateContactFromBrsk
+ * @permission schema.action.createcontactfrombrsk.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+class CreateContactFromBrskDto extends core_1.OdinRecordCreateDto {
+    constructor(properties, options) {
+        super({
+            entity: 'CrmModule:Contact',
+            type: undefined,
+            properties,
+            journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
+        });
+        this.actionName = 'CreateContactFromBrsk';
+        this.schemaActionId = 'd559c9ed-5798-4eb9-b315-3e0a602283a7';
+        this.entity = 'CrmModule:Contact';
+    }
+}
+exports.CreateContactFromBrskDto = CreateContactFromBrskDto;
+/** Used by SDK generators to identify action type */
+CreateContactFromBrskDto.ACTION_TYPE = 'CREATE';
+CreateContactFromBrskDto.ACTION_KEY = 'CreateContactFromBrsk';
+CreateContactFromBrskDto.MODULE_NAME = 'CrmModule';
+CreateContactFromBrskDto.ENTITIES = ['Contact'];
+CreateContactFromBrskDto.EVENT_NAME = 'k1.t-hEOJjsDb.CrmModule.Contact.Create.CreateContactFromBrsk';
+CreateContactFromBrskDto.PERMISSION = 'schema.action.createcontactfrombrsk.trigger';
+/** Step metadata - entity this action targets */
+CreateContactFromBrskDto.STEP_ENTITY = 'CrmModule:Contact';
+CreateContactFromBrskDto.STEP_SCHEMA_ID = 'ff4313f0-9929-4481-bdf4-c90ff9624014';
+CreateContactFromBrskDto.STEP_SCHEMA_ACTION_ID = 'd559c9ed-5798-4eb9-b315-3e0a602283a7';
+CreateContactFromBrskDto.AUTO_LINK_PARENT = true;

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

@@ -360,7 +360,9 @@ export declare enum ContactPropertyKeys {
     /** The date that the customer signed up or registered to the customer platforms (Sales - Contact) */
     ActivationDate = "ActivationDate",
     /** Is the customer medically dependant on their broadband (Sales - Contact) */
-    MedicallyDependant = "MedicallyDependant"
+    MedicallyDependant = "MedicallyDependant",
+    /** External Reference */
+    ExternalReference = "ExternalReference"
 }
 /**
  * Properties for Contact records
@@ -679,6 +681,11 @@ export interface ContactProperties {
      * @default FALSE
      */
     MedicallyDependant: boolean;
+    /** External Reference
+     *
+     * @type {TEXT}
+     */
+    ExternalReference: string;
 }
 /**
  * Contact entity from CrmModule

package/dist/entities-v2/Contact.js

@@ -344,6 +344,8 @@ var ContactPropertyKeys;
     ContactPropertyKeys["ActivationDate"] = "ActivationDate";
     /** Is the customer medically dependant on their broadband (Sales - Contact) */
     ContactPropertyKeys["MedicallyDependant"] = "MedicallyDependant";
+    /** External Reference */
+    ContactPropertyKeys["ExternalReference"] = "ExternalReference";
 })(ContactPropertyKeys = exports.ContactPropertyKeys || (exports.ContactPropertyKeys = {}));
 /**
  * Contact entity from CrmModule

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

@@ -24,6 +24,7 @@ import { ContactProperties } from '../entities-v2/Contact';
 import { CreateCaseProperties } from '../actions-v2/CreateCaseFromContactDto';
 import { AssignCaseProperties } from '../actions-v2/CreateCaseFromContactDto';
 import { CreateContactProperties } from '../actions-v2/CreateContactDto';
+import { CreateContactFromBrskProperties } from '../actions-v2/CreateContactFromBrskDto';
 import { UpdateAdditionalCareProperties } from '../actions-v2/UpdateAdditionalCareDto';
 import { UpdateContactProperties } from '../actions-v2/UpdateContactDto';
 import { UpdateReferralCodeProperties } from '../actions-v2/UpdateReferralCodeDto';
@@ -724,6 +725,34 @@ export declare class ContactRecord<TProps = ContactProperties> {
         journeyId?: string;
         stageKey?: string;
     }): ActionBuilder;
+    /**
+     * CreateContactFromBrsk
+     *
+     * Creates a new Contact record with the specified properties.
+     * Returns an ActionBuilder - call .execute() to create or .dryRun() for debugging.
+     *
+     * @param properties - The properties for the new record
+     * @param options - Optional settings
+     * @param options.type - Override the record type
+     * @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.contacts.new();
+     * await record.createContactFromBrsk({ ... }).execute();
+     *
+     * // Dry run (for debugging)
+     * const payload = record.createContactFromBrsk({ ... }).dryRun();
+     * ```
+     */
+    createContactFromBrsk(properties?: CreateContactFromBrskProperties, options?: {
+        type?: string;
+        journeyId?: string;
+        stageKey?: string;
+    }): ActionBuilder;
     /**
      * CreateCaseFromContact
      *

package/dist/records-v2/ContactRecord.js

@@ -1118,6 +1118,42 @@ class ContactRecord {
         };
         return new ActionBuilder(this._provider, 'CrmModule', 'Contact', payload, () => { this._pendingLinks = []; });
     }
+    /**
+     * CreateContactFromBrsk
+     *
+     * Creates a new Contact record with the specified properties.
+     * Returns an ActionBuilder - call .execute() to create or .dryRun() for debugging.
+     *
+     * @param properties - The properties for the new record
+     * @param options - Optional settings
+     * @param options.type - Override the record type
+     * @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.contacts.new();
+     * await record.createContactFromBrsk({ ... }).execute();
+     *
+     * // Dry run (for debugging)
+     * const payload = record.createContactFromBrsk({ ... }).dryRun();
+     * ```
+     */
+    createContactFromBrsk(properties, options) {
+        var _a, _b;
+        const payload = {
+            entity: 'CrmModule:Contact',
+            type: (_a = options === null || options === void 0 ? void 0 : options.type) !== null && _a !== void 0 ? _a : (_b = this._record) === null || _b === void 0 ? void 0 : _b.type,
+            actionName: 'CreateContactFromBrsk',
+            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, 'CrmModule', 'Contact', payload, () => { this._pendingLinks = []; });
+    }
     // ============================================
     // UPDATE ACTIONS (require existing record)
     // ============================================

package/package.json

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