@d19n/youfibre-odin-sdk 2.0.373 → 2.0.374

package/README.md

@@ -398,7 +398,7 @@ This SDK includes **205** entities across **13** modules.
 
 ## Actions
 
-This SDK includes **936** actions.
+This SDK includes **937** actions.
 
 ### Action Types
 
@@ -1639,6 +1639,7 @@ This SDK includes **936** actions.
 |--------|------|-------|
 | `CreateContact` | CREATE | k1.t-hEOJjsDb.CrmModule.Contact.Create.CreateContact |
 | `CreateContactSalesApp` | CREATE | k1.t-hEOJjsDb.CrmModule.Contact.Create.CreateContactSalesApp |
+| `OrderBuilderCreateContact` | CREATE | k1.t-hEOJjsDb.CrmModule.Contact.Create.OrderBuilderCreateContact |
 | `OrderBuilderUpdateContact` | UPDATE | k1.t-hEOJjsDb.CrmModule.Contact.Update.OrderBuilderUpdateContact |
 | `UpdateAdditionalCare` | UPDATE | k1.t-hEOJjsDb.CrmModule.Contact.Update.UpdateAdditionalCare |
 | `UpdateContactAppPreferences` | UPDATE | k1.t-hEOJjsDb.CrmModule.Contact.Update.UpdateContactAppPreferences |

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

