@d19n/youfibre-odin-sdk 2.0.374 → 2.0.375

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

@@ -21,12 +21,12 @@ export interface OrderBuilderCreateContactMessage extends OdinRecordCreatedEvent
 /**
  * Properties for OrderBuilderCreateContact action
  *
- * @property Required fields: 3
- * @property Optional fields: 3
+ * @property Required fields: 5
+ * @property Optional fields: 10
  */
 export interface OrderBuilderCreateContactProperties {
     /**
-     * FirstName
+     * First Name
      *
      * Contacts First Name (Sales - Contact)
      * @type {TEXT}
@@ -34,7 +34,7 @@ export interface OrderBuilderCreateContactProperties {
      */
     FirstName: string;
     /**
-     * LastName
+     * Last Name
      *
      * Contacts Last Name (Sales - Contact)
      * @type {TEXT}
@@ -42,7 +42,7 @@ export interface OrderBuilderCreateContactProperties {
      */
     LastName: string;
     /**
-     * EmailAddress
+     * Email Address
      *
      * Contacts Email Address (Sales - Contact)
      * @type {EMAIL}
@@ -50,12 +50,21 @@ export interface OrderBuilderCreateContactProperties {
      */
     EmailAddress: string;
     /**
-     * MarketingConsent
+     * Are you medically dependent on your broadband?
      *
-     * 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}
+     * Is the customer medically dependant on their broadband (Sales - Contact)
+     * @type {ENUM}
+     * @required
      */
-    MarketingConsent?: boolean | 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
      *
@@ -63,6 +72,64 @@ export interface OrderBuilderCreateContactProperties {
      * @type {PHONE_NUMBER_E164_GB}
      */
     Phone?: 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;
+    /**
+     * 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;
 }
 /**
  * OrderBuilderCreateContact

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

@@ -22,7 +22,7 @@ export interface OrderBuilderUpdateContactMessage extends OdinRecordUpdatedEvent
  * Properties for OrderBuilderUpdateContact action
  *
  * @property Required fields: 5
- * @property Optional fields: 11
+ * @property Optional fields: 10
  */
 export interface OrderBuilderUpdateContactProperties {
     /**
@@ -33,14 +33,6 @@ export interface OrderBuilderUpdateContactProperties {
      * @required
      */
     FirstName: string;
-    /**
-     * Email Address
-     *
-     * Contacts Email Address (Sales - Contact)
-     * @type {EMAIL}
-     * @required
-     */
-    EmailAddress: string;
     /**
      * Last Name
      *
@@ -49,6 +41,14 @@ export interface OrderBuilderUpdateContactProperties {
      * @required
      */
     LastName: string;
+    /**
+     * Email Address
+     *
+     * Contacts Email Address (Sales - Contact)
+     * @type {EMAIL}
+     * @required
+     */
+    EmailAddress: string;
     /**
      * Are you medically dependent on your broadband?
      *
@@ -72,13 +72,6 @@ export interface OrderBuilderUpdateContactProperties {
      * @type {PHONE_NUMBER_E164_GB}
      */
     Phone?: string | null;
-    /**
-     * Mobile
-     *
-     * Mobile phone (Sales - Contact)
-     * @type {TEXT}
-     */
-    Mobile?: string | null;
     /**
      * Referral Email
      *

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

@@ -1,7 +1,7 @@
 /**
  * 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.
+ * 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. Can send the customer another collection bag. BILL-1005.
  *
  * @module FieldServiceModule
  * @entity WorkOrder
@@ -21,8 +21,8 @@ export interface UpdateWorkOrderWithdrawEquipmentChargeMessage extends OdinRecor
 /**
  * Properties for UpdateWorkOrderWithdrawEquipmentCharge action
  *
- * @property Required fields: 1
- * @property Optional fields: 0
+ * @property Required fields: 4
+ * @property Optional fields: 3
  */
 export interface UpdateWorkOrderWithdrawEquipmentChargeProperties {
     /**
@@ -33,11 +33,61 @@ export interface UpdateWorkOrderWithdrawEquipmentChargeProperties {
      * @required
      */
     StatusReason: string;
+    /**
+     * Address line 1
+     *
+     * Contact information field for WorkOrder. Used by Field Operations team for communication.
+     * @type {TEXT}
+     * @required
+     * @visibleWhen SendAnotherBag = ["*"] AND UseAlternativeAddressManual = ["*"]
+     */
+    AlternativeAddressLine1: string;
+    /**
+     * Town or city
+     *
+     * Contact information field for WorkOrder. Used by Field Operations team for communication.
+     * @type {TEXT}
+     * @required
+     * @visibleWhen SendAnotherBag = ["*"] AND UseAlternativeAddressManual = ["*"]
+     */
+    AlternativeAddressCityTown: string;
+    /**
+     * Postcode
+     *
+     * Contact information field for WorkOrder. Used by Field Operations team for communication.
+     * @type {TEXT}
+     * @required
+     * @visibleWhen SendAnotherBag = ["*"] AND UseAlternativeAddressManual = ["*"]
+     */
+    AlternativeAddressPostCode: string;
+    /**
+     * Send another collection bag
+     *
+     * Set by the "Withdraw equipment charge" form. When the collection is cancelled, field-service raises a new collection, to the alternative address when one is given (BILL-1005).
+     * @type {BOOLEAN}
+     */
+    SendAnotherBag?: boolean | null;
+    /**
+     * Send it to a different address
+     *
+     * UseAlternativeAddressManual (Field Operations - WorkOrder)
+     * @type {BOOLEAN}
+     * @visibleWhen SendAnotherBag = ["*"]
+     */
+    UseAlternativeAddressManual?: boolean | null;
+    /**
+     * Address line 2
+     *
+     * Contact information field for WorkOrder. Used by Field Operations team for communication.
+     * @type {TEXT}
+     * @visibleWhen SendAnotherBag = ["*"] AND UseAlternativeAddressManual = ["*"]
+     */
+    AlternativeAddressLine2?: string | null;
 }
 /**
  * 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.
+ * 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. Can send the customer another collection bag. BILL-1005.
  *
  * @actionType UPDATE - Updates an existing WorkOrder record
  * @module FieldServiceModule

package/dist/actions-v2/UpdateWorkOrderWithdrawEquipmentChargeDto.js

@@ -2,7 +2,7 @@
 /**
  * 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.
+ * 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. Can send the customer another collection bag. BILL-1005.
  *
  * @module FieldServiceModule
  * @entity WorkOrder
@@ -17,7 +17,7 @@ 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.
+ * 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. Can send the customer another collection bag. BILL-1005.
  *
  * @actionType UPDATE - Updates an existing WorkOrder record
  * @module FieldServiceModule

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

@@ -1701,7 +1701,9 @@ export declare enum WorkOrderPropertyKeys {
     /** The missing devices behind InspectionCharge, counted by kind, same shape as EquipmentChargeBreakdown: {"MESH":1}. {} when everything came back. Kinds that cost nothing (ATA) are left out. */
     InspectionChargeBreakdown = "InspectionChargeBreakdown",
     /** On a follow-on COLLECTION_AMCO (a second bag for a partial return): the id of the collection whose missing devices it collects. Set from that collection by CreateCollectionAmcoFollowOnWorkOrder. Null on every other work order */
-    FollowOnOfWorkOrderId = "FollowOnOfWorkOrderId"
+    FollowOnOfWorkOrderId = "FollowOnOfWorkOrderId",
+    /** Set by the "Withdraw equipment charge" form. When the collection is cancelled, field-service raises a new collection, to the alternative address when one is given (BILL-1005). */
+    SendAnotherBag = "SendAnotherBag"
 }
 /**
  * Properties for WorkOrder records
@@ -2532,6 +2534,12 @@ export interface WorkOrderProperties {
      * @default
      */
     FollowOnOfWorkOrderId: string;
+    /** Set by the "Withdraw equipment charge" form. When the collection is cancelled, field-service raises a new collection, to the alternative address when one is given (BILL-1005).
+     *
+     * @type {BOOLEAN}
+     * @default
+     */
+    SendAnotherBag: boolean;
 }
 /**
  * Properties for COLLECTION WorkOrder records
@@ -3362,6 +3370,12 @@ export interface CollectionWorkOrderProperties {
      * @default
      */
     FollowOnOfWorkOrderId: string;
+    /** Set by the "Withdraw equipment charge" form. When the collection is cancelled, field-service raises a new collection, to the alternative address when one is given (BILL-1005).
+     *
+     * @type {BOOLEAN}
+     * @default
+     */
+    SendAnotherBag: boolean;
 }
 /**
  * Properties for COLLECTION_AMCO WorkOrder records
@@ -4192,6 +4206,12 @@ export interface CollectionAmcoWorkOrderProperties {
      * @default
      */
     FollowOnOfWorkOrderId: string;
