@d19n/youfibre-odin-sdk 2.0.385 → 2.0.387

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.
@@ -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_ORDER_CUSTOMER_DEVICE_ROUTER_DELETED = exports.ROUTING_KEY_LINK_ORDER_CUSTOMER_DEVICE_ROUTER_CREATED = exports.ROUTING_KEY_LINK_ORDER_SMS_MESSAGE_DELETED = exports.ROUTING_KEY_LINK_ORDER_SMS_MESSAGE_CREATED = exports.ROUTING_KEY_LINK_ORDER_ORDER_DELETED = exports.ROUTING_KEY_LINK_ORDER_ORDER_CREATED = exports.ROUTING_KEY_LINK_ORDER_FILE_DELETED = exports.ROUTING_KEY_LINK_ORDER_FILE_CREATED = exports.ROUTING_KEY_LINK_ORDER_ORDER_ITEM_DELETED = exports.ROUTING_KEY_LINK_ORDER_ORDER_ITEM_CREATED = exports.ROUTING_KEY_LINK_ORDER_BILLING_ADJUSTMENT_DELETED = exports.ROUTING_KEY_LINK_ORDER_BILLING_ADJUSTMENT_CREATED = exports.ROUTING_KEY_LINK_ORDER_PUSH_NOTIFICATION_DELETED = exports.ROUTING_KEY_LINK_ORDER_PUSH_NOTIFICATION_CREATED = exports.ROUTING_KEY_LINK_ORDER_DISCOUNT_DELETED = exports.ROUTING_KEY_LINK_ORDER_DISCOUNT_CREATED = exports.ROUTING_KEY_LINK_ORDER_ADDRESS_DELETED = exports.ROUTING_KEY_LINK_ORDER_ADDRESS_CREATED = exports.ROUTING_KEY_LINK_ORDER_PHONE_NUMBER_DELETED = exports.ROUTING_KEY_LINK_ORDER_PHONE_NUMBER_CREATED = exports.ROUTING_KEY_LINK_ORDER_NOTE_DELETED = exports.ROUTING_KEY_LINK_ORDER_NOTE_CREATED = exports.ROUTING_KEY_ORDER_DEFAULT_DELETED = exports.ROUTING_KEY_ORDER_DEFAULT_UPDATED = exports.ROUTING_KEY_ORDER_DEFAULT_CREATED = exports.ROUTING_KEY_ORDER_DELETED = exports.ROUTING_KEY_ORDER_UPDATED = exports.ROUTING_KEY_ORDER_CREATED = exports.Order = exports.OrderPropertyKeys = exports.OrderWithholdCommissionReason = exports.OrderTrialUnit = exports.OrderSupplierOrderType = exports.OrderProvider = exports.OrderOtsNotRequiredReason = exports.OrderMobileCoverage = exports.OrderFulfillmentState = exports.OrderDiscountUnit = exports.OrderDiscountType = exports.OrderDeactivationReason = exports.OrderCurrencyCode = exports.OrderContractType = exports.OrderBillingTerms = exports.OrderBatteryPackRequired = exports.OrderBatteryBackupAnswersSource = exports.OrderAltContactMethod = exports.OrderActivationStatus = exports.DefaultOrderStageKeys = exports.DefaultOrderStageNames = exports.OrderEntityTypes = void 0;
15
+ exports.ROUTING_KEY_LINK_ORDER_CUSTOMER_DEVICE_ROUTER_DELETED = exports.ROUTING_KEY_LINK_ORDER_CUSTOMER_DEVICE_ROUTER_CREATED = exports.ROUTING_KEY_LINK_ORDER_SMS_MESSAGE_DELETED = exports.ROUTING_KEY_LINK_ORDER_SMS_MESSAGE_CREATED = exports.ROUTING_KEY_LINK_ORDER_ORDER_DELETED = exports.ROUTING_KEY_LINK_ORDER_ORDER_CREATED = exports.ROUTING_KEY_LINK_ORDER_FILE_DELETED = exports.ROUTING_KEY_LINK_ORDER_FILE_CREATED = exports.ROUTING_KEY_LINK_ORDER_ORDER_ITEM_DELETED = exports.ROUTING_KEY_LINK_ORDER_ORDER_ITEM_CREATED = exports.ROUTING_KEY_LINK_ORDER_BILLING_ADJUSTMENT_DELETED = exports.ROUTING_KEY_LINK_ORDER_BILLING_ADJUSTMENT_CREATED = exports.ROUTING_KEY_LINK_ORDER_PUSH_NOTIFICATION_DELETED = exports.ROUTING_KEY_LINK_ORDER_PUSH_NOTIFICATION_CREATED = exports.ROUTING_KEY_LINK_ORDER_DISCOUNT_DELETED = exports.ROUTING_KEY_LINK_ORDER_DISCOUNT_CREATED = exports.ROUTING_KEY_LINK_ORDER_ADDRESS_DELETED = exports.ROUTING_KEY_LINK_ORDER_ADDRESS_CREATED = exports.ROUTING_KEY_LINK_ORDER_PHONE_NUMBER_DELETED = exports.ROUTING_KEY_LINK_ORDER_PHONE_NUMBER_CREATED = exports.ROUTING_KEY_LINK_ORDER_NOTE_DELETED = exports.ROUTING_KEY_LINK_ORDER_NOTE_CREATED = exports.ROUTING_KEY_ORDER_DEFAULT_DELETED = exports.ROUTING_KEY_ORDER_DEFAULT_UPDATED = exports.ROUTING_KEY_ORDER_DEFAULT_CREATED = exports.ROUTING_KEY_ORDER_DELETED = exports.ROUTING_KEY_ORDER_UPDATED = exports.ROUTING_KEY_ORDER_CREATED = exports.Order = exports.OrderPropertyKeys = exports.OrderFulfillmentState = exports.OrderBatteryBackupAnswersSource = exports.OrderActivationStatus = exports.OrderSupplierOrderType = exports.OrderOtsNotRequiredReason = exports.OrderBatteryPackRequired = exports.OrderMobileCoverage = exports.OrderAltContactMethod = exports.OrderProvider = exports.OrderBillingTerms = exports.OrderDeactivationReason = exports.OrderDiscountType = exports.OrderWithholdCommissionReason = exports.OrderDiscountUnit = exports.OrderTrialUnit = exports.OrderContractType = exports.OrderCurrencyCode = exports.DefaultOrderStageKeys = exports.DefaultOrderStageNames = exports.OrderEntityTypes = void 0;
16
16
  exports.ROUTING_KEY_LINK_ORDER_EMAIL_DELETED = exports.ROUTING_KEY_LINK_ORDER_EMAIL_CREATED = exports.ROUTING_KEY_LINK_ORDER_WORK_ORDER_DELETED = exports.ROUTING_KEY_LINK_ORDER_WORK_ORDER_CREATED = exports.ROUTING_KEY_LINK_ORDER_CONTACT_DELETED = exports.ROUTING_KEY_LINK_ORDER_CONTACT_CREATED = exports.ROUTING_KEY_LINK_ORDER_INVOICE_DELETED = exports.ROUTING_KEY_LINK_ORDER_INVOICE_CREATED = exports.ROUTING_KEY_LINK_ORDER_ACTIVITY_LOG_DELETED = exports.ROUTING_KEY_LINK_ORDER_ACTIVITY_LOG_CREATED = exports.ROUTING_KEY_LINK_ORDER_ACTIVITY_DELETED = exports.ROUTING_KEY_LINK_ORDER_ACTIVITY_CREATED = exports.ROUTING_KEY_LINK_ORDER_ORDER_CHECK_DELETED = exports.ROUTING_KEY_LINK_ORDER_ORDER_CHECK_CREATED = exports.ROUTING_KEY_LINK_ORDER_CUSTOMER_DEVICE_ONT_DELETED = exports.ROUTING_KEY_LINK_ORDER_CUSTOMER_DEVICE_ONT_CREATED = exports.ROUTING_KEY_LINK_ORDER_VISIT_DELETED = exports.ROUTING_KEY_LINK_ORDER_VISIT_CREATED = exports.ROUTING_KEY_LINK_ORDER_COMMISSION_DELETED = exports.ROUTING_KEY_LINK_ORDER_COMMISSION_CREATED = exports.ROUTING_KEY_LINK_ORDER_ORDER_KCI_DELETED = exports.ROUTING_KEY_LINK_ORDER_ORDER_KCI_CREATED = exports.ROUTING_KEY_LINK_ORDER_REFERRAL_DELETED = exports.ROUTING_KEY_LINK_ORDER_REFERRAL_CREATED = exports.ROUTING_KEY_LINK_ORDER_CONTRACT_BUY_OUT_DELETED = exports.ROUTING_KEY_LINK_ORDER_CONTRACT_BUY_OUT_CREATED = exports.ROUTING_KEY_LINK_ORDER_CONTACT_IDENTITY_DELETED = exports.ROUTING_KEY_LINK_ORDER_CONTACT_IDENTITY_CREATED = exports.ROUTING_KEY_LINK_ORDER_APPOINTMENT_DELETED = exports.ROUTING_KEY_LINK_ORDER_APPOINTMENT_CREATED = void 0;
