@d19n/youfibre-odin-sdk 2.0.352 → 2.0.353

package/dist/entities-v2/HomeMove.js

@@ -12,7 +12,7 @@
  * Generated from Odin schema definition
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ROUTING_KEY_LINK_HOME_MOVE_NOTE_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_NOTE_CREATED = exports.ROUTING_KEY_LINK_HOME_MOVE_WORK_ORDER_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_WORK_ORDER_CREATED = exports.ROUTING_KEY_LINK_HOME_MOVE_CASE_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_CASE_CREATED = exports.ROUTING_KEY_LINK_HOME_MOVE_NEW_ADDRESS_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_NEW_ADDRESS_CREATED = exports.ROUTING_KEY_LINK_HOME_MOVE_OLD_ORDER_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_OLD_ORDER_CREATED = exports.ROUTING_KEY_LINK_HOME_MOVE_FILE_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_FILE_CREATED = exports.ROUTING_KEY_LINK_HOME_MOVE_CONTACT_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_CONTACT_CREATED = exports.ROUTING_KEY_HOME_MOVE_DEFAULT_DELETED = exports.ROUTING_KEY_HOME_MOVE_DEFAULT_UPDATED = exports.ROUTING_KEY_HOME_MOVE_DEFAULT_CREATED = exports.ROUTING_KEY_HOME_MOVE_DELETED = exports.ROUTING_KEY_HOME_MOVE_UPDATED = exports.ROUTING_KEY_HOME_MOVE_CREATED = exports.HomeMove = exports.HomeMovePropertyKeys = exports.HomeMoveCollectionKitAddress = exports.HomeMoveRouterDeliveryAddress = exports.HomeMoveServiceableVia = exports.DefaultHomeMoveStageKeys = exports.DefaultHomeMoveStageNames = exports.HomeMoveEntityTypes = void 0;
+exports.ROUTING_KEY_LINK_HOME_MOVE_NOTE_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_NOTE_CREATED = exports.ROUTING_KEY_LINK_HOME_MOVE_WORK_ORDER_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_WORK_ORDER_CREATED = exports.ROUTING_KEY_LINK_HOME_MOVE_CASE_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_CASE_CREATED = exports.ROUTING_KEY_LINK_HOME_MOVE_NEW_ADDRESS_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_NEW_ADDRESS_CREATED = exports.ROUTING_KEY_LINK_HOME_MOVE_OLD_ORDER_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_OLD_ORDER_CREATED = exports.ROUTING_KEY_LINK_HOME_MOVE_FILE_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_FILE_CREATED = exports.ROUTING_KEY_LINK_HOME_MOVE_CONTACT_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_CONTACT_CREATED = exports.ROUTING_KEY_HOME_MOVE_DEFAULT_DELETED = exports.ROUTING_KEY_HOME_MOVE_DEFAULT_UPDATED = exports.ROUTING_KEY_HOME_MOVE_DEFAULT_CREATED = exports.ROUTING_KEY_HOME_MOVE_DELETED = exports.ROUTING_KEY_HOME_MOVE_UPDATED = exports.ROUTING_KEY_HOME_MOVE_CREATED = exports.HomeMove = exports.HomeMovePropertyKeys = exports.HomeMoveServiceableVia = exports.HomeMoveCollectionKitAddress = exports.HomeMoveRouterDeliveryAddress = exports.DefaultHomeMoveStageKeys = exports.DefaultHomeMoveStageNames = exports.HomeMoveEntityTypes = void 0;
 const core_1 = require("@d19n/odin-types/dist/core");
 /**
  * Available types for HomeMove records
@@ -29,28 +29,24 @@ var HomeMoveEntityTypes;
  */
 var DefaultHomeMoveStageNames;
 (function (DefaultHomeMoveStageNames) {
-    /** Raised against one Active order (the old order). The new address has not been checked yet. (default) */
+    /** Raised against one Active order (the old order). The serviceability check decides the next stage. (default) */
     DefaultHomeMoveStageNames["Created"] = "Created";
-    /** Serviceability looked up for the new address. Next: confirm the move, or Not Serviceable. */
-    DefaultHomeMoveStageNames["AddressChecked"] = "Address Checked";
-    /** Choosing the install date and the old order cancel date. Old balance must be clear to go on. */
-    DefaultHomeMoveStageNames["ConfirmingMove"] = "Confirming Move";
-    /** New order being placed at the new address; old order cancel date being scheduled. */
-    DefaultHomeMoveStageNames["PlacingNewOrder"] = "Placing New Order";
-    /** The new order is live. Waiting for the old order to cancel on its own chosen date. */
-    DefaultHomeMoveStageNames["NewServiceActive"] = "New Service Active";
-    /** New order live and old order cancelled. Final. (success) */
+    /** We can serve the new address. Agreeing dates and products. Old balance must be clear to go on. */
+    DefaultHomeMoveStageNames["Serviceable"] = "Serviceable";
+    /** New order placed. Waiting for its install or activation, and for the old order to close. */
+    DefaultHomeMoveStageNames["MoveInProgress"] = "Move In Progress";
+    /** New service live and old order closed. Final. (success) */
     DefaultHomeMoveStageNames["MoveComplete"] = "Move Complete";
-    /** No coverage at the new address. Waiting up to 7 days for proof of the move (see ProofDueDate). */
+    /** We cannot serve the new address. Waiting up to 7 days for proof of the move (see ProofDueDate). */
     DefaultHomeMoveStageNames["NotServiceable"] = "Not Serviceable";
-    /** Proof arrived within 7 days. Account cancelled with the ETF waived. Final. (fail) */
-    DefaultHomeMoveStageNames["ProofReceived"] = "Proof Received";
-    /** No proof after 7 days. ETF invoiced and passed to RevOps, then Debt Collection. Final. (fail) */
-    DefaultHomeMoveStageNames["NoProof"] = "No Proof";
-    /** The customer is leaving rather than moving service. ETF quoted, old order cancel scheduled. Final. (fail) */
-    DefaultHomeMoveStageNames["Declined"] = "Declined";
-    /** The move was abandoned. The customer keeps their current service. Final. (fail) */
-    DefaultHomeMoveStageNames["Cancelled"] = "Cancelled";
+    /** Proof arrived within 7 days. Account cancelled with no early termination fee. Final. (fail) */
+    DefaultHomeMoveStageNames["EtfWaived"] = "ETF Waived";
+    /** No proof after 7 days. Early termination fee invoiced and passed to RevOps, then Debt Collection. Final. (fail) */
+    DefaultHomeMoveStageNames["EtfCharged"] = "ETF Charged";
+    /** The customer is not moving their service. ETF quoted, old order cancel scheduled. Final. (fail) */
+    DefaultHomeMoveStageNames["CustomerLeaving"] = "Customer Leaving";
+    /** The Home Move was cancelled. The customer keeps their current service. Final. (fail) */
+    DefaultHomeMoveStageNames["MoveCancelled"] = "Move Cancelled";
 })(DefaultHomeMoveStageNames = exports.DefaultHomeMoveStageNames || (exports.DefaultHomeMoveStageNames = {}));
 /**
  * Pipeline stage keys for DEFAULT HomeMove
@@ -58,45 +54,25 @@ var DefaultHomeMoveStageNames;
  */
 var DefaultHomeMoveStageKeys;
 (function (DefaultHomeMoveStageKeys) {
-    /** Raised against one Active order (the old order). The new address has not been checked yet. */
+    /** Raised against one Active order (the old order). The serviceability check decides the next stage. */
     DefaultHomeMoveStageKeys["HomeMoveStageCreated"] = "HomeMoveStageCreated";
-    /** Serviceability looked up for the new address. Next: confirm the move, or Not Serviceable. */
-    DefaultHomeMoveStageKeys["HomeMoveStageAddressChecked"] = "HomeMoveStageAddressChecked";
-    /** Choosing the install date and the old order cancel date. Old balance must be clear to go on. */
-    DefaultHomeMoveStageKeys["HomeMoveStageConfirmingMove"] = "HomeMoveStageConfirmingMove";
-    /** New order being placed at the new address; old order cancel date being scheduled. */
-    DefaultHomeMoveStageKeys["HomeMoveStagePlacingNewOrder"] = "HomeMoveStagePlacingNewOrder";
-    /** The new order is live. Waiting for the old order to cancel on its own chosen date. */
-    DefaultHomeMoveStageKeys["HomeMoveStageNewServiceActive"] = "HomeMoveStageNewServiceActive";
-    /** New order live and old order cancelled. Final. */
+    /** We can serve the new address. Agreeing dates and products. Old balance must be clear to go on. */
+    DefaultHomeMoveStageKeys["HomeMoveStageServiceable"] = "HomeMoveStageServiceable";
+    /** New order placed. Waiting for its install or activation, and for the old order to close. */
+    DefaultHomeMoveStageKeys["HomeMoveStageMoveInProgress"] = "HomeMoveStageMoveInProgress";
+    /** New service live and old order closed. Final. */
     DefaultHomeMoveStageKeys["HomeMoveStageMoveComplete"] = "HomeMoveStageMoveComplete";
-    /** No coverage at the new address. Waiting up to 7 days for proof of the move (see ProofDueDate). */
+    /** We cannot serve the new address. Waiting up to 7 days for proof of the move (see ProofDueDate). */
     DefaultHomeMoveStageKeys["HomeMoveStageNotServiceable"] = "HomeMoveStageNotServiceable";
-    /** Proof arrived within 7 days. Account cancelled with the ETF waived. Final. */
-    DefaultHomeMoveStageKeys["HomeMoveStageProofReceived"] = "HomeMoveStageProofReceived";
-    /** No proof after 7 days. ETF invoiced and passed to RevOps, then Debt Collection. Final. */
-    DefaultHomeMoveStageKeys["HomeMoveStageNoProof"] = "HomeMoveStageNoProof";
-    /** The customer is leaving rather than moving service. ETF quoted, old order cancel scheduled. Final. */
-    DefaultHomeMoveStageKeys["HomeMoveStageDeclined"] = "HomeMoveStageDeclined";
-    /** The move was abandoned. The customer keeps their current service. Final. */
-    DefaultHomeMoveStageKeys["HomeMoveStageCancelled"] = "HomeMoveStageCancelled";
+    /** Proof arrived within 7 days. Account cancelled with no early termination fee. Final. */
+    DefaultHomeMoveStageKeys["HomeMoveStageEtfWaived"] = "HomeMoveStageEtfWaived";
+    /** No proof after 7 days. Early termination fee invoiced and passed to RevOps, then Debt Collection. Final. */
+    DefaultHomeMoveStageKeys["HomeMoveStageEtfCharged"] = "HomeMoveStageEtfCharged";
+    /** The customer is not moving their service. ETF quoted, old order cancel scheduled. Final. */
+    DefaultHomeMoveStageKeys["HomeMoveStageCustomerLeaving"] = "HomeMoveStageCustomerLeaving";
+    /** The Home Move was cancelled. The customer keeps their current service. Final. */
+    DefaultHomeMoveStageKeys["HomeMoveStageMoveCancelled"] = "HomeMoveStageMoveCancelled";
 })(DefaultHomeMoveStageKeys = exports.DefaultHomeMoveStageKeys || (exports.DefaultHomeMoveStageKeys = {}));
