@d19n/youfibre-odin-sdk 2.0.20 → 2.0.21

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 (5) hide show
  1. package/dist/entities-v2/Order.d.ts +517 -517
  2. package/dist/entities-v2/Order.js +236 -236
  3. package/dist/entities-v2/PaymentMethodRefund.d.ts +29 -29
  4. package/dist/entities-v2/PaymentMethodRefund.js +8 -8
  5. package/package.json +1 -1
package/dist/entities-v2/Order.js CHANGED
@@ -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_VISIT_CREATED = exports.ROUTING_KEY_LINK_ORDER_WORK_ORDER_DELETED = exports.ROUTING_KEY_LINK_ORDER_WORK_ORDER_CREATED = exports.ROUTING_KEY_LINK_ORDER_CUSTOMER_DEVICE_ROUTER_DELETED = exports.ROUTING_KEY_LINK_ORDER_CUSTOMER_DEVICE_ROUTER_CREATED = exports.ROUTING_KEY_LINK_ORDER_CONTACT_IDENTITY_DELETED = exports.ROUTING_KEY_LINK_ORDER_CONTACT_IDENTITY_CREATED = exports.ROUTING_KEY_LINK_ORDER_CUSTOMER_DEVICE_ONT_DELETED = exports.ROUTING_KEY_LINK_ORDER_CUSTOMER_DEVICE_ONT_CREATED = exports.ROUTING_KEY_LINK_ORDER_SMS_MESSAGE_DELETED = exports.ROUTING_KEY_LINK_ORDER_SMS_MESSAGE_CREATED = exports.ROUTING_KEY_LINK_ORDER_NOTE_DELETED = exports.ROUTING_KEY_LINK_ORDER_NOTE_CREATED = exports.ROUTING_KEY_LINK_ORDER_PHONE_NUMBER_DELETED = exports.ROUTING_KEY_LINK_ORDER_PHONE_NUMBER_CREATED = exports.ROUTING_KEY_LINK_ORDER_ORDER_ITEM_DELETED = exports.ROUTING_KEY_LINK_ORDER_ORDER_ITEM_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_BILLING_ADJUSTMENT_DELETED = exports.ROUTING_KEY_LINK_ORDER_BILLING_ADJUSTMENT_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_ADDRESS_DELETED = exports.ROUTING_KEY_LINK_ORDER_ADDRESS_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.OrderProvider = exports.OrderDiscountUnit = exports.OrderDiscountType = exports.OrderDeactivationReason = exports.OrderCurrencyCode = exports.OrderContractType = exports.OrderBillingTerms = exports.OrderActivationStatus = exports.DefaultOrderStageKeys = exports.DefaultOrderStageNames = exports.OrderEntityTypes = void 0;
15
+ exports.ROUTING_KEY_LINK_ORDER_VISIT_CREATED = exports.ROUTING_KEY_LINK_ORDER_WORK_ORDER_DELETED = exports.ROUTING_KEY_LINK_ORDER_WORK_ORDER_CREATED = exports.ROUTING_KEY_LINK_ORDER_CUSTOMER_DEVICE_ROUTER_DELETED = exports.ROUTING_KEY_LINK_ORDER_CUSTOMER_DEVICE_ROUTER_CREATED = exports.ROUTING_KEY_LINK_ORDER_CONTACT_IDENTITY_DELETED = exports.ROUTING_KEY_LINK_ORDER_CONTACT_IDENTITY_CREATED = exports.ROUTING_KEY_LINK_ORDER_CUSTOMER_DEVICE_ONT_DELETED = exports.ROUTING_KEY_LINK_ORDER_CUSTOMER_DEVICE_ONT_CREATED = exports.ROUTING_KEY_LINK_ORDER_SMS_MESSAGE_DELETED = exports.ROUTING_KEY_LINK_ORDER_SMS_MESSAGE_CREATED = exports.ROUTING_KEY_LINK_ORDER_NOTE_DELETED = exports.ROUTING_KEY_LINK_ORDER_NOTE_CREATED = exports.ROUTING_KEY_LINK_ORDER_PHONE_NUMBER_DELETED = exports.ROUTING_KEY_LINK_ORDER_PHONE_NUMBER_CREATED = exports.ROUTING_KEY_LINK_ORDER_ORDER_ITEM_DELETED = exports.ROUTING_KEY_LINK_ORDER_ORDER_ITEM_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_BILLING_ADJUSTMENT_DELETED = exports.ROUTING_KEY_LINK_ORDER_BILLING_ADJUSTMENT_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_ADDRESS_DELETED = exports.ROUTING_KEY_LINK_ORDER_ADDRESS_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.OrderDiscountUnit = exports.OrderTrialUnit = exports.OrderContractType = exports.OrderActivationStatus = exports.OrderDeactivationReason = exports.OrderWithholdCommissionReason = exports.OrderProvider = exports.OrderBillingTerms = exports.OrderDiscountType = exports.OrderCurrencyCode = exports.DefaultOrderStageKeys = exports.DefaultOrderStageNames = exports.OrderEntityTypes = void 0;
16
16
  exports.ROUTING_KEY_LINK_ORDER_PUSH_NOTIFICATION_DELETED = exports.ROUTING_KEY_LINK_ORDER_PUSH_NOTIFICATION_CREATED = exports.ROUTING_KEY_LINK_ORDER_REFERRAL_DELETED = exports.ROUTING_KEY_LINK_ORDER_REFERRAL_CREATED = exports.ROUTING_KEY_LINK_ORDER_ACTIVITY_DELETED = exports.ROUTING_KEY_LINK_ORDER_ACTIVITY_CREATED = exports.ROUTING_KEY_LINK_ORDER_APPOINTMENT_DELETED = exports.ROUTING_KEY_LINK_ORDER_APPOINTMENT_CREATED = exports.ROUTING_KEY_LINK_ORDER_ORDER_CHECK_DELETED = exports.ROUTING_KEY_LINK_ORDER_ORDER_CHECK_CREATED = exports.ROUTING_KEY_LINK_ORDER_ORDER_DELETED = exports.ROUTING_KEY_LINK_ORDER_ORDER_CREATED = exports.ROUTING_KEY_LINK_ORDER_CONTACT_DELETED = exports.ROUTING_KEY_LINK_ORDER_CONTACT_CREATED = exports.ROUTING_KEY_LINK_ORDER_CONTRACT_BUY_OUT_DELETED = exports.ROUTING_KEY_LINK_ORDER_CONTRACT_BUY_OUT_CREATED = exports.ROUTING_KEY_LINK_ORDER_FILE_DELETED = exports.ROUTING_KEY_LINK_ORDER_FILE_CREATED = exports.ROUTING_KEY_LINK_ORDER_DISCOUNT_DELETED = exports.ROUTING_KEY_LINK_ORDER_DISCOUNT_CREATED = exports.ROUTING_KEY_LINK_ORDER_VISIT_DELETED = void 0;