17
17
  const core_1 = require("@d19n/odin-types/dist/core");
18
18
  /**
@@ -75,99 +75,17 @@ var DefaultOrderStageKeys;
75
75
  DefaultOrderStageKeys["OrderStageBrskMigrationRemediation"] = "OrderStageBrskMigrationRemediation";
76
76
  })(DefaultOrderStageKeys = exports.DefaultOrderStageKeys || (exports.DefaultOrderStageKeys = {}));
77
77
  /**
78
- * Valid values for Order.ActivationStatus
79
- *
80
- * status of the order (must be activated for billing) (Sales - Order)
81
- *
82
- * @remarks Available options:
83
- * - `ACTIVE` - Active
84
- * - `BLOCKED` - Blocked
85
- * - `CANCELLED` - Cancelled
86
- * - `DRAFT` - Draft
87
- * - `EXPIRED` - Expired
88
- * - `PENDING_FULFILMENT` - Pending Fulfillment
89
- * - `PROVISIONING` - Provisioning
90
- * - `SUSPENDED` - Suspended
91
- */
92
- var OrderActivationStatus;
93
- (function (OrderActivationStatus) {
94
- OrderActivationStatus["ACTIVE"] = "ACTIVE";
95
- OrderActivationStatus["BLOCKED"] = "BLOCKED";
96
- OrderActivationStatus["CANCELLED"] = "CANCELLED";
97
- OrderActivationStatus["DRAFT"] = "DRAFT";
98
- OrderActivationStatus["EXPIRED"] = "EXPIRED";
99
- OrderActivationStatus["PENDING_FULFILLMENT"] = "PENDING_FULFILMENT";
100
- OrderActivationStatus["PROVISIONING"] = "PROVISIONING";
101
- OrderActivationStatus["SUSPENDED"] = "SUSPENDED";
102
- })(OrderActivationStatus = exports.OrderActivationStatus || (exports.OrderActivationStatus = {}));
103
- /**
104
- * Valid values for Order.AltContactMethod
105
- *
106
- * AltContactMethod
107
- *
108
- * @remarks Available options:
109
- * - `NO` - No
110
- * - `YES` - Yes
111
- */
112
- var OrderAltContactMethod;
113
- (function (OrderAltContactMethod) {
114
- OrderAltContactMethod["NO"] = "NO";
115
- OrderAltContactMethod["YES"] = "YES";
116
- })(OrderAltContactMethod = exports.OrderAltContactMethod || (exports.OrderAltContactMethod = {}));
117
- /**
118
- * Valid values for Order.BatteryBackupAnswersSource
119
- *
120
- * Front end that last saved the battery backup answers. Set by the customer portal API, copied to the dispatch work order Source by the orders module, then cleared (PORTAPP-3276).
121
- *
122
- * @remarks Available options:
123
- * - `CUSTOMER_APP` - Customer App
124
- * - `CUSTOMER_PORTAL` - Customer Portal
125
- */
126
- var OrderBatteryBackupAnswersSource;
127
- (function (OrderBatteryBackupAnswersSource) {
128
- OrderBatteryBackupAnswersSource["CUSTOMER_APP"] = "CUSTOMER_APP";
129
- OrderBatteryBackupAnswersSource["CUSTOMER_PORTAL"] = "CUSTOMER_PORTAL";
130
- })(OrderBatteryBackupAnswersSource = exports.OrderBatteryBackupAnswersSource || (exports.OrderBatteryBackupAnswersSource = {}));
131
- /**
132
- * Valid values for Order.BatteryPackRequired
133
- *
134
- * BatteryPackRequired
135
- *
136
- * @remarks Available options:
137
- * - `NO` - No
138
- * - `YES` - Yes
139
- */
140
- var OrderBatteryPackRequired;
141
- (function (OrderBatteryPackRequired) {
142
- OrderBatteryPackRequired["NO"] = "NO";
143
- OrderBatteryPackRequired["YES"] = "YES";
144
- })(OrderBatteryPackRequired = exports.OrderBatteryPackRequired || (exports.OrderBatteryPackRequired = {}));
145
- /**
146
- * Valid values for Order.BillingTerms
78
+ * Valid values for Order.CurrencyCode
147
79
  *
148
- * Billing terms i.e NET 15,30 (Sales - Order)
80
+ * Currency code (Sales - Order)
149
81
  *
150
82
  * @remarks Available options:
151
- * - `NET_0` - NET 0
152
- * - `NET_10` - NET 10
153
- * - `NET_120` - NET 120
154
- * - `NET_15` - NET 15
155
- * - `NET_3` - NET 3
156
- * - `NET_30` - NET 30
157
- * - `NET_60` - NET 60
158
- * - `NET_90` - NET 90
83
+ * - `GBP`
159
84
  */
160
- var OrderBillingTerms;
161
- (function (OrderBillingTerms) {
162
- OrderBillingTerms["NET_0"] = "NET_0";
163
- OrderBillingTerms["NET_10"] = "NET_10";
164
- OrderBillingTerms["NET_120"] = "NET_120";
165
- OrderBillingTerms["NET_15"] = "NET_15";
166
- OrderBillingTerms["NET_3"] = "NET_3";
167
- OrderBillingTerms["NET_30"] = "NET_30";
168
- OrderBillingTerms["NET_60"] = "NET_60";
169
- OrderBillingTerms["NET_90"] = "NET_90";
170
- })(OrderBillingTerms = exports.OrderBillingTerms || (exports.OrderBillingTerms = {}));
85
+ var OrderCurrencyCode;
86
+ (function (OrderCurrencyCode) {
87
+ OrderCurrencyCode["GBP"] = "GBP";
88
+ })(OrderCurrencyCode = exports.OrderCurrencyCode || (exports.OrderCurrencyCode = {}));
171
89
  /**
172
90
  * Valid values for Order.ContractType
173
91
  *
@@ -196,29 +114,51 @@ var OrderContractType;
196
114
  OrderContractType["NO_CONTRACT"] = "NONE";
197
115
  })(OrderContractType = exports.OrderContractType || (exports.OrderContractType = {}));
198
116
  /**
199
- * Valid values for Order.CurrencyCode
117
+ * Valid values for Order.TrialUnit
200
118
  *
201
- * Currency code (Sales - Order)
119
+ * trial unit is the unit of measure for free periods (Sales - Order)
202
120
  *
203
121
  * @remarks Available options:
204
- * - `GBP`
122
+ * - `DAYS` - Days
123
+ * - `MONTHS` - Months
205
124
  */
206
- var OrderCurrencyCode;
207
- (function (OrderCurrencyCode) {
208
- OrderCurrencyCode["GBP"] = "GBP";
209
- })(OrderCurrencyCode = exports.OrderCurrencyCode || (exports.OrderCurrencyCode = {}));
125
+ var OrderTrialUnit;
126
+ (function (OrderTrialUnit) {
127
+ OrderTrialUnit["DAYS"] = "DAYS";
128
+ OrderTrialUnit["MONTHS"] = "MONTHS";
129
+ })(OrderTrialUnit = exports.OrderTrialUnit || (exports.OrderTrialUnit = {}));
210
130
  /**
211
- * Valid values for Order.DeactivationReason
131
+ * Valid values for Order.DiscountUnit
212
132
  *
213
- * Reason for deactivating the order (Sales - Order)
133
+ * discount duration unit (Sales - Order)
214
134
  *
215
135
  * @remarks Available options:
216
- * - `PAYMENT_OVERDUE` - Payment overdue
136
+ * - `DAYS` - Days
137
+ * - `MONTHS` - Months
217
138
  */