+    /** Set by the "Withdraw equipment charge" form. When the collection is cancelled, field-service raises a new collection, to the alternative address when one is given (BILL-1005).
+     *
+     * @type {BOOLEAN}
+     * @default
+     */
+    SendAnotherBag: boolean;
 }
 /**
  * Properties for DISPATCH_AMCO WorkOrder records
@@ -5022,6 +5042,12 @@ export interface DispatchAmcoWorkOrderProperties {
      * @default
      */
     FollowOnOfWorkOrderId: string;
+    /** Set by the "Withdraw equipment charge" form. When the collection is cancelled, field-service raises a new collection, to the alternative address when one is given (BILL-1005).
+     *
+     * @type {BOOLEAN}
+     * @default
+     */
+    SendAnotherBag: boolean;
 }
 /**
  * Properties for FINANCE WorkOrder records
@@ -5852,6 +5878,12 @@ export interface FinanceWorkOrderProperties {
      * @default
      */
     FollowOnOfWorkOrderId: string;
+    /** Set by the "Withdraw equipment charge" form. When the collection is cancelled, field-service raises a new collection, to the alternative address when one is given (BILL-1005).
+     *
+     * @type {BOOLEAN}
+     * @default
+     */
+    SendAnotherBag: boolean;
 }
 /**
  * Properties for INSPECTION WorkOrder records
@@ -6682,6 +6714,12 @@ export interface InspectionWorkOrderProperties {
      * @default
      */
     FollowOnOfWorkOrderId: string;