-/**
- * Valid values for HomeMove.ServiceableVia
- *
- * Which network can serve the new address. Set at Address Checked. OPENREACH is handled by hand in v1.
- *
- * @remarks Available options:
- * - `NETOMNIA` - Netomnia
- * - `NONE` - None
- * - `OPENREACH` - Openreach
- */
-var HomeMoveServiceableVia;
-(function (HomeMoveServiceableVia) {
-    HomeMoveServiceableVia["NETOMNIA"] = "NETOMNIA";
-    HomeMoveServiceableVia["NONE"] = "NONE";
-    HomeMoveServiceableVia["OPENREACH"] = "OPENREACH";
-})(HomeMoveServiceableVia = exports.HomeMoveServiceableVia || (exports.HomeMoveServiceableVia = {}));
 /**
  * Valid values for HomeMove.RouterDeliveryAddress
  *
@@ -114,7 +90,7 @@ var HomeMoveRouterDeliveryAddress;
 /**
  * Valid values for HomeMove.CollectionKitAddress
  *
- * Which address the return kit for the old router goes to. Asked only when the customer is leaving (Declined or Not Serviceable).
+ * Which address the return kit for the old router goes to. Asked only when the customer is leaving (Customer Leaving or Not Serviceable).
  *
  * @remarks Available options:
  * - `OLD_ADDRESS` - Current address
@@ -125,6 +101,24 @@ var HomeMoveCollectionKitAddress;
     HomeMoveCollectionKitAddress["CURRENT_ADDRESS"] = "OLD_ADDRESS";
     HomeMoveCollectionKitAddress["NEW_ADDRESS"] = "NEW_ADDRESS";
 })(HomeMoveCollectionKitAddress = exports.HomeMoveCollectionKitAddress || (exports.HomeMoveCollectionKitAddress = {}));
+/**
+ * Valid values for HomeMove.ServiceableVia
+ *
+ * Which network can serve the new address. Set by the serviceability check at Created. Netomnia and Brsk are one company, so both move now; OPENREACH is a later phase.
+ *
+ * @remarks Available options:
+ * - `BRSK` - Brsk
+ * - `NETOMNIA` - Netomnia
+ * - `NONE` - None
+ * - `OPENREACH` - Openreach
+ */
+var HomeMoveServiceableVia;
+(function (HomeMoveServiceableVia) {
+    HomeMoveServiceableVia["BRSK"] = "BRSK";
+    HomeMoveServiceableVia["NETOMNIA"] = "NETOMNIA";
+    HomeMoveServiceableVia["NONE"] = "NONE";
+    HomeMoveServiceableVia["OPENREACH"] = "OPENREACH";
+})(HomeMoveServiceableVia = exports.HomeMoveServiceableVia || (exports.HomeMoveServiceableVia = {}));
 /**
  * Property keys for HomeMove
  * Use these constants instead of string literals for type safety
@@ -135,34 +129,34 @@ var HomeMovePropertyKeys;
     HomeMovePropertyKeys["OldOrderId"] = "OldOrderId";
     /** The account holder who is moving. Set when the move is created. */
     HomeMovePropertyKeys["ContactId"] = "ContactId";