@@ -479,20 +479,6 @@ export declare class CreatePrePullWorkOrderDto extends OdinRecordCreateDto<Creat
  * @property Optional fields: 5
  */
 export interface CreateNetworkAdjustmentWorkOrderProperties {
-    /**
-     * EarlierAvailability
-     *
-     * Earlier Availability (Field Operations - WorkOrder)
-     * @type {BOOLEAN}
-     */
-    EarlierAvailability?: boolean | null;
-    /**
-     * Provider
-     *
-     * network to provision service to (Field Operations - WorkOrder)
-     * @type {ENUM}
-     */
-    Provider?: string | null;
     /**
      * Description
      *
@@ -500,6 +486,13 @@ export interface CreateNetworkAdjustmentWorkOrderProperties {
      * @type {TEXT_LONG}
      */
     Description?: string | null;
+    /**
+     * SLADays
+     *
+     * Data field for WorkOrder records. Used by Field Operations team.
+     * @type {NUMBER}
+     */
+    SLADays?: number | null;
     /**
      * IsVIP
      *
@@ -508,12 +501,19 @@ export interface CreateNetworkAdjustmentWorkOrderProperties {
      */
     IsVIP?: boolean | null;
     /**
-     * SLADays
+     * Provider
      *
-     * Data field for WorkOrder records. Used by Field Operations team.
-     * @type {NUMBER}
+     * network to provision service to (Field Operations - WorkOrder)
+     * @type {ENUM}
      */
-    SLADays?: number | null;
+    Provider?: string | null;
+    /**
+     * EarlierAvailability
+     *
+     * Earlier Availability (Field Operations - WorkOrder)
+     * @type {BOOLEAN}
+     */
+    EarlierAvailability?: boolean | null;
 }
 /**
  * Create Network Adjustment Work Order

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

@@ -26,20 +26,6 @@ export interface CreateNetworkAdjustmentWorkOrderMessage extends OdinRecordCreat
  * @property Optional fields: 5
  */
 export interface CreateNetworkAdjustmentWorkOrderProperties {
-    /**
-     * EarlierAvailability
-     *
-     * Earlier Availability (Field Operations - WorkOrder)
-     * @type {BOOLEAN}
-     */
-    EarlierAvailability?: boolean | null;
-    /**
-     * Provider
-     *
-     * network to provision service to (Field Operations - WorkOrder)
-     * @type {ENUM}
-     */
-    Provider?: string | null;
     /**
      * Description
      *
@@ -47,6 +33,13 @@ export interface CreateNetworkAdjustmentWorkOrderProperties {
      * @type {TEXT_LONG}
      */
     Description?: string | null;
+    /**
+     * SLADays
+     *
+     * Data field for WorkOrder records. Used by Field Operations team.
+     * @type {NUMBER}
+     */
+    SLADays?: number | null;
     /**
      * IsVIP
      *
@@ -55,12 +48,19 @@ export interface CreateNetworkAdjustmentWorkOrderProperties {
      */
     IsVIP?: boolean | null;
     /**
-     * SLADays
+     * Provider
      *
-     * Data field for WorkOrder records. Used by Field Operations team.
-     * @type {NUMBER}
+     * network to provision service to (Field Operations - WorkOrder)
+     * @type {ENUM}
      */
-    SLADays?: number | null;
+    Provider?: string | null;
+    /**
+     * EarlierAvailability
+     *
+     * Earlier Availability (Field Operations - WorkOrder)
+     * @type {BOOLEAN}
+     */
+    EarlierAvailability?: boolean | null;
 }
 /**
  * Create Network Adjustment Work Order

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

@@ -23,7 +23,7 @@ export interface CreateOutboundDialCampaignMessage extends OdinRecordCreatedEven
  * Properties for CreateOutboundDialCampaign action
  *
  * @property Required fields: 6
- * @property Optional fields: 3
+ * @property Optional fields: 4
  */
 export interface CreateOutboundDialCampaignProperties {
     /**
@@ -95,6 +95,13 @@ export interface CreateOutboundDialCampaignProperties {
      * @type {BOOLEAN}
      */
     RetentionCampaign?: boolean | null;
+    /**
+     * NewCasesPerOwnCase
+     *
+     * Round-robin: new cases handed out before each of the agent's own cases, e.g. 2 gives new, new, own (CASES-1986). Empty or 0 keeps own cases first.
+     * @type {NUMBER}
+     */
+    NewCasesPerOwnCase?: number | null;
 }
 /**
  * CreateOutboundDialCampaign

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

@@ -22,7 +22,7 @@ export interface CreateOutboundDialSessionMessage extends OdinRecordCreatedEvent
  * Properties for CreateOutboundDialSession action
  *
  * @property Required fields: 9
- * @property Optional fields: 4
+ * @property Optional fields: 5
  */
 export interface CreateOutboundDialSessionProperties {
     /**
@@ -129,6 +129,13 @@ export interface CreateOutboundDialSessionProperties {
      * @type {DATE_TIME}
      */
     LastCaseRequestAt?: string | null;
+    /**
+     * NewSinceOwnCase
+     *
+     * New cases this session has been handed since its last own case; drives the campaign's own-case ratio (CASES-1986).
+     * @type {NUMBER}
+     */
+    NewSinceOwnCase?: number | null;
 }
 /**
  * CreateOutboundDialSession

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

@@ -26,6 +26,14 @@ export interface EditNetworkDeviceMessage extends OdinRecordUpdatedEvent<EditNet
  * @property Optional fields: 2
  */
 export interface EditNetworkDeviceProperties {
+    /**
+     * IpAddress
+     *
+     * ip address for the olt (Network Operations - NetworkDevice)
+     * @type {TEXT}
+     * @required
+     */
+    IpAddress: string;
     /**
      * Model
      *
@@ -35,13 +43,12 @@ export interface EditNetworkDeviceProperties {
      */
     Model: string;
     /**
-     * IpAddress
+     * Name
      *
-     * ip address for the olt (Network Operations - NetworkDevice)
+     * Network Device Name (Network Operations - NetworkDevice)
      * @type {TEXT}
-     * @required
      */
-    IpAddress: string;
+    Name?: string | null;
     /**
      * ExPolygonId
      *
@@ -49,13 +56,6 @@ export interface EditNetworkDeviceProperties {
      * @type {TEXT}
      */
     ExPolygonId?: string | null;
-    /**
-     * Name
-     *
-     * Network Device Name (Network Operations - NetworkDevice)
-     * @type {TEXT}
-     */
-    Name?: string | null;
 }
 /**
  * EditNetworkDevice

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

@@ -0,0 +1,98 @@
+/**
+ * OrderBuilderCreateContact Action DTO
+ *
+ * Collects a new Contact in Order Builder V2 step 2. Loaded by name by the desktop builder and rendered through CoreForm; the contact is created by the order batch, so this action is the form and its rules rather than the save. The fields the builder asks for are therefore set here rather than in React. A sibling of CreateContact, which keeps serving every other create journey: this one is not the default form and is not a record-header button. Form copied from CreateContact. CORE-1516.
+ *
+ * @module CrmModule
+ * @entity Contact
+ * @actionKey OrderBuilderCreateContact
+ * @event k1.t-hEOJjsDb.CrmModule.Contact.Create.OrderBuilderCreateContact
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+import { OdinRecordCreateDto, OdinRecordCreatedEvent } from '@d19n/odin-types/dist/core';
+/**
+ * RabbitMQ message payload for OrderBuilderCreateContact created events
+ *
+ * @event k1.t-hEOJjsDb.CrmModule.Contact.Create.OrderBuilderCreateContact
+ */
+export interface OrderBuilderCreateContactMessage extends OdinRecordCreatedEvent<OrderBuilderCreateContactDto, OrderBuilderCreateContactProperties> {
+}
+/**
+ * Properties for OrderBuilderCreateContact action
+ *
+ * @property Required fields: 3
+ * @property Optional fields: 3
+ */
+export interface OrderBuilderCreateContactProperties {
+    /**
+     * FirstName
+     *
+     * Contacts First Name (Sales - Contact)
+     * @type {TEXT}
+     * @required
+     */
+    FirstName: string;
+    /**
+     * LastName
+     *
+     * Contacts Last Name (Sales - Contact)
+     * @type {TEXT}
+     * @required
+     */
+    LastName: string;
+    /**
+     * EmailAddress
+     *
+     * Contacts Email Address (Sales - Contact)
+     * @type {EMAIL}
+     * @required
+     */
+    EmailAddress: string;
+    /**
+     * MarketingConsent
+     *
+     * 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.
+     * @type {BOOLEAN}
+     */
+    MarketingConsent?: boolean | null;
+    /**
+     * Phone
+     *
+     * Phone number (Sales - Contact)
+     * @type {PHONE_NUMBER_E164_GB}
+     */
+    Phone?: string | null;
+}
+/**
+ * OrderBuilderCreateContact
+ *
+ * Collects a new Contact in Order Builder V2 step 2. Loaded by name by the desktop builder and rendered through CoreForm; the contact is created by the order batch, so this action is the form and its rules rather than the save. The fields the builder asks for are therefore set here rather than in React. A sibling of CreateContact, which keeps serving every other create journey: this one is not the default form and is not a record-header button. Form copied from CreateContact. CORE-1516.
+ *
+ * @actionType CREATE - Creates a new Contact record
+ * @module CrmModule
+ * @entity Contact
+ * @event k1.t-hEOJjsDb.CrmModule.Contact.Create.OrderBuilderCreateContact
+ * @permission schema.action.orderbuildercreatecontact.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+export declare class OrderBuilderCreateContactDto extends OdinRecordCreateDto<OrderBuilderCreateContactProperties> {
+    /** Used by SDK generators to identify action type */
+    static readonly ACTION_TYPE = "CREATE";
+    static readonly ACTION_KEY = "OrderBuilderCreateContact";
+    static readonly MODULE_NAME = "CrmModule";
+    static readonly ENTITIES: string[];
+    static readonly EVENT_NAME = "k1.t-hEOJjsDb.CrmModule.Contact.Create.OrderBuilderCreateContact";
+    static readonly PERMISSION = "schema.action.orderbuildercreatecontact.trigger";
+    /** Step metadata - entity this action targets */
+    static readonly STEP_ENTITY = "CrmModule:Contact";
+    static readonly STEP_SCHEMA_ID = "33643a0d-5b77-4895-a2da-991e0fd3432f";
+    static readonly STEP_SCHEMA_ACTION_ID = "2d295a37-7256-4303-b490-d3de6e9a32ff";
+    static readonly AUTO_LINK_PARENT = true;
+    readonly actionName: string;
+    readonly schemaActionId: string;
+    readonly entity: string;
+    constructor(properties: OrderBuilderCreateContactProperties, options?: {
+        journeyId?: string;
+    });
+}

