@d19n/youfibre-odin-sdk 2.0.352 → 2.0.353

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. package/README.md +16 -19
  2. package/dist/actions-v2/{MoveHomeMoveToPlacingNewOrderDto.d.ts → MoveHomeMoveToCustomerLeavingDto.d.ts} +20 -20
  3. package/dist/actions-v2/MoveHomeMoveToCustomerLeavingDto.js +62 -0
  4. package/dist/actions-v2/{MoveHomeMoveToNoProofDto.d.ts → MoveHomeMoveToEtfChargedDto.d.ts} +20 -20
  5. package/dist/actions-v2/MoveHomeMoveToEtfChargedDto.js +62 -0
  6. package/dist/actions-v2/{MoveHomeMoveToCancelledDto.d.ts → MoveHomeMoveToEtfWaivedDto.d.ts} +20 -20
  7. package/dist/actions-v2/MoveHomeMoveToEtfWaivedDto.js +62 -0
  8. package/dist/actions-v2/{MoveHomeMoveToProofReceivedDto.d.ts → MoveHomeMoveToMoveCancelledDto.d.ts} +20 -20
  9. package/dist/actions-v2/MoveHomeMoveToMoveCancelledDto.js +62 -0
  10. package/dist/actions-v2/{MoveHomeMoveToAddressCheckedDto.d.ts → MoveHomeMoveToMoveInProgressDto.d.ts} +20 -20
  11. package/dist/actions-v2/MoveHomeMoveToMoveInProgressDto.js +62 -0
  12. package/dist/actions-v2/{MoveHomeMoveToDeclinedDto.d.ts → MoveHomeMoveToServiceableDto.d.ts} +20 -20
  13. package/dist/actions-v2/MoveHomeMoveToServiceableDto.js +62 -0
  14. package/dist/actions-v2/MovePgPaymentMethodToTransferredDto.d.ts +70 -0
  15. package/dist/actions-v2/MovePgPaymentMethodToTransferredDto.js +62 -0
  16. package/dist/entities-v2/Case.d.ts +14 -1
  17. package/dist/entities-v2/Case.js +14 -1
  18. package/dist/entities-v2/Commitment.d.ts +9 -9
  19. package/dist/entities-v2/Commitment.js +2 -2
  20. package/dist/entities-v2/CustomerDevice.d.ts +37 -1
  21. package/dist/entities-v2/CustomerDevice.js +17 -1
  22. package/dist/entities-v2/HomeMove.d.ts +95 -101
  23. package/dist/entities-v2/HomeMove.js +68 -74
  24. package/dist/entities-v2/PgPaymentMethod.d.ts +6 -2
  25. package/dist/entities-v2/PgPaymentMethod.js +4 -0
  26. package/dist/entities-v2/Recontract.d.ts +2 -0
  27. package/dist/entities-v2/Recontract.js +2 -0
  28. package/dist/entities-v2/VoiceConfiguration.d.ts +130 -130
  29. package/dist/entities-v2/VoiceConfiguration.js +46 -46
  30. package/dist/records-v2/HomeMoveRecord.d.ts +30 -80
  31. package/dist/records-v2/HomeMoveRecord.js +42 -100
  32. package/dist/records-v2/PgPaymentMethodRecord.d.ts +25 -0
  33. package/dist/records-v2/PgPaymentMethodRecord.js +29 -0
  34. package/package.json +1 -1
  35. package/dist/actions-v2/MoveHomeMoveToAddressCheckedDto.js +0 -62
  36. package/dist/actions-v2/MoveHomeMoveToCancelledDto.js +0 -62
  37. package/dist/actions-v2/MoveHomeMoveToConfirmingMoveDto.d.ts +0 -70
  38. package/dist/actions-v2/MoveHomeMoveToConfirmingMoveDto.js +0 -62
  39. package/dist/actions-v2/MoveHomeMoveToDeclinedDto.js +0 -62
  40. package/dist/actions-v2/MoveHomeMoveToNewServiceActiveDto.d.ts +0 -70
  41. package/dist/actions-v2/MoveHomeMoveToNewServiceActiveDto.js +0 -62
  42. package/dist/actions-v2/MoveHomeMoveToNoProofDto.js +0 -62
  43. package/dist/actions-v2/MoveHomeMoveToPlacingNewOrderDto.js +0 -62
  44. package/dist/actions-v2/MoveHomeMoveToProofReceivedDto.js +0 -62