-    /** The address being moved to. Set at Address Checked; used by checkout (addressId). */
-    HomeMovePropertyKeys["NewAddressId"] = "NewAddressId";
-    /** The order placed at the new address. Set once, when checkout returns at Placing New Order. */
-    HomeMovePropertyKeys["NewOrderId"] = "NewOrderId";
     /** The Case raised at Not Serviceable, held 7 days for proof of the move. */
     HomeMovePropertyKeys["CaseId"] = "CaseId";
-    /** Which network can serve the new address. Set at Address Checked. OPENREACH is handled by hand in v1. */
-    HomeMovePropertyKeys["ServiceableVia"] = "ServiceableVia";
-    /** The ONT at the new address cannot carry the product speed, so an engineer visit is needed. Set at Confirming Move by the speed-change hardware rules. Empty = not checked. */
+    /** Which address a replacement router goes to. Asked only when a router is replaced. One parcel: new router in, old one back. */
+    HomeMovePropertyKeys["RouterDeliveryAddress"] = "RouterDeliveryAddress";
+    /** End of the 7-day proof window. Set on entering Not Serviceable; the 7-day job reads it. */
+    HomeMovePropertyKeys["ProofDueDate"] = "ProofDueDate";
+    /** The address being moved to. Set by the serviceability check at Created; used by checkout (addressId). */
+    HomeMovePropertyKeys["NewAddressId"] = "NewAddressId";
+    /** The order placed at the new address. Set once, when checkout returns at Move In Progress. */
+    HomeMovePropertyKeys["NewOrderId"] = "NewOrderId";
+    /** The ONT at the new address cannot carry the product speed, so an engineer visit is needed. Set at Serviceable by the speed-change hardware rules. Empty = not checked. */
     HomeMovePropertyKeys["RequiredOntUpgrade"] = "RequiredOntUpgrade";
