@d19n/youfibre-odin-sdk 1.0.261-beta.0 → 1.0.262

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.
@@ -15,7 +15,7 @@ import { OdinRecord, OdinRecordCreateDto, OdinRecordUpdateDto, OdinRecordUpdated
15
15
  /**
16
16
  * Properties for Remediation Outcome Form action
17
17
  *
18
- * @property Required fields: 13
18
+ * @property Required fields: 26
19
19
  * @property Optional fields: 0
20
20
  */
21
21
  export interface RemediationOutcomeFormProperties {
@@ -88,6 +88,15 @@ export interface RemediationOutcomeFormProperties {
88
88
  * @visibleWhen DeadCBT = ["YES"]
89
89
  */
90
90
  IssueCause: string;
91
+ /**
92
+ * LightReadingAfterWorkImage
93
+ *
94
+ * upload files
95
+ * @type {FILE_MULTIPLE}
96
+ * @required
97
+ * @visibleWhen DeadCBT = ["YES"]
98
+ */
99
+ LightReadingAfterWorkImage: undefined;
91
100
  /**
92
101
  * ClosureAfterWorkImage
93
102
  *
@@ -115,6 +124,114 @@ export interface RemediationOutcomeFormProperties {
115
124
  * @visibleWhen DeadCBT = ["YES"]
116
125
  */
117
126
  ActionsTaken: string;
127
+ /**
128
+ * AmendmendsToSplicingRecords
129
+ *
130
+ * Select
131
+ * @type {ENUM}
132
+ * @required
133
+ * @visibleWhen DeadCBT = ["YES"]
134
+ */
135
+ AmendmendsToSplicingRecords: string;
136
+ /**
137
+ * ClosureId
138
+ *
139
+ * Write here
140
+ * @type {TEXT}
141
+ * @required
142
+ * @visibleWhen AmendmendsToSplicingRecords = ["YES"]
143
+ */
144
+ ClosureId: string;
145
+ /**
146
+ * IncomingCableId
147
+ *
148
+ * Write here
149
+ * @type {TEXT}
150
+ * @required
151
+ * @visibleWhen AmendmendsToSplicingRecords = ["YES"]
152
+ */
153
+ IncomingCableId: string;
154
+ /**
155
+ * IncomingTubeNumber
156
+ *
157
+ * Write here
158
+ * @type {TEXT}
159
+ * @required
160
+ * @visibleWhen AmendmendsToSplicingRecords = ["YES"]
161
+ */
162
+ IncomingTubeNumber: string;
163
+ /**
164
+ * OutgoingCableId
165
+ *
166
+ * Write here
167
+ * @type {TEXT}
168
+ * @required
169
+ * @visibleWhen AmendmendsToSplicingRecords = ["YES"]
170
+ */
171
+ OutgoingCableId: string;
172
+ /**
173
+ * OutgoingFibreNumber
174
+ *
175
+ * Write here
176
+ * @type {TEXT}
177
+ * @required
178
+ * @visibleWhen AmendmendsToSplicingRecords = ["YES"]
179
+ */
180
+ OutgoingFibreNumber: string;
181
+ /**
182
+ * AmendmentsToOtherClosureFibreRecords
183
+ *
184
+ * Write here
185
+ * @type {ENUM}
186
+ * @required
187
+ * @visibleWhen AmendmendsToSplicingRecords = ["YES"]
188
+ */
189
+ AmendmentsToOtherClosureFibreRecords: string;
190
+ /**
191
+ * OcfrClosureId
192
+ *
193
+ * Write here
194
+ * @type {TEXT}
195
+ * @required
196
+ * @visibleWhen AmendmentsToOtherClosureFibreRecords = ["YES"]
197
+ */
198
+ OcfrClosureId: string;
199
+ /**
200
+ * OcfrIncomingCableId
201
+ *
202
+ * Write here
203
+ * @type {TEXT}
204
+ * @required
205
+ * @visibleWhen AmendmentsToOtherClosureFibreRecords = ["YES"]
206
+ */
207
+ OcfrIncomingCableId: string;
208
+ /**
209
+ * OcfrIncomingTubeNumberUsed
210
+ *
211
+ * Write here
212
+ * @type {TEXT}
213
+ * @required
214
+ * @visibleWhen AmendmentsToOtherClosureFibreRecords = ["YES"]
215
+ */
216
+ OcfrIncomingTubeNumberUsed: string;
217
+ /**
218
+ * OcfrOutgoingCableId
219
+ *
220
+ * Write here
221
+ * @type {TEXT}
222
+ * @required
223
+ * @visibleWhen AmendmentsToOtherClosureFibreRecords = ["YES"]
224
+ */
225
+ OcfrOutgoingCableId: string;
226
+ /**
227
+ * OcfrOutgoingTubeNumberUsed
228
+ *
229
+ * Write here
230
+ * @type {TEXT}
231
+ * @required
232
+ * @visibleWhen AmendmentsToOtherClosureFibreRecords = ["YES"]
233
+ */
234
+ OcfrOutgoingTubeNumberUsed: string;
118
235
  /**
119
236
  * EvidenceUploaded
120
237
  *
@@ -273,6 +273,15 @@ export interface YfFieldServiceVisitAuditProperties {
273
273
  * @visibleWhen WorkEnvironmentSafe = ["NO"]
274
274
  */
275
275
  WorkEnvironmentUnsafe: string;
276
+ /**
277
+ * Please capture images
278
+ *
279
+ * Data field for YfFieldServiceVisit records. Used by Field Operations team.
280
+ * @type {FILE_MULTIPLE}
281
+ * @required
282
+ * @visibleWhen WorkEnvironmentSafe = ["NO"]
283
+ */
284
+ WorkEnvironmentUnsafePhoto: undefined;
276
285
  /**
277
286
  * Will the customer benefit from YouMesh?
278
287
  *
@@ -345,6 +354,24 @@ export interface YfFieldServiceVisitAuditProperties {
345
354
  * @visibleWhen EngineerDiagnosis = ["INSTALL_MESH"]
346
355
  */
347
356
  YouMeshInstalledFirstTime: string;
357
+ /**
358
+ * Please include a screenshot of the Network Topology from Eero insights before you add Mesh.
359
+ *
360
+ * Data field for YfFieldServiceVisit records. Used by Field Operations team.
361
+ * @type {FILE_MULTIPLE}
362
+ * @required
363
+ * @visibleWhen YouMeshInstalledFirstTime = ["NO"]
364
+ */
365
+ NetworkTopologyPhoto: undefined;
366
+ /**
367
+ * Go to the problem area & perfrom a Wi-Fi speedtest using EX1 before adding Mesh - this is to show a clear improvement once it is installed.
368
+ *
369
+ * Data field for YfFieldServiceVisit records. Used by Field Operations team.
370
+ * @type {FILE_MULTIPLE}
371
+ * @required
372
+ * @visibleWhen EngineerDiagnosis = ["INSTALL_MESH"]
373
+ */
374
+ WiFiSpeedTest: undefined;
348
375
  /**
349
376
  * Remember that if a customer wants to have ANYTIME calls as opposed to evening & weekends, it’s only £5 more for this. YouPhone (evening after 19:00 & weekends) £3PM YouPhone Plus (Anytime) £8PM *applies to landline calls only - calls automatically disconnect at the hour duration to avoid charges* Confirm
350
377
  *
@@ -363,6 +390,51 @@ export interface YfFieldServiceVisitAuditProperties {
363
390
  * @visibleWhen EngineerDiagnosis = ["HARDWIRE_DEVICES"]
364
391
  */
365
392
  HardWireDevices: string;
393
+ /**
394
+ * Go to the worst-performing location and perform one Wi-Fi speed test using approved test equipment. Save and attach a screenshot or test report once complete.
395
+ *
396
+ * Data field for YfFieldServiceVisit records. Used by Field Operations team.
397
+ * @type {FILE_MULTIPLE}
398
+ * @required
399
+ * @visibleWhen EngineerDiagnosis = ["SLOW_SPEEDS"]
400
+ */
401
+ WiFiSpeedTestWorstLocation: undefined;
402
+ /**
403
+ * Hardwire EX1 to router and complete speedtest Screen Shot of EX1 Report by tapping the clipboard icon awaiting the report to generate then attach to form.
404
+ *
405
+ * Data field for YfFieldServiceVisit records. Used by Field Operations team.
406
+ * @type {FILE_MULTIPLE}
407
+ * @required
408
+ * @visibleWhen EngineerDiagnosis = ["CONNECTION_DROP_OUTS"]
409
+ */
410
+ Ex1Report1: undefined;
411
+ /**
412
+ * If a particular area is impacted, go to this location and perform 1 Wi-Fi Speedtest using the EX1 Screen Shot of EX1 Report by tapping the clipboard icon awating the report ro generate then attach to form. If a particular area is impacted, go to this location and perform 1 Wi-Fi Speedtest using the EX1 Screen Shot of EX1 Report by tapping the clipboard icon awating the report ro generate then attach to form. Turn on screen reader support. To enable screen reader support, press Ctrl+Alt+Z To learn about keyboard shortcuts, press Ctrl+slash Frank Truglio has left the document.
413
+ *
414
+ * Data field for YfFieldServiceVisit records. Used by Field Operations team.
415
+ * @type {FILE_MULTIPLE}
416
+ * @required
417
+ * @visibleWhen EngineerDiagnosis = ["CONNECTION_DROP_OUTS"]
418
+ */
419
+ Ex1Report2: undefined;
420
+ /**
421
+ * Go to the problem location and perform 1 Wi-Fi Speedtest using the EX1 - include screen shot of Eero insights network topology. Attach PDF results
422
+ *
423
+ * Data field for YfFieldServiceVisit records. Used by Field Operations team.
424
+ * @type {FILE_MULTIPLE}
425
+ * @required
426
+ * @visibleWhen EngineerDiagnosis = ["WIFI_COVERAGE_ISSUE"]
427
+ */
428
+ WiFiCoverageReport: undefined;
429
+ /**
430
+ * Outcome form Schemas Outcome form Schemas 100% 10 B36 Go to the problem location and perform 1 Wi-Fi Speedtest using the EX1 Screen Shot of EX1 Report by tapping the "clipboard icon" awating the report ro generate then attach to form. Go to the problem location and perform 1 Wi-Fi Speedtest using the EX1 Screen Shot of EX1 Report by tapping the "clipboard icon" awating the report ro generate then attach to form. Turn on screen reader support To enable screen reader support, press Ctrl+Alt+Z To learn about keyboard shortcuts, press Ctrl+slash Frank Truglio has left the document.
431
+ *
432
+ * Data field for YfFieldServiceVisit records. Used by Field Operations team.
433
+ * @type {FILE_MULTIPLE}
434
+ * @required
435
+ * @visibleWhen EngineerDiagnosis = ["WIFI_INTERFERENCE_ISSUE"]
436
+ */
437
+ WiFiInterferenceReport: undefined;
366
438
  /**
367
439
  * What is the device having the issue?
368
440
  *
@@ -472,7 +544,7 @@ export interface YfFieldServiceVisitAuditProperties {
472
544
  */
473
545
  MainRouterSerial: string;
474
546
  /**
475
- * Does the Customer have YouMesh?
547
+ * Does the customer have a Mesh Node installed?
476
548
  *
477
549
  * Data field for YfFieldServiceVisit records. Used by Field Operations team.
478
550
  * @type {ENUM}
@@ -589,7 +661,7 @@ export interface YfFieldServiceVisitAuditProperties {
589
661
  */
590
662
  NotAbleToAchieveSignalNote: string;
591
663
  /**
592
- * ** FYI ** WI-Fi analysis of the property Should be at the furthest location from GATEWAY & include screenshot from Eero insight Network Toplogy map Use EX1 to check channel bands, once tested, screenshot the results. Note for YouMesh Customers: RF environmental factors notwithstanding, you must ensure a minimum wireless signal strength of -67 db and a minimum internet speed of 20mbps throughout the property. If you are not able to do so, you must propose an improvement plan agreed upon with your Supervisor / Manager eg additional mesh nodes / power line adaptors etc. I confirm I have read these instructions.
664
+ * Wi-Fi analysis of the property should be at the furthest location from he router or gateway using approved diagnostic tools. Include a screenshot or report showing signal strength and network topology. A minimum signal strength of -65 dB and a minimum speed of 20 Mbps should be achieved throughout the property. If these standards cannot be met, propose an improvement plan agreed with a Supervisor (e.g. additional mesh nodes or powerline adaptors). I confirm I have read these instructions.
593
665
  *
594
666
  * Data field for YfFieldServiceVisit records. Used by Field Operations team.
595
667
  * @type {BOOLEAN}
@@ -598,7 +670,16 @@ export interface YfFieldServiceVisitAuditProperties {
598
670
  */
599
671
  WiFiAnalysisConsent: boolean;
600
672
  /**
601
- * Resolution notes: (summarise what you done to resolve the issue, this doesn’t have to lengthy but it should contain enough information to understand what you did and why you did it).
673
+ * Perform Wi-Fi speed test in the furthest or problem-affected room using approved test equipment. Attach screenshot or test report once generated.
674
+ *
675
+ * Data field for YfFieldServiceVisit records. Used by Field Operations team.
676
+ * @type {FILE_MULTIPLE}
677
+ * @required
678
+ * @visibleWhen FaultResolvedEngineer = ["YES"]
679
+ */
680
+ Ex1SpeedtestReport: undefined;
681
+ /**
682
+ * (Summarise the actions taken to resolve the issue, providing sufficient detail to understand the steps and reasoning.)
602
683
  *
603
684
  * Free-text notes field for YfFieldServiceVisit. Used by Field Operations team for documentation.
604
685
  * @type {TEXT_LONG}
@@ -779,7 +860,7 @@ export interface YfFieldServiceVisitAuditProperties {
779
860
  */
780
861
  AdditionalNotes2: string;
781
862
  /**
782
- * I/We acknowledge that the work has been completed in a professional and courteous manner I/We confirm that the site has been left in a clean and tidy condition I/We am aware of the WiFi coverage around the property, and, if required, know what improvements are required I/We confirm that the fault/complaint/upgrade has been attended to and fully resolved I/We confirm that the Gateway/Router/Mesh nodes are in my possession on a lease basis and remain the property of YouFibre Ltd I am happy with my setup and all queries have been covered.
863
+ * I/We acknowledge that the work has been completed in a professional and courteous manner I/We confirm that the site has been left in a clean and tidy condition I/We am aware of the WiFi coverage around the property, and, if required, know what improvements are required I/We confirm that the fault/complaint/upgrade has been attended to and fully resolved. I/We confirm that the Gateway/Router/Mesh Nodes are provided on a lease basis and remain the property of the service provider. I am happy with my setup and all queries have been covered.
783
864
  *
784
865
  * Data field for YfFieldServiceVisit records. Used by Field Operations team.
785
866
  * @type {BOOLEAN}
@@ -810,6 +891,7 @@ export interface YfFieldServiceVisitAuditProperties {
810
891
  *
811
892
  * Service visit Date and Time: (Field Operations - YfFieldServiceVisit)
812
893
  * @type {DATE_TIME}
894
+ * @default Dynamic: {date_today}
813
895
  * @format DD/MM/YYYY hh:mm:ss
814
896
  */
815
897
  ServiceVisitDateTime?: string;
@@ -818,6 +900,7 @@ export interface YfFieldServiceVisitAuditProperties {
818
900
  *
819
901
  * Service engineer names (Field Operations - YfFieldServiceVisit)
820
902
  * @type {NAME}
903
+ * @default Dynamic: {source_record_properties_EngineerName}
821
904
  */
822
905
  EngineerNames?: string;
823
906
  /**
@@ -825,6 +908,7 @@ export interface YfFieldServiceVisitAuditProperties {
825
908
  *
826
909
  * e.g. (WO12345) (Field Operations - YfFieldServiceVisit)
827
910
  * @type {ALPHA_NUMERICAL}
911
+ * @default Dynamic: {source_record_recordNumber}
828
912
  */
829
913
  WorkOrderNumber?: string;
830
914
  /**
@@ -905,7 +989,7 @@ export interface YfFieldServiceVisitAuditProperties {
905
989
  */
906
990
  RiskAssessmentConsent?: boolean;
907
991
  /**
908
- * Start your PRE fault investigation (BEFORE CHANGING ANYTHING) SPEEDTESTS are Required to be completed using EX1. This is not optional, unless approved by Field Manager. ALL SPEEDTESTS need to be screenshots or clear pictures rather then PDFs. I confirm I have read these instructions.
992
+ * Start your PRE fault investigation (BEFORE CHANGING ANYTHING). Speed tests must be completed using approved test equipment. This is mandatory unless authorised by a Supervisor. All results must be attached as screenshots or clear images (not PDFs). I confirm I have read these instructions.
909
993
  *
910
994
  * Reference identifier for YfFieldServiceVisit relationships. Used for data integrity.
911
995
  * @type {BOOLEAN}
@@ -919,14 +1003,14 @@ export interface YfFieldServiceVisitAuditProperties {
919
1003
  */
920
1004
  EngineerDiagnosis?: string;
921
1005
  /**
922
- * Start your POST fault investigation (AFTER MAKING CHANGES) This section should be populated only after the changes are made. I confirm I have read these instructions.
1006
+ * Start your POST fault investigation (AFTER MAKING CHANGES). Complete this section only after changes have been implemented. I confirm I have read these instructions.
923
1007
  *
924
1008
  * Data field for YfFieldServiceVisit records. Used by Field Operations team.
925
1009
  * @type {BOOLEAN}
926
1010
  */
927
1011
  PostFaultInvestigationConsent?: boolean;
928
1012
  /**
929
- * Can this fault be resolved by YF Engineer? If its just an Install / Upgrade / Replacment please select "Install Setup Replacement" For all other resolvable issues by YouFibre, then select ""Yes"" and continue with the form.
1013
+ * Can this fault be resolved by the attending engineer? If it is an installation, upgrade, or replacement, select “Install/Setup/Replacement.” For all other resolvable issues, select “Yes” and continue with the form.
930
1014
  *
931
1015
  * Data field for YfFieldServiceVisit records. Used by Field Operations team.
932
1016
  * @type {ENUM}
@@ -16,7 +16,7 @@ import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/o
16
16
  * Properties for DefaultServiceWorkOrderEditForm action
17
17
  *
18
18
  * @property Required fields: 0
19
- * @property Optional fields: 5
19
+ * @property Optional fields: 6
20
20
  */
21
21
  export interface DefaultServiceWorkOrderEditFormProperties {
22
22
  /**
@@ -54,6 +54,13 @@ export interface DefaultServiceWorkOrderEditFormProperties {
54
54
  * @type {ENUM}
55
55
  */
56
56
  OutcomeOfServiceVisit?: string;
57
+ /**
58
+ * Contractor
59
+ *
60
+ * Data field for WorkOrder records. Used by Field Operations team.
61
+ * @type {TEXT}
62
+ */
63
+ Contractor?: string;
57
64
  }
58
65
  /**
59
66
  * DefaultServiceWorkOrderEditForm
@@ -15,7 +15,7 @@ import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/o
15
15
  * Properties for UpdateTeam action
16
16
  *
17
17
  * @property Required fields: 0
18
- * @property Optional fields: 6
18
+ * @property Optional fields: 7
19
19
  */
20
20
  export interface UpdateTeamProperties {
21
21
  /**
@@ -60,6 +60,13 @@ export interface UpdateTeamProperties {
60
60
  * @type {ENUM}
61
61
  */
62
62
  SecondaryChannel?: string;
63
+ /**
64
+ * TwilioSupport
65
+ *
66
+ * TwilioSupport (IT Security - Team)
67
+ * @type {BOOLEAN}
68
+ */
69
+ TwilioSupport?: boolean;
63
70
  }
64
71
  /**
65
72
  * UpdateTeam
@@ -15,7 +15,7 @@ import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/o
15
15
  * Properties for UpdateUser action
16
16
  *
17
17
  * @property Required fields: 0
18
- * @property Optional fields: 10
18
+ * @property Optional fields: 11
19
19
  */
20
20
  export interface UpdateUserProperties {
21
21
  /**
@@ -88,6 +88,13 @@ export interface UpdateUserProperties {
88
88
  * @type {TEXT}
89
89
  */
90
90
  TwilioWorkerStatus?: string;
91
+ /**
92
+ * TwilioWorker
93
+ *
94
+ * TwilioWorker (IT Security - User)
95
+ * @type {BOOLEAN}
96
+ */
97
+ TwilioWorker?: boolean;
91
98
  }
92
99
  /**
93
100
  * UpdateUser
@@ -124,13 +124,13 @@ export declare enum OrderProvider {
124
124
  *
125
125
  * @remarks Available options:
126
126
  * - `ETF_VALUE` - ETF over £300
127
- * - `NO_WELCOME` - No welcome pack
127
+ * - `NO_WELCOME_PACK` - No welcome pack
128
128
  * - `OTHER` - Other
129
129
  * - `PRICE_MATCH_EVIDENCE` - Price Match evidence insufficient or missing
130
130
  */
131
131
  export declare enum OrderWithholdCommissionReason {
132
132
  ETF_OVER_300 = "ETF_VALUE",
133
- NO_WELCOME_PACK = "NO_WELCOME",
133
+ NO_WELCOME_PACK = "NO_WELCOME_PACK",
134
134
  OTHER = "OTHER",
135
135
  PRICE_MATCH_EVIDENCE_INSUFFICIENT_OR_MISSING = "PRICE_MATCH_EVIDENCE"
136
136
  }
@@ -145,6 +145,43 @@ export declare enum OrderWithholdCommissionReason {
145
145
  export declare enum OrderDeactivationReason {
146
146
  PAYMENT_OVERDUE = "PAYMENT_OVERDUE"
147
147
  }
148
+ /**
149
+ * Valid values for Order.CancellationReason
150
+ *
151
+ * Cancelation reason (Sales - Order)
152
+ *
153
+ * @remarks Available options:
154
+ * - `CUSTOMER_NOT_AGREED_INSTALL_ROUTE` - Customer Not Agreed Install Route
155
+ * - `CUSTOMER_SERVICE` - Customer Service
156
+ * - `DECEASED` - Deceased
157
+ * - `INSTALLATION_DELAY_NETOMNIA` - Installation Delay (Netomnia)
158
+ * - `PERSONAL_REASONS` - Personal reasons
159
+ * - `REQUEST_TO_DELAY` - Request to Delay
160
+ * - `SALES_DUPLICATE_ORDER` - Sales (Duplicate Order)
161
+ * - `SALES_INSTALL_NOT_BOOKED` - Sales (Install Not Booked)
162
+ * - `SALES_LOST_TO_COMPETITION` - Sales (Lost to Competition)
163
+ * - `SALES_MISSELLING` - Sales (Misselling)
164
+ * - `SALES_MOVE_OUT` - Sales (Move-Out)
165
+ * - `SALES_OFFER_LAPSED_RESOLD` - Sales (Offer Lapsed & Re-sold)
166
+ * - `SALES_UNREACHABLE` - Sales (Unreachable)
167
+ * - `UNINSTALLABLE_PROPERTY_NETOMNIA` - Uninstallable Property (Netomnia)
168
+ */
169
+ export declare enum OrderCancellationReason {
170
+ CUSTOMER_NOT_AGREED_INSTALL_ROUTE = "CUSTOMER_NOT_AGREED_INSTALL_ROUTE",
171
+ CUSTOMER_SERVICE = "CUSTOMER_SERVICE",
172
+ DECEASED = "DECEASED",
173
+ INSTALLATION_DELAY_NETOMNIA = "INSTALLATION_DELAY_NETOMNIA",
174
+ PERSONAL_REASONS = "PERSONAL_REASONS",
175
+ REQUEST_TO_DELAY = "REQUEST_TO_DELAY",
176
+ SALES_DUPLICATE_ORDER = "SALES_DUPLICATE_ORDER",
177
+ SALES_INSTALL_NOT_BOOKED = "SALES_INSTALL_NOT_BOOKED",
178
+ SALES_LOST_TO_COMPETITION = "SALES_LOST_TO_COMPETITION",
179
+ SALES_MISSELLING = "SALES_MISSELLING",
180
+ SALES_MOVE_OUT = "SALES_MOVE_OUT",
181
+ SALES_OFFER_LAPSED_RE_SOLD = "SALES_OFFER_LAPSED_RESOLD",
182
+ SALES_UNREACHABLE = "SALES_UNREACHABLE",
183
+ UNINSTALLABLE_PROPERTY_NETOMNIA = "UNINSTALLABLE_PROPERTY_NETOMNIA"
184
+ }
148
185
  /**
149
186
  * Valid values for Order.ActivationStatus
150
187
  *
@@ -305,8 +342,6 @@ export declare enum OrderPropertyKeys {
305
342
  DeactivationReason = "DeactivationReason",
306
343
  /** cancellation reason notes (Sales - Order) */
307
344
  CancellationReasonNote = "CancellationReasonNote",
308
- /** Cancelation reason (Sales - Order) */
309
- CancellationReason = "CancellationReason",
310
345
  /** alerts that need to be visible on the order (Sales - Order) */
311
346
  AlertMessage = "AlertMessage",
312
347
  /** the date of the alert message (Sales - Order) */
@@ -321,6 +356,8 @@ export declare enum OrderPropertyKeys {
321
356
  BillingDay = "BillingDay",
322
357
  /** The date the order was rejected in aklamio (Sales - Order) */
323
358
  AklamioRejectionDate = "AklamioRejectionDate",
359
+ /** Cancelation reason (Sales - Order) */
360
+ CancellationReason = "CancellationReason",
324
361
  /** active date (Sales - Order) */
325
362
  ActiveDate = "ActiveDate",
326
363
  /** This order comes because of an Aklamio Reference (Sales - Order) */
@@ -662,12 +699,6 @@ export interface OrderProperties {
662
699
  * @hidden This field is hidden in the UI
663
700
  */
664
701
  CancellationReasonNote?: string;
665
- /** Cancelation reason (Sales - Order)
666
- *
667
- * @type {TEXT}
668
- * @hidden This field is hidden in the UI
669
- */
670
- CancellationReason?: string;
671
702
  /** alerts that need to be visible on the order (Sales - Order)
672
703
  *
673
704
  * @type {TEXT_LONG}
@@ -711,6 +742,13 @@ export interface OrderProperties {
711
742
  * @type {DATE}
712
743
  */
713
744
  AklamioRejectionDate?: string;
745
+ /** Cancelation reason (Sales - Order)
746
+ *
747
+ * @type {ENUM}
748
+ * @enum {OrderCancellationReason}
749
+ * @hidden This field is hidden in the UI
750
+ */
751
+ CancellationReason?: OrderCancellationReason;
714
752
  /** active date (Sales - Order)
715
753
  *
716
754
  * @type {DATE}
@@ -12,8 +12,8 @@
12
12
  * Generated from Odin schema definition
13
13
  */
14
14
  Object.defineProperty(exports, "__esModule", { value: true });
15
- 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 = 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_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_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.OrderEntityTypes = void 0;
16
- 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 = void 0;
15
+ 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 = 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_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_DELETED = exports.ROUTING_KEY_ORDER_UPDATED = exports.ROUTING_KEY_ORDER_CREATED = exports.Order = exports.OrderPropertyKeys = exports.OrderDiscountUnit = exports.OrderTrialUnit = exports.OrderContractType = exports.OrderActivationStatus = exports.OrderCancellationReason = exports.OrderDeactivationReason = exports.OrderWithholdCommissionReason = exports.OrderProvider = exports.OrderBillingTerms = exports.OrderDiscountType = exports.OrderCurrencyCode = exports.OrderEntityTypes = void 0;
16
+ 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 = void 0;
17
17
  const core_1 = require("@d19n/odin-types/dist/core");
18
18
  /**
19
19
  * Available types for Order records
@@ -100,14 +100,14 @@ var OrderProvider;
100
100
  *
101
101
  * @remarks Available options:
102
102
  * - `ETF_VALUE` - ETF over £300
103
- * - `NO_WELCOME` - No welcome pack
103
+ * - `NO_WELCOME_PACK` - No welcome pack
104
104
  * - `OTHER` - Other
105
105
  * - `PRICE_MATCH_EVIDENCE` - Price Match evidence insufficient or missing
106
106
  */
107
107
  var OrderWithholdCommissionReason;
108
108
  (function (OrderWithholdCommissionReason) {
109
109
  OrderWithholdCommissionReason["ETF_OVER_300"] = "ETF_VALUE";
110
- OrderWithholdCommissionReason["NO_WELCOME_PACK"] = "NO_WELCOME";
110
+ OrderWithholdCommissionReason["NO_WELCOME_PACK"] = "NO_WELCOME_PACK";
111
111
  OrderWithholdCommissionReason["OTHER"] = "OTHER";
112
112
  OrderWithholdCommissionReason["PRICE_MATCH_EVIDENCE_INSUFFICIENT_OR_MISSING"] = "PRICE_MATCH_EVIDENCE";
113
113
  })(OrderWithholdCommissionReason = exports.OrderWithholdCommissionReason || (exports.OrderWithholdCommissionReason = {}));
@@ -123,6 +123,44 @@ var OrderDeactivationReason;
123
123
  (function (OrderDeactivationReason) {
124
124
  OrderDeactivationReason["PAYMENT_OVERDUE"] = "PAYMENT_OVERDUE";
125
125
  })(OrderDeactivationReason = exports.OrderDeactivationReason || (exports.OrderDeactivationReason = {}));
126
+ /**
127
+ * Valid values for Order.CancellationReason
128
+ *
129
+ * Cancelation reason (Sales - Order)
130
+ *
131
+ * @remarks Available options:
132
+ * - `CUSTOMER_NOT_AGREED_INSTALL_ROUTE` - Customer Not Agreed Install Route
133
+ * - `CUSTOMER_SERVICE` - Customer Service
134
+ * - `DECEASED` - Deceased
135
+ * - `INSTALLATION_DELAY_NETOMNIA` - Installation Delay (Netomnia)
136
+ * - `PERSONAL_REASONS` - Personal reasons
137
+ * - `REQUEST_TO_DELAY` - Request to Delay
138
+ * - `SALES_DUPLICATE_ORDER` - Sales (Duplicate Order)
139
+ * - `SALES_INSTALL_NOT_BOOKED` - Sales (Install Not Booked)
140
+ * - `SALES_LOST_TO_COMPETITION` - Sales (Lost to Competition)
141
+ * - `SALES_MISSELLING` - Sales (Misselling)
142
+ * - `SALES_MOVE_OUT` - Sales (Move-Out)
143
+ * - `SALES_OFFER_LAPSED_RESOLD` - Sales (Offer Lapsed & Re-sold)
144
+ * - `SALES_UNREACHABLE` - Sales (Unreachable)
145
+ * - `UNINSTALLABLE_PROPERTY_NETOMNIA` - Uninstallable Property (Netomnia)
146
+ */
147
+ var OrderCancellationReason;
148
+ (function (OrderCancellationReason) {
149
+ OrderCancellationReason["CUSTOMER_NOT_AGREED_INSTALL_ROUTE"] = "CUSTOMER_NOT_AGREED_INSTALL_ROUTE";
150
+ OrderCancellationReason["CUSTOMER_SERVICE"] = "CUSTOMER_SERVICE";
151
+ OrderCancellationReason["DECEASED"] = "DECEASED";
152
+ OrderCancellationReason["INSTALLATION_DELAY_NETOMNIA"] = "INSTALLATION_DELAY_NETOMNIA";
153
+ OrderCancellationReason["PERSONAL_REASONS"] = "PERSONAL_REASONS";
154
+ OrderCancellationReason["REQUEST_TO_DELAY"] = "REQUEST_TO_DELAY";
155
+ OrderCancellationReason["SALES_DUPLICATE_ORDER"] = "SALES_DUPLICATE_ORDER";
156
+ OrderCancellationReason["SALES_INSTALL_NOT_BOOKED"] = "SALES_INSTALL_NOT_BOOKED";
157
+ OrderCancellationReason["SALES_LOST_TO_COMPETITION"] = "SALES_LOST_TO_COMPETITION";
158
+ OrderCancellationReason["SALES_MISSELLING"] = "SALES_MISSELLING";
159
+ OrderCancellationReason["SALES_MOVE_OUT"] = "SALES_MOVE_OUT";
160
+ OrderCancellationReason["SALES_OFFER_LAPSED_RE_SOLD"] = "SALES_OFFER_LAPSED_RESOLD";
161
+ OrderCancellationReason["SALES_UNREACHABLE"] = "SALES_UNREACHABLE";
162
+ OrderCancellationReason["UNINSTALLABLE_PROPERTY_NETOMNIA"] = "UNINSTALLABLE_PROPERTY_NETOMNIA";
163
+ })(OrderCancellationReason = exports.OrderCancellationReason || (exports.OrderCancellationReason = {}));
126
164
  /**
127
165
  * Valid values for Order.ActivationStatus
128
166
  *
@@ -288,8 +326,6 @@ var OrderPropertyKeys;
288
326
  OrderPropertyKeys["DeactivationReason"] = "DeactivationReason";
289
327
  /** cancellation reason notes (Sales - Order) */
290
328
  OrderPropertyKeys["CancellationReasonNote"] = "CancellationReasonNote";
291
- /** Cancelation reason (Sales - Order) */
292
- OrderPropertyKeys["CancellationReason"] = "CancellationReason";
293
329
  /** alerts that need to be visible on the order (Sales - Order) */
294
330
  OrderPropertyKeys["AlertMessage"] = "AlertMessage";
295
331
  /** the date of the alert message (Sales - Order) */
@@ -304,6 +340,8 @@ var OrderPropertyKeys;
304
340
  OrderPropertyKeys["BillingDay"] = "BillingDay";
305
341
  /** The date the order was rejected in aklamio (Sales - Order) */
306
342
  OrderPropertyKeys["AklamioRejectionDate"] = "AklamioRejectionDate";
343
+ /** Cancelation reason (Sales - Order) */
344
+ OrderPropertyKeys["CancellationReason"] = "CancellationReason";
307
345
  /** active date (Sales - Order) */
308
346
  OrderPropertyKeys["ActiveDate"] = "ActiveDate";
309
347
  /** This order comes because of an Aklamio Reference (Sales - Order) */
@@ -62,6 +62,8 @@ export declare enum OrderCheckPropertyKeys {
62
62
  OntDate = "OntDate",
63
63
  /** SpeedTestState (Network Operations - OrderCheck) */
64
64
  SpeedTestState = "SpeedTestState",
65
+ /** Name use as title */
66
+ Name = "Name",
65
67
  /** Date field for OrderCheck records. Used by Network Operations team. */
66
68
  VoiceDate = "VoiceDate"
67
69
  }
@@ -166,6 +168,11 @@ export interface OrderCheckProperties {
166
168
  * @type {TEXT}
167
169
  */
168
170
  SpeedTestState?: string;
171
+ /** Name use as title
172
+ *
173
+ * @type {TEXT}
174
+ */
175
+ Name?: string;
169
176
  /** Date field for OrderCheck records. Used by Network Operations team.
170
177
  *
171
178
  * @type {DATE_TIME}
@@ -66,6 +66,8 @@ var OrderCheckPropertyKeys;
66
66
  OrderCheckPropertyKeys["OntDate"] = "OntDate";
67
67
  /** SpeedTestState (Network Operations - OrderCheck) */
68
68
  OrderCheckPropertyKeys["SpeedTestState"] = "SpeedTestState";
69
+ /** Name use as title */
70
+ OrderCheckPropertyKeys["Name"] = "Name";
69
71
  /** Date field for OrderCheck records. Used by Network Operations team. */
70
72
  OrderCheckPropertyKeys["VoiceDate"] = "VoiceDate";
71
73
  })(OrderCheckPropertyKeys = exports.OrderCheckPropertyKeys || (exports.OrderCheckPropertyKeys = {}));