@@ -26,6 +26,19 @@ export declare enum CustomerDeviceEntityTypes {
26
26
  /** TV Device */
27
27
  TV_DEVICE = "TV_DEVICE"
28
28
  }
29
+ /**
30
+ * Valid values for CustomerDevice.Version
31
+ *
32
+ * Which TV box this is: the original BetterTV box (V1) or the Pleio box (V2) (PORTAPP-3405).
33
+ *
34
+ * @remarks Available options:
35
+ * - `V1`
36
+ * - `V2` - V2 (Pleio)
37
+ */
38
+ export declare enum CustomerDeviceVersion {
39
+ V1 = "V1",
40
+ V2_PLEIO = "V2"
41
+ }
29
42
  /**
30
43
  * Property keys for CustomerDevice
31
44
  * Use these constants instead of string literals for type safety
@@ -34,7 +47,9 @@ export declare enum CustomerDevicePropertyKeys {
34
47
  /** Mac Address */
35
48
  MacAddress = "MacAddress",
36
49
  /** Serial Number */
37
- SerialNumber = "SerialNumber"
50
+ SerialNumber = "SerialNumber",
51
+ /** Which TV box this is: the original BetterTV box (V1) or the Pleio box (V2) (PORTAPP-3405). */
52
+ Version = "Version"
38
53
  }
39
54
  /**
40
55
  * Properties for CustomerDevice records
@@ -52,6 +67,13 @@ export interface CustomerDeviceProperties {
52
67
  * @type {TEXT}
53
68
  */
54
69
  SerialNumber: string;
70
+ /** Which TV box this is: the original BetterTV box (V1) or the Pleio box (V2) (PORTAPP-3405).
71
+ *
72
+ * @type {ENUM}
73
+ * @default
74
+ * @enum {CustomerDeviceVersion}
75
+ */
76
+ Version: CustomerDeviceVersion;
55
77
  }
56
78
  /**
57
79
  * Properties for BATTERY CustomerDevice records
@@ -69,6 +91,13 @@ export interface BatteryCustomerDeviceProperties {
69
91
  * @type {TEXT}
70
92
  */
71
93
  SerialNumber: string;
94
+ /** Which TV box this is: the original BetterTV box (V1) or the Pleio box (V2) (PORTAPP-3405).
95
+ *
96
+ * @type {ENUM}
97
+ * @default
98
+ * @enum {CustomerDeviceVersion}
99
+ */
100
+ Version: CustomerDeviceVersion;
72
101
  }
73
102
  /**
74
103
  * Properties for TV_DEVICE CustomerDevice records
@@ -86,6 +115,13 @@ export interface TvDeviceCustomerDeviceProperties {
86
115
  * @type {TEXT}
87
116
  */
88
117
  SerialNumber: string;
118
+ /** Which TV box this is: the original BetterTV box (V1) or the Pleio box (V2) (PORTAPP-3405).
119
+ *
120
+ * @type {ENUM}
121
+ * @default
122
+ * @enum {CustomerDeviceVersion}
123
+ */
124
+ Version: CustomerDeviceVersion;
89
125
  }
90
126
  /**
91
127
  * CustomerDevice entity from ServiceModule
@@ -12,7 +12,7 @@
12
12
  * Generated from Odin schema definition
13
13
  */
14
14
  Object.defineProperty(exports, "__esModule", { value: true });