218
- var OrderDeactivationReason;
219
- (function (OrderDeactivationReason) {
220
- OrderDeactivationReason["PAYMENT_OVERDUE"] = "PAYMENT_OVERDUE";
221
- })(OrderDeactivationReason = exports.OrderDeactivationReason || (exports.OrderDeactivationReason = {}));
139
+ var OrderDiscountUnit;
140
+ (function (OrderDiscountUnit) {
141
+ OrderDiscountUnit["DAYS"] = "DAYS";
142
+ OrderDiscountUnit["MONTHS"] = "MONTHS";
143
+ })(OrderDiscountUnit = exports.OrderDiscountUnit || (exports.OrderDiscountUnit = {}));
144
+ /**
145
+ * Valid values for Order.WithholdCommissionReason
146
+ *
147
+ * WithholdCommissionReason
148
+ *
149
+ * @remarks Available options:
150
+ * - `ETF_VALUE` - ETF over £300
151
+ * - `NO_WELCOME_PACK` - No welcome pack
152
+ * - `OTHER` - Other
153
+ * - `PRICE_MATCH_EVIDENCE` - Price Match evidence insufficient or missing
154
+ */
155
+ var OrderWithholdCommissionReason;
156
+ (function (OrderWithholdCommissionReason) {
157
+ OrderWithholdCommissionReason["ETF_OVER_300"] = "ETF_VALUE";
158
+ OrderWithholdCommissionReason["NO_WELCOME_PACK"] = "NO_WELCOME_PACK";
159
+ OrderWithholdCommissionReason["OTHER"] = "OTHER";
160
+ OrderWithholdCommissionReason["PRICE_MATCH_EVIDENCE_INSUFFICIENT_OR_MISSING"] = "PRICE_MATCH_EVIDENCE";
161
+ })(OrderWithholdCommissionReason = exports.OrderWithholdCommissionReason || (exports.OrderWithholdCommissionReason = {}));
222
162
  /**
223
163
  * Valid values for Order.DiscountType
224
164
  *
@@ -234,33 +174,79 @@ var OrderDiscountType;
234
174
  OrderDiscountType["PERCENT"] = "PERCENT";
235
175
  })(OrderDiscountType = exports.OrderDiscountType || (exports.OrderDiscountType = {}));
236
176
  /**
237
- * Valid values for Order.DiscountUnit
177
+ * Valid values for Order.DeactivationReason
238
178
  *
239
- * discount duration unit (Sales - Order)
179
+ * Reason for deactivating the order (Sales - Order)
240
180
  *
241
181
  * @remarks Available options:
242
- * - `DAYS` - Days
243
- * - `MONTHS` - Months
182
+ * - `PAYMENT_OVERDUE` - Payment overdue
244
183
  */
245
- var OrderDiscountUnit;
246
- (function (OrderDiscountUnit) {
247
- OrderDiscountUnit["DAYS"] = "DAYS";
248
- OrderDiscountUnit["MONTHS"] = "MONTHS";
249
- })(OrderDiscountUnit = exports.OrderDiscountUnit || (exports.OrderDiscountUnit = {}));
184
+ var OrderDeactivationReason;
185
+ (function (OrderDeactivationReason) {
186
+ OrderDeactivationReason["PAYMENT_OVERDUE"] = "PAYMENT_OVERDUE";
187
+ })(OrderDeactivationReason = exports.OrderDeactivationReason || (exports.OrderDeactivationReason = {}));
250
188
  /**
251
- * Valid values for Order.FulfillmentState
189
+ * Valid values for Order.BillingTerms
252
190
  *
253
- * Derived from the commitment set: OPEN while any commitment is Pending or Breached, SETTLED when none is. Written only by the commitment lifecycle.
191
+ * Billing terms i.e NET 15,30 (Sales - Order)
254
192
  *
255
193
  * @remarks Available options:
256
- * - `OPEN` - Open
257
- * - `SETTLED` - Settled
194
+ * - `NET_0` - NET 0
195
+ * - `NET_10` - NET 10
196
+ * - `NET_120` - NET 120
197
+ * - `NET_15` - NET 15
198
+ * - `NET_3` - NET 3
199
+ * - `NET_30` - NET 30
200
+ * - `NET_60` - NET 60
201
+ * - `NET_90` - NET 90
258
202
  */
259
- var OrderFulfillmentState;
260
- (function (OrderFulfillmentState) {
261
- OrderFulfillmentState["OPEN"] = "OPEN";
262
- OrderFulfillmentState["SETTLED"] = "SETTLED";
263
- })(OrderFulfillmentState = exports.OrderFulfillmentState || (exports.OrderFulfillmentState = {}));
203
+ var OrderBillingTerms;
204
+ (function (OrderBillingTerms) {
205
+ OrderBillingTerms["NET_0"] = "NET_0";
206
+ OrderBillingTerms["NET_10"] = "NET_10";
207
+ OrderBillingTerms["NET_120"] = "NET_120";
208
+ OrderBillingTerms["NET_15"] = "NET_15";
209
+ OrderBillingTerms["NET_3"] = "NET_3";
210
+ OrderBillingTerms["NET_30"] = "NET_30";
211
+ OrderBillingTerms["NET_60"] = "NET_60";
212
+ OrderBillingTerms["NET_90"] = "NET_90";
213
+ })(OrderBillingTerms = exports.OrderBillingTerms || (exports.OrderBillingTerms = {}));
214
+ /**
215
+ * Valid values for Order.Provider
216
+ *
217
+ * network provider (Sales - Order)
218
+ *
219
+ * @remarks Available options:
220
+ * - `BRSK` - Brsk
221
+ * - `CITYFIBRE` - CityFibre
222
+ * - `NETOMNIA` - Netomnia
223
+ * - `NETOMNIA_LEGACY` - Netomnia legacy
224
+ * - `OPENREACH` - Openreach
225
+ * - `PYOMNI` - PyOmni
226
+ */
227
+ var OrderProvider;
228
+ (function (OrderProvider) {
229
+ OrderProvider["BRSK"] = "BRSK";
230
+ OrderProvider["CITY_FIBRE"] = "CITYFIBRE";
231
+ OrderProvider["NETOMNIA"] = "NETOMNIA";
232
+ OrderProvider["NETOMNIA_LEGACY"] = "NETOMNIA_LEGACY";
233
+ OrderProvider["OPENREACH"] = "OPENREACH";
234
+ OrderProvider["PY_OMNI"] = "PYOMNI";
235
+ })(OrderProvider = exports.OrderProvider || (exports.OrderProvider = {}));
236
+ /**
237
+ * Valid values for Order.AltContactMethod
238
+ *
239
+ * AltContactMethod
240
+ *
241
+ * @remarks Available options:
242
+ * - `NO` - No
243
+ * - `YES` - Yes
244
+ */
245
+ var OrderAltContactMethod;
246
+ (function (OrderAltContactMethod) {
247
+ OrderAltContactMethod["NO"] = "NO";
248
+ OrderAltContactMethod["YES"] = "YES";
249
+ })(OrderAltContactMethod = exports.OrderAltContactMethod || (exports.OrderAltContactMethod = {}));
264
250
  /**
265
251
  * Valid values for Order.MobileCoverage
266
252
  *
@@ -275,6 +261,20 @@ var OrderMobileCoverage;
275
261
  OrderMobileCoverage["NO"] = "NO";
276
262
  OrderMobileCoverage["YES"] = "YES";
277
263
  })(OrderMobileCoverage = exports.OrderMobileCoverage || (exports.OrderMobileCoverage = {}));
264
+ /**
265
+ * Valid values for Order.BatteryPackRequired
266
+ *
267
+ * BatteryPackRequired
268
+ *
269
+ * @remarks Available options:
270
+ * - `NO` - No
271
+ * - `YES` - Yes
272
+ */
273
+ var OrderBatteryPackRequired;
274
+ (function (OrderBatteryPackRequired) {
275
+ OrderBatteryPackRequired["NO"] = "NO";
276
+ OrderBatteryPackRequired["YES"] = "YES";
277
+ })(OrderBatteryPackRequired = exports.OrderBatteryPackRequired || (exports.OrderBatteryPackRequired = {}));
278
278
  /**
279
279
  * Valid values for Order.OtsNotRequiredReason
280
280
  *
@@ -307,35 +307,13 @@ var OrderOtsNotRequiredReason;
307
307
  OrderOtsNotRequiredReason["TRANSFER_OF_OWNERSHIP"] = "TRANSFER_OF_OWNERSHIP";
308
308
  })(OrderOtsNotRequiredReason = exports.OrderOtsNotRequiredReason || (exports.OrderOtsNotRequiredReason = {}));
309
309
  /**
310
- * Valid values for Order.Provider
310
+ * Valid values for Order.SupplierOrderType
311
311
  *
312
- * network provider (Sales - Order)
312
+ * The type of supplier order required to fulfil this YF order.
313
313
  *
314
314
  * @remarks Available options:
315
- * - `BRSK` - Brsk
316
- * - `CITYFIBRE` - CityFibre
317
- * - `NETOMNIA` - Netomnia
318
- * - `NETOMNIA_LEGACY` - Netomnia legacy
319
- * - `OPENREACH` - Openreach
320
- * - `PYOMNI` - PyOmni
321
- */
322
- var OrderProvider;
323
- (function (OrderProvider) {
324
- OrderProvider["BRSK"] = "BRSK";
325
- OrderProvider["CITY_FIBRE"] = "CITYFIBRE";
326
- OrderProvider["NETOMNIA"] = "NETOMNIA";
327
- OrderProvider["NETOMNIA_LEGACY"] = "NETOMNIA_LEGACY";
328
- OrderProvider["OPENREACH"] = "OPENREACH";
329
- OrderProvider["PY_OMNI"] = "PYOMNI";
330
- })(OrderProvider = exports.OrderProvider || (exports.OrderProvider = {}));
331
- /**
332
- * Valid values for Order.SupplierOrderType
333
- *
334
- * The type of supplier order required to fulfil this YF order.
335
- *
336
- * @remarks Available options:
337
- * - `NEW` - New Install
338
- * - `START` - Start Existing
315
+ * - `NEW` - New Install
316
+ * - `START` - Start Existing
339
317
  */