+    /** Set by the "Withdraw equipment charge" form. When the collection is cancelled, field-service raises a new collection, to the alternative address when one is given (BILL-1005).
+     *
+     * @type {BOOLEAN}
+     * @default
+     */
+    SendAnotherBag: boolean;
 }
 /**
  * Properties for INSTALL WorkOrder records
@@ -7512,6 +7550,12 @@ export interface InstallWorkOrderProperties {
      * @default
      */
     FollowOnOfWorkOrderId: string;
+    /** Set by the "Withdraw equipment charge" form. When the collection is cancelled, field-service raises a new collection, to the alternative address when one is given (BILL-1005).
+     *
+     * @type {BOOLEAN}
+     * @default
+     */
+    SendAnotherBag: boolean;
 }
 /**
  * Properties for INSTALL_BUSINESS WorkOrder records
@@ -8342,6 +8386,12 @@ export interface InstallBusinessWorkOrderProperties {
      * @default
      */
     FollowOnOfWorkOrderId: string;
+    /** Set by the "Withdraw equipment charge" form. When the collection is cancelled, field-service raises a new collection, to the alternative address when one is given (BILL-1005).
+     *
+     * @type {BOOLEAN}
+     * @default
+     */
+    SendAnotherBag: boolean;
 }
 /**
  * Properties for INSTALL_SERVICE WorkOrder records
@@ -9172,6 +9222,12 @@ export interface InstallServiceWorkOrderProperties {
      * @default
      */
     FollowOnOfWorkOrderId: string;
+    /** Set by the "Withdraw equipment charge" form. When the collection is cancelled, field-service raises a new collection, to the alternative address when one is given (BILL-1005).
+     *
+     * @type {BOOLEAN}
+     * @default
+     */
+    SendAnotherBag: boolean;
 }
 /**
  * Properties for NETWORK_ADJUSTMENT WorkOrder records
@@ -10002,6 +10058,12 @@ export interface NetworkAdjustmentWorkOrderProperties {
      * @default
      */
     FollowOnOfWorkOrderId: string;