15
- exports.ROUTING_KEY_LINK_CUSTOMER_DEVICE_ORDER_ITEM_DELETED = exports.ROUTING_KEY_LINK_CUSTOMER_DEVICE_ORDER_ITEM_CREATED = exports.ROUTING_KEY_LINK_CUSTOMER_DEVICE_FIELD_SERVICE_DISPATCHED_PRODUCT_DELETED = exports.ROUTING_KEY_LINK_CUSTOMER_DEVICE_FIELD_SERVICE_DISPATCHED_PRODUCT_CREATED = exports.ROUTING_KEY_CUSTOMER_DEVICE_TV_DEVICE_DELETED = exports.ROUTING_KEY_CUSTOMER_DEVICE_TV_DEVICE_UPDATED = exports.ROUTING_KEY_CUSTOMER_DEVICE_TV_DEVICE_CREATED = exports.ROUTING_KEY_CUSTOMER_DEVICE_DEFAULT_DELETED = exports.ROUTING_KEY_CUSTOMER_DEVICE_DEFAULT_UPDATED = exports.ROUTING_KEY_CUSTOMER_DEVICE_DEFAULT_CREATED = exports.ROUTING_KEY_CUSTOMER_DEVICE_BATTERY_DELETED = exports.ROUTING_KEY_CUSTOMER_DEVICE_BATTERY_UPDATED = exports.ROUTING_KEY_CUSTOMER_DEVICE_BATTERY_CREATED = exports.ROUTING_KEY_CUSTOMER_DEVICE_DELETED = exports.ROUTING_KEY_CUSTOMER_DEVICE_UPDATED = exports.ROUTING_KEY_CUSTOMER_DEVICE_CREATED = exports.CustomerDevice = exports.CustomerDevicePropertyKeys = exports.CustomerDeviceEntityTypes = void 0;
15
+ exports.ROUTING_KEY_LINK_CUSTOMER_DEVICE_ORDER_ITEM_DELETED = exports.ROUTING_KEY_LINK_CUSTOMER_DEVICE_ORDER_ITEM_CREATED = exports.ROUTING_KEY_LINK_CUSTOMER_DEVICE_FIELD_SERVICE_DISPATCHED_PRODUCT_DELETED = exports.ROUTING_KEY_LINK_CUSTOMER_DEVICE_FIELD_SERVICE_DISPATCHED_PRODUCT_CREATED = exports.ROUTING_KEY_CUSTOMER_DEVICE_TV_DEVICE_DELETED = exports.ROUTING_KEY_CUSTOMER_DEVICE_TV_DEVICE_UPDATED = exports.ROUTING_KEY_CUSTOMER_DEVICE_TV_DEVICE_CREATED = exports.ROUTING_KEY_CUSTOMER_DEVICE_DEFAULT_DELETED = exports.ROUTING_KEY_CUSTOMER_DEVICE_DEFAULT_UPDATED = exports.ROUTING_KEY_CUSTOMER_DEVICE_DEFAULT_CREATED = exports.ROUTING_KEY_CUSTOMER_DEVICE_BATTERY_DELETED = exports.ROUTING_KEY_CUSTOMER_DEVICE_BATTERY_UPDATED = exports.ROUTING_KEY_CUSTOMER_DEVICE_BATTERY_CREATED = exports.ROUTING_KEY_CUSTOMER_DEVICE_DELETED = exports.ROUTING_KEY_CUSTOMER_DEVICE_UPDATED = exports.ROUTING_KEY_CUSTOMER_DEVICE_CREATED = exports.CustomerDevice = exports.CustomerDevicePropertyKeys = exports.CustomerDeviceVersion = exports.CustomerDeviceEntityTypes = void 0;
16
16
  const core_1 = require("@d19n/odin-types/dist/core");
17
17
  /**
18
18
  * Available types for CustomerDevice records
@@ -26,6 +26,20 @@ var CustomerDeviceEntityTypes;
26
26
  /** TV Device */
27
27
  CustomerDeviceEntityTypes["TV_DEVICE"] = "TV_DEVICE";
28
28
  })(CustomerDeviceEntityTypes = exports.CustomerDeviceEntityTypes || (exports.CustomerDeviceEntityTypes = {}));