-    /** The router cannot carry the product speed, so a replacement is sent. Set at Confirming Move. Empty = not checked. */
+    /** The router cannot carry the product speed, so a replacement is sent. Set at Serviceable. Empty = not checked. */
     HomeMovePropertyKeys["RequiredRouterUpgrade"] = "RequiredRouterUpgrade";
-    /** The mesh cannot carry the product speed, so replacements are sent. Set at Confirming Move. Empty = not checked. */
+    /** The mesh cannot carry the product speed, so replacements are sent. Set at Serviceable. Empty = not checked. */
     HomeMovePropertyKeys["RequiredMeshUpgrade"] = "RequiredMeshUpgrade";
-    /** Customer-chosen date for the new order. Set at Confirming Move. Independent of the old order cancel date. */
+    /** Customer-chosen date for the new order. Set at Serviceable. Independent of the old order cancel date. */
     HomeMovePropertyKeys["NewOrderInstallOrActivationDate"] = "NewOrderInstallOrActivationDate";
-    /** Customer-chosen cancel date for the old order. Set at Confirming Move. Both orders run, and are billed, until then. */
+    /** Customer-chosen cancel date for the old order. Set at Serviceable. Both orders run, and are billed, until then. */
     HomeMovePropertyKeys["OldOrderCancellationDate"] = "OldOrderCancellationDate";