package/dist/actions-v2/OrderBuilderCreateContactDto.js

@@ -0,0 +1,54 @@
+"use strict";
+/**
+ * OrderBuilderCreateContact Action DTO
+ *
+ * Collects a new Contact in Order Builder V2 step 2. Loaded by name by the desktop builder and rendered through CoreForm; the contact is created by the order batch, so this action is the form and its rules rather than the save. The fields the builder asks for are therefore set here rather than in React. A sibling of CreateContact, which keeps serving every other create journey: this one is not the default form and is not a record-header button. Form copied from CreateContact. CORE-1516.
+ *
+ * @module CrmModule
+ * @entity Contact
+ * @actionKey OrderBuilderCreateContact
+ * @event k1.t-hEOJjsDb.CrmModule.Contact.Create.OrderBuilderCreateContact
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrderBuilderCreateContactDto = void 0;
+const core_1 = require("@d19n/odin-types/dist/core");
+/**
+ * OrderBuilderCreateContact
+ *
+ * Collects a new Contact in Order Builder V2 step 2. Loaded by name by the desktop builder and rendered through CoreForm; the contact is created by the order batch, so this action is the form and its rules rather than the save. The fields the builder asks for are therefore set here rather than in React. A sibling of CreateContact, which keeps serving every other create journey: this one is not the default form and is not a record-header button. Form copied from CreateContact. CORE-1516.
+ *
+ * @actionType CREATE - Creates a new Contact record
+ * @module CrmModule
+ * @entity Contact
+ * @event k1.t-hEOJjsDb.CrmModule.Contact.Create.OrderBuilderCreateContact
+ * @permission schema.action.orderbuildercreatecontact.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+class OrderBuilderCreateContactDto 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 = 'OrderBuilderCreateContact';
+        this.schemaActionId = '2d295a37-7256-4303-b490-d3de6e9a32ff';
+        this.entity = 'CrmModule:Contact';
+    }
+}
+exports.OrderBuilderCreateContactDto = OrderBuilderCreateContactDto;
+/** Used by SDK generators to identify action type */
+OrderBuilderCreateContactDto.ACTION_TYPE = 'CREATE';
+OrderBuilderCreateContactDto.ACTION_KEY = 'OrderBuilderCreateContact';
+OrderBuilderCreateContactDto.MODULE_NAME = 'CrmModule';
+OrderBuilderCreateContactDto.ENTITIES = ['Contact'];
+OrderBuilderCreateContactDto.EVENT_NAME = 'k1.t-hEOJjsDb.CrmModule.Contact.Create.OrderBuilderCreateContact';
+OrderBuilderCreateContactDto.PERMISSION = 'schema.action.orderbuildercreatecontact.trigger';
+/** Step metadata - entity this action targets */
+OrderBuilderCreateContactDto.STEP_ENTITY = 'CrmModule:Contact';
+OrderBuilderCreateContactDto.STEP_SCHEMA_ID = '33643a0d-5b77-4895-a2da-991e0fd3432f';
+OrderBuilderCreateContactDto.STEP_SCHEMA_ACTION_ID = '2d295a37-7256-4303-b490-d3de6e9a32ff';
+OrderBuilderCreateContactDto.AUTO_LINK_PARENT = true;

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