29
+ /**
30
+ * Valid values for CustomerDevice.Version
31
+ *
32
+ * Which TV box this is: the original BetterTV box (V1) or the Pleio box (V2) (PORTAPP-3405).
33
+ *
34
+ * @remarks Available options:
35
+ * - `V1`
36
+ * - `V2` - V2 (Pleio)
37
+ */
38
+ var CustomerDeviceVersion;
39
+ (function (CustomerDeviceVersion) {
40
+ CustomerDeviceVersion["V1"] = "V1";
41
+ CustomerDeviceVersion["V2_PLEIO"] = "V2";
42
+ })(CustomerDeviceVersion = exports.CustomerDeviceVersion || (exports.CustomerDeviceVersion = {}));
29
43
  /**
30
44
  * Property keys for CustomerDevice
31
45
  * Use these constants instead of string literals for type safety
@@ -36,6 +50,8 @@ var CustomerDevicePropertyKeys;
36
50
  CustomerDevicePropertyKeys["MacAddress"] = "MacAddress";
37
51
  /** Serial Number */
38
52
  CustomerDevicePropertyKeys["SerialNumber"] = "SerialNumber";
53
+ /** Which TV box this is: the original BetterTV box (V1) or the Pleio box (V2) (PORTAPP-3405). */
54
+ CustomerDevicePropertyKeys["Version"] = "Version";
39
55
  })(CustomerDevicePropertyKeys = exports.CustomerDevicePropertyKeys || (exports.CustomerDevicePropertyKeys = {}));
40
56
  /**
41
57
  * CustomerDevice entity from ServiceModule
@@ -31,71 +31,48 @@ export declare enum HomeMoveEntityTypes {
31
31
  * A customer moving address: check the new address, confirm what moves, place the new order, then wait for the old order to cancel.
32
32
  */
33
33
  export declare enum DefaultHomeMoveStageNames {
34
- /** Raised against one Active order (the old order). The new address has not been checked yet. (default) */
34
+ /** Raised against one Active order (the old order). The serviceability check decides the next stage. (default) */
35
35
  Created = "Created",
36
- /** Serviceability looked up for the new address. Next: confirm the move, or Not Serviceable. */
37
- AddressChecked = "Address Checked",
38
- /** Choosing the install date and the old order cancel date. Old balance must be clear to go on. */
39
- ConfirmingMove = "Confirming Move",
40
- /** New order being placed at the new address; old order cancel date being scheduled. */
41
- PlacingNewOrder = "Placing New Order",
42
- /** The new order is live. Waiting for the old order to cancel on its own chosen date. */
43
- NewServiceActive = "New Service Active",
44
- /** New order live and old order cancelled. Final. (success) */
36
+ /** We can serve the new address. Agreeing dates and products. Old balance must be clear to go on. */
37
+ Serviceable = "Serviceable",
38
+ /** New order placed. Waiting for its install or activation, and for the old order to close. */
39
+ MoveInProgress = "Move In Progress",
40
+ /** New service live and old order closed. Final. (success) */
45
41
  MoveComplete = "Move Complete",
46
- /** No coverage at the new address. Waiting up to 7 days for proof of the move (see ProofDueDate). */
42
+ /** We cannot serve the new address. Waiting up to 7 days for proof of the move (see ProofDueDate). */
47
43
  NotServiceable = "Not Serviceable",
48
- /** Proof arrived within 7 days. Account cancelled with the ETF waived. Final. (fail) */
49
- ProofReceived = "Proof Received",
50
- /** No proof after 7 days. ETF invoiced and passed to RevOps, then Debt Collection. Final. (fail) */
51
- NoProof = "No Proof",
52
- /** The customer is leaving rather than moving service. ETF quoted, old order cancel scheduled. Final. (fail) */
53
- Declined = "Declined",
54
- /** The move was abandoned. The customer keeps their current service. Final. (fail) */
55
- Cancelled = "Cancelled"
44
+ /** Proof arrived within 7 days. Account cancelled with no early termination fee. Final. (fail) */
45
+ EtfWaived = "ETF Waived",
46
+ /** No proof after 7 days. Early termination fee invoiced and passed to RevOps, then Debt Collection. Final. (fail) */
47
+ EtfCharged = "ETF Charged",
48
+ /** The customer is not moving their service. ETF quoted, old order cancel scheduled. Final. (fail) */
49
+ CustomerLeaving = "Customer Leaving",
50
+ /** The Home Move was cancelled. The customer keeps their current service. Final. (fail) */
51
+ MoveCancelled = "Move Cancelled"
56
52
  }