17
17
  const core_1 = require("@d19n/odin-types/dist/core");
18
18
  /**
@@ -71,27 +71,31 @@ var DefaultOrderStageKeys;
71
71
  DefaultOrderStageKeys["OrderStagePendingCancellation"] = "OrderStagePendingCancellation";
72
72
  })(DefaultOrderStageKeys = exports.DefaultOrderStageKeys || (exports.DefaultOrderStageKeys = {}));
73
73
  /**
74
- * Valid values for Order.ActivationStatus
74
+ * Valid values for Order.CurrencyCode
75
75
  *
76
- * status of the order (must be activated for billing) (Sales - Order)
76
+ * Currency code (Sales - Order)
77
77
  *
78
78
  * @remarks Available options:
79
- * - `APPROVAL_PENDING` - Approval Pending
80
- * - `CLOSED` - Closed
81
- * - `DRAFT` - Draft
82
- * - `OPEN` - Open
83
- * - `PARTIAL` - Partial
84
- * - `PROCESSING` - Processing
79
+ * - `GBP`
85
80
  */
86
- var OrderActivationStatus;
87
- (function (OrderActivationStatus) {
88
- OrderActivationStatus["APPROVAL_PENDING"] = "APPROVAL_PENDING";
89
- OrderActivationStatus["CLOSED"] = "CLOSED";
90
- OrderActivationStatus["DRAFT"] = "DRAFT";
91
- OrderActivationStatus["OPEN"] = "OPEN";
92
- OrderActivationStatus["PARTIAL"] = "PARTIAL";
93
- OrderActivationStatus["PROCESSING"] = "PROCESSING";
94
- })(OrderActivationStatus = exports.OrderActivationStatus || (exports.OrderActivationStatus = {}));
81
+ var OrderCurrencyCode;
82
+ (function (OrderCurrencyCode) {
83
+ OrderCurrencyCode["GBP"] = "GBP";
84
+ })(OrderCurrencyCode = exports.OrderCurrencyCode || (exports.OrderCurrencyCode = {}));
85
+ /**
86
+ * Valid values for Order.DiscountType
87
+ *
88
+ * the type of discount (Sales - Order)
89
+ *
90
+ * @remarks Available options:
91
+ * - `AMOUNT` - Amount
92
+ * - `PERCENT` - Percent
93
+ */
94
+ var OrderDiscountType;
95
+ (function (OrderDiscountType) {
96
+ OrderDiscountType["AMOUNT"] = "AMOUNT";
97
+ OrderDiscountType["PERCENT"] = "PERCENT";
98
+ })(OrderDiscountType = exports.OrderDiscountType || (exports.OrderDiscountType = {}));
95
99
  /**
96
100
  * Valid values for Order.BillingTerms
97
101
  *
@@ -119,44 +123,43 @@ var OrderBillingTerms;
119
123
  OrderBillingTerms["NET_90"] = "NET_90";
120
124
  })(OrderBillingTerms = exports.OrderBillingTerms || (exports.OrderBillingTerms = {}));
121
125
  /**
122
- * Valid values for Order.ContractType
126
+ * Valid values for Order.Provider
123
127
  *
124
- * the type of the contract (Sales - Order)
128
+ * network provider (Sales - Order)
125
129
  *
126
130
  * @remarks Available options:
127
- * - `ANNUAL_12` - 12 months
128
- * - `ANNUAL_18` - 18 months
129
- * - `ANNUAL_19` - 19 months
130
- * - `MONTHLY` - 1 month rolling
131
- * - `ANNUAL_20` - 20 months
132
- * - `ANNUAL_21` - 21 months
133
- * - `ANNUAL_22` - 22 months
134
- * - `ANNUAL_23` - 23 months
135
- * - `ANNUAL_24` - 24 months
136
- * - `ANNUAL_25` - 25 months
137
- * - `ANNUAL_26` - 26 months
138
- * - `ANNUAL_27` - 27 months
139
- * - `ANNUAL_28` - 28 months
140
- * - `ANNUAL_29` - 29 months
141
- * - `ANNUAL_30` - 30 months
142
- * - ... and 14 more
131
+ * - `BRSK` - Brsk
132
+ * - `CITYFIBRE` - CityFibre
133
+ * - `NETOMNIA` - Netomnia
134
+ * - `NETOMNIA_LEGACY` - Netomnia legacy
135
+ * - `PYOMNI` - PyOmni
143
136
  */