+    /** Set by the "Withdraw equipment charge" form. When the collection is cancelled, field-service raises a new collection, to the alternative address when one is given (BILL-1005).
+     *
+     * @type {BOOLEAN}
+     * @default
+     */
+    SendAnotherBag: boolean;
 }
 /**
  * Properties for PLANNING WorkOrder records
@@ -10832,6 +10894,12 @@ export interface PlanningWorkOrderProperties {
      * @default
      */
     FollowOnOfWorkOrderId: string;
+    /** Set by the "Withdraw equipment charge" form. When the collection is cancelled, field-service raises a new collection, to the alternative address when one is given (BILL-1005).
+     *
+     * @type {BOOLEAN}
+     * @default
+     */
+    SendAnotherBag: boolean;
 }
 /**
  * Properties for PRE_PULL WorkOrder records
@@ -11662,6 +11730,12 @@ export interface PrePullWorkOrderProperties {
      * @default
      */
     FollowOnOfWorkOrderId: string;
+    /** Set by the "Withdraw equipment charge" form. When the collection is cancelled, field-service raises a new collection, to the alternative address when one is given (BILL-1005).
+     *
+     * @type {BOOLEAN}
+     * @default
+     */
+    SendAnotherBag: boolean;
 }
 /**
  * Properties for REMEDIATION WorkOrder records
@@ -12492,6 +12566,12 @@ export interface RemediationWorkOrderProperties {
      * @default
      */
     FollowOnOfWorkOrderId: string;
+    /** Set by the "Withdraw equipment charge" form. When the collection is cancelled, field-service raises a new collection, to the alternative address when one is given (BILL-1005).
+     *
+     * @type {BOOLEAN}
+     * @default
+     */
+    SendAnotherBag: boolean;
 }
 /**
  * Properties for REPLACEMENT_AMCO WorkOrder records
@@ -13322,6 +13402,12 @@ export interface ReplacementAmcoWorkOrderProperties {
      * @default
      */
     FollowOnOfWorkOrderId: string;
+    /** Set by the "Withdraw equipment charge" form. When the collection is cancelled, field-service raises a new collection, to the alternative address when one is given (BILL-1005).
+     *
+     * @type {BOOLEAN}
+     * @default
+     */
+    SendAnotherBag: boolean;
 }
 /**
  * Properties for SERVICE WorkOrder records
@@ -14152,6 +14238,12 @@ export interface ServiceWorkOrderProperties {
      * @default
      */
     FollowOnOfWorkOrderId: string;
+    /** Set by the "Withdraw equipment charge" form. When the collection is cancelled, field-service raises a new collection, to the alternative address when one is given (BILL-1005).
+     *
+     * @type {BOOLEAN}
+     * @default
+     */
+    SendAnotherBag: boolean;
 }
 /**
  * Properties for WAYLEAVE WorkOrder records
@@ -14982,6 +15074,12 @@ export interface WayleaveWorkOrderProperties {
      * @default
      */
     FollowOnOfWorkOrderId: string;
+    /** Set by the "Withdraw equipment charge" form. When the collection is cancelled, field-service raises a new collection, to the alternative address when one is given (BILL-1005).
+     *
+     * @type {BOOLEAN}
+     * @default
+     */
+    SendAnotherBag: boolean;
 }
 /**
  * WorkOrder entity from FieldServiceModule

package/dist/entities-v2/WorkOrder.js

@@ -1702,6 +1702,8 @@ var WorkOrderPropertyKeys;
     WorkOrderPropertyKeys["InspectionChargeBreakdown"] = "InspectionChargeBreakdown";
     /** On a follow-on COLLECTION_AMCO (a second bag for a partial return): the id of the collection whose missing devices it collects. Set from that collection by CreateCollectionAmcoFollowOnWorkOrder. Null on every other work order */
     WorkOrderPropertyKeys["FollowOnOfWorkOrderId"] = "FollowOnOfWorkOrderId";
+    /** Set by the "Withdraw equipment charge" form. When the collection is cancelled, field-service raises a new collection, to the alternative address when one is given (BILL-1005). */
+    WorkOrderPropertyKeys["SendAnotherBag"] = "SendAnotherBag";
 })(WorkOrderPropertyKeys = exports.WorkOrderPropertyKeys || (exports.WorkOrderPropertyKeys = {}));
 /**
  * WorkOrder entity from FieldServiceModule

package/package.json

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