340
318
  var OrderSupplierOrderType;
341
319
  (function (OrderSupplierOrderType) {
@@ -343,265 +321,287 @@ var OrderSupplierOrderType;
343
321
  OrderSupplierOrderType["START_EXISTING"] = "START";
344
322
  })(OrderSupplierOrderType = exports.OrderSupplierOrderType || (exports.OrderSupplierOrderType = {}));
345
323
  /**
346
- * Valid values for Order.TrialUnit
324
+ * Valid values for Order.ActivationStatus
347
325
  *
348
- * trial unit is the unit of measure for free periods (Sales - Order)
326
+ * status of the order (must be activated for billing) (Sales - Order)
349
327
  *
350
328
  * @remarks Available options:
351
- * - `DAYS` - Days
352
- * - `MONTHS` - Months
329
+ * - `ACTIVE` - Active
330
+ * - `BLOCKED` - Blocked
331
+ * - `CANCELLED` - Cancelled
332
+ * - `DRAFT` - Draft
333
+ * - `EXPIRED` - Expired
334
+ * - `PENDING_FULFILMENT` - Pending Fulfillment
335
+ * - `PROVISIONING` - Provisioning
336
+ * - `SUSPENDED` - Suspended
353
337
  */
354
- var OrderTrialUnit;
355
- (function (OrderTrialUnit) {
356
- OrderTrialUnit["DAYS"] = "DAYS";
357
- OrderTrialUnit["MONTHS"] = "MONTHS";
358
- })(OrderTrialUnit = exports.OrderTrialUnit || (exports.OrderTrialUnit = {}));
338
+ var OrderActivationStatus;
339
+ (function (OrderActivationStatus) {
340
+ OrderActivationStatus["ACTIVE"] = "ACTIVE";
341
+ OrderActivationStatus["BLOCKED"] = "BLOCKED";
342
+ OrderActivationStatus["CANCELLED"] = "CANCELLED";
343
+ OrderActivationStatus["DRAFT"] = "DRAFT";
344
+ OrderActivationStatus["EXPIRED"] = "EXPIRED";
345
+ OrderActivationStatus["PENDING_FULFILLMENT"] = "PENDING_FULFILMENT";
346
+ OrderActivationStatus["PROVISIONING"] = "PROVISIONING";
347
+ OrderActivationStatus["SUSPENDED"] = "SUSPENDED";
348
+ })(OrderActivationStatus = exports.OrderActivationStatus || (exports.OrderActivationStatus = {}));
359
349
  /**
360
- * Valid values for Order.WithholdCommissionReason
350
+ * Valid values for Order.BatteryBackupAnswersSource
361
351
  *
362
- * WithholdCommissionReason
352
+ * Front end that last saved the battery backup answers. Set by the customer portal API, copied to the dispatch work order Source by the orders module, then cleared (PORTAPP-3276).
363
353
  *
364
354
  * @remarks Available options:
365
- * - `ETF_VALUE` - ETF over £300
366
- * - `NO_WELCOME_PACK` - No welcome pack
367
- * - `OTHER` - Other
368
- * - `PRICE_MATCH_EVIDENCE` - Price Match evidence insufficient or missing
355
+ * - `CUSTOMER_APP` - Customer App
356
+ * - `CUSTOMER_PORTAL` - Customer Portal
369
357
  */
370
- var OrderWithholdCommissionReason;
371
- (function (OrderWithholdCommissionReason) {
372
- OrderWithholdCommissionReason["ETF_OVER_300"] = "ETF_VALUE";
373
- OrderWithholdCommissionReason["NO_WELCOME_PACK"] = "NO_WELCOME_PACK";
374
- OrderWithholdCommissionReason["OTHER"] = "OTHER";
375
- OrderWithholdCommissionReason["PRICE_MATCH_EVIDENCE_INSUFFICIENT_OR_MISSING"] = "PRICE_MATCH_EVIDENCE";
376
- })(OrderWithholdCommissionReason = exports.OrderWithholdCommissionReason || (exports.OrderWithholdCommissionReason = {}));
358
+ var OrderBatteryBackupAnswersSource;
359
+ (function (OrderBatteryBackupAnswersSource) {
360
+ OrderBatteryBackupAnswersSource["CUSTOMER_APP"] = "CUSTOMER_APP";
361
+ OrderBatteryBackupAnswersSource["CUSTOMER_PORTAL"] = "CUSTOMER_PORTAL";
362
+ })(OrderBatteryBackupAnswersSource = exports.OrderBatteryBackupAnswersSource || (exports.OrderBatteryBackupAnswersSource = {}));
363
+ /**
364
+ * Valid values for Order.FulfillmentState
365
+ *
366
+ * Derived from the commitment set: OPEN while any commitment is Pending or Breached, SETTLED when none is. Written only by the commitment lifecycle.
367
+ *
368
+ * @remarks Available options:
369
+ * - `OPEN` - Open
370
+ * - `SETTLED` - Settled
371
+ */
372
+ var OrderFulfillmentState;
373
+ (function (OrderFulfillmentState) {
374
+ OrderFulfillmentState["OPEN"] = "OPEN";
375
+ OrderFulfillmentState["SETTLED"] = "SETTLED";
376
+ })(OrderFulfillmentState = exports.OrderFulfillmentState || (exports.OrderFulfillmentState = {}));
377
377
  /**
378
378
  * Property keys for Order
379
379
  * Use these constants instead of string literals for type safety
380
380
  */
381
381
  var OrderPropertyKeys;