57
53
  /**
58
54
  * Pipeline stage keys for DEFAULT HomeMove
59
55
  * Use these keys when transitioning between stages
60
56
  */
61
57
  export declare enum DefaultHomeMoveStageKeys {
62
- /** Raised against one Active order (the old order). The new address has not been checked yet. */
58
+ /** Raised against one Active order (the old order). The serviceability check decides the next stage. */
63
59
  HomeMoveStageCreated = "HomeMoveStageCreated",
64
- /** Serviceability looked up for the new address. Next: confirm the move, or Not Serviceable. */
65
- HomeMoveStageAddressChecked = "HomeMoveStageAddressChecked",
66
- /** Choosing the install date and the old order cancel date. Old balance must be clear to go on. */
67
- HomeMoveStageConfirmingMove = "HomeMoveStageConfirmingMove",
68
- /** New order being placed at the new address; old order cancel date being scheduled. */
69
- HomeMoveStagePlacingNewOrder = "HomeMoveStagePlacingNewOrder",
70
- /** The new order is live. Waiting for the old order to cancel on its own chosen date. */
71
- HomeMoveStageNewServiceActive = "HomeMoveStageNewServiceActive",
72
- /** New order live and old order cancelled. Final. */
60
+ /** We can serve the new address. Agreeing dates and products. Old balance must be clear to go on. */
61
+ HomeMoveStageServiceable = "HomeMoveStageServiceable",
62
+ /** New order placed. Waiting for its install or activation, and for the old order to close. */
63
+ HomeMoveStageMoveInProgress = "HomeMoveStageMoveInProgress",
64
+ /** New service live and old order closed. Final. */
73
65
  HomeMoveStageMoveComplete = "HomeMoveStageMoveComplete",
74
- /** No coverage at the new address. Waiting up to 7 days for proof of the move (see ProofDueDate). */
66
+ /** We cannot serve the new address. Waiting up to 7 days for proof of the move (see ProofDueDate). */
75
67
  HomeMoveStageNotServiceable = "HomeMoveStageNotServiceable",
76
- /** Proof arrived within 7 days. Account cancelled with the ETF waived. Final. */
77
- HomeMoveStageProofReceived = "HomeMoveStageProofReceived",
78
- /** No proof after 7 days. ETF invoiced and passed to RevOps, then Debt Collection. Final. */
79
- HomeMoveStageNoProof = "HomeMoveStageNoProof",
80
- /** The customer is leaving rather than moving service. ETF quoted, old order cancel scheduled. Final. */
81
- HomeMoveStageDeclined = "HomeMoveStageDeclined",
82
- /** The move was abandoned. The customer keeps their current service. Final. */
83
- HomeMoveStageCancelled = "HomeMoveStageCancelled"
84
- }
85
- /**
86
- * Valid values for HomeMove.ServiceableVia
87
- *
88
- * Which network can serve the new address. Set at Address Checked. OPENREACH is handled by hand in v1.
89
- *
90
- * @remarks Available options:
91
- * - `NETOMNIA` - Netomnia
92
- * - `NONE` - None
93
- * - `OPENREACH` - Openreach
94
- */
95
- export declare enum HomeMoveServiceableVia {
96
- NETOMNIA = "NETOMNIA",
97
- NONE = "NONE",
98
- OPENREACH = "OPENREACH"
68
+ /** Proof arrived within 7 days. Account cancelled with no early termination fee. Final. */
69
+ HomeMoveStageEtfWaived = "HomeMoveStageEtfWaived",
70
+ /** No proof after 7 days. Early termination fee invoiced and passed to RevOps, then Debt Collection. Final. */
71
+ HomeMoveStageEtfCharged = "HomeMoveStageEtfCharged",
72
+ /** The customer is not moving their service. ETF quoted, old order cancel scheduled. Final. */
73
+ HomeMoveStageCustomerLeaving = "HomeMoveStageCustomerLeaving",
74
+ /** The Home Move was cancelled. The customer keeps their current service. Final. */
75
+ HomeMoveStageMoveCancelled = "HomeMoveStageMoveCancelled"
99
76
  }