144
- var OrderContractType;
145
- (function (OrderContractType) {
146
- OrderContractType["NO_CONTRACT"] = "NONE";
147
- })(OrderContractType = exports.OrderContractType || (exports.OrderContractType = {}));
137
+ var OrderProvider;
138
+ (function (OrderProvider) {
139
+ OrderProvider["BRSK"] = "BRSK";
140
+ OrderProvider["CITY_FIBRE"] = "CITYFIBRE";
141
+ OrderProvider["NETOMNIA"] = "NETOMNIA";
142
+ OrderProvider["NETOMNIA_LEGACY"] = "NETOMNIA_LEGACY";
143
+ OrderProvider["PY_OMNI"] = "PYOMNI";
144
+ })(OrderProvider = exports.OrderProvider || (exports.OrderProvider = {}));
148
145
  /**
149
- * Valid values for Order.CurrencyCode
146
+ * Valid values for Order.WithholdCommissionReason
150
147
  *
151
- * Currency code (Sales - Order)
148
+ * Withhold Commission Reason
152
149
  *
153
150
  * @remarks Available options:
154
- * - `GBP`
151
+ * - `ETF_VALUE` - ETF over £300
152
+ * - `NO_WELCOME_PACK` - No welcome pack
153
+ * - `OTHER` - Other
154
+ * - `PRICE_MATCH_EVIDENCE` - Price Match evidence insufficient or missing
155
155
  */
156
- var OrderCurrencyCode;
157
- (function (OrderCurrencyCode) {
158
- OrderCurrencyCode["GBP"] = "GBP";
159
- })(OrderCurrencyCode = exports.OrderCurrencyCode || (exports.OrderCurrencyCode = {}));
156
+ var OrderWithholdCommissionReason;
157
+ (function (OrderWithholdCommissionReason) {
158
+ OrderWithholdCommissionReason["ETF_OVER_300"] = "ETF_VALUE";
159
+ OrderWithholdCommissionReason["NO_WELCOME_PACK"] = "NO_WELCOME_PACK";
160
+ OrderWithholdCommissionReason["OTHER"] = "OTHER";
161
+ OrderWithholdCommissionReason["PRICE_MATCH_EVIDENCE_INSUFFICIENT_OR_MISSING"] = "PRICE_MATCH_EVIDENCE";
162
+ })(OrderWithholdCommissionReason = exports.OrderWithholdCommissionReason || (exports.OrderWithholdCommissionReason = {}));
160
163
  /**
161
164
  * Valid values for Order.DeactivationReason
162
165
  *
@@ -170,53 +173,54 @@ var OrderDeactivationReason;
170
173
  OrderDeactivationReason["PAYMENT_OVERDUE"] = "PAYMENT_OVERDUE";
171
174
  })(OrderDeactivationReason = exports.OrderDeactivationReason || (exports.OrderDeactivationReason = {}));
172
175
  /**
173
- * Valid values for Order.DiscountType
174
- *
175
- * the type of discount (Sales - Order)
176
- *
177
- * @remarks Available options:
178
- * - `AMOUNT` - Amount
179
- * - `PERCENT` - Percent
180
- */
181
- var OrderDiscountType;
182
- (function (OrderDiscountType) {
183
- OrderDiscountType["AMOUNT"] = "AMOUNT";
184
- OrderDiscountType["PERCENT"] = "PERCENT";
185
- })(OrderDiscountType = exports.OrderDiscountType || (exports.OrderDiscountType = {}));
186
- /**
187
- * Valid values for Order.DiscountUnit
176
+ * Valid values for Order.ActivationStatus
188
177
  *
189
- * discount duration unit (Sales - Order)
178
+ * status of the order (must be activated for billing) (Sales - Order)
190
179
  *
191
180
  * @remarks Available options:
192
- * - `DAYS` - Days
193
- * - `MONTHS` - Months
181
+ * - `APPROVAL_PENDING` - Approval Pending
182
+ * - `CLOSED` - Closed
183
+ * - `DRAFT` - Draft
184
+ * - `OPEN` - Open
185
+ * - `PARTIAL` - Partial
186
+ * - `PROCESSING` - Processing
194
187
  */
195
- var OrderDiscountUnit;
196
- (function (OrderDiscountUnit) {
197
- OrderDiscountUnit["DAYS"] = "DAYS";
198
- OrderDiscountUnit["MONTHS"] = "MONTHS";
199
- })(OrderDiscountUnit = exports.OrderDiscountUnit || (exports.OrderDiscountUnit = {}));
188
+ var OrderActivationStatus;
189
+ (function (OrderActivationStatus) {
190
+ OrderActivationStatus["APPROVAL_PENDING"] = "APPROVAL_PENDING";
191
+ OrderActivationStatus["CLOSED"] = "CLOSED";
192
+ OrderActivationStatus["DRAFT"] = "DRAFT";
193
+ OrderActivationStatus["OPEN"] = "OPEN";
194
+ OrderActivationStatus["PARTIAL"] = "PARTIAL";
195
+ OrderActivationStatus["PROCESSING"] = "PROCESSING";
196
+ })(OrderActivationStatus = exports.OrderActivationStatus || (exports.OrderActivationStatus = {}));
200
197
  /**
201
- * Valid values for Order.Provider
198
+ * Valid values for Order.ContractType
202
199
  *
203
- * network provider (Sales - Order)
200
+ * the type of the contract (Sales - Order)
204
201
  *
205
202
  * @remarks Available options:
206
- * - `BRSK` - Brsk
207
- * - `CITYFIBRE` - CityFibre
208
- * - `NETOMNIA` - Netomnia
209
- * - `NETOMNIA_LEGACY` - Netomnia legacy
210
- * - `PYOMNI` - PyOmni
203
+ * - `ANNUAL_12` - 12 months
204
+ * - `ANNUAL_18` - 18 months
205
+ * - `ANNUAL_19` - 19 months
206
+ * - `MONTHLY` - 1 month rolling
207
+ * - `ANNUAL_20` - 20 months
208
+ * - `ANNUAL_21` - 21 months
209
+ * - `ANNUAL_22` - 22 months
210
+ * - `ANNUAL_23` - 23 months
211
+ * - `ANNUAL_24` - 24 months
212
+ * - `ANNUAL_25` - 25 months
213
+ * - `ANNUAL_26` - 26 months
214
+ * - `ANNUAL_27` - 27 months
215
+ * - `ANNUAL_28` - 28 months
216
+ * - `ANNUAL_29` - 29 months
217
+ * - `ANNUAL_30` - 30 months
218
+ * - ... and 14 more
211
219
  */
