@d19n/youfibre-odin-sdk 2.0.371 → 2.0.373

package/README.md

@@ -372,7 +372,7 @@ This SDK includes **205** entities across **13** modules.
 
 | Entity | Description | Types |
 |--------|-------------|-------|
-| **Document** | Document Entity Definition | CONTRACT_BUYOUT, EMAIL_ATTACHMENT, INVOICE... |
+| **Document** | Document Entity Definition | CONTRACT, CONTRACT_BUYOUT, CORPORATE_DOCUMENT... |
 | **DocumentProcessing** | DocumentProcessing Entity Definition | DEFAULT |
 
 ### ProjectModule
@@ -398,7 +398,7 @@ This SDK includes **205** entities across **13** modules.
 
 ## Actions
 
-This SDK includes **934** actions.
+This SDK includes **936** actions.
 
 ### Action Types
 
@@ -658,6 +658,7 @@ This SDK includes **934** actions.
 | `UpdateRemediationWorkOrder` | UPDATE | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Update.UpdateRemediationWorkOrder |
 | `UpdateSetReturnedLegacy` | UPDATE | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Update.UpdateSetReturnedLegacy |
 | `UpdateWayleaveWorkOrder` | UPDATE | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Update.UpdateWayleaveWorkOrder |
+| `UpdateWorkOrderWithdrawEquipmentCharge` | UPDATE | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Update.UpdateWorkOrderWithdrawEquipmentCharge |
 
 **CancelInstallWorkOrderFlowSupplier Target Stages:** `WorkOrderStageCancelled`
 
@@ -1638,6 +1639,7 @@ This SDK includes **934** actions.
 |--------|------|-------|
 | `CreateContact` | CREATE | k1.t-hEOJjsDb.CrmModule.Contact.Create.CreateContact |
 | `CreateContactSalesApp` | CREATE | k1.t-hEOJjsDb.CrmModule.Contact.Create.CreateContactSalesApp |