100
77
  /**
101
78
  * Valid values for HomeMove.RouterDeliveryAddress
@@ -113,7 +90,7 @@ export declare enum HomeMoveRouterDeliveryAddress {
113
90
  /**
114
91
  * Valid values for HomeMove.CollectionKitAddress
115
92
  *
116
- * Which address the return kit for the old router goes to. Asked only when the customer is leaving (Declined or Not Serviceable).
93
+ * Which address the return kit for the old router goes to. Asked only when the customer is leaving (Customer Leaving or Not Serviceable).
117
94
  *
118
95
  * @remarks Available options:
119
96
  * - `OLD_ADDRESS` - Current address
@@ -123,6 +100,23 @@ export declare enum HomeMoveCollectionKitAddress {
123
100
  CURRENT_ADDRESS = "OLD_ADDRESS",
124
101
  NEW_ADDRESS = "NEW_ADDRESS"
125
102
  }
103
+ /**
104
+ * Valid values for HomeMove.ServiceableVia
105
+ *
106
+ * 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.
107
+ *
108
+ * @remarks Available options:
109
+ * - `BRSK` - Brsk
110
+ * - `NETOMNIA` - Netomnia
111
+ * - `NONE` - None
112
+ * - `OPENREACH` - Openreach
113
+ */
114
+ export declare enum HomeMoveServiceableVia {
115
+ BRSK = "BRSK",
116
+ NETOMNIA = "NETOMNIA",
117
+ NONE = "NONE",
118
+ OPENREACH = "OPENREACH"
119
+ }
126
120
  /**
127
121
  * Property keys for HomeMove
128
122
  * Use these constants instead of string literals for type safety
@@ -132,34 +126,34 @@ export declare enum HomeMovePropertyKeys {
132
126
  OldOrderId = "OldOrderId",
133
127
  /** The account holder who is moving. Set when the move is created. */
134
128
  ContactId = "ContactId",
135
- /** The address being moved to. Set at Address Checked; used by checkout (addressId). */
136
- NewAddressId = "NewAddressId",
137
- /** The order placed at the new address. Set once, when checkout returns at Placing New Order. */
138
- NewOrderId = "NewOrderId",
139
129
  /** The Case raised at Not Serviceable, held 7 days for proof of the move. */
140
130
  CaseId = "CaseId",
141
- /** Which network can serve the new address. Set at Address Checked. OPENREACH is handled by hand in v1. */
142
- ServiceableVia = "ServiceableVia",
143
- /** 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. */
131
+ /** Which address a replacement router goes to. Asked only when a router is replaced. One parcel: new router in, old one back. */
132
+ RouterDeliveryAddress = "RouterDeliveryAddress",
133
+ /** End of the 7-day proof window. Set on entering Not Serviceable; the 7-day job reads it. */
134
+ ProofDueDate = "ProofDueDate",
135
+ /** The address being moved to. Set by the serviceability check at Created; used by checkout (addressId). */
136
+ NewAddressId = "NewAddressId",
137
+ /** The order placed at the new address. Set once, when checkout returns at Move In Progress. */
138
+ NewOrderId = "NewOrderId",
139
+ /** 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. */
144
140
  RequiredOntUpgrade = "RequiredOntUpgrade",
145
- /** The router cannot carry the product speed, so a replacement is sent. Set at Confirming Move. Empty = not checked. */
141
+ /** The router cannot carry the product speed, so a replacement is sent. Set at Serviceable. Empty = not checked. */
146
142
  RequiredRouterUpgrade = "RequiredRouterUpgrade",
