@d19n/youfibre-odin-sdk 2.0.8 → 2.0.9
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.
- package/dist/entities-v2/Visit.d.ts +163 -163
- package/dist/entities-v2/Visit.js +110 -110
- package/package.json +1 -1
|
@@ -25,48 +25,34 @@ export declare enum VisitEntityTypes {
|
|
|
25
25
|
DEFAULT = "DEFAULT"
|
|
26
26
|
}
|
|
27
27
|
/**
|
|
28
|
-
* Valid values for Visit.
|
|
28
|
+
* Valid values for Visit.InterestedReason
|
|
29
29
|
*
|
|
30
|
-
*
|
|
30
|
+
* outcome Interested closer description (Sales - Visit)
|
|
31
31
|
*
|
|
32
32
|
* @remarks Available options:
|
|
33
|
-
* - `
|
|
34
|
-
* - `
|
|
35
|
-
* - `
|
|
36
|
-
* - `
|
|
33
|
+
* - `CONSULTATION_WITH_PARTNER` - Consultation with Partner
|
|
34
|
+
* - `LEFT_INFORMATION` - Left information
|
|
35
|
+
* - `NEEDS_TO_CHECK_CONTRACT` - Needs to check contract
|
|
36
|
+
* - `PITCHED_MISSED` - Pitched & Missed
|
|
37
37
|
*/
|
|
38
|
-
export declare enum
|
|
38
|
+
export declare enum VisitInterestedReason {
|
|
39
|
+
CONSULTATION_WITH_PARTNER = "CONSULTATION_WITH_PARTNER",
|
|
40
|
+
LEFT_INFORMATION = "LEFT_INFORMATION",
|
|
41
|
+
NEEDS_TO_CHECK_CONTRACT = "NEEDS_TO_CHECK_CONTRACT",
|
|
42
|
+
PITCHED_MISSED = "PITCHED_MISSED"
|
|
39
43
|
}
|
|
40
44
|
/**
|
|
41
|
-
* Valid values for Visit.
|
|
45
|
+
* Valid values for Visit.Status
|
|
42
46
|
*
|
|
43
|
-
*
|
|
47
|
+
* Status indicator for Visit records. Tracks lifecycle state. Used by Sales team.
|
|
44
48
|
*
|
|
45
49
|
* @remarks Available options:
|
|
46
|
-
* - `
|
|
47
|
-
* - `
|
|
48
|
-
* - `EE`
|
|
49
|
-
* - `OTHER` - Other
|
|
50
|
-
* - `PLUSNET` - Plusnet
|
|
51
|
-
* - `SHELL` - Shell
|
|
52
|
-
* - `SKY` - Sky
|
|
53
|
-
* - `TALK_TALK` - Talk Talk
|
|
54
|
-
* - `VIRGIN` - Virgin
|
|
55
|
-
* - `VODAFONE` - Vodafone
|
|
56
|
-
* - `ZEN` - Zen
|
|
50
|
+
* - `DONE` - Done
|
|
51
|
+
* - `TODO` - Todo
|
|
57
52
|
*/
|
|
58
|
-
export declare enum
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
EE = "EE",
|
|
62
|
-
OTHER = "OTHER",
|
|
63
|
-
PLUSNET = "PLUSNET",
|
|
64
|
-
SHELL = "SHELL",
|
|
65
|
-
SKY = "SKY",
|
|
66
|
-
TALK_TALK = "TALK_TALK",
|
|
67
|
-
VIRGIN = "VIRGIN",
|
|
68
|
-
VODAFONE = "VODAFONE",
|
|
69
|
-
ZEN = "ZEN"
|
|
53
|
+
export declare enum VisitStatus {
|
|
54
|
+
DONE = "DONE",
|
|
55
|
+
TODO = "TODO"
|
|
70
56
|
}
|
|
71
57
|
/**
|
|
72
58
|
* Valid values for Visit.DoNotKnockReason
|
|
@@ -83,44 +69,6 @@ export declare enum VisitDoNotKnockReason {
|
|
|
83
69
|
REQUESTED_NOT_TO_KNOCK = "REQUESTED_NOT_TO_KNOCK",
|
|
84
70
|
VULNERABLE_PERSON = "VULNERABLE_PERSON"
|
|
85
71
|
}
|
|
86
|
-
/**
|
|
87
|
-
* Valid values for Visit.InterestedReason
|
|
88
|
-
*
|
|
89
|
-
* outcome Interested closer description (Sales - Visit)
|
|
90
|
-
*
|
|
91
|
-
* @remarks Available options:
|
|
92
|
-
* - `CONSULTATION_WITH_PARTNER` - Consultation with Partner
|
|
93
|
-
* - `LEFT_INFORMATION` - Left information
|
|
94
|
-
* - `NEEDS_TO_CHECK_CONTRACT` - Needs to check contract
|
|
95
|
-
* - `PITCHED_MISSED` - Pitched & Missed
|
|
96
|
-
*/
|
|
97
|
-
export declare enum VisitInterestedReason {
|
|
98
|
-
CONSULTATION_WITH_PARTNER = "CONSULTATION_WITH_PARTNER",
|
|
99
|
-
LEFT_INFORMATION = "LEFT_INFORMATION",
|
|
100
|
-
NEEDS_TO_CHECK_CONTRACT = "NEEDS_TO_CHECK_CONTRACT",
|
|
101
|
-
PITCHED_MISSED = "PITCHED_MISSED"
|
|
102
|
-
}
|
|
103
|
-
/**
|
|
104
|
-
* Valid values for Visit.NotInterestedReason
|
|
105
|
-
*
|
|
106
|
-
* outcome not_interested additional information (Sales - Visit)
|
|
107
|
-
*
|
|
108
|
-
* @remarks Available options:
|
|
109
|
-
* - `HAPPY_WITH_CURRENT_PROVIDER` - Happy with Current Provider
|
|
110
|
-
* - `MOVING_HOUSE` - Moving House (non YF area)
|
|
111
|
-
* - `NO_BUNDLE` - No Bundle (TV / Sports, etc.)
|
|
112
|
-
* - `NO_REASON_GIVEN` - No Reason Given
|
|
113
|
-
* - `OLDER_DEMOGRAPHIC` - Older Demographic
|
|
114
|
-
* - `TOO_EXPENSIVE` - Too Expensive
|
|
115
|
-
*/
|
|
116
|
-
export declare enum VisitNotInterestedReason {
|
|
117
|
-
HAPPY_WITH_CURRENT_PROVIDER = "HAPPY_WITH_CURRENT_PROVIDER",
|
|
118
|
-
MOVING_HOUSE_NON_YF_AREA = "MOVING_HOUSE",
|
|
119
|
-
NO_BUNDLE_TV_SPORTS_ETC = "NO_BUNDLE",
|
|
120
|
-
NO_REASON_GIVEN = "NO_REASON_GIVEN",
|
|
121
|
-
OLDER_DEMOGRAPHIC = "OLDER_DEMOGRAPHIC",
|
|
122
|
-
TOO_EXPENSIVE = "TOO_EXPENSIVE"
|
|
123
|
-
}
|
|
124
72
|
/**
|
|
125
73
|
* Valid values for Visit.Outcome
|
|
126
74
|
*
|
|
@@ -163,63 +111,115 @@ export declare enum VisitOutcome {
|
|
|
163
111
|
VULNERABLE_PERSON = "VULNERABLE_PERSON"
|
|
164
112
|
}
|
|
165
113
|
/**
|
|
166
|
-
* Valid values for Visit.
|
|
114
|
+
* Valid values for Visit.AgeBracket
|
|
167
115
|
*
|
|
168
|
-
*
|
|
116
|
+
* the age bracket of the person (Sales - Visit)
|
|
169
117
|
*
|
|
170
118
|
* @remarks Available options:
|
|
171
|
-
* - `
|
|
172
|
-
* - `
|
|
119
|
+
* - `18_30` - 18-30
|
|
120
|
+
* - `30_50` - 30-50
|
|
121
|
+
* - `50_65` - 50-65
|
|
122
|
+
* - `65_AND_OLDER` - 65 +
|
|
173
123
|
*/
|
|
174
|
-
export declare enum
|
|
175
|
-
|
|
176
|
-
|
|
124
|
+
export declare enum VisitAgeBracket {
|
|
125
|
+
}
|
|
126
|
+
/**
|
|
127
|
+
* Valid values for Visit.CurrentProvider
|
|
128
|
+
*
|
|
129
|
+
* Current provider (Sales - Visit)
|
|
130
|
+
*
|
|
131
|
+
* @remarks Available options:
|
|
132
|
+
* - `BT`
|
|
133
|
+
* - `CUCKOO` - Cuckoo
|
|
134
|
+
* - `EE`
|
|
135
|
+
* - `OTHER` - Other
|
|
136
|
+
* - `PLUSNET` - Plusnet
|
|
137
|
+
* - `SHELL` - Shell
|
|
138
|
+
* - `SKY` - Sky
|
|
139
|
+
* - `TALK_TALK` - Talk Talk
|
|
140
|
+
* - `VIRGIN` - Virgin
|
|
141
|
+
* - `VODAFONE` - Vodafone
|
|
142
|
+
* - `ZEN` - Zen
|
|
143
|
+
*/
|
|
144
|
+
export declare enum VisitCurrentProvider {
|
|
145
|
+
BT = "BT",
|
|
146
|
+
CUCKOO = "CUCKOO",
|
|
147
|
+
EE = "EE",
|
|
148
|
+
OTHER = "OTHER",
|
|
149
|
+
PLUSNET = "PLUSNET",
|
|
150
|
+
SHELL = "SHELL",
|
|
151
|
+
SKY = "SKY",
|
|
152
|
+
TALK_TALK = "TALK_TALK",
|
|
153
|
+
VIRGIN = "VIRGIN",
|
|
154
|
+
VODAFONE = "VODAFONE",
|
|
155
|
+
ZEN = "ZEN"
|
|
156
|
+
}
|
|
157
|
+
/**
|
|
158
|
+
* Valid values for Visit.NotInterestedReason
|
|
159
|
+
*
|
|
160
|
+
* outcome not_interested additional information (Sales - Visit)
|
|
161
|
+
*
|
|
162
|
+
* @remarks Available options:
|
|
163
|
+
* - `HAPPY_WITH_CURRENT_PROVIDER` - Happy with Current Provider
|
|
164
|
+
* - `MOVING_HOUSE` - Moving House (non YF area)
|
|
165
|
+
* - `NO_BUNDLE` - No Bundle (TV / Sports, etc.)
|
|
166
|
+
* - `NO_REASON_GIVEN` - No Reason Given
|
|
167
|
+
* - `OLDER_DEMOGRAPHIC` - Older Demographic
|
|
168
|
+
* - `TOO_EXPENSIVE` - Too Expensive
|
|
169
|
+
*/
|
|
170
|
+
export declare enum VisitNotInterestedReason {
|
|
171
|
+
HAPPY_WITH_CURRENT_PROVIDER = "HAPPY_WITH_CURRENT_PROVIDER",
|
|
172
|
+
MOVING_HOUSE_NON_YF_AREA = "MOVING_HOUSE",
|
|
173
|
+
NO_BUNDLE_TV_SPORTS_ETC = "NO_BUNDLE",
|
|
174
|
+
NO_REASON_GIVEN = "NO_REASON_GIVEN",
|
|
175
|
+
OLDER_DEMOGRAPHIC = "OLDER_DEMOGRAPHIC",
|
|
176
|
+
TOO_EXPENSIVE = "TOO_EXPENSIVE"
|
|
177
177
|
}
|
|
178
178
|
/**
|
|
179
179
|
* Property keys for Visit
|
|
180
180
|
* Use these constants instead of string literals for type safety
|
|
181
181
|
*/
|
|
182
182
|
export declare enum VisitPropertyKeys {
|
|
183
|
-
/**
|
|
184
|
-
|
|
185
|
-
/**
|
|
186
|
-
|
|
187
|
-
/** Contract end date (Sales - Visit) */
|
|
188
|
-
ContractEndDate = "ContractEndDate",
|
|
183
|
+
/** Unique delivery point reference number (Sales - Visit) */
|
|
184
|
+
Udprn = "UDPRN",
|
|
185
|
+
/** unique multiple point reference number (Sales - Visit) */
|
|
186
|
+
Umprn = "UMPRN",
|
|
189
187
|
/** longitude and latitude coordinates (Sales - Visit) */
|
|
190
188
|
Coordinates = "Coordinates",
|
|
189
|
+
/** outcome Interested closer description (Sales - Visit) */
|
|
190
|
+
InterestedReason = "InterestedReason",
|
|
191
|
+
/** Status indicator for Visit records. Tracks lifecycle state. Used by Sales team. */
|
|
192
|
+
Status = "Status",
|
|
191
193
|
/** Current Price (Sales - Visit) */
|
|
192
194
|
CurrentPrice = "CurrentPrice",
|
|
193
|
-
/** Current provider (Sales - Visit) */
|
|
194
|
-
CurrentProvider = "CurrentProvider",
|
|
195
195
|
/** Reference identifier for Visit relationships. Used for data integrity. */
|
|
196
196
|
DataSetId = "DataSetId",
|
|
197
197
|
/** DoNotKnockReason (Sales - Visit) */
|
|
198
198
|
DoNotKnockReason = "DoNotKnockReason",
|
|
199
|
-
/**
|
|
200
|
-
|
|
201
|
-
/**
|
|
202
|
-
|
|
199
|
+
/** Data field for Visit records. Used by Sales team. */
|
|
200
|
+
Latitude = "Latitude",
|
|
201
|
+
/** outcome of the visit (Sales - Visit) */
|
|
202
|
+
Outcome = "Outcome",
|
|
203
|
+
/** the age bracket of the person (Sales - Visit) */
|
|
204
|
+
AgeBracket = "AgeBracket",
|
|
205
|
+
/** Leave comments about the visit (Sales - Visit) */
|
|
206
|
+
Comments = "Comments",
|
|
207
|
+
/** Contract end date (Sales - Visit) */
|
|
208
|
+
ContractEndDate = "ContractEndDate",
|
|
209
|
+
/** Current provider (Sales - Visit) */
|
|
210
|
+
CurrentProvider = "CurrentProvider",
|
|
203
211
|
/** the full address of the visit (Sales - Visit) */
|
|
204
212
|
FullAddress = "FullAddress",
|
|
205
|
-
/** outcome Interested closer description (Sales - Visit) */
|
|
206
|
-
InterestedReason = "InterestedReason",
|
|
207
213
|
/** the id of the l2 polygon (Sales - Visit) */
|
|
208
214
|
L2PolygonId = "L2PolygonId",
|
|
209
215
|
/** Data field for Visit records. Used by Sales team. */
|
|
210
|
-
Latitude = "Latitude",
|
|
211
|
-
/** Data field for Visit records. Used by Sales team. */
|
|
212
216
|
Longitude = "Longitude",
|
|
217
|
+
/** Download Speed (Sales - Visit) */
|
|
218
|
+
DownloadSpeed = "DownloadSpeed",
|
|
219
|
+
/** date to follow up with the address (Sales - Visit) */
|
|
220
|
+
FollowUpDate = "FollowUpDate",
|
|
213
221
|
/** outcome not_interested additional information (Sales - Visit) */
|
|
214
|
-
NotInterestedReason = "NotInterestedReason"
|
|
215
|
-
/** outcome of the visit (Sales - Visit) */
|
|
216
|
-
Outcome = "Outcome",
|
|
217
|
-
/** Status indicator for Visit records. Tracks lifecycle state. Used by Sales team. */
|
|
218
|
-
Status = "Status",
|
|
219
|
-
/** Unique delivery point reference number (Sales - Visit) */
|
|
220
|
-
Udprn = "UDPRN",
|
|
221
|
-
/** unique multiple point reference number (Sales - Visit) */
|
|
222
|
-
Umprn = "UMPRN"
|
|
222
|
+
NotInterestedReason = "NotInterestedReason"
|
|
223
223
|
}
|
|
224
224
|
/**
|
|
225
225
|
* Properties for Visit records
|
|
@@ -227,39 +227,43 @@ export declare enum VisitPropertyKeys {
|
|
|
227
227
|
* @see CrmModule:Visit
|
|
228
228
|
*/
|
|
229
229
|
export interface VisitProperties {
|
|
230
|
-
/**
|
|
231
|
-
*
|
|
232
|
-
* @type {ENUM}
|
|
233
|
-
* @enum {VisitAgeBracket}
|
|
234
|
-
*/
|
|
235
|
-
AgeBracket: VisitAgeBracket;
|
|
236
|
-
/** Leave comments about the visit (Sales - Visit)
|
|
230
|
+
/** Unique delivery point reference number (Sales - Visit)
|
|
237
231
|
*
|
|
238
|
-
* @type {
|
|
232
|
+
* @type {NUMBER}
|
|
233
|
+
* @hidden This field is hidden in the UI
|
|
239
234
|
*/
|
|
240
|
-
|
|
241
|
-
/**
|
|
235
|
+
Udprn: number;
|
|
236
|
+
/** unique multiple point reference number (Sales - Visit)
|
|
242
237
|
*
|
|
243
|
-
* @type {
|
|
238
|
+
* @type {NUMBER}
|
|
239
|
+
* @hidden This field is hidden in the UI
|
|
244
240
|
*/
|
|
245
|
-
|
|
241
|
+
Umprn: number;
|
|
246
242
|
/** longitude and latitude coordinates (Sales - Visit)
|
|
247
243
|
*
|
|
248
244
|
* @type {TEXT}
|
|
249
245
|
* @hidden This field is hidden in the UI
|
|
250
246
|
*/
|
|
251
247
|
Coordinates: string;
|
|
252
|
-
/**
|
|
248
|
+
/** outcome Interested closer description (Sales - Visit)
|
|
253
249
|
*
|
|
254
|
-
* @type {
|
|
250
|
+
* @type {ENUM}
|
|
251
|
+
* @enum {VisitInterestedReason}
|
|
255
252
|
*/
|
|
256
|
-
|
|
257
|
-
/**
|
|
253
|
+
InterestedReason: VisitInterestedReason;
|
|
254
|
+
/** Status indicator for Visit records. Tracks lifecycle state. Used by Sales team.
|
|
258
255
|
*
|
|
259
256
|
* @type {ENUM}
|
|
260
|
-
* @
|
|
257
|
+
* @default
|
|
258
|
+
* @enum {VisitStatus}
|
|
259
|
+
* @hidden This field is hidden in the UI
|
|
261
260
|
*/
|
|
262
|
-
|
|
261
|
+
Status: VisitStatus;
|
|
262
|
+
/** Current Price (Sales - Visit)
|
|
263
|
+
*
|
|
264
|
+
* @type {NUMERIC}
|
|
265
|
+
*/
|
|
266
|
+
CurrentPrice: number;
|
|
263
267
|
/** Reference identifier for Visit relationships. Used for data integrity.
|
|
264
268
|
*
|
|
265
269
|
* @type {UUID}
|
|
@@ -272,30 +276,46 @@ export interface VisitProperties {
|
|
|
272
276
|
* @enum {VisitDoNotKnockReason}
|
|
273
277
|
*/
|
|
274
278
|
DoNotKnockReason: VisitDoNotKnockReason;
|
|
275
|
-
/**
|
|
279
|
+
/** Data field for Visit records. Used by Sales team.
|
|
276
280
|
*
|
|
277
|
-
* @type {
|
|
281
|
+
* @type {TEXT}
|
|
282
|
+
* @hidden This field is hidden in the UI
|
|
278
283
|
*/
|
|
279
|
-
|
|
280
|
-
/**
|
|
284
|
+
Latitude: string;
|
|
285
|
+
/** outcome of the visit (Sales - Visit)
|
|
286
|
+
*
|
|
287
|
+
* @type {ENUM}
|
|
288
|
+
* @enum {VisitOutcome}
|
|
289
|
+
*/
|
|
290
|
+
Outcome: VisitOutcome;
|
|
291
|
+
/** the age bracket of the person (Sales - Visit)
|
|
292
|
+
*
|
|
293
|
+
* @type {ENUM}
|
|
294
|
+
* @enum {VisitAgeBracket}
|
|
295
|
+
*/
|
|
296
|
+
AgeBracket: VisitAgeBracket;
|
|
297
|
+
/** Leave comments about the visit (Sales - Visit)
|
|
298
|
+
*
|
|
299
|
+
* @type {TEXT_LONG}
|
|
300
|
+
*/
|
|
301
|
+
Comments: string;
|
|
302
|
+
/** Contract end date (Sales - Visit)
|
|
281
303
|
*
|
|
282
304
|
* @type {DATE}
|
|
283
|
-
* @format DD/MM/YYYY
|
|
284
|
-
* @hidden This field is hidden in the UI
|
|
285
305
|
*/
|
|
286
|
-
|
|
306
|
+
ContractEndDate: string;
|
|
307
|
+
/** Current provider (Sales - Visit)
|
|
308
|
+
*
|
|
309
|
+
* @type {ENUM}
|
|
310
|
+
* @enum {VisitCurrentProvider}
|
|
311
|
+
*/
|
|
312
|
+
CurrentProvider: VisitCurrentProvider;
|
|
287
313
|
/** the full address of the visit (Sales - Visit)
|
|
288
314
|
*
|
|
289
315
|
* @type {TEXT}
|
|
290
316
|
* @hidden This field is hidden in the UI
|
|
291
317
|
*/
|
|
292
318
|
FullAddress: string;
|
|
293
|
-
/** outcome Interested closer description (Sales - Visit)
|
|
294
|
-
*
|
|
295
|
-
* @type {ENUM}
|
|
296
|
-
* @enum {VisitInterestedReason}
|
|
297
|
-
*/
|
|
298
|
-
InterestedReason: VisitInterestedReason;
|
|
299
319
|
/** the id of the l2 polygon (Sales - Visit)
|
|
300
320
|
*
|
|
301
321
|
* @type {NUMBER}
|
|
@@ -307,45 +327,25 @@ export interface VisitProperties {
|
|
|
307
327
|
* @type {TEXT}
|
|
308
328
|
* @hidden This field is hidden in the UI
|
|
309
329
|
*/
|
|
310
|
-
|
|
311
|
-
/**
|
|
330
|
+
Longitude: string;
|
|
331
|
+
/** Download Speed (Sales - Visit)
|
|
312
332
|
*
|
|
313
|
-
* @type {
|
|
333
|
+
* @type {ALPHA_NUMERICAL}
|
|
334
|
+
*/
|
|
335
|
+
DownloadSpeed: string;
|
|
336
|
+
/** date to follow up with the address (Sales - Visit)
|
|
337
|
+
*
|
|
338
|
+
* @type {DATE}
|
|
339
|
+
* @format DD/MM/YYYY
|
|
314
340
|
* @hidden This field is hidden in the UI
|
|
315
341
|
*/
|
|
316
|
-
|
|
342
|
+
FollowUpDate: string;
|
|
317
343
|
/** outcome not_interested additional information (Sales - Visit)
|
|
318
344
|
*
|
|
319
345
|
* @type {ENUM}
|
|
320
346
|
* @enum {VisitNotInterestedReason}
|
|
321
347
|
*/
|
|
322
348
|
NotInterestedReason: VisitNotInterestedReason;
|
|
323
|
-
/** outcome of the visit (Sales - Visit)
|
|
324
|
-
*
|
|
325
|
-
* @type {ENUM}
|
|
326
|
-
* @enum {VisitOutcome}
|
|
327
|
-
*/
|
|
328
|
-
Outcome: VisitOutcome;
|
|
329
|
-
/** Status indicator for Visit records. Tracks lifecycle state. Used by Sales team.
|
|
330
|
-
*
|
|
331
|
-
* @type {ENUM}
|
|
332
|
-
* @default
|
|
333
|
-
* @enum {VisitStatus}
|
|
334
|
-
* @hidden This field is hidden in the UI
|
|
335
|
-
*/
|
|
336
|
-
Status: VisitStatus;
|
|
337
|
-
/** Unique delivery point reference number (Sales - Visit)
|
|
338
|
-
*
|
|
339
|
-
* @type {NUMBER}
|
|
340
|
-
* @hidden This field is hidden in the UI
|
|
341
|
-
*/
|
|
342
|
-
Udprn: number;
|
|
343
|
-
/** unique multiple point reference number (Sales - Visit)
|
|
344
|
-
*
|
|
345
|
-
* @type {NUMBER}
|
|
346
|
-
* @hidden This field is hidden in the UI
|
|
347
|
-
*/
|
|
348
|
-
Umprn: number;
|
|
349
349
|
}
|
|
350
350
|
/**
|
|
351
351
|
* Visit entity from CrmModule
|
|
@@ -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_VISIT_APPOINTMENT_DELETED = exports.ROUTING_KEY_LINK_VISIT_APPOINTMENT_CREATED = exports.ROUTING_KEY_LINK_VISIT_FILE_DELETED = exports.ROUTING_KEY_LINK_VISIT_FILE_CREATED = exports.ROUTING_KEY_LINK_VISIT_NOTE_DELETED = exports.ROUTING_KEY_LINK_VISIT_NOTE_CREATED = exports.ROUTING_KEY_VISIT_DEFAULT_DELETED = exports.ROUTING_KEY_VISIT_DEFAULT_UPDATED = exports.ROUTING_KEY_VISIT_DEFAULT_CREATED = exports.ROUTING_KEY_VISIT_DELETED = exports.ROUTING_KEY_VISIT_UPDATED = exports.ROUTING_KEY_VISIT_CREATED = exports.Visit = exports.VisitPropertyKeys = exports.
|
|
15
|
+
exports.ROUTING_KEY_LINK_VISIT_APPOINTMENT_DELETED = exports.ROUTING_KEY_LINK_VISIT_APPOINTMENT_CREATED = exports.ROUTING_KEY_LINK_VISIT_FILE_DELETED = exports.ROUTING_KEY_LINK_VISIT_FILE_CREATED = exports.ROUTING_KEY_LINK_VISIT_NOTE_DELETED = exports.ROUTING_KEY_LINK_VISIT_NOTE_CREATED = exports.ROUTING_KEY_VISIT_DEFAULT_DELETED = exports.ROUTING_KEY_VISIT_DEFAULT_UPDATED = exports.ROUTING_KEY_VISIT_DEFAULT_CREATED = exports.ROUTING_KEY_VISIT_DELETED = exports.ROUTING_KEY_VISIT_UPDATED = exports.ROUTING_KEY_VISIT_CREATED = exports.Visit = exports.VisitPropertyKeys = exports.VisitNotInterestedReason = exports.VisitCurrentProvider = exports.VisitAgeBracket = exports.VisitOutcome = exports.VisitDoNotKnockReason = exports.VisitStatus = exports.VisitInterestedReason = exports.VisitEntityTypes = void 0;
|
|
16
16
|
const core_1 = require("@d19n/odin-types/dist/core");
|
|
17
17
|
/**
|
|
18
18
|
* Available types for Visit records
|
|
@@ -23,51 +23,37 @@ var VisitEntityTypes;
|
|
|
23
23
|
VisitEntityTypes["DEFAULT"] = "DEFAULT";
|
|
24
24
|
})(VisitEntityTypes = exports.VisitEntityTypes || (exports.VisitEntityTypes = {}));
|
|
25
25
|
/**
|
|
26
|
-
* Valid values for Visit.
|
|
26
|
+
* Valid values for Visit.InterestedReason
|
|
27
27
|
*
|
|
28
|
-
*
|
|
28
|
+
* outcome Interested closer description (Sales - Visit)
|
|
29
29
|
*
|
|
30
30
|
* @remarks Available options:
|
|
31
|
-
* - `
|
|
32
|
-
* - `
|
|
33
|
-
* - `
|
|
34
|
-
* - `
|
|
31
|
+
* - `CONSULTATION_WITH_PARTNER` - Consultation with Partner
|
|
32
|
+
* - `LEFT_INFORMATION` - Left information
|
|
33
|
+
* - `NEEDS_TO_CHECK_CONTRACT` - Needs to check contract
|
|
34
|
+
* - `PITCHED_MISSED` - Pitched & Missed
|
|
35
35
|
*/
|
|
36
|
-
var
|
|
37
|
-
(function (
|
|
38
|
-
|
|
36
|
+
var VisitInterestedReason;
|
|
37
|
+
(function (VisitInterestedReason) {
|
|
38
|
+
VisitInterestedReason["CONSULTATION_WITH_PARTNER"] = "CONSULTATION_WITH_PARTNER";
|
|
39
|
+
VisitInterestedReason["LEFT_INFORMATION"] = "LEFT_INFORMATION";
|
|
40
|
+
VisitInterestedReason["NEEDS_TO_CHECK_CONTRACT"] = "NEEDS_TO_CHECK_CONTRACT";
|
|
41
|
+
VisitInterestedReason["PITCHED_MISSED"] = "PITCHED_MISSED";
|
|
42
|
+
})(VisitInterestedReason = exports.VisitInterestedReason || (exports.VisitInterestedReason = {}));
|
|
39
43
|
/**
|
|
40
|
-
* Valid values for Visit.
|
|
44
|
+
* Valid values for Visit.Status
|
|
41
45
|
*
|
|
42
|
-
*
|
|
46
|
+
* Status indicator for Visit records. Tracks lifecycle state. Used by Sales team.
|
|
43
47
|
*
|
|
44
48
|
* @remarks Available options:
|
|
45
|
-
* - `
|
|
46
|
-
* - `
|
|
47
|
-
* - `EE`
|
|
48
|
-
* - `OTHER` - Other
|
|
49
|
-
* - `PLUSNET` - Plusnet
|
|
50
|
-
* - `SHELL` - Shell
|
|
51
|
-
* - `SKY` - Sky
|
|
52
|
-
* - `TALK_TALK` - Talk Talk
|
|
53
|
-
* - `VIRGIN` - Virgin
|
|
54
|
-
* - `VODAFONE` - Vodafone
|
|
55
|
-
* - `ZEN` - Zen
|
|
49
|
+
* - `DONE` - Done
|
|
50
|
+
* - `TODO` - Todo
|
|
56
51
|
*/
|
|
57
|
-
var
|
|
58
|
-
(function (
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
VisitCurrentProvider["OTHER"] = "OTHER";
|
|
63
|
-
VisitCurrentProvider["PLUSNET"] = "PLUSNET";
|
|
64
|
-
VisitCurrentProvider["SHELL"] = "SHELL";
|
|
65
|
-
VisitCurrentProvider["SKY"] = "SKY";
|
|
66
|
-
VisitCurrentProvider["TALK_TALK"] = "TALK_TALK";
|
|
67
|
-
VisitCurrentProvider["VIRGIN"] = "VIRGIN";
|
|
68
|
-
VisitCurrentProvider["VODAFONE"] = "VODAFONE";
|
|
69
|
-
VisitCurrentProvider["ZEN"] = "ZEN";
|
|
70
|
-
})(VisitCurrentProvider = exports.VisitCurrentProvider || (exports.VisitCurrentProvider = {}));
|
|
52
|
+
var VisitStatus;
|
|
53
|
+
(function (VisitStatus) {
|
|
54
|
+
VisitStatus["DONE"] = "DONE";
|
|
55
|
+
VisitStatus["TODO"] = "TODO";
|
|
56
|
+
})(VisitStatus = exports.VisitStatus || (exports.VisitStatus = {}));
|
|
71
57
|
/**
|
|
72
58
|
* Valid values for Visit.DoNotKnockReason
|
|
73
59
|
*
|
|
@@ -84,46 +70,6 @@ var VisitDoNotKnockReason;
|
|
|
84
70
|
VisitDoNotKnockReason["REQUESTED_NOT_TO_KNOCK"] = "REQUESTED_NOT_TO_KNOCK";
|
|
85
71
|
VisitDoNotKnockReason["VULNERABLE_PERSON"] = "VULNERABLE_PERSON";
|
|
86
72
|
})(VisitDoNotKnockReason = exports.VisitDoNotKnockReason || (exports.VisitDoNotKnockReason = {}));
|
|
87
|
-
/**
|
|
88
|
-
* Valid values for Visit.InterestedReason
|
|
89
|
-
*
|
|
90
|
-
* outcome Interested closer description (Sales - Visit)
|
|
91
|
-
*
|
|
92
|
-
* @remarks Available options:
|
|
93
|
-
* - `CONSULTATION_WITH_PARTNER` - Consultation with Partner
|
|
94
|
-
* - `LEFT_INFORMATION` - Left information
|
|
95
|
-
* - `NEEDS_TO_CHECK_CONTRACT` - Needs to check contract
|
|
96
|
-
* - `PITCHED_MISSED` - Pitched & Missed
|
|
97
|
-
*/
|
|
98
|
-
var VisitInterestedReason;
|
|
99
|
-
(function (VisitInterestedReason) {
|
|
100
|
-
VisitInterestedReason["CONSULTATION_WITH_PARTNER"] = "CONSULTATION_WITH_PARTNER";
|
|
101
|
-
VisitInterestedReason["LEFT_INFORMATION"] = "LEFT_INFORMATION";
|
|
102
|
-
VisitInterestedReason["NEEDS_TO_CHECK_CONTRACT"] = "NEEDS_TO_CHECK_CONTRACT";
|
|
103
|
-
VisitInterestedReason["PITCHED_MISSED"] = "PITCHED_MISSED";
|
|
104
|
-
})(VisitInterestedReason = exports.VisitInterestedReason || (exports.VisitInterestedReason = {}));
|
|
105
|
-
/**
|
|
106
|
-
* Valid values for Visit.NotInterestedReason
|
|
107
|
-
*
|
|
108
|
-
* outcome not_interested additional information (Sales - Visit)
|
|
109
|
-
*
|
|
110
|
-
* @remarks Available options:
|
|
111
|
-
* - `HAPPY_WITH_CURRENT_PROVIDER` - Happy with Current Provider
|
|
112
|
-
* - `MOVING_HOUSE` - Moving House (non YF area)
|
|
113
|
-
* - `NO_BUNDLE` - No Bundle (TV / Sports, etc.)
|
|
114
|
-
* - `NO_REASON_GIVEN` - No Reason Given
|
|
115
|
-
* - `OLDER_DEMOGRAPHIC` - Older Demographic
|
|
116
|
-
* - `TOO_EXPENSIVE` - Too Expensive
|
|
117
|
-
*/
|
|
118
|
-
var VisitNotInterestedReason;
|
|
119
|
-
(function (VisitNotInterestedReason) {
|
|
120
|
-
VisitNotInterestedReason["HAPPY_WITH_CURRENT_PROVIDER"] = "HAPPY_WITH_CURRENT_PROVIDER";
|
|
121
|
-
VisitNotInterestedReason["MOVING_HOUSE_NON_YF_AREA"] = "MOVING_HOUSE";
|
|
122
|
-
VisitNotInterestedReason["NO_BUNDLE_TV_SPORTS_ETC"] = "NO_BUNDLE";
|
|
123
|
-
VisitNotInterestedReason["NO_REASON_GIVEN"] = "NO_REASON_GIVEN";
|
|
124
|
-
VisitNotInterestedReason["OLDER_DEMOGRAPHIC"] = "OLDER_DEMOGRAPHIC";
|
|
125
|
-
VisitNotInterestedReason["TOO_EXPENSIVE"] = "TOO_EXPENSIVE";
|
|
126
|
-
})(VisitNotInterestedReason = exports.VisitNotInterestedReason || (exports.VisitNotInterestedReason = {}));
|
|
127
73
|
/**
|
|
128
74
|
* Valid values for Visit.Outcome
|
|
129
75
|
*
|
|
@@ -167,65 +113,119 @@ var VisitOutcome;
|
|
|
167
113
|
VisitOutcome["VULNERABLE_PERSON"] = "VULNERABLE_PERSON";
|
|
168
114
|
})(VisitOutcome = exports.VisitOutcome || (exports.VisitOutcome = {}));
|
|
169
115
|
/**
|
|
170
|
-
* Valid values for Visit.
|
|
116
|
+
* Valid values for Visit.AgeBracket
|
|
171
117
|
*
|
|
172
|
-
*
|
|
118
|
+
* the age bracket of the person (Sales - Visit)
|
|
173
119
|
*
|
|
174
120
|
* @remarks Available options:
|
|
175
|
-
* - `
|
|
176
|
-
* - `
|
|
121
|
+
* - `18_30` - 18-30
|
|
122
|
+
* - `30_50` - 30-50
|
|
123
|
+
* - `50_65` - 50-65
|
|
124
|
+
* - `65_AND_OLDER` - 65 +
|
|
177
125
|
*/
|
|
178
|
-
var
|
|
179
|
-
(function (
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
126
|
+
var VisitAgeBracket;
|
|
127
|
+
(function (VisitAgeBracket) {
|
|
128
|
+
})(VisitAgeBracket = exports.VisitAgeBracket || (exports.VisitAgeBracket = {}));
|
|
129
|
+
/**
|
|
130
|
+
* Valid values for Visit.CurrentProvider
|
|
131
|
+
*
|
|
132
|
+
* Current provider (Sales - Visit)
|
|
133
|
+
*
|
|
134
|
+
* @remarks Available options:
|
|
135
|
+
* - `BT`
|
|
136
|
+
* - `CUCKOO` - Cuckoo
|
|
137
|
+
* - `EE`
|
|
138
|
+
* - `OTHER` - Other
|
|
139
|
+
* - `PLUSNET` - Plusnet
|
|
140
|
+
* - `SHELL` - Shell
|
|
141
|
+
* - `SKY` - Sky
|
|
142
|
+
* - `TALK_TALK` - Talk Talk
|
|
143
|
+
* - `VIRGIN` - Virgin
|
|
144
|
+
* - `VODAFONE` - Vodafone
|
|
145
|
+
* - `ZEN` - Zen
|
|
146
|
+
*/
|
|
147
|
+
var VisitCurrentProvider;
|
|
148
|
+
(function (VisitCurrentProvider) {
|
|
149
|
+
VisitCurrentProvider["BT"] = "BT";
|
|
150
|
+
VisitCurrentProvider["CUCKOO"] = "CUCKOO";
|
|
151
|
+
VisitCurrentProvider["EE"] = "EE";
|
|
152
|
+
VisitCurrentProvider["OTHER"] = "OTHER";
|
|
153
|
+
VisitCurrentProvider["PLUSNET"] = "PLUSNET";
|
|
154
|
+
VisitCurrentProvider["SHELL"] = "SHELL";
|
|
155
|
+
VisitCurrentProvider["SKY"] = "SKY";
|
|
156
|
+
VisitCurrentProvider["TALK_TALK"] = "TALK_TALK";
|
|
157
|
+
VisitCurrentProvider["VIRGIN"] = "VIRGIN";
|
|
158
|
+
VisitCurrentProvider["VODAFONE"] = "VODAFONE";
|
|
159
|
+
VisitCurrentProvider["ZEN"] = "ZEN";
|
|
160
|
+
})(VisitCurrentProvider = exports.VisitCurrentProvider || (exports.VisitCurrentProvider = {}));
|
|
161
|
+
/**
|
|
162
|
+
* Valid values for Visit.NotInterestedReason
|
|
163
|
+
*
|
|
164
|
+
* outcome not_interested additional information (Sales - Visit)
|
|
165
|
+
*
|
|
166
|
+
* @remarks Available options:
|
|
167
|
+
* - `HAPPY_WITH_CURRENT_PROVIDER` - Happy with Current Provider
|
|
168
|
+
* - `MOVING_HOUSE` - Moving House (non YF area)
|
|
169
|
+
* - `NO_BUNDLE` - No Bundle (TV / Sports, etc.)
|
|
170
|
+
* - `NO_REASON_GIVEN` - No Reason Given
|
|
171
|
+
* - `OLDER_DEMOGRAPHIC` - Older Demographic
|
|
172
|
+
* - `TOO_EXPENSIVE` - Too Expensive
|
|
173
|
+
*/
|
|
174
|
+
var VisitNotInterestedReason;
|
|
175
|
+
(function (VisitNotInterestedReason) {
|
|
176
|
+
VisitNotInterestedReason["HAPPY_WITH_CURRENT_PROVIDER"] = "HAPPY_WITH_CURRENT_PROVIDER";
|
|
177
|
+
VisitNotInterestedReason["MOVING_HOUSE_NON_YF_AREA"] = "MOVING_HOUSE";
|
|
178
|
+
VisitNotInterestedReason["NO_BUNDLE_TV_SPORTS_ETC"] = "NO_BUNDLE";
|
|
179
|
+
VisitNotInterestedReason["NO_REASON_GIVEN"] = "NO_REASON_GIVEN";
|
|
180
|
+
VisitNotInterestedReason["OLDER_DEMOGRAPHIC"] = "OLDER_DEMOGRAPHIC";
|
|
181
|
+
VisitNotInterestedReason["TOO_EXPENSIVE"] = "TOO_EXPENSIVE";
|
|
182
|
+
})(VisitNotInterestedReason = exports.VisitNotInterestedReason || (exports.VisitNotInterestedReason = {}));
|
|
183
183
|
/**
|
|
184
184
|
* Property keys for Visit
|
|
185
185
|
* Use these constants instead of string literals for type safety
|
|
186
186
|
*/
|
|
187
187
|
var VisitPropertyKeys;
|
|
188
188
|
(function (VisitPropertyKeys) {
|
|
189
|
-
/**
|
|
190
|
-
VisitPropertyKeys["
|
|
191
|
-
/**
|
|
192
|
-
VisitPropertyKeys["
|
|
193
|
-
/** Contract end date (Sales - Visit) */
|
|
194
|
-
VisitPropertyKeys["ContractEndDate"] = "ContractEndDate";
|
|
189
|
+
/** Unique delivery point reference number (Sales - Visit) */
|
|
190
|
+
VisitPropertyKeys["Udprn"] = "UDPRN";
|
|
191
|
+
/** unique multiple point reference number (Sales - Visit) */
|
|
192
|
+
VisitPropertyKeys["Umprn"] = "UMPRN";
|
|
195
193
|
/** longitude and latitude coordinates (Sales - Visit) */
|
|
196
194
|
VisitPropertyKeys["Coordinates"] = "Coordinates";
|
|
195
|
+
/** outcome Interested closer description (Sales - Visit) */
|
|
196
|
+
VisitPropertyKeys["InterestedReason"] = "InterestedReason";
|
|
197
|
+
/** Status indicator for Visit records. Tracks lifecycle state. Used by Sales team. */
|
|
198
|
+
VisitPropertyKeys["Status"] = "Status";
|
|
197
199
|
/** Current Price (Sales - Visit) */
|
|
198
200
|
VisitPropertyKeys["CurrentPrice"] = "CurrentPrice";
|
|
199
|
-
/** Current provider (Sales - Visit) */
|
|
200
|
-
VisitPropertyKeys["CurrentProvider"] = "CurrentProvider";
|
|
201
201
|
/** Reference identifier for Visit relationships. Used for data integrity. */
|
|
202
202
|
VisitPropertyKeys["DataSetId"] = "DataSetId";
|
|
203
203
|
/** DoNotKnockReason (Sales - Visit) */
|
|
204
204
|
VisitPropertyKeys["DoNotKnockReason"] = "DoNotKnockReason";
|
|
205
|
-
/**
|
|
206
|
-
VisitPropertyKeys["
|
|
207
|
-
/**
|
|
208
|
-
VisitPropertyKeys["
|
|
205
|
+
/** Data field for Visit records. Used by Sales team. */
|
|
206
|
+
VisitPropertyKeys["Latitude"] = "Latitude";
|
|
207
|
+
/** outcome of the visit (Sales - Visit) */
|
|
208
|
+
VisitPropertyKeys["Outcome"] = "Outcome";
|
|
209
|
+
/** the age bracket of the person (Sales - Visit) */
|
|
210
|
+
VisitPropertyKeys["AgeBracket"] = "AgeBracket";
|
|
211
|
+
/** Leave comments about the visit (Sales - Visit) */
|
|
212
|
+
VisitPropertyKeys["Comments"] = "Comments";
|
|
213
|
+
/** Contract end date (Sales - Visit) */
|
|
214
|
+
VisitPropertyKeys["ContractEndDate"] = "ContractEndDate";
|
|
215
|
+
/** Current provider (Sales - Visit) */
|
|
216
|
+
VisitPropertyKeys["CurrentProvider"] = "CurrentProvider";
|
|
209
217
|
/** the full address of the visit (Sales - Visit) */
|
|
210
218
|
VisitPropertyKeys["FullAddress"] = "FullAddress";
|
|
211
|
-
/** outcome Interested closer description (Sales - Visit) */
|
|
212
|
-
VisitPropertyKeys["InterestedReason"] = "InterestedReason";
|
|
213
219
|
/** the id of the l2 polygon (Sales - Visit) */
|
|
214
220
|
VisitPropertyKeys["L2PolygonId"] = "L2PolygonId";
|
|
215
221
|
/** Data field for Visit records. Used by Sales team. */
|
|
216
|
-
VisitPropertyKeys["Latitude"] = "Latitude";
|
|
217
|
-
/** Data field for Visit records. Used by Sales team. */
|
|
218
222
|
VisitPropertyKeys["Longitude"] = "Longitude";
|
|
223
|
+
/** Download Speed (Sales - Visit) */
|
|
224
|
+
VisitPropertyKeys["DownloadSpeed"] = "DownloadSpeed";
|
|
225
|
+
/** date to follow up with the address (Sales - Visit) */
|
|
226
|
+
VisitPropertyKeys["FollowUpDate"] = "FollowUpDate";
|
|
219
227
|
/** outcome not_interested additional information (Sales - Visit) */
|
|
220
228
|
VisitPropertyKeys["NotInterestedReason"] = "NotInterestedReason";
|
|
221
|
-
/** outcome of the visit (Sales - Visit) */
|
|
222
|
-
VisitPropertyKeys["Outcome"] = "Outcome";
|
|
223
|
-
/** Status indicator for Visit records. Tracks lifecycle state. Used by Sales team. */
|
|
224
|
-
VisitPropertyKeys["Status"] = "Status";
|
|
225
|
-
/** Unique delivery point reference number (Sales - Visit) */
|
|
226
|
-
VisitPropertyKeys["Udprn"] = "UDPRN";
|
|
227
|
-
/** unique multiple point reference number (Sales - Visit) */
|
|
228
|
-
VisitPropertyKeys["Umprn"] = "UMPRN";
|
|
229
229
|
})(VisitPropertyKeys = exports.VisitPropertyKeys || (exports.VisitPropertyKeys = {}));
|
|
230
230
|
/**
|
|
231
231
|
* Visit entity from CrmModule
|