-    /** Which address a replacement router goes to. Asked only when a router is replaced. One parcel: new router in, old one back. */
-    HomeMovePropertyKeys["RouterDeliveryAddress"] = "RouterDeliveryAddress";
-    /** Which address the return kit for the old router goes to. Asked only when the customer is leaving (Declined or Not Serviceable). */
+    /** Which address the return kit for the old router goes to. Asked only when the customer is leaving (Customer Leaving or Not Serviceable). */
     HomeMovePropertyKeys["CollectionKitAddress"] = "CollectionKitAddress";
-    /** Early termination fee on the old order, from BillingModule early-termination quote. Set at Declined or No Proof. */
+    /** Early termination fee on the old order, from BillingModule early-termination quote. Set at Customer Leaving or ETF Charged. */
     HomeMovePropertyKeys["EtfAmount"] = "ETFAmount";
-    /** True when proof of move arrived in time (Proof Received). Empty until decided. */
+    /** True when proof of move arrived in time (ETF Waived). Empty until decided. */
     HomeMovePropertyKeys["EtfWaived"] = "ETFWaived";
-    /** End of the 7-day proof window. Set on entering Not Serviceable; the 7-day job reads it. */
-    HomeMovePropertyKeys["ProofDueDate"] = "ProofDueDate";
+    /** Which network can serve the new address. Set by the serviceability check at Created. Netomnia and Brsk are one company, so both move now; OPENREACH is a later phase. */
+    HomeMovePropertyKeys["ServiceableVia"] = "ServiceableVia";
 })(HomeMovePropertyKeys = exports.HomeMovePropertyKeys || (exports.HomeMovePropertyKeys = {}));
 /**
  * HomeMove entity from OrderModule

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

@@ -58,7 +58,9 @@ export declare enum DefaultPgPaymentMethodStageNames {
     /** Invalid (fail) */
     Invalid = "Invalid",
     /** Reallocating */