147
- /** The mesh cannot carry the product speed, so replacements are sent. Set at Confirming Move. Empty = not checked. */
143
+ /** The mesh cannot carry the product speed, so replacements are sent. Set at Serviceable. Empty = not checked. */
148
144
  RequiredMeshUpgrade = "RequiredMeshUpgrade",
149
- /** Customer-chosen date for the new order. Set at Confirming Move. Independent of the old order cancel date. */
145
+ /** Customer-chosen date for the new order. Set at Serviceable. Independent of the old order cancel date. */
150
146
  NewOrderInstallOrActivationDate = "NewOrderInstallOrActivationDate",
151
- /** Customer-chosen cancel date for the old order. Set at Confirming Move. Both orders run, and are billed, until then. */
147
+ /** Customer-chosen cancel date for the old order. Set at Serviceable. Both orders run, and are billed, until then. */
152
148
  OldOrderCancellationDate = "OldOrderCancellationDate",
153
- /** Which address a replacement router goes to. Asked only when a router is replaced. One parcel: new router in, old one back. */
154
- RouterDeliveryAddress = "RouterDeliveryAddress",
155
- /** Which address the return kit for the old router goes to. Asked only when the customer is leaving (Declined or Not Serviceable). */
149
+ /** Which address the return kit for the old router goes to. Asked only when the customer is leaving (Customer Leaving or Not Serviceable). */
156
150
  CollectionKitAddress = "CollectionKitAddress",
157
- /** Early termination fee on the old order, from BillingModule early-termination quote. Set at Declined or No Proof. */
151
+ /** Early termination fee on the old order, from BillingModule early-termination quote. Set at Customer Leaving or ETF Charged. */
158
152
  EtfAmount = "ETFAmount",
159
- /** True when proof of move arrived in time (Proof Received). Empty until decided. */
153
+ /** True when proof of move arrived in time (ETF Waived). Empty until decided. */
160
154
  EtfWaived = "ETFWaived",
161
- /** End of the 7-day proof window. Set on entering Not Serviceable; the 7-day job reads it. */
162
- ProofDueDate = "ProofDueDate"
155
+ /** 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. */
156
+ ServiceableVia = "ServiceableVia"
163
157
  }
164
158
  /**
165
159
  * Properties for HomeMove records
@@ -179,93 +173,93 @@ export interface HomeMoveProperties {
179
173
  * @default
180
174
  */
181
175
  ContactId: string;
182
- /** The address being moved to. Set at Address Checked; used by checkout (addressId).
176
+ /** The Case raised at Not Serviceable, held 7 days for proof of the move.
183
177
  *
184
178
  * @type {LOOKUP}
185
179
  * @default
186
180
  */
187
- NewAddressId: string;
188
- /** The order placed at the new address. Set once, when checkout returns at Placing New Order.
181
+ CaseId: string;
182
+ /** Which address a replacement router goes to. Asked only when a router is replaced. One parcel: new router in, old one back.
189
183
  *
190
- * @type {LOOKUP}
184
+ * @type {ENUM}
191
185
  * @default
186
+ * @enum {HomeMoveRouterDeliveryAddress}
192
187
  */
193
- NewOrderId: string;
194
- /** The Case raised at Not Serviceable, held 7 days for proof of the move.
188
+ RouterDeliveryAddress: HomeMoveRouterDeliveryAddress;
189
+ /** End of the 7-day proof window. Set on entering Not Serviceable; the 7-day job reads it.
190
+ *
191
+ * @type {DATE}
192
+ * @default
193
+ */
194
+ ProofDueDate: string;
195
+ /** The address being moved to. Set by the serviceability check at Created; used by checkout (addressId).
195
196
  *
196
197
  * @type {LOOKUP}
197
198
  * @default
198
199
  */
199
- CaseId: string;
200
- /** Which network can serve the new address. Set at Address Checked. OPENREACH is handled by hand in v1.
200
+ NewAddressId: string;
201
+ /** The order placed at the new address. Set once, when checkout returns at Move In Progress.
201
202
  *
202
- * @type {ENUM}
203
+ * @type {LOOKUP}
203
204
  * @default
204
- * @enum {HomeMoveServiceableVia}
205
205
  */