382
382
  (function (OrderPropertyKeys) {
383
- /** status of the order (must be activated for billing) (Sales - Order) */
384
- OrderPropertyKeys["ActivationStatus"] = "ActivationStatus";
385
- /** active date (Sales - Order) */
386
- OrderPropertyKeys["ActiveDate"] = "ActiveDate";
387
- /** true if the customer has an active mandate (Sales - Order) */
388
- OrderPropertyKeys["ActiveMandate"] = "ActiveMandate";
389
- /** Reference identifier for Order relationships. Used for data integrity. */
390
- OrderPropertyKeys["AddressId"] = "AddressId";
383
+ /** Pending Amco Collection Work Order */
384
+ OrderPropertyKeys["PendingAmcoCollection"] = "PendingAmcoCollection";
385
+ /** ExternalReference */
386
+ OrderPropertyKeys["ExternalReference"] = "ExternalReference";
387
+ /** unit cost for the product derived from product components UnitCost (Sales - Order) */
388
+ OrderPropertyKeys["TaxRate"] = "TaxRate";
389
+ /** Currency code (Sales - Order) */
390
+ OrderPropertyKeys["CurrencyCode"] = "CurrencyCode";
391
+ /** the delivery date requested by the customer (Sales - Order) */
392
+ OrderPropertyKeys["RequestedDeliveryDate"] = "RequestedDeliveryDate";
393
+ /** Display name/title for Order records. Primary identifier for Sales team. */
394
+ OrderPropertyKeys["Name"] = "Name";
395
+ /** the type of the contract (Sales - Order) */
396
+ OrderPropertyKeys["ContractType"] = "ContractType";
397
+ /** unique multiple point reference number (Sales - Order) */
398
+ OrderPropertyKeys["Umprn"] = "UMPRN";
391
399
  /** Affiliate code used when order was placed */
392
400
  OrderPropertyKeys["AffiliateCode"] = "AffiliateCode";
393
- /** Aklamio cashback was rejected (Sales - Order) */
394
- OrderPropertyKeys["AklamioCashbackRejectionDate"] = "AklamioCashbackRejectionDate";
395
- /** Aklamio cashback was applied (Sales - Order) */
396
- OrderPropertyKeys["AklamioCashbackVerificationDate"] = "AklamioCashbackVerificationDate";
401
+ /** Pending Amco Replacement WorkOrder */
402
+ OrderPropertyKeys["PendingAmcoReplacement"] = "PendingAmcoReplacement";
403
+ /** BrskOrderStatus */
404
+ OrderPropertyKeys["BrskOrderStatus"] = "BrskOrderStatus";
397
405
  /** This order comes because of an Aklamio Reference (Sales - Order) */
398
406
  OrderPropertyKeys["AklamioReferenced"] = "AklamioReferenced";
399
- /** The date the order was rejected in aklamio (Sales - Order) */
400
- OrderPropertyKeys["AklamioRejectionDate"] = "AklamioRejectionDate";
401
- /** Aklamio Verification Date (Sales - Order) */
402
- OrderPropertyKeys["AklamioVerificationDate"] = "AklamioVerificationDate";
403
- /** alerts that need to be visible on the order (Sales - Order) */
404
- OrderPropertyKeys["AlertMessage"] = "AlertMessage";
405
- /** the date of the alert message (Sales - Order) */
406
- OrderPropertyKeys["AlertMessageDate"] = "AlertMessageDate";
407
- /** AltContactMethod */
408
- OrderPropertyKeys["AltContactMethod"] = "AltContactMethod";
409
- /** the datetime when the amendment was performed (Sales - Order) */
410
- OrderPropertyKeys["AmendmentDate"] = "AmendmentDate";
411
- /** the average monthly contract value (Sales - Order) */
412
- OrderPropertyKeys["AverageMonthlyValue"] = "AverageMonthlyValue";
413
- /** Front end that last saved the battery backup answers. Set by the customer portal API, copied to the dispatch work order Source by the orders module, then cleared (PORTAPP-3276). */
414
- OrderPropertyKeys["BatteryBackupAnswersSource"] = "BatteryBackupAnswersSource";
415
- /** Whether a customer already has a battery pack from YouFibre or not */
416
- OrderPropertyKeys["BatteryPackProvided"] = "BatteryPackProvided";
417
- /** BatteryPackRequired */
418
- OrderPropertyKeys["BatteryPackRequired"] = "BatteryPackRequired";
419
- /** Billing day in the month (Sales - Order) */
420
- OrderPropertyKeys["BillingDay"] = "BillingDay";
407
+ /** total taxes (Sales - Order) */
408
+ OrderPropertyKeys["TotalTaxAmount"] = "TotalTaxAmount";
409
+ /** Data field for Order records. Used by Sales team. */
410
+ OrderPropertyKeys["VatNumber"] = "VATNumber";
421
411
  /** Billing start date (Sales - Order) */
422
412
  OrderPropertyKeys["BillingStartDate"] = "BillingStartDate";
423
- /** Billing terms i.e NET 15,30 (Sales - Order) */
424
- OrderPropertyKeys["BillingTerms"] = "BillingTerms";
425
- /** BrskOrderStatus */
426
- OrderPropertyKeys["BrskOrderStatus"] = "BrskOrderStatus";
427
- /** This will be the date the order is automatically cancelled. It will always be at the end of an invoice billing period end date. (Sales - Order) */
428
- OrderPropertyKeys["CancellationEffectiveDate"] = "CancellationEffectiveDate";
429
- /** Cancelation reason (Sales - Order) */
430
- OrderPropertyKeys["CancellationReason"] = "CancellationReason";
413
+ /** trial unit is the unit of measure for free periods (Sales - Order) */
414
+ OrderPropertyKeys["TrialUnit"] = "TrialUnit";
415
+ /** discount duration unit (Sales - Order) */
416
+ OrderPropertyKeys["DiscountUnit"] = "DiscountUnit";
417
+ /** trial length is the number of X free periods (Sales - Order) */
418
+ OrderPropertyKeys["TrialLength"] = "TrialLength";
419
+ /** the datetime when the amendment was performed (Sales - Order) */
420
+ OrderPropertyKeys["AmendmentDate"] = "AmendmentDate";
421
+ /** Monthly contract value (Sales - Order) */
422
+ OrderPropertyKeys["ContractValueMonthly"] = "ContractValueMonthly";
423
+ /** WithholdCommissionNotes */
424
+ OrderPropertyKeys["WithholdCommissionNotes"] = "WithholdCommissionNotes";
425
+ /** WithholdCommissionReason */
426
+ OrderPropertyKeys["WithholdCommissionReason"] = "WithholdCommissionReason";
427
+ /** total discounts (Sales - Order) */
428
+ OrderPropertyKeys["TotalDiscounts"] = "TotalDiscounts";
429
+ /** ExternalRefBrskISP */
430
+ OrderPropertyKeys["ExternalRefBrskIsp"] = "ExternalRefBrskISP";
431
+ /** Pending Amco Dispatch Work Order */
432
+ OrderPropertyKeys["PendingAmcoDispatch"] = "PendingAmcoDispatch";
433
+ /** ExternalRefBrskFF */
434
+ OrderPropertyKeys["ExternalRefBrskFf"] = "ExternalRefBrskFF";
435
+ /** ExternalRefBrskFNO */
436
+ OrderPropertyKeys["ExternalRefBrskFno"] = "ExternalRefBrskFNO";
437
+ /** the date the order is delivered (Sales - Order) */
438
+ OrderPropertyKeys["DeliveryDate"] = "DeliveryDate";
439
+ /** subtotal of the prices no taxes (Sales - Order) */
440
+ OrderPropertyKeys["Subtotal"] = "Subtotal";
441
+ /** phone number to transfer (Sales - Order) */
442
+ OrderPropertyKeys["TransferPhone"] = "TransferPhone";
443
+ /** the date the order is issued (Sales - Order) */
444
+ OrderPropertyKeys["IssuedDate"] = "IssuedDate";
445
+ /** active date (Sales - Order) */
446
+ OrderPropertyKeys["ActiveDate"] = "ActiveDate";
447
+ /** the type of discount (Sales - Order) */
448
+ OrderPropertyKeys["DiscountType"] = "DiscountType";
449
+ /** Reference identifier for Order relationships. Used for data integrity. */
450
+ OrderPropertyKeys["AddressId"] = "AddressId";
451
+ /** Total contract value (Sales - Order) */
452
+ OrderPropertyKeys["ContractValueTotal"] = "ContractValueTotal";
453
+ /** Reason for deactivating the order (Sales - Order) */
454
+ OrderPropertyKeys["DeactivationReason"] = "DeactivationReason";
431
455
  /** cancellation reason notes (Sales - Order) */
432
456
  OrderPropertyKeys["CancellationReasonNote"] = "CancellationReasonNote";
433
- /** the date the order was cancelled (Sales - Order) */
434
- OrderPropertyKeys["CancelledDate"] = "CancelledDate";
435
- /** The date the order should be moved to cancelled (Sales - Order) */
436
- OrderPropertyKeys["CancelOnDate"] = "CancelOnDate";
437
- /** When the Cashback was approved (Sales - Order) */
438
- OrderPropertyKeys["CashbackApprovalDate"] = "CashbackApprovalDate";
439
- /** Supplier-committed fulfillment date carried on COMMITTED KCI (per yf-kci-effect-bridge.ts#provide-committed). Stamped onto YF Order via walker-driven receiveKci PROPERTY_WRITE. */
440
- OrderPropertyKeys["CommittedDate"] = "CommittedDate";
441
- /** the contract buy out amount requested by the customer (Sales - Order) */
442
- OrderPropertyKeys["ContractBuyOutRequested"] = "ContractBuyOutRequested";
443
- /** I have read and confirm receipt of the Contract Summary. I consent to the Privacy Policy and acknowledge receipt of the T&Cs. (Sales - Contact) */
444
- OrderPropertyKeys["ContractConsent"] = "ContractConsent";
445
- /** the date the contract will end (Sales - Order) */
446
- OrderPropertyKeys["ContractEndDate"] = "ContractEndDate";
457
+ /** Cancelation reason (Sales - Order) */
458
+ OrderPropertyKeys["CancellationReason"] = "CancellationReason";
459
+ /** To be handled manually by an operator. Default state = false (Sales - Order) */
460
+ OrderPropertyKeys["IsVerified"] = "IsVerified";
461
+ /** true if the customer has an active mandate (Sales - Order) */
462
+ OrderPropertyKeys["ActiveMandate"] = "ActiveMandate";
463
+ /** the highest status of the invoices in dunning (Sales - Order) */
464
+ OrderPropertyKeys["DunningStatus"] = "DunningStatus";
465
+ /** alerts that need to be visible on the order (Sales - Order) */
466
+ OrderPropertyKeys["AlertMessage"] = "AlertMessage";
467
+ /** Data field for Order records. Used by Sales team. */
468
+ OrderPropertyKeys["Source"] = "Source";
469
+ /** Landing Page (Sales - Order) */
470
+ OrderPropertyKeys["LandingPage"] = "LandingPage";
471
+ /** the date the mandate reminder was sent (Sales - Order) */
472
+ OrderPropertyKeys["MandateReminderSmsSentAt"] = "MandateReminderSmsSentAt";
473
+ /** unique delivery point reference number (Sales - Order) */
474
+ OrderPropertyKeys["Udprn"] = "UDPRN";
475
+ /** the value to discount (Sales - Order) */
476
+ OrderPropertyKeys["DiscountValue"] = "DiscountValue";
447
477
  /** the number of times the contract has renewed (Sales - Order) */
448
478
  OrderPropertyKeys["ContractRenewalCount"] = "ContractRenewalCount";
479
+ /** total price including taxes and discounts (Sales - Order) */
480
+ OrderPropertyKeys["TotalPrice"] = "TotalPrice";
481
+ /** length for the items discount duration (Sales - Order) */
482
+ OrderPropertyKeys["DiscountLength"] = "DiscountLength";
449
483
  /** the additional number of times the contract has renewed (Sales - Order) */
450
484
  OrderPropertyKeys["ContractRenewalCountOverride"] = "ContractRenewalCountOverride";
485
+ /** Description of order deactivation (Sales - Order) */
486
+ OrderPropertyKeys["DeactivationDescription"] = "DeactivationDescription";
487
+ /** the number of invoices in dunning (Sales - Order) */
488
+ OrderPropertyKeys["InvoicesDunning"] = "InvoicesDunning";
489
+ /** the date the dunning period started (Sales - Order) */
490
+ OrderPropertyKeys["DunningStartDate"] = "DunningStartDate";
491
+ /** the average monthly contract value (Sales - Order) */
492
+ OrderPropertyKeys["AverageMonthlyValue"] = "AverageMonthlyValue";
493
+ /** the date of the alert message (Sales - Order) */
494
+ OrderPropertyKeys["AlertMessageDate"] = "AlertMessageDate";
451
495
  /** the date the contract start (Sales - Order) */
452
496
  OrderPropertyKeys["ContractStartDate"] = "ContractStartDate";
453
- /** the type of the contract (Sales - Order) */
454
- OrderPropertyKeys["ContractType"] = "ContractType";
455
- /** Monthly contract value (Sales - Order) */
456
- OrderPropertyKeys["ContractValueMonthly"] = "ContractValueMonthly";
457
- /** Total contract value (Sales - Order) */
458
- OrderPropertyKeys["ContractValueTotal"] = "ContractValueTotal";
459
- /** Currency code (Sales - Order) */
460
- OrderPropertyKeys["CurrencyCode"] = "CurrencyCode";
461
- /** Reference identifier for Order relationships. Used for data integrity. */
462
- OrderPropertyKeys["DataSetId"] = "DataSetId";
463
- /** The reason for collection attempts stopping (Sales - Order) */
464
- OrderPropertyKeys["DcaClosureReason"] = "DCAClosureReason";
497
+ /** the date the order was cancelled (Sales - Order) */
498
+ OrderPropertyKeys["CancelledDate"] = "CancelledDate";
499
+ /** the date the mandate reminder email was sent (Sales - Order) */
500
+ OrderPropertyKeys["MandateReminderEmailSentAt"] = "MandateReminderEmailSentAt";
501
+ /** the date the contract will end (Sales - Order) */
502
+ OrderPropertyKeys["ContractEndDate"] = "ContractEndDate";
503
+ /** the previous order prior to an amendment or recontract (Sales - Order) */
504
+ OrderPropertyKeys["PreviousOrderId"] = "PreviousOrderId";
505
+ /** This will be the date the order is automatically cancelled. It will always be at the end of an invoice billing period end date. (Sales - Order) */
506
+ OrderPropertyKeys["CancellationEffectiveDate"] = "CancellationEffectiveDate";
507
+ /** the date the mandate status was updated (Sales - Order) */
508
+ OrderPropertyKeys["MandateStatusUpdatedAt"] = "MandateStatusUpdatedAt";
509
+ /** the contract buy out amount requested by the customer (Sales - Order) */
510
+ OrderPropertyKeys["ContractBuyOutRequested"] = "ContractBuyOutRequested";
465
511
  /** The total value sent to collect (Sales - Order) */
466
512
  OrderPropertyKeys["DcaCollectionValue"] = "DCACollectionValue";
467
- /** The date the DCA loaded the order (Sales - Order) */
468
- OrderPropertyKeys["DcaLoadedDate"] = "DCALoadedDate";
469
513
  /** The collection value paid to date (Sales - Order) */
470
514
  OrderPropertyKeys["DcaPaidToDate"] = "DCAPaidToDate";
471
- /** The debt collection agency status (Sales - Order) */
472
- OrderPropertyKeys["DcaStatus"] = "DCAStatus";
473
- /** The date the order should be moved to deactivated (Sales - Order) */
474
- OrderPropertyKeys["DeactivateOnDate"] = "DeactivateOnDate";
475
- /** The day this order was deactivated. Cleared when the order goes back to Active, and kept when it goes on to Cancelled. Empty means the order is not deactivated. Not to be confused with DeactivateOnDate, which is a scheduled instruction and is cleared once it is acted on. */
476
- OrderPropertyKeys["DeactivationDate"] = "DeactivationDate";
477
- /** Description of order deactivation (Sales - Order) */
478
- OrderPropertyKeys["DeactivationDescription"] = "DeactivationDescription";
479
- /** Reason for deactivating the order (Sales - Order) */
480
- OrderPropertyKeys["DeactivationReason"] = "DeactivationReason";
481
- /** the date the order is delivered (Sales - Order) */
482
- OrderPropertyKeys["DeliveryDate"] = "DeliveryDate";
515
+ /** The reason for collection attempts stopping (Sales - Order) */
516
+ OrderPropertyKeys["DcaClosureReason"] = "DCAClosureReason";
517
+ /** The date the DCA loaded the order (Sales - Order) */
518
+ OrderPropertyKeys["DcaLoadedDate"] = "DCALoadedDate";
519
+ /** Data field for Order records. Used by Sales team. */
520
+ OrderPropertyKeys["Longitude"] = "Longitude";
521
+ /** Reference identifier for Order relationships. Used for data integrity. */
522
+ OrderPropertyKeys["DataSetId"] = "DataSetId";
523
+ /** Data field for Order records. Used by Sales team. */
524
+ OrderPropertyKeys["Latitude"] = "Latitude";
483
525
  /** Desired Billing Day (Sales - Order) */
484
526
  OrderPropertyKeys["DesiredBillingDay"] = "DesiredBillingDay";
485
- /** length for the items discount duration (Sales - Order) */
486
- OrderPropertyKeys["DiscountLength"] = "DiscountLength";
487
- /** the type of discount (Sales - Order) */
488
- OrderPropertyKeys["DiscountType"] = "DiscountType";
489
- /** discount duration unit (Sales - Order) */
490
- OrderPropertyKeys["DiscountUnit"] = "DiscountUnit";
491
- /** the value to discount (Sales - Order) */
492
- OrderPropertyKeys["DiscountValue"] = "DiscountValue";
493
- /** the date the dunning period started (Sales - Order) */
494
- OrderPropertyKeys["DunningStartDate"] = "DunningStartDate";
495
- /** the highest status of the invoices in dunning (Sales - Order) */
496
- OrderPropertyKeys["DunningStatus"] = "DunningStatus";
527
+ /** The date the order should be moved to deactivated (Sales - Order) */
528
+ OrderPropertyKeys["DeactivateOnDate"] = "DeactivateOnDate";
529
+ /** The date the order should be moved to cancelled (Sales - Order) */
530
+ OrderPropertyKeys["CancelOnDate"] = "CancelOnDate";
531
+ /** Billing terms i.e NET 15,30 (Sales - Order) */
532
+ OrderPropertyKeys["BillingTerms"] = "BillingTerms";
533
+ /** Data field for Order records. Used by Sales team. */
534
+ OrderPropertyKeys["Uprn"] = "Uprn";
535
+ /** referral email (Sales - Order) */
536
+ OrderPropertyKeys["ReferralEmail"] = "ReferralEmail";
537
+ /** network provider (Sales - Order) */
538
+ OrderPropertyKeys["Provider"] = "Provider";
497
539
  /** when the dunning status was last updated (Sales - Order) */
498
540
  OrderPropertyKeys["DunningStatusUpdatedAt"] = "DunningStatusUpdatedAt";
499
- /** The next commitment to fall due. What a "what is about to breach" query sorts on, without walking every commitment. Written only by the lifecycle. */
500
- OrderPropertyKeys["EarliestDueAt"] = "EarliestDueAt";
541
+ /** The debt collection agency status (Sales - Order) */
542
+ OrderPropertyKeys["DcaStatus"] = "DCAStatus";
543
+ /** the price match requested by the customer (Sales - Order) */
544
+ OrderPropertyKeys["PriceMatchRequested"] = "PriceMatchRequested";
545
+ /** Billing day in the month (Sales - Order) */
546
+ OrderPropertyKeys["BillingDay"] = "BillingDay";
547
+ /** ReferralApprovalDate (Sales - Order) */
548
+ OrderPropertyKeys["ReferralApprovalDate"] = "ReferralApprovalDate";
549
+ /** The date the order was rejected in aklamio (Sales - Order) */
550
+ OrderPropertyKeys["AklamioRejectionDate"] = "AklamioRejectionDate";
551
+ /** the subscriber id is used as the identifier when provisioning on the network (Sales - Order) */
552
+ OrderPropertyKeys["SubscriberId"] = "SubscriberId";
553
+ /** check this box if you want to flag a commission hold on this order (Sales - Order) */
554
+ OrderPropertyKeys["WithholdCommission"] = "WithholdCommission";
555
+ /** Aklamio cashback was rejected (Sales - Order) */
556
+ OrderPropertyKeys["AklamioCashbackRejectionDate"] = "AklamioCashbackRejectionDate";
557
+ /** Aklamio cashback was applied (Sales - Order) */
558
+ OrderPropertyKeys["AklamioCashbackVerificationDate"] = "AklamioCashbackVerificationDate";
559
+ /** When the Cashback was approved (Sales - Order) */
560
+ OrderPropertyKeys["CashbackApprovalDate"] = "CashbackApprovalDate";
561
+ /** Supplier-committed fulfillment date carried on COMMITTED KCI (per yf-kci-effect-bridge.ts#provide-committed). Stamped onto YF Order via walker-driven receiveKci PROPERTY_WRITE. */
562
+ OrderPropertyKeys["CommittedDate"] = "CommittedDate";
563
+ /** Whether a customer already has a battery pack from YouFibre or not */
564
+ OrderPropertyKeys["BatteryPackProvided"] = "BatteryPackProvided";
565
+ /** I have read and confirm receipt of the Contract Summary. I consent to the Privacy Policy and acknowledge receipt of the T&Cs. (Sales - Contact) */
566
+ OrderPropertyKeys["ContractConsent"] = "ContractConsent";
501
567
  /** The early termination fee quoted for this order (VAT-inclusive, totalGross from the ETF quote calculation). Written by EarlyTerminationService.getQuote on every quote call, for any caller and any atDate — a hypothetical quote overwrites the "as of now" value (deliberate, see CASES-1640). Direct input to the ETF <= £330 eligibility rule in the product-selection flow (WEB-1421 / PORTAPP-2651). */
502
568
  OrderPropertyKeys["EarlyTerminationFee"] = "EarlyTerminationFee";
503
- /** ExternalRefBrskFF */
504
- OrderPropertyKeys["ExternalRefBrskFf"] = "ExternalRefBrskFF";
505
- /** ExternalRefBrskFNO */
506
- OrderPropertyKeys["ExternalRefBrskFno"] = "ExternalRefBrskFNO";
507
- /** ExternalRefBrskISP */
508
- OrderPropertyKeys["ExternalRefBrskIsp"] = "ExternalRefBrskISP";
509
- /** ExternalReference */
510
- OrderPropertyKeys["ExternalReference"] = "ExternalReference";
511
- /** One Touch Switch reference number */
512
- OrderPropertyKeys["ExternalReferenceOts"] = "ExternalReferenceOts";
513
- /** The activation date asked for when the order was placed. Written once at checkout and never changed; RequestedActivationDate moves when the date does. */
514
- OrderPropertyKeys["FirstRequestedActivationDate"] = "FirstRequestedActivationDate";
515
- /** Derived from the commitment set: OPEN while any commitment is Pending or Breached, SETTLED when none is. Written only by the commitment lifecycle. */
516
- OrderPropertyKeys["FulfillmentState"] = "FulfillmentState";
517
- /** the number of invoices in dunning (Sales - Order) */
518
- OrderPropertyKeys["InvoicesDunning"] = "InvoicesDunning";
519
- /** the date the order is issued (Sales - Order) */
520
- OrderPropertyKeys["IssuedDate"] = "IssuedDate";
521
- /** To be handled manually by an operator. Default state = false (Sales - Order) */
522
- OrderPropertyKeys["IsVerified"] = "IsVerified";
523
- /** Landing Page (Sales - Order) */
524
- OrderPropertyKeys["LandingPage"] = "LandingPage";
525
- /** Data field for Order records. Used by Sales team. */
526
- OrderPropertyKeys["Latitude"] = "Latitude";
527
- /** LegacyBrskOtsData */
528
- OrderPropertyKeys["LegacyBrskOtsData"] = "LegacyBrskOtsData";
529
- /** Data field for Order records. Used by Sales team. */
530
- OrderPropertyKeys["Longitude"] = "Longitude";
531
- /** the date the mandate reminder email was sent (Sales - Order) */
532
- OrderPropertyKeys["MandateReminderEmailSentAt"] = "MandateReminderEmailSentAt";
533
- /** the date the mandate reminder was sent (Sales - Order) */
534
- OrderPropertyKeys["MandateReminderSmsSentAt"] = "MandateReminderSmsSentAt";
535
- /** the date the mandate status was updated (Sales - Order) */
536
- OrderPropertyKeys["MandateStatusUpdatedAt"] = "MandateStatusUpdatedAt";
569
+ /** AltContactMethod */
570
+ OrderPropertyKeys["AltContactMethod"] = "AltContactMethod";
537
571
  /** MobileCoverage */
538
572
  OrderPropertyKeys["MobileCoverage"] = "MobileCoverage";
539
- /** Display name/title for Order records. Primary identifier for Sales team. */
540
- OrderPropertyKeys["Name"] = "Name";
541
- /** How many commitments are Pending or Breached. Written only by the lifecycle. */
542
- OrderPropertyKeys["OpenCommitmentCount"] = "OpenCommitmentCount";
573
+ /** BatteryPackRequired */
574
+ OrderPropertyKeys["BatteryPackRequired"] = "BatteryPackRequired";
575
+ /** LegacyBrskOtsData */
576
+ OrderPropertyKeys["LegacyBrskOtsData"] = "LegacyBrskOtsData";
543
577
  /** OtsNotRequiredReason */
544
578
  OrderPropertyKeys["OtsNotRequiredReason"] = "OtsNotRequiredReason";
545
- /** Pending Amco Collection Work Order */
546
- OrderPropertyKeys["PendingAmcoCollection"] = "PendingAmcoCollection";
547
- /** Pending Amco Dispatch Work Order */
548
- OrderPropertyKeys["PendingAmcoDispatch"] = "PendingAmcoDispatch";
549
- /** Pending Amco Replacement WorkOrder */
550
- OrderPropertyKeys["PendingAmcoReplacement"] = "PendingAmcoReplacement";
551
- /** the previous order prior to an amendment or recontract (Sales - Order) */
552
- OrderPropertyKeys["PreviousOrderId"] = "PreviousOrderId";
553
- /** the price match requested by the customer (Sales - Order) */
554
- OrderPropertyKeys["PriceMatchRequested"] = "PriceMatchRequested";
555
- /** network provider (Sales - Order) */
556
- OrderPropertyKeys["Provider"] = "Provider";
579
+ /** Aklamio Verification Date (Sales - Order) */
580
+ OrderPropertyKeys["AklamioVerificationDate"] = "AklamioVerificationDate";
581
+ /** The type of supplier order required to fulfil this YF order. */
582
+ OrderPropertyKeys["SupplierOrderType"] = "SupplierOrderType";
583
+ /** One Touch Switch reference number */
584
+ OrderPropertyKeys["ExternalReferenceOts"] = "ExternalReferenceOts";
557
585
  /** Date the order was recontracted (in place). Discriminator + event date. */
558
586
  OrderPropertyKeys["RecontractDate"] = "RecontractDate";
559
- /** ReferralApprovalDate (Sales - Order) */
560
- OrderPropertyKeys["ReferralApprovalDate"] = "ReferralApprovalDate";
561
- /** referral email (Sales - Order) */
562
- OrderPropertyKeys["ReferralEmail"] = "ReferralEmail";
587
+ /** status of the order (must be activated for billing) (Sales - Order) */
588
+ OrderPropertyKeys["ActivationStatus"] = "ActivationStatus";
589
+ /** Front end that last saved the battery backup answers. Set by the customer portal API, copied to the dispatch work order Source by the orders module, then cleared (PORTAPP-3276). */
590
+ OrderPropertyKeys["BatteryBackupAnswersSource"] = "BatteryBackupAnswersSource";
591
+ /** The day this order was deactivated. Cleared when the order goes back to Active, and kept when it goes on to Cancelled. Empty means the order is not deactivated. Not to be confused with DeactivateOnDate, which is a scheduled instruction and is cleared once it is acted on. */
592
+ OrderPropertyKeys["DeactivationDate"] = "DeactivationDate";
563
593
  /** Used when restarting an existing service, allows the customer to specify what date is used for the RequestedCompletionDate on the supplier-side START order. Used for when a customer is technically able to start receiving service. */
564
594
  OrderPropertyKeys["RequestedActivationDate"] = "RequestedActivationDate";
565
- /** the delivery date requested by the customer (Sales - Order) */
566
- OrderPropertyKeys["RequestedDeliveryDate"] = "RequestedDeliveryDate";
595
+ /** Derived from the commitment set: OPEN while any commitment is Pending or Breached, SETTLED when none is. Written only by the commitment lifecycle. */
596
+ OrderPropertyKeys["FulfillmentState"] = "FulfillmentState";
597
+ /** How many commitments are Pending or Breached. Written only by the lifecycle. */
598
+ OrderPropertyKeys["OpenCommitmentCount"] = "OpenCommitmentCount";
599
+ /** The next commitment to fall due. What a "what is about to breach" query sorts on, without walking every commitment. Written only by the lifecycle. */
600
+ OrderPropertyKeys["EarliestDueAt"] = "EarliestDueAt";
567
601
  /** True while the customer has declined the router/mesh dispatch this recontract would otherwise raise. Written by dispatchRouterForSpeedChange on every call — true when a decline is honoured, false otherwise — so reversal is simply calling the endpoint again with no decline flag (ORD-493). */
568
602
  OrderPropertyKeys["RouterUpgradeDeclined"] = "RouterUpgradeDeclined";
569
- /** Data field for Order records. Used by Sales team. */
570
- OrderPropertyKeys["Source"] = "Source";
571
- /** the subscriber id is used as the identifier when provisioning on the network (Sales - Order) */
572
- OrderPropertyKeys["SubscriberId"] = "SubscriberId";
573
- /** subtotal of the prices no taxes (Sales - Order) */
574
- OrderPropertyKeys["Subtotal"] = "Subtotal";
575
- /** The type of supplier order required to fulfil this YF order. */
576
- OrderPropertyKeys["SupplierOrderType"] = "SupplierOrderType";
577
- /** unit cost for the product derived from product components UnitCost (Sales - Order) */
578
- OrderPropertyKeys["TaxRate"] = "TaxRate";
579
- /** total discounts (Sales - Order) */
580
- OrderPropertyKeys["TotalDiscounts"] = "TotalDiscounts";
581
- /** total price including taxes and discounts (Sales - Order) */
582
- OrderPropertyKeys["TotalPrice"] = "TotalPrice";
583
- /** total taxes (Sales - Order) */
584
- OrderPropertyKeys["TotalTaxAmount"] = "TotalTaxAmount";
585
- /** phone number to transfer (Sales - Order) */
586
- OrderPropertyKeys["TransferPhone"] = "TransferPhone";
587
- /** trial length is the number of X free periods (Sales - Order) */
588
- OrderPropertyKeys["TrialLength"] = "TrialLength";
589
- /** trial unit is the unit of measure for free periods (Sales - Order) */
590
- OrderPropertyKeys["TrialUnit"] = "TrialUnit";
591
- /** unique delivery point reference number (Sales - Order) */
592
- OrderPropertyKeys["Udprn"] = "UDPRN";
593
- /** unique multiple point reference number (Sales - Order) */
594
- OrderPropertyKeys["Umprn"] = "UMPRN";
595
- /** Data field for Order records. Used by Sales team. */
596
- OrderPropertyKeys["Uprn"] = "Uprn";
597
- /** Data field for Order records. Used by Sales team. */
598
- OrderPropertyKeys["VatNumber"] = "VATNumber";
599
- /** check this box if you want to flag a commission hold on this order (Sales - Order) */
600
- OrderPropertyKeys["WithholdCommission"] = "WithholdCommission";
601
- /** WithholdCommissionNotes */
602
- OrderPropertyKeys["WithholdCommissionNotes"] = "WithholdCommissionNotes";
603
- /** WithholdCommissionReason */
604
- OrderPropertyKeys["WithholdCommissionReason"] = "WithholdCommissionReason";
603
+ /** The activation date asked for when the order was placed. Written once at checkout and never changed; RequestedActivationDate moves when the date does. */
604
+ OrderPropertyKeys["FirstRequestedActivationDate"] = "FirstRequestedActivationDate";
605
605
  })(OrderPropertyKeys = exports.OrderPropertyKeys || (exports.OrderPropertyKeys = {}));
606
606
  /**
607
607
  * Order entity from OrderModule