212
- var OrderProvider;
213
- (function (OrderProvider) {
214
- OrderProvider["BRSK"] = "BRSK";
215
- OrderProvider["CITY_FIBRE"] = "CITYFIBRE";
216
- OrderProvider["NETOMNIA"] = "NETOMNIA";
217
- OrderProvider["NETOMNIA_LEGACY"] = "NETOMNIA_LEGACY";
218
- OrderProvider["PY_OMNI"] = "PYOMNI";
219
- })(OrderProvider = exports.OrderProvider || (exports.OrderProvider = {}));
220
+ var OrderContractType;
221
+ (function (OrderContractType) {
222
+ OrderContractType["NO_CONTRACT"] = "NONE";
223
+ })(OrderContractType = exports.OrderContractType || (exports.OrderContractType = {}));
220
224
  /**
221
225
  * Valid values for Order.TrialUnit
222
226
  *
@@ -232,203 +236,199 @@ var OrderTrialUnit;
232
236
  OrderTrialUnit["MONTHS"] = "MONTHS";
233
237
  })(OrderTrialUnit = exports.OrderTrialUnit || (exports.OrderTrialUnit = {}));
234
238
  /**
235
- * Valid values for Order.WithholdCommissionReason
239
+ * Valid values for Order.DiscountUnit
236
240
  *
237
- * Withhold Commission Reason
241
+ * discount duration unit (Sales - Order)
238
242
  *
239
243
  * @remarks Available options:
240
- * - `ETF_VALUE` - ETF over £300
241
- * - `NO_WELCOME_PACK` - No welcome pack
242
- * - `OTHER` - Other
243
- * - `PRICE_MATCH_EVIDENCE` - Price Match evidence insufficient or missing
244
+ * - `DAYS` - Days
245
+ * - `MONTHS` - Months
244
246
  */
245
- var OrderWithholdCommissionReason;
246
- (function (OrderWithholdCommissionReason) {
247
- OrderWithholdCommissionReason["ETF_OVER_300"] = "ETF_VALUE";
248
- OrderWithholdCommissionReason["NO_WELCOME_PACK"] = "NO_WELCOME_PACK";
249
- OrderWithholdCommissionReason["OTHER"] = "OTHER";
250
- OrderWithholdCommissionReason["PRICE_MATCH_EVIDENCE_INSUFFICIENT_OR_MISSING"] = "PRICE_MATCH_EVIDENCE";
251
- })(OrderWithholdCommissionReason = exports.OrderWithholdCommissionReason || (exports.OrderWithholdCommissionReason = {}));
247
+ var OrderDiscountUnit;
248
+ (function (OrderDiscountUnit) {
249
+ OrderDiscountUnit["DAYS"] = "DAYS";
250
+ OrderDiscountUnit["MONTHS"] = "MONTHS";
251
+ })(OrderDiscountUnit = exports.OrderDiscountUnit || (exports.OrderDiscountUnit = {}));
252
252
  /**
253
253
  * Property keys for Order
254
254
  * Use these constants instead of string literals for type safety
255
255
  */
256
256
  var OrderPropertyKeys;