206
- ServiceableVia: HomeMoveServiceableVia;
207
- /** 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.
206
+ NewOrderId: string;
207
+ /** 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.
208
208
  *
209
209
  * @type {BOOLEAN}
210
210
  * @default
211
211
  */
212
212
  RequiredOntUpgrade: boolean;
213
- /** The router cannot carry the product speed, so a replacement is sent. Set at Confirming Move. Empty = not checked.
213
+ /** The router cannot carry the product speed, so a replacement is sent. Set at Serviceable. Empty = not checked.
214
214
  *
215
215
  * @type {BOOLEAN}
216
216
  * @default
217
217
  */
218
218
  RequiredRouterUpgrade: boolean;
219
- /** The mesh cannot carry the product speed, so replacements are sent. Set at Confirming Move. Empty = not checked.
219
+ /** The mesh cannot carry the product speed, so replacements are sent. Set at Serviceable. Empty = not checked.
220
220
  *
221
221
  * @type {BOOLEAN}
222
222
  * @default
223
223
  */
224
224
  RequiredMeshUpgrade: boolean;
225
- /** Customer-chosen date for the new order. Set at Confirming Move. Independent of the old order cancel date.
225
+ /** Customer-chosen date for the new order. Set at Serviceable. Independent of the old order cancel date.
226
226
  *
227
227
  * @type {DATE}
228
228
  * @default
229
229
  */
230
230
  NewOrderInstallOrActivationDate: string;
231
- /** Customer-chosen cancel date for the old order. Set at Confirming Move. Both orders run, and are billed, until then.
231
+ /** Customer-chosen cancel date for the old order. Set at Serviceable. Both orders run, and are billed, until then.
232
232
  *
233
233
  * @type {DATE}
234
234
  * @default
235
235
  */
236
236
  OldOrderCancellationDate: string;
237
- /** Which address a replacement router goes to. Asked only when a router is replaced. One parcel: new router in, old one back.
238
- *
239
- * @type {ENUM}
240
- * @default
241
- * @enum {HomeMoveRouterDeliveryAddress}
242
- */
243
- RouterDeliveryAddress: HomeMoveRouterDeliveryAddress;
244
- /** Which address the return kit for the old router goes to. Asked only when the customer is leaving (Declined or Not Serviceable).
237
+ /** Which address the return kit for the old router goes to. Asked only when the customer is leaving (Customer Leaving or Not Serviceable).
245
238
  *
246
239
  * @type {ENUM}
247
240
  * @default
248
241
  * @enum {HomeMoveCollectionKitAddress}
249
242
  */
250
243
  CollectionKitAddress: HomeMoveCollectionKitAddress;
251
- /** Early termination fee on the old order, from BillingModule early-termination quote. Set at Declined or No Proof.
244
+ /** Early termination fee on the old order, from BillingModule early-termination quote. Set at Customer Leaving or ETF Charged.
252
245
  *
253
246
  * @type {CURRENCY}
254
247
  * @default
255
248
  */
256
249
  EtfAmount: string;
257
- /** True when proof of move arrived in time (Proof Received). Empty until decided.
250
+ /** True when proof of move arrived in time (ETF Waived). Empty until decided.
258
251
  *
259
252
  * @type {BOOLEAN}
260
253
  * @default
261
254
  */
262
255
  EtfWaived: boolean;
263
- /** End of the 7-day proof window. Set on entering Not Serviceable; the 7-day job reads it.
256
+ /** 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.
264
257
  *
265
- * @type {DATE}
258
+ * @type {ENUM}
266
259
  * @default
260
+ * @enum {HomeMoveServiceableVia}
267
261
  */
268
- ProofDueDate: string;
262
+ ServiceableVia: HomeMoveServiceableVia;
269
263
  }
270
264
  /**
271
265
  * HomeMove entity from OrderModule