-    Reallocating = "Reallocating"
+    Reallocating = "Reallocating",
+    /** The payer's bank moved this account and we followed it. This instruction is retired; a successor payment method holds the new details. Not a cancellation — the payer did not cancel — and not Invalid, which would bar them from re-adding these details. */
+    Transferred = "Transferred"
 }
 /**
  * Pipeline stage keys for DEFAULT PgPaymentMethod
@@ -94,7 +96,9 @@ export declare enum DefaultPgPaymentMethodStageKeys {
     /** Invalid */
     StatusStageInvalid = "StatusStageInvalid",
     /** Reallocating */
-    StatusStageReallocating = "StatusStageReallocating"
+    StatusStageReallocating = "StatusStageReallocating",
+    /** The payer's bank moved this account and we followed it. This instruction is retired; a successor payment method holds the new details. Not a cancellation — the payer did not cancel — and not Invalid, which would bar them from re-adding these details. */
+    StatusStageTransferred = "StatusStageTransferred"
 }
 /**
  * Valid values for PgPaymentMethod.Company

package/dist/entities-v2/PgPaymentMethod.js

@@ -59,6 +59,8 @@ var DefaultPgPaymentMethodStageNames;
     DefaultPgPaymentMethodStageNames["Invalid"] = "Invalid";
     /** Reallocating */
     DefaultPgPaymentMethodStageNames["Reallocating"] = "Reallocating";
+    /** The payer's bank moved this account and we followed it. This instruction is retired; a successor payment method holds the new details. Not a cancellation — the payer did not cancel — and not Invalid, which would bar them from re-adding these details. */
+    DefaultPgPaymentMethodStageNames["Transferred"] = "Transferred";
 })(DefaultPgPaymentMethodStageNames = exports.DefaultPgPaymentMethodStageNames || (exports.DefaultPgPaymentMethodStageNames = {}));
 /**
  * Pipeline stage keys for DEFAULT PgPaymentMethod
@@ -96,6 +98,8 @@ var DefaultPgPaymentMethodStageKeys;
     DefaultPgPaymentMethodStageKeys["StatusStageInvalid"] = "StatusStageInvalid";
     /** Reallocating */
     DefaultPgPaymentMethodStageKeys["StatusStageReallocating"] = "StatusStageReallocating";
+    /** The payer's bank moved this account and we followed it. This instruction is retired; a successor payment method holds the new details. Not a cancellation — the payer did not cancel — and not Invalid, which would bar them from re-adding these details. */
+    DefaultPgPaymentMethodStageKeys["StatusStageTransferred"] = "StatusStageTransferred";
 })(DefaultPgPaymentMethodStageKeys = exports.DefaultPgPaymentMethodStageKeys || (exports.DefaultPgPaymentMethodStageKeys = {}));
 /**
  * Valid values for PgPaymentMethod.Company

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

@@ -57,11 +57,13 @@ export declare enum DefaultRecontractStageKeys {
  * @remarks Available options:
  * - `AGENT` - Agent
  * - `CUSTOMER_APP` - Customer App
+ * - `CUSTOMER_PORTAL` - Customer Portal
  * - `WEB_RECONTRACT` - Website
  */
 export declare enum RecontractSource {
     AGENT = "AGENT",
     CUSTOMER_APP = "CUSTOMER_APP",
+    CUSTOMER_PORTAL = "CUSTOMER_PORTAL",
     WEBSITE = "WEB_RECONTRACT"
 }
 /**

package/dist/entities-v2/Recontract.js

@@ -61,12 +61,14 @@ var DefaultRecontractStageKeys;
  * @remarks Available options:
  * - `AGENT` - Agent
  * - `CUSTOMER_APP` - Customer App
+ * - `CUSTOMER_PORTAL` - Customer Portal
  * - `WEB_RECONTRACT` - Website
  */
 var RecontractSource;
 (function (RecontractSource) {
     RecontractSource["AGENT"] = "AGENT";
     RecontractSource["CUSTOMER_APP"] = "CUSTOMER_APP";
+    RecontractSource["CUSTOMER_PORTAL"] = "CUSTOMER_PORTAL";
     RecontractSource["WEBSITE"] = "WEB_RECONTRACT";
 })(RecontractSource = exports.RecontractSource || (exports.RecontractSource = {}));
 /**