257
257
  (function (OrderPropertyKeys) {
258
- /** status of the order (must be activated for billing) (Sales - Order) */
259
- OrderPropertyKeys["ActivationStatus"] = "ActivationStatus";
260
- /** active date (Sales - Order) */
261
- OrderPropertyKeys["ActiveDate"] = "ActiveDate";
262
- /** true if the customer has an active mandate (Sales - Order) */
263
- OrderPropertyKeys["ActiveMandate"] = "ActiveMandate";
264
- /** Reference identifier for Order relationships. Used for data integrity. */
265
- OrderPropertyKeys["AddressId"] = "AddressId";
266
- /** Affiliate code used when order was placed */
267
- OrderPropertyKeys["AffiliateCode"] = "AffiliateCode";
268
- /** Aklamio cashback was rejected (Sales - Order) */
269
- OrderPropertyKeys["AklamioCashbackRejectionDate"] = "AklamioCashbackRejectionDate";
270
- /** Aklamio cashback was applied (Sales - Order) */
271
- OrderPropertyKeys["AklamioCashbackVerificationDate"] = "AklamioCashbackVerificationDate";
272
- /** This order comes because of an Aklamio Reference (Sales - Order) */
273
- OrderPropertyKeys["AklamioReferenced"] = "AklamioReferenced";
274
- /** The date the order was rejected in aklamio (Sales - Order) */
275
- OrderPropertyKeys["AklamioRejectionDate"] = "AklamioRejectionDate";
276
- /** Aklamio Verification Date (Sales - Order) */
277
- OrderPropertyKeys["AklamioVerificationDate"] = "AklamioVerificationDate";
278
- /** alerts that need to be visible on the order (Sales - Order) */
279
- OrderPropertyKeys["AlertMessage"] = "AlertMessage";
280
- /** the date of the alert message (Sales - Order) */
281
- OrderPropertyKeys["AlertMessageDate"] = "AlertMessageDate";
258
+ /** ExternalReference */
259
+ OrderPropertyKeys["ExternalReference"] = "ExternalReference";
260
+ /** Data field for Order records. Used by Sales team. */
261
+ OrderPropertyKeys["VatNumber"] = "VATNumber";
282
262
  /** the datetime when the amendment was performed (Sales - Order) */
283
263
  OrderPropertyKeys["AmendmentDate"] = "AmendmentDate";
284
- /** the average monthly contract value (Sales - Order) */
285
- OrderPropertyKeys["AverageMonthlyValue"] = "AverageMonthlyValue";
286
- /** Billing day in the month (Sales - Order) */
287
- OrderPropertyKeys["BillingDay"] = "BillingDay";
288
- /** Billing start date (Sales - Order) */
289
- OrderPropertyKeys["BillingStartDate"] = "BillingStartDate";
290
- /** Billing terms i.e NET 15,30 (Sales - Order) */
291
- OrderPropertyKeys["BillingTerms"] = "BillingTerms";
292
- /** 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) */
293
- OrderPropertyKeys["CancellationEffectiveDate"] = "CancellationEffectiveDate";
294
- /** Cancellation reason (Sales - Order) */
295
- OrderPropertyKeys["CancellationReason"] = "CancellationReason";
296
- /** cancellation reason notes (Sales - Order) */
297
- OrderPropertyKeys["CancellationReasonNote"] = "CancellationReasonNote";
298
- /** the date the order was cancelled (Sales - Order) */
299
- OrderPropertyKeys["CancelledDate"] = "CancelledDate";
300
- /** The date the order should be moved to cancelled (Sales - Order) */
301
- OrderPropertyKeys["CancelOnDate"] = "CancelOnDate";
302
- /** When the Cashback was approved (Sales - Order) */
303
- OrderPropertyKeys["CashbackApprovalDate"] = "CashbackApprovalDate";
304
- /** the contract buy out amount requested by the customer (Sales - Order) */
305
- OrderPropertyKeys["ContractBuyOutRequested"] = "ContractBuyOutRequested";
306
- /** the date the contract will end (Sales - Order) */
307
- OrderPropertyKeys["ContractEndDate"] = "ContractEndDate";
308
- /** the number of times the contract has renewed (Sales - Order) */
309
- OrderPropertyKeys["ContractRenewalCount"] = "ContractRenewalCount";
310
- /** the additional number of times the contract has renewed (Sales - Order) */
311
- OrderPropertyKeys["ContractRenewalCountOverride"] = "ContractRenewalCountOverride";
312
- /** the date the contract start (Sales - Order) */
313
- OrderPropertyKeys["ContractStartDate"] = "ContractStartDate";
314
- /** the type of the contract (Sales - Order) */
315
- OrderPropertyKeys["ContractType"] = "ContractType";
316
- /** Monthly contract value (Sales - Order) */
317
- OrderPropertyKeys["ContractValueMonthly"] = "ContractValueMonthly";
318
- /** Total contract value (Sales - Order) */
319
- OrderPropertyKeys["ContractValueTotal"] = "ContractValueTotal";
320
264
  /** Currency code (Sales - Order) */
321
265
  OrderPropertyKeys["CurrencyCode"] = "CurrencyCode";
322
- /** Reference identifier for Order relationships. Used for data integrity. */
323
- OrderPropertyKeys["DataSetId"] = "DataSetId";
324
- /** The reason for collection attempts stopping (Sales - Order) */
325
- OrderPropertyKeys["DcaClosureReason"] = "DCAClosureReason";
326
- /** The total value sent to collect (Sales - Order) */
327
- OrderPropertyKeys["DcaCollectionValue"] = "DCACollectionValue";
328
- /** The date the DCA loaded the order (Sales - Order) */
329
- OrderPropertyKeys["DcaLoadedDate"] = "DCALoadedDate";
330
- /** The collection value paid to date (Sales - Order) */
331
- OrderPropertyKeys["DcaPaidToDate"] = "DCAPaidToDate";
332
- /** The debt collection agency status (Sales - Order) */
333
- OrderPropertyKeys["DcaStatus"] = "DCAStatus";
334
- /** The date the order should be moved to deactivated (Sales - Order) */
335
- OrderPropertyKeys["DeactivateOnDate"] = "DeactivateOnDate";
336
- /** Description of order deactivation (Sales - Order) */
337
- OrderPropertyKeys["DeactivationDescription"] = "DeactivationDescription";
338
- /** Reason for deactivating the order (Sales - Order) */
339
- OrderPropertyKeys["DeactivationReason"] = "DeactivationReason";
340
266
  /** the date the order is delivered (Sales - Order) */
341
267
  OrderPropertyKeys["DeliveryDate"] = "DeliveryDate";
342
- /** Desired Billing Day (Sales - Order) */
343
- OrderPropertyKeys["DesiredBillingDay"] = "DesiredBillingDay";
344
- /** length for the items discount duration (Sales - Order) */
345
- OrderPropertyKeys["DiscountLength"] = "DiscountLength";
268
+ /** phone number to transfer (Sales - Order) */
269
+ OrderPropertyKeys["TransferPhone"] = "TransferPhone";
346
270
  /** the type of discount (Sales - Order) */
347
271
  OrderPropertyKeys["DiscountType"] = "DiscountType";
348
- /** discount duration unit (Sales - Order) */
349
- OrderPropertyKeys["DiscountUnit"] = "DiscountUnit";
350
- /** the value to discount (Sales - Order) */
351
- OrderPropertyKeys["DiscountValue"] = "DiscountValue";
272
+ /** length for the items discount duration (Sales - Order) */
273
+ OrderPropertyKeys["DiscountLength"] = "DiscountLength";
274
+ /** Reference identifier for Order relationships. Used for data integrity. */
275
+ OrderPropertyKeys["AddressId"] = "AddressId";
276
+ /** Billing terms i.e NET 15,30 (Sales - Order) */
277
+ OrderPropertyKeys["BillingTerms"] = "BillingTerms";
278
+ /** the date the order is issued (Sales - Order) */
279
+ OrderPropertyKeys["IssuedDate"] = "IssuedDate";
352
280
  /** the date the dunning period started (Sales - Order) */
353
281
  OrderPropertyKeys["DunningStartDate"] = "DunningStartDate";
282
+ /** Landing Page (Sales - Order) */
283
+ OrderPropertyKeys["LandingPage"] = "LandingPage";
284
+ /** Total contract value (Sales - Order) */
285
+ OrderPropertyKeys["ContractValueTotal"] = "ContractValueTotal";
286
+ /** Monthly contract value (Sales - Order) */
287
+ OrderPropertyKeys["ContractValueMonthly"] = "ContractValueMonthly";
288
+ /** the additional number of times the contract has renewed (Sales - Order) */
289
+ OrderPropertyKeys["ContractRenewalCountOverride"] = "ContractRenewalCountOverride";
290
+ /** To be handled manually by an operator. Default state = false (Sales - Order) */
291
+ OrderPropertyKeys["IsVerified"] = "IsVerified";
354
292
  /** the highest status of the invoices in dunning (Sales - Order) */
355
293
  OrderPropertyKeys["DunningStatus"] = "DunningStatus";
294
+ /** the date the mandate reminder was sent (Sales - Order) */
295
+ OrderPropertyKeys["MandateReminderSmsSentAt"] = "MandateReminderSmsSentAt";
356
296
  /** when the dunning status was last updated (Sales - Order) */
357
297
  OrderPropertyKeys["DunningStatusUpdatedAt"] = "DunningStatusUpdatedAt";
358
- /** ExternalReference */
359
- OrderPropertyKeys["ExternalReference"] = "ExternalReference";
360
- /** the number of invoices in dunning (Sales - Order) */
361
- OrderPropertyKeys["InvoicesDunning"] = "InvoicesDunning";
362
- /** the date the order is issued (Sales - Order) */
363
- OrderPropertyKeys["IssuedDate"] = "IssuedDate";
364
- /** To be handled manually by an operator. Default state = false (Sales - Order) */
365
- OrderPropertyKeys["IsVerified"] = "IsVerified";
366
- /** Landing Page (Sales - Order) */
367
- OrderPropertyKeys["LandingPage"] = "LandingPage";
298
+ /** the date the mandate status was updated (Sales - Order) */
299
+ OrderPropertyKeys["MandateStatusUpdatedAt"] = "MandateStatusUpdatedAt";
368
300
  /** Data field for Order records. Used by Sales team. */
369
301
  OrderPropertyKeys["Latitude"] = "Latitude";
370
- /** Data field for Order records. Used by Sales team. */
371
- OrderPropertyKeys["Longitude"] = "Longitude";
302
+ /** total discounts (Sales - Order) */
303
+ OrderPropertyKeys["TotalDiscounts"] = "TotalDiscounts";
304
+ /** total price including taxes and discounts (Sales - Order) */
305
+ OrderPropertyKeys["TotalPrice"] = "TotalPrice";
372
306
  /** the date the mandate reminder email was sent (Sales - Order) */
373
307
  OrderPropertyKeys["MandateReminderEmailSentAt"] = "MandateReminderEmailSentAt";
374
- /** the date the mandate reminder was sent (Sales - Order) */
375
- OrderPropertyKeys["MandateReminderSmsSentAt"] = "MandateReminderSmsSentAt";
376
- /** the date the mandate status was updated (Sales - Order) */
377
- OrderPropertyKeys["MandateStatusUpdatedAt"] = "MandateStatusUpdatedAt";
378
- /** Display name/title for Order records. Primary identifier for Sales team. */
379
- OrderPropertyKeys["Name"] = "Name";
380
- /** PendingAmcoCollection */
381
- OrderPropertyKeys["PendingAmcoCollection"] = "PendingAmcoCollection";
382
- /** PendingAmcoDispatch */
383
- OrderPropertyKeys["PendingAmcoDispatch"] = "PendingAmcoDispatch";
384
- /** PendingAmcoReplacement */
385
- OrderPropertyKeys["PendingAmcoReplacement"] = "PendingAmcoReplacement";
386
- /** the previous order prior to an amendment or recontract (Sales - Order) */
387
- OrderPropertyKeys["PreviousOrderId"] = "PreviousOrderId";
308
+ /** Data field for Order records. Used by Sales team. */
309
+ OrderPropertyKeys["Longitude"] = "Longitude";
388
310
  /** the price match requested by the customer (Sales - Order) */
389
311
  OrderPropertyKeys["PriceMatchRequested"] = "PriceMatchRequested";
390
- /** network provider (Sales - Order) */
391
- OrderPropertyKeys["Provider"] = "Provider";
392
312
  /** ReferralApprovalDate (Sales - Order) */
393
313
  OrderPropertyKeys["ReferralApprovalDate"] = "ReferralApprovalDate";
394
- /** referral email (Sales - Order) */
395
- OrderPropertyKeys["ReferralEmail"] = "ReferralEmail";
396
- /** the delivery date requested by the customer (Sales - Order) */
397
- OrderPropertyKeys["RequestedDeliveryDate"] = "RequestedDeliveryDate";
398
- /** Data field for Order records. Used by Sales team. */
399
- OrderPropertyKeys["Source"] = "Source";
314
+ /** network provider (Sales - Order) */
315
+ OrderPropertyKeys["Provider"] = "Provider";
400
316
  /** the subscriber id is used as the identifier when provisioning on the network (Sales - Order) */
401
317
  OrderPropertyKeys["SubscriberId"] = "SubscriberId";
402
- /** subtotal of the prices no taxes (Sales - Order) */
403
- OrderPropertyKeys["Subtotal"] = "Subtotal";
404
- /** unit cost for the product derived from product components UnitCost (Sales - Order) */
405
- OrderPropertyKeys["TaxRate"] = "TaxRate";
406
- /** total discounts (Sales - Order) */
407
- OrderPropertyKeys["TotalDiscounts"] = "TotalDiscounts";
408
- /** total price including taxes and discounts (Sales - Order) */
409
- OrderPropertyKeys["TotalPrice"] = "TotalPrice";
410
318
  /** total taxes (Sales - Order) */
411
319
  OrderPropertyKeys["TotalTaxAmount"] = "TotalTaxAmount";
412
- /** phone number to transfer (Sales - Order) */
413
- OrderPropertyKeys["TransferPhone"] = "TransferPhone";
320
+ /** unit cost for the product derived from product components UnitCost (Sales - Order) */
321
+ OrderPropertyKeys["TaxRate"] = "TaxRate";
322
+ /** subtotal of the prices no taxes (Sales - Order) */
323
+ OrderPropertyKeys["Subtotal"] = "Subtotal";
324
+ /** Display name/title for Order records. Primary identifier for Sales team. */
325
+ OrderPropertyKeys["Name"] = "Name";
326
+ /** Data field for Order records. Used by Sales team. */
327
+ OrderPropertyKeys["Source"] = "Source";
328
+ /** referral email (Sales - Order) */
329
+ OrderPropertyKeys["ReferralEmail"] = "ReferralEmail";
414
330
  /** trial length is the number of X free periods (Sales - Order) */
415
331
  OrderPropertyKeys["TrialLength"] = "TrialLength";
416
- /** trial unit is the unit of measure for free periods (Sales - Order) */
417
- OrderPropertyKeys["TrialUnit"] = "TrialUnit";
332
+ /** Withhold Commission Reason */
333
+ OrderPropertyKeys["WithholdCommissionReason"] = "WithholdCommissionReason";
334
+ /** Withhold Commission Notes */
335
+ OrderPropertyKeys["WithholdCommissionNotes"] = "WithholdCommissionNotes";
336
+ /** Billing start date (Sales - Order) */
337
+ OrderPropertyKeys["BillingStartDate"] = "BillingStartDate";
338
+ /** Reason for deactivating the order (Sales - Order) */
339
+ OrderPropertyKeys["DeactivationReason"] = "DeactivationReason";
340
+ /** cancellation reason notes (Sales - Order) */
341
+ OrderPropertyKeys["CancellationReasonNote"] = "CancellationReasonNote";
342
+ /** alerts that need to be visible on the order (Sales - Order) */
343
+ OrderPropertyKeys["AlertMessage"] = "AlertMessage";
344
+ /** the date of the alert message (Sales - Order) */
345
+ OrderPropertyKeys["AlertMessageDate"] = "AlertMessageDate";
346
+ /** the date the contract will end (Sales - Order) */
347
+ OrderPropertyKeys["ContractEndDate"] = "ContractEndDate";
348
+ /** 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) */
349
+ OrderPropertyKeys["CancellationEffectiveDate"] = "CancellationEffectiveDate";
350
+ /** Reference identifier for Order relationships. Used for data integrity. */
351
+ OrderPropertyKeys["DataSetId"] = "DataSetId";
352
+ /** Billing day in the month (Sales - Order) */
353
+ OrderPropertyKeys["BillingDay"] = "BillingDay";
354
+ /** The date the order was rejected in aklamio (Sales - Order) */
355
+ OrderPropertyKeys["AklamioRejectionDate"] = "AklamioRejectionDate";
356
+ /** Cancellation reason (Sales - Order) */
357
+ OrderPropertyKeys["CancellationReason"] = "CancellationReason";
358
+ /** active date (Sales - Order) */
359
+ OrderPropertyKeys["ActiveDate"] = "ActiveDate";
360
+ /** This order comes because of an Aklamio Reference (Sales - Order) */
361
+ OrderPropertyKeys["AklamioReferenced"] = "AklamioReferenced";
362
+ /** true if the customer has an active mandate (Sales - Order) */
363
+ OrderPropertyKeys["ActiveMandate"] = "ActiveMandate";
364
+ /** the average monthly contract value (Sales - Order) */
365
+ OrderPropertyKeys["AverageMonthlyValue"] = "AverageMonthlyValue";
366
+ /** the date the order was cancelled (Sales - Order) */
367
+ OrderPropertyKeys["CancelledDate"] = "CancelledDate";
368
+ /** The debt collection agency status (Sales - Order) */
369
+ OrderPropertyKeys["DcaStatus"] = "DCAStatus";
370
+ /** The total value sent to collect (Sales - Order) */
371
+ OrderPropertyKeys["DcaCollectionValue"] = "DCACollectionValue";
372
+ /** The date the DCA loaded the order (Sales - Order) */
373
+ OrderPropertyKeys["DcaLoadedDate"] = "DCALoadedDate";
374
+ /** Desired Billing Day (Sales - Order) */
375
+ OrderPropertyKeys["DesiredBillingDay"] = "DesiredBillingDay";
376
+ /** Description of order deactivation (Sales - Order) */
377
+ OrderPropertyKeys["DeactivationDescription"] = "DeactivationDescription";
378
+ /** the contract buy out amount requested by the customer (Sales - Order) */
379
+ OrderPropertyKeys["ContractBuyOutRequested"] = "ContractBuyOutRequested";
418
380
  /** unique delivery point reference number (Sales - Order) */
419
381
  OrderPropertyKeys["Udprn"] = "UDPRN";
382
+ /** The reason for collection attempts stopping (Sales - Order) */
383
+ OrderPropertyKeys["DcaClosureReason"] = "DCAClosureReason";
420
384
  /** unique multiple point reference number (Sales - Order) */
421
385
  OrderPropertyKeys["Umprn"] = "UMPRN";
386
+ /** Aklamio cashback was rejected (Sales - Order) */
387
+ OrderPropertyKeys["AklamioCashbackRejectionDate"] = "AklamioCashbackRejectionDate";
388
+ /** Aklamio cashback was applied (Sales - Order) */
389
+ OrderPropertyKeys["AklamioCashbackVerificationDate"] = "AklamioCashbackVerificationDate";
390
+ /** When the Cashback was approved (Sales - Order) */
391
+ OrderPropertyKeys["CashbackApprovalDate"] = "CashbackApprovalDate";
392
+ /** The date the order should be moved to deactivated (Sales - Order) */
393
+ OrderPropertyKeys["DeactivateOnDate"] = "DeactivateOnDate";
394
+ /** The date the order should be moved to cancelled (Sales - Order) */
395
+ OrderPropertyKeys["CancelOnDate"] = "CancelOnDate";
422
396
  /** Data field for Order records. Used by Sales team. */
423
397
  OrderPropertyKeys["Uprn"] = "Uprn";
424
- /** Data field for Order records. Used by Sales team. */
425
- OrderPropertyKeys["VatNumber"] = "VATNumber";
398
+ /** the value to discount (Sales - Order) */
399
+ OrderPropertyKeys["DiscountValue"] = "DiscountValue";
400
+ /** the number of times the contract has renewed (Sales - Order) */
401
+ OrderPropertyKeys["ContractRenewalCount"] = "ContractRenewalCount";
402
+ /** the number of invoices in dunning (Sales - Order) */
403
+ OrderPropertyKeys["InvoicesDunning"] = "InvoicesDunning";
404
+ /** status of the order (must be activated for billing) (Sales - Order) */
405
+ OrderPropertyKeys["ActivationStatus"] = "ActivationStatus";
406
+ /** the delivery date requested by the customer (Sales - Order) */
407
+ OrderPropertyKeys["RequestedDeliveryDate"] = "RequestedDeliveryDate";
408
+ /** the type of the contract (Sales - Order) */
409
+ OrderPropertyKeys["ContractType"] = "ContractType";
410
+ /** trial unit is the unit of measure for free periods (Sales - Order) */
411
+ OrderPropertyKeys["TrialUnit"] = "TrialUnit";
412
+ /** discount duration unit (Sales - Order) */
413
+ OrderPropertyKeys["DiscountUnit"] = "DiscountUnit";
414
+ /** the previous order prior to an amendment or recontract (Sales - Order) */
415
+ OrderPropertyKeys["PreviousOrderId"] = "PreviousOrderId";
416
+ /** The collection value paid to date (Sales - Order) */
417
+ OrderPropertyKeys["DcaPaidToDate"] = "DCAPaidToDate";
418
+ /** Aklamio Verification Date (Sales - Order) */
419
+ OrderPropertyKeys["AklamioVerificationDate"] = "AklamioVerificationDate";
420
+ /** the date the contract start (Sales - Order) */
421
+ OrderPropertyKeys["ContractStartDate"] = "ContractStartDate";
426
422
  /** check this box if you want to flag a commission hold on this order (Sales - Order) */
427
423
  OrderPropertyKeys["WithholdCommission"] = "WithholdCommission";
428
- /** Withhold Commission Notes */
429
- OrderPropertyKeys["WithholdCommissionNotes"] = "WithholdCommissionNotes";
430
- /** Withhold Commission Reason */
431
- OrderPropertyKeys["WithholdCommissionReason"] = "WithholdCommissionReason";
424
+ /** PendingAmcoReplacement */
425
+ OrderPropertyKeys["PendingAmcoReplacement"] = "PendingAmcoReplacement";
426
+ /** PendingAmcoDispatch */
427
+ OrderPropertyKeys["PendingAmcoDispatch"] = "PendingAmcoDispatch";
428
+ /** PendingAmcoCollection */
429
+ OrderPropertyKeys["PendingAmcoCollection"] = "PendingAmcoCollection";
430
+ /** Affiliate code used when order was placed */
431
+ OrderPropertyKeys["AffiliateCode"] = "AffiliateCode";
432
432
  })(OrderPropertyKeys = exports.OrderPropertyKeys || (exports.OrderPropertyKeys = {}));
433
433
  /**
434
434
  * Order entity from OrderModule