@@ -21,8 +21,8 @@ export interface OrderBuilderUpdateContactMessage extends OdinRecordUpdatedEvent
 /**
  * Properties for OrderBuilderUpdateContact action
  *
- * @property Required fields: 3
- * @property Optional fields: 14
+ * @property Required fields: 5
+ * @property Optional fields: 11
  */
 export interface OrderBuilderUpdateContactProperties {
     /**
@@ -50,12 +50,21 @@ export interface OrderBuilderUpdateContactProperties {
      */
     LastName: string;
     /**
-     * Account Status
+     * Are you medically dependent on your broadband?
      *
-     * NONE if haven't started registering, INACTIVE if started registering but haven't finished yet, or ACTIVE if successfully registered (Sales - Contact)
+     * Is the customer medically dependant on their broadband (Sales - Contact)
      * @type {ENUM}
+     * @required
      */
-    AccountStatus?: string | null;
+    MedicallyDependant: string;
+    /**
+     * Do any members of your household rely on a Telecare Alarm?
+     *
+     * Does the customer use a Telecare Alarm (Sales - Contact)
+     * @type {ENUM}
+     * @required
+     */
+    TelecareAlarm: string;
     /**
      * Phone
      *
@@ -106,20 +115,6 @@ export interface OrderBuilderUpdateContactProperties {
      * @type {TEXT}
      */
     CurrentContractType?: string | null;
-    /**
-     * Are you medically dependent on your broadband?
-     *
-     * Is the customer medically dependant on their broadband (Sales - Contact)
-     * @type {ENUM}
-     */
-    MedicallyDependant?: string | null;
-    /**
-     * Do any members of your household rely on a Telecare Alarm?
-     *
-     * Does the customer use a Telecare Alarm (Sales - Contact)
-     * @type {ENUM}
-     */
-    TelecareAlarm?: string | null;
     /**
      * Additional care requirements?
      *

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

@@ -22,7 +22,7 @@ export interface UpdateOutboundDialSessionMessage extends OdinRecordUpdatedEvent
  * Properties for UpdateOutboundDialSession action
  *
  * @property Required fields: 0
- * @property Optional fields: 6
+ * @property Optional fields: 7
  */
 export interface UpdateOutboundDialSessionProperties {
     /**
@@ -67,6 +67,13 @@ export interface UpdateOutboundDialSessionProperties {
      * @type {DATE_TIME}
      */
     LastCaseRequestAt?: string | null;
+    /**
+     * NewSinceOwnCase
+     *
+     * New cases this session has been handed since its last own case; drives the campaign's own-case ratio (CASES-1986).
+     * @type {NUMBER}
+     */
+    NewSinceOwnCase?: number | null;
 }
 /**
  * UpdateOutboundDialSession

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

@@ -22,7 +22,7 @@ export interface UpdateoutbounddialcampaignMessage extends OdinRecordUpdatedEven
  * Properties for Updateoutbounddialcampaign action
  *
  * @property Required fields: 0
- * @property Optional fields: 9
+ * @property Optional fields: 10
  */
 export interface UpdateoutbounddialcampaignProperties {
     /**
@@ -88,6 +88,13 @@ export interface UpdateoutbounddialcampaignProperties {
      * @type {BOOLEAN}
      */
     RetentionCampaign?: boolean | null;
+    /**
+     * NewCasesPerOwnCase
+     *
+     * Round-robin: new cases handed out before each of the agent's own cases, e.g. 2 gives new, new, own (CASES-1986). Empty or 0 keeps own cases first.
+     * @type {NUMBER}
+     */
+    NewCasesPerOwnCase?: number | null;
 }
 /**
  * Updateoutbounddialcampaign