+| `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 |
 | `UpdateContact` | UPDATE | k1.t-hEOJjsDb.CrmModule.Contact.Update.UpdateContact |

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: 2
+ * @property Optional fields: 3
  */
 export interface CreateOutboundDialCampaignProperties {
     /**
@@ -88,6 +88,13 @@ export interface CreateOutboundDialCampaignProperties {
      * @type {TEXT}
      */
     DistributionMode?: string | null;
+    /**
+     * RetentionCampaign
+     *
+     * When true, agents on this campaign record the retention RET outcomes and give a reason when they skip a case (CASES-1993). Empty means false.
+     * @type {BOOLEAN}
+     */
+    RetentionCampaign?: boolean | null;
 }
 /**
  * CreateOutboundDialCampaign

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

@@ -0,0 +1,182 @@
+/**
+ * OrderBuilderUpdateContact Action DTO
+ *
+ * Updates an existing Contact from Order Builder V2 step 2. Loaded by name by the desktop builder and saved through CrmModule/v2.0/records/apply-action, so the fields an agent may change on an existing contact are set on this form rather than in React. A sibling of UpdateContact, which keeps serving the Contact detail view: this one is not the default form and is not a record-header button. Form copied from UpdateContact, Critical Dependencies section included. CORE-1493.
+ *
+ * @module CrmModule
+ * @entity Contact
+ * @actionKey OrderBuilderUpdateContact
+ * @event k1.t-hEOJjsDb.CrmModule.Contact.Update.OrderBuilderUpdateContact
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
+/**
+ * RabbitMQ message payload for OrderBuilderUpdateContact updated events
+ *
+ * @event k1.t-hEOJjsDb.CrmModule.Contact.Update.OrderBuilderUpdateContact
+ */
+export interface OrderBuilderUpdateContactMessage extends OdinRecordUpdatedEvent<OrderBuilderUpdateContactDto, OrderBuilderUpdateContactProperties> {
+}
+/**
+ * Properties for OrderBuilderUpdateContact action
+ *
+ * @property Required fields: 3
+ * @property Optional fields: 14
+ */
+export interface OrderBuilderUpdateContactProperties {
+    /**
+     * First Name
+     *
+     * Contacts First Name (Sales - Contact)
+     * @type {TEXT}
+     * @required
+     */
+    FirstName: string;
+    /**
+     * Email Address
+     *
+     * Contacts Email Address (Sales - Contact)
+     * @type {EMAIL}
+     * @required
+     */
+    EmailAddress: string;
+    /**
+     * Last Name
+     *
+     * Contacts Last Name (Sales - Contact)
+     * @type {TEXT}
+     * @required
+     */
+    LastName: string;
+    /**
+     * Account Status
+     *
+     * NONE if haven't started registering, INACTIVE if started registering but haven't finished yet, or ACTIVE if successfully registered (Sales - Contact)
+     * @type {ENUM}
+     */
+    AccountStatus?: string | null;
+    /**
+     * Phone
+     *
+     * Phone number (Sales - Contact)
+     * @type {PHONE_NUMBER_E164_GB}
+     */
+    Phone?: string | null;
+    /**
+     * Mobile
+     *
+     * Mobile phone (Sales - Contact)
+     * @type {TEXT}
+     */
+    Mobile?: string | null;
+    /**
+     * Referral Email
+     *
+     * referral email (Sales - Contact)
+     * @type {TEXT}
+     */
+    ReferralEmail?: string | null;
+    /**
+     * 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;
+    /**
+     * In Contract Until
+     *
+     * the date the customer is in contract with another provider (Sales - Contact)
+     * @type {DATE}
+     * @format DD/MM/YYYY
+     */
+    InContractUntil?: string | null;
+    /**
+     * Previous Provider
+     *
+     * previous/current provider (Sales - Contact)
+     * @type {ENUM}
+     */
+    PreviousProvider?: string | null;
+    /**
+     * Current Contract Type
+     *
+     * current contract type (Sales - Contact)
+     * @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?
+     *
+     * Select a care requirement
+     * @type {ENUM_MULTI_SELECT}
+     */
+    AdditionalCareReason?: string | null;
+    /**
+     * Additional care notes
+     *
+     * Any additional information
+     * @type {TEXT_LONG}
+     */
+    AdditionalCareNotes?: string | null;
+    /**
+     * Additional Care Consent
+     *
+     * Customer consent for recording additional care requirements (Sales - Contact)
+     * @type {BOOLEAN}
+     * @requiredWhen MedicallyDependant = ["YES"] AND TelecareAlarm = ["YES"]
+     */
+    AdditionalCareConsent?: boolean | null;
+}
+/**
+ * OrderBuilderUpdateContact
+ *
+ * Updates an existing Contact from Order Builder V2 step 2. Loaded by name by the desktop builder and saved through CrmModule/v2.0/records/apply-action, so the fields an agent may change on an existing contact are set on this form rather than in React. A sibling of UpdateContact, which keeps serving the Contact detail view: this one is not the default form and is not a record-header button. Form copied from UpdateContact, Critical Dependencies section included. CORE-1493.
+ *
+ * @actionType UPDATE - Updates an existing Contact record
+ * @module CrmModule
+ * @entity Contact
+ * @event k1.t-hEOJjsDb.CrmModule.Contact.Update.OrderBuilderUpdateContact
+ * @permission schema.action.orderbuilderupdatecontact.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+export declare class OrderBuilderUpdateContactDto extends OdinRecordUpdateDto<OrderBuilderUpdateContactProperties> {
+    /** Used by SDK generators to identify action type */
+    static readonly ACTION_TYPE = "UPDATE";
+    static readonly ACTION_KEY = "OrderBuilderUpdateContact";
+    static readonly MODULE_NAME = "CrmModule";
+    static readonly ENTITIES: string[];
+    static readonly EVENT_NAME = "k1.t-hEOJjsDb.CrmModule.Contact.Update.OrderBuilderUpdateContact";
+    static readonly PERMISSION = "schema.action.orderbuilderupdatecontact.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 = "4466e908-e22c-4980-8523-9a18492ab692";
+    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: OrderBuilderUpdateContactProperties, options?: {
+        journeyId?: string;
+        stageKey?: string;
+    });
+}

package/dist/actions-v2/OrderBuilderUpdateContactDto.js

@@ -0,0 +1,56 @@
+"use strict";
+/**
+ * OrderBuilderUpdateContact Action DTO
+ *
+ * Updates an existing Contact from Order Builder V2 step 2. Loaded by name by the desktop builder and saved through CrmModule/v2.0/records/apply-action, so the fields an agent may change on an existing contact are set on this form rather than in React. A sibling of UpdateContact, which keeps serving the Contact detail view: this one is not the default form and is not a record-header button. Form copied from UpdateContact, Critical Dependencies section included. CORE-1493.
+ *
+ * @module CrmModule
+ * @entity Contact
+ * @actionKey OrderBuilderUpdateContact
+ * @event k1.t-hEOJjsDb.CrmModule.Contact.Update.OrderBuilderUpdateContact
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrderBuilderUpdateContactDto = void 0;
+const core_1 = require("@d19n/odin-types/dist/core");
+/**
+ * OrderBuilderUpdateContact
+ *
+ * Updates an existing Contact from Order Builder V2 step 2. Loaded by name by the desktop builder and saved through CrmModule/v2.0/records/apply-action, so the fields an agent may change on an existing contact are set on this form rather than in React. A sibling of UpdateContact, which keeps serving the Contact detail view: this one is not the default form and is not a record-header button. Form copied from UpdateContact, Critical Dependencies section included. CORE-1493.
+ *
+ * @actionType UPDATE - Updates an existing Contact record
+ * @module CrmModule
+ * @entity Contact
+ * @event k1.t-hEOJjsDb.CrmModule.Contact.Update.OrderBuilderUpdateContact
+ * @permission schema.action.orderbuilderupdatecontact.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+class OrderBuilderUpdateContactDto 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 = 'OrderBuilderUpdateContact';
+        this.schemaActionId = '4466e908-e22c-4980-8523-9a18492ab692';
+        this.entity = 'CrmModule:Contact';
+    }
+}
+exports.OrderBuilderUpdateContactDto = OrderBuilderUpdateContactDto;
+/** Used by SDK generators to identify action type */
+OrderBuilderUpdateContactDto.ACTION_TYPE = 'UPDATE';
+OrderBuilderUpdateContactDto.ACTION_KEY = 'OrderBuilderUpdateContact';
+OrderBuilderUpdateContactDto.MODULE_NAME = 'CrmModule';
+OrderBuilderUpdateContactDto.ENTITIES = ['Contact'];
+OrderBuilderUpdateContactDto.EVENT_NAME = 'k1.t-hEOJjsDb.CrmModule.Contact.Update.OrderBuilderUpdateContact';
+OrderBuilderUpdateContactDto.PERMISSION = 'schema.action.orderbuilderupdatecontact.trigger';
+/** Step metadata - entity this action targets */
+OrderBuilderUpdateContactDto.STEP_ENTITY = 'CrmModule:Contact';
+OrderBuilderUpdateContactDto.STEP_SCHEMA_ID = '33643a0d-5b77-4895-a2da-991e0fd3432f';
+OrderBuilderUpdateContactDto.STEP_SCHEMA_ACTION_ID = '4466e908-e22c-4980-8523-9a18492ab692';
+OrderBuilderUpdateContactDto.AUTO_LINK_PARENT = false;

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

@@ -0,0 +1,73 @@
+/**
+ * UpdateWorkOrderWithdrawEquipmentCharge Action DTO
+ *
+ * Withdraws an equipment charge no payment has been taken for: billing credits the invoice, then cancels this work order. A paid or part-paid charge goes through the normal credit and refund process instead. BILL-1005.
+ *
+ * @module FieldServiceModule
+ * @entity WorkOrder
+ * @actionKey UpdateWorkOrderWithdrawEquipmentCharge
+ * @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Update.UpdateWorkOrderWithdrawEquipmentCharge
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
+/**
+ * RabbitMQ message payload for UpdateWorkOrderWithdrawEquipmentCharge updated events
+ *
+ * @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Update.UpdateWorkOrderWithdrawEquipmentCharge
+ */
+export interface UpdateWorkOrderWithdrawEquipmentChargeMessage extends OdinRecordUpdatedEvent<UpdateWorkOrderWithdrawEquipmentChargeDto, UpdateWorkOrderWithdrawEquipmentChargeProperties> {
+}
+/**
+ * Properties for UpdateWorkOrderWithdrawEquipmentCharge action
+ *
+ * @property Required fields: 1
+ * @property Optional fields: 0
+ */
+export interface UpdateWorkOrderWithdrawEquipmentChargeProperties {
+    /**
+     * Why is the charge being withdrawn?
+     *
+     * StatusReason (Field Operations - WorkOrder)
+     * @type {TEXT_LONG}
+     * @required
+     */
+    StatusReason: string;
+}
+/**
+ * Withdraw equipment charge
+ *
+ * Withdraws an equipment charge no payment has been taken for: billing credits the invoice, then cancels this work order. A paid or part-paid charge goes through the normal credit and refund process instead. BILL-1005.
+ *
+ * @actionType UPDATE - Updates an existing WorkOrder record
+ * @module FieldServiceModule
+ * @entity WorkOrder
+ * @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Update.UpdateWorkOrderWithdrawEquipmentCharge
+ * @permission schema.action.updateworkorderwithdrawequipmentcharge.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+export declare class UpdateWorkOrderWithdrawEquipmentChargeDto extends OdinRecordUpdateDto<UpdateWorkOrderWithdrawEquipmentChargeProperties> {
+    /** Used by SDK generators to identify action type */
+    static readonly ACTION_TYPE = "UPDATE";
+    static readonly ACTION_KEY = "UpdateWorkOrderWithdrawEquipmentCharge";
+    static readonly MODULE_NAME = "FieldServiceModule";
+    static readonly ENTITIES: string[];
+    static readonly EVENT_NAME = "k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Update.UpdateWorkOrderWithdrawEquipmentCharge";
+    static readonly PERMISSION = "schema.action.updateworkorderwithdrawequipmentcharge.trigger";
+    /** Step metadata - entity this action targets */
+    static readonly STEP_ENTITY = "FieldServiceModule:WorkOrder";
+    static readonly STEP_SCHEMA_ID = "966bf5d9-163e-4132-85e2-56a5f801c9de";
+    static readonly STEP_SCHEMA_ACTION_ID = "e4fbb5bf-aaff-4783-98ea-6ae58b67d596";
+    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: UpdateWorkOrderWithdrawEquipmentChargeProperties, options?: {
+        journeyId?: string;
+        stageKey?: string;
+    });
+}

package/dist/actions-v2/UpdateWorkOrderWithdrawEquipmentChargeDto.js

@@ -0,0 +1,56 @@
+"use strict";
+/**
+ * UpdateWorkOrderWithdrawEquipmentCharge Action DTO
+ *
+ * Withdraws an equipment charge no payment has been taken for: billing credits the invoice, then cancels this work order. A paid or part-paid charge goes through the normal credit and refund process instead. BILL-1005.
+ *
+ * @module FieldServiceModule
+ * @entity WorkOrder
+ * @actionKey UpdateWorkOrderWithdrawEquipmentCharge
+ * @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Update.UpdateWorkOrderWithdrawEquipmentCharge
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdateWorkOrderWithdrawEquipmentChargeDto = void 0;
+const core_1 = require("@d19n/odin-types/dist/core");
+/**
+ * Withdraw equipment charge
+ *
+ * Withdraws an equipment charge no payment has been taken for: billing credits the invoice, then cancels this work order. A paid or part-paid charge goes through the normal credit and refund process instead. BILL-1005.
+ *
+ * @actionType UPDATE - Updates an existing WorkOrder record
+ * @module FieldServiceModule
+ * @entity WorkOrder
+ * @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Update.UpdateWorkOrderWithdrawEquipmentCharge
+ * @permission schema.action.updateworkorderwithdrawequipmentcharge.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+class UpdateWorkOrderWithdrawEquipmentChargeDto 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 = 'UpdateWorkOrderWithdrawEquipmentCharge';
+        this.schemaActionId = 'e4fbb5bf-aaff-4783-98ea-6ae58b67d596';
+        this.entity = 'FieldServiceModule:WorkOrder';
+    }
+}
+exports.UpdateWorkOrderWithdrawEquipmentChargeDto = UpdateWorkOrderWithdrawEquipmentChargeDto;
+/** Used by SDK generators to identify action type */
+UpdateWorkOrderWithdrawEquipmentChargeDto.ACTION_TYPE = 'UPDATE';
+UpdateWorkOrderWithdrawEquipmentChargeDto.ACTION_KEY = 'UpdateWorkOrderWithdrawEquipmentCharge';
+UpdateWorkOrderWithdrawEquipmentChargeDto.MODULE_NAME = 'FieldServiceModule';
+UpdateWorkOrderWithdrawEquipmentChargeDto.ENTITIES = ['WorkOrder'];
+UpdateWorkOrderWithdrawEquipmentChargeDto.EVENT_NAME = 'k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Update.UpdateWorkOrderWithdrawEquipmentCharge';
+UpdateWorkOrderWithdrawEquipmentChargeDto.PERMISSION = 'schema.action.updateworkorderwithdrawequipmentcharge.trigger';
+/** Step metadata - entity this action targets */
+UpdateWorkOrderWithdrawEquipmentChargeDto.STEP_ENTITY = 'FieldServiceModule:WorkOrder';
+UpdateWorkOrderWithdrawEquipmentChargeDto.STEP_SCHEMA_ID = '966bf5d9-163e-4132-85e2-56a5f801c9de';
+UpdateWorkOrderWithdrawEquipmentChargeDto.STEP_SCHEMA_ACTION_ID = 'e4fbb5bf-aaff-4783-98ea-6ae58b67d596';
+UpdateWorkOrderWithdrawEquipmentChargeDto.AUTO_LINK_PARENT = false;

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: 8
+ * @property Optional fields: 9
  */
 export interface UpdateoutbounddialcampaignProperties {
     /**
@@ -81,6 +81,13 @@ export interface UpdateoutbounddialcampaignProperties {
      * @type {TEXT}
      */
     DistributionMode?: string | null;
+    /**
+     * RetentionCampaign
+     *
+     * When true, agents on this campaign record the retention RET outcomes and give a reason when they skip a case (CASES-1993). Empty means false.
+     * @type {BOOLEAN}
+     */
+    RetentionCampaign?: boolean | null;
 }
 /**
  * Updateoutbounddialcampaign