@d19n/youfibre-odin-sdk 2.0.172 → 2.0.176

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 (42) hide show
  1. package/README.md +16 -18
  2. package/dist/actions-v2/CreateContactDto.d.ts +2 -53
  3. package/dist/actions-v2/CreateLeadFromAddressDto.d.ts +2 -53
  4. package/dist/actions-v2/CreateSsraDto.d.ts +232 -0
  5. package/dist/actions-v2/CreateSsraDto.js +50 -0
  6. package/dist/actions-v2/MoveInspectionWorkOrderToInProgressSubstantialDto.d.ts +17 -254
  7. package/dist/actions-v2/MoveInspectionWorkOrderToInProgressSubstantialDto.js +1 -7
  8. package/dist/actions-v2/MoveInstallWorkOrderToInProgressSubstantialDto.d.ts +17 -254
  9. package/dist/actions-v2/MoveInstallWorkOrderToInProgressSubstantialDto.js +1 -7
  10. package/dist/actions-v2/MovePrePullWorkOrderToInProgressSubstantialDto.d.ts +17 -254
  11. package/dist/actions-v2/MovePrePullWorkOrderToInProgressSubstantialDto.js +1 -7
  12. package/dist/actions-v2/MoveRemediationWorkOrderToInProgressSubstantialDto.d.ts +17 -254
  13. package/dist/actions-v2/MoveRemediationWorkOrderToInProgressSubstantialDto.js +1 -7
  14. package/dist/actions-v2/MoveServiceWorkOrderToInProgressDto.d.ts +269 -3
  15. package/dist/actions-v2/MoveServiceWorkOrderToInProgressDto.js +61 -2
  16. package/dist/actions-v2/MoveServiceWorkOrderToInProgressSubstantialDto.d.ts +17 -254
  17. package/dist/actions-v2/MoveServiceWorkOrderToInProgressSubstantialDto.js +1 -7
  18. package/dist/actions-v2/MoveServiceWorkOrderToInProgressSupplierDto.d.ts +269 -3
  19. package/dist/actions-v2/MoveServiceWorkOrderToInProgressSupplierDto.js +61 -2
  20. package/dist/actions-v2/UpdateAdditionalCareDto.d.ts +1 -13
  21. package/dist/actions-v2/UpdateCallEventAfterProcessingDto.d.ts +8 -1
  22. package/dist/actions-v2/UpdateSsraDto.d.ts +17 -252
  23. package/dist/actions-v2/UpdateSsraDto.js +0 -4
  24. package/dist/actions-v2/UpdateWhitelistQueueAndEndTimeDto.d.ts +74 -0
  25. package/dist/actions-v2/UpdateWhitelistQueueAndEndTimeDto.js +52 -0
  26. package/dist/entities-v2/Contact.d.ts +32 -0
  27. package/dist/entities-v2/Contact.js +24 -2
  28. package/dist/entities-v2/SiteSpecificRiskAssessmentOutcomeForm.d.ts +99 -29
  29. package/dist/entities-v2/SiteSpecificRiskAssessmentOutcomeForm.js +46 -9
  30. package/dist/entities-v2/TwilioCallEvent.d.ts +18 -1
  31. package/dist/entities-v2/TwilioCallEvent.js +2 -0
  32. package/dist/records-v2/ContactRecord.d.ts +29 -0
  33. package/dist/records-v2/ContactRecord.js +36 -0
  34. package/dist/records-v2/OfferRecord.d.ts +70 -10
  35. package/dist/records-v2/OfferRecord.js +116 -17
  36. package/dist/records-v2/SiteSpecificRiskAssessmentOutcomeFormRecord.d.ts +3 -3
  37. package/dist/records-v2/SiteSpecificRiskAssessmentOutcomeFormRecord.js +3 -3
  38. package/dist/records-v2/WorkOrderRecord.d.ts +138 -16
  39. package/dist/records-v2/WorkOrderRecord.js +223 -24
  40. package/dist/records-v2/index.d.ts +1 -1
  41. package/dist/records-v2/index.js +4 -4
  42. package/package.json +1 -1
@@ -15,8 +15,8 @@ import { OdinRecord, OdinRecordCreateDto, OdinRecordUpdateDto, OdinRecordUpdated
15
15
  /**
16
16
  * Properties for CreateSsra action
17
17
  *
18
- * @property Required fields: 41
19
- * @property Optional fields: 7
18
+ * @property Required fields: 18
19
+ * @property Optional fields: 4
20
20
  */
21
21
  export interface CreateSsraProperties {
22
22
  /**
@@ -77,183 +77,44 @@ export interface CreateSsraProperties {
77
77
  */
78
78
  AnimalsAndPetsLockedAway: string;
79
79
  /**
80
- * ExternalWork
81
- *
82
- * Data field for SiteSpecificRiskAssessmentOutcomeForm records. Used by Field Operations team.
83
- * @type {ENUM}
84
- * @required
85
- */
86
- ExternalWork: string;
87
- /**
88
- * LaddersHarnessLanyardWorkingBeltPreCheck
89
- *
90
- * Data field for SiteSpecificRiskAssessmentOutcomeForm records. Used by Field Operations team.
91
- * @type {ENUM}
92
- * @required
93
- * @visibleWhen ExternalWork = ["OVERHEAD_ACCESS","OVERHEAD_AND_UNDERGROUND"]
94
- */
95
- LaddersHarnessLanyardWorkingBeltPreCheck: string;
96
- /**
97
- * FullTetraSetupAvailable
98
- *
99
- * Data field for SiteSpecificRiskAssessmentOutcomeForm records. Used by Field Operations team.
100
- * @type {ENUM}
101
- * @required
102
- * @visibleWhen ExternalWork = ["OVERHEAD_ACCESS","OVERHEAD_AND_UNDERGROUND"]
103
- */
104
- FullTetraSetupAvailable: string;
105
- /**
106
- * SashAndPuleyUsedForInstallation
107
- *
108
- * Data field for SiteSpecificRiskAssessmentOutcomeForm records. Used by Field Operations team.
109
- * @type {ENUM}
110
- * @required
111
- * @visibleWhen ExternalWork = ["OVERHEAD_ACCESS","OVERHEAD_AND_UNDERGROUND"]
112
- */
113
- SashAndPuleyUsedForInstallation: string;
114
- /**
115
- * PreUseCheckCompleted
116
- *
117
- * Data field for SiteSpecificRiskAssessmentOutcomeForm records. Used by Field Operations team.
80
+ * WorkAreaFreeFromHazards
118
81
  * @type {ENUM}
119
82
  * @required
120
- * @visibleWhen ExternalWork = ["OVERHEAD_ACCESS","OVERHEAD_AND_UNDERGROUND"]
121
- */
122
- PreUseCheckCompleted: string;
123
- /**
124
- * SetupEvidenceAndAdditionalControls
125
- *
126
- * Reference identifier for SiteSpecificRiskAssessmentOutcomeForm relationships. Used for data integrity.
127
- * @type {TEXT_LONG}
128
- * @required
129
- * @visibleWhen ExternalWork = ["OVERHEAD_ACCESS","OVERHEAD_AND_UNDERGROUND"]
130
83
  */
131
- SetupEvidenceAndAdditionalControls: string;
84
+ WorkAreaFreeFromHazards: string;
132
85
  /**
133
- * SetupEvidenceAndAdditionalControlsPhoto
134
- *
135
- * Reference identifier for SiteSpecificRiskAssessmentOutcomeForm relationships. Used for data integrity.
136
- * @type {FILE_MULTIPLE}
137
- * @required
138
- * @visibleWhen ExternalWork = ["OVERHEAD_ACCESS","OVERHEAD_AND_UNDERGROUND"]
139
- */
140
- SetupEvidenceAndAdditionalControlsPhoto: string;
141
- /**
142
- * AllChambersSufficiallyGuarded
143
- *
144
- * Data field for SiteSpecificRiskAssessmentOutcomeForm records. Used by Field Operations team.
86
+ * CompletingDrillingWithinProperty
145
87
  * @type {ENUM}
146
88
  * @required
147
- * @visibleWhen ExternalWork = ["OVERHEAD_AND_UNDERGROUND","UNDERGROUND_ACCESS"]
148
89
  */
149
- AllChambersSufficiallyGuarded: string;
150
- /**
151
- * SetupDescriptionAndEvidence
152
- *
153
- * Reference identifier for SiteSpecificRiskAssessmentOutcomeForm relationships. Used for data integrity.
154
- * @type {TEXT_LONG}
155
- * @required
156
- * @visibleWhen ExternalWork = ["OVERHEAD_AND_UNDERGROUND","UNDERGROUND_ACCESS"]
157
- */
158
- SetupDescriptionAndEvidence: string;
159
- /**
160
- * SetupDescriptionAndEvidencePhoto
161
- *
162
- * Reference identifier for SiteSpecificRiskAssessmentOutcomeForm relationships. Used for data integrity.
163
- * @type {FILE_MULTIPLE}
164
- * @required
165
- * @visibleWhen ExternalWork = ["OVERHEAD_AND_UNDERGROUND","UNDERGROUND_ACCESS"]
166
- */
167
- SetupDescriptionAndEvidencePhoto: string;
168
- /**
169
- * GduChargedAndCalibrated
170
- *
171
- * Data field for SiteSpecificRiskAssessmentOutcomeForm records. Used by Field Operations team.
172
- * @type {ENUM}
173
- * @required
174
- * @visibleWhen ExternalWork = ["OVERHEAD_AND_UNDERGROUND","UNDERGROUND_ACCESS"]
175
- */
176
- GduChargedAndCalibrated: string;
177
- /**
178
- * GduChargedAndCalibratedPhoto
179
- *
180
- * Upload image (Field Operations - SiteSpecificRiskAssessmentOutcomeForm)
181
- * @type {FILE_MULTIPLE}
182
- * @required
183
- * @visibleWhen ExternalWork = ["OVERHEAD_AND_UNDERGROUND","UNDERGROUND_ACCESS"]
184
- */
185
- GduChargedAndCalibratedPhoto: string;
186
- /**
187
- * KeyLifterAndRollerBarAvailable
188
- *
189
- * Data field for SiteSpecificRiskAssessmentOutcomeForm records. Used by Field Operations team.
190
- * @type {ENUM}
191
- * @required
192
- * @visibleWhen ExternalWork = ["OVERHEAD_AND_UNDERGROUND","UNDERGROUND_ACCESS"]
193
- */
194
- KeyLifterAndRollerBarAvailable: string;
195
- /**
196
- * InternalWork
197
- *
198
- * Data field for SiteSpecificRiskAssessmentOutcomeForm records. Used by Field Operations team.
199
- * @type {ENUM}
200
- * @required
201
- */
202
- InternalWork: string;
90
+ CompletingDrillingWithinProperty: string;
203
91
  /**
204
92
  * SafetyGlassesEarDefendersDustMaskAvailable
205
93
  *
206
94
  * Data field for SiteSpecificRiskAssessmentOutcomeForm records. Used by Field Operations team.
207
95
  * @type {ENUM}
208
96
  * @required
209
- * @visibleWhen InternalWork = ["YES"]
97
+ * @visibleWhen CompletingDrillingWithinProperty = ["YES"]
210
98
  */
211
99
  SafetyGlassesEarDefendersDustMaskAvailable: string;
212
100
  /**
213
- * AccessToCustomerPropertySafe
214
- *
215
- * Data field for SiteSpecificRiskAssessmentOutcomeForm records. Used by Field Operations team.
216
- * @type {ENUM}
217
- * @required
218
- * @visibleWhen InternalWork = ["YES"]
219
- */
220
- AccessToCustomerPropertySafe: string;
221
- /**
222
- * DrillConfirmationDrillOut
223
- *
224
- * Data field for SiteSpecificRiskAssessmentOutcomeForm records. Used by Field Operations team.
225
- * @type {ENUM}
226
- * @required
227
- * @visibleWhen InternalWork = ["YES"]
228
- */
229
- DrillConfirmationDrillOut: string;
230
- /**
231
- * DrillConfirmationDrillOutPhoto
101
+ * DrillConfirmationOntMountPhoto
232
102
  *
233
103
  * Please add image (Field Operations - SiteSpecificRiskAssessmentOutcomeForm)
234
104
  * @type {FILE_MULTIPLE}
235
105
  * @required
236
- * @visibleWhen InternalWork = ["YES"]
106
+ * @visibleWhen CompletingDrillingWithinProperty = ["YES"]
237
107
  */
238
- DrillConfirmationDrillOutPhoto: string;
239
- /**
240
- * DrillConfirmationOntMount
241
- *
242
- * Data field for SiteSpecificRiskAssessmentOutcomeForm records. Used by Field Operations team.
243
- * @type {ENUM}
244
- * @required
245
- * @visibleWhen InternalWork = ["YES"]
246
- */
247
- DrillConfirmationOntMount: string;
108
+ DrillConfirmationOntMountPhoto: string;
248
109
  /**
249
- * DrillConfirmationOntMountPhoto
110
+ * DrillConfirmationDrillOutPhoto
250
111
  *
251
112
  * Please add image (Field Operations - SiteSpecificRiskAssessmentOutcomeForm)
252
113
  * @type {FILE_MULTIPLE}
253
114
  * @required
254
- * @visibleWhen InternalWork = ["YES"]
115
+ * @visibleWhen CompletingDrillingWithinProperty = ["YES"]
255
116
  */
256
- DrillConfirmationOntMountPhoto: string;
117
+ DrillConfirmationDrillOutPhoto: string;
257
118
  /**
258
119
  * EquipmentDefects
259
120
  *
@@ -263,88 +124,18 @@ export interface CreateSsraProperties {
263
124
  */
264
125
  EquipmentDefects: string;
265
126
  /**
266
- * RemediationIncluded
267
- *
268
- * Data field for SiteSpecificRiskAssessmentOutcomeForm records. Used by Field Operations team.
127
+ * AreThereAnyAdditionalHazards
269
128
  * @type {ENUM}
270
129
  * @required
271
130
  */
272
- RemediationIncluded: string;
273
- /**
274
- * RemediationIncludedPhoto
275
- *
276
- * Please add photo (Field Operations - SiteSpecificRiskAssessmentOutcomeForm)
277
- * @type {FILE_MULTIPLE}
278
- * @required
279
- * @visibleWhen RemediationIncluded = ["YES"]
280
- */
281
- RemediationIncludedPhoto: string;
282
- /**
283
- * RemediationIncludedExplanation
284
- *
285
- * Data field for SiteSpecificRiskAssessmentOutcomeForm records. Used by Field Operations team.
286
- * @type {TEXT_LONG}
287
- * @required
288
- * @visibleWhen RemediationIncluded = ["YES"]
289
- */
290
- RemediationIncludedExplanation: string;
291
- /**
292
- * SafeToProceedOnRemediationWork
293
- *
294
- * Data field for SiteSpecificRiskAssessmentOutcomeForm records. Used by Field Operations team.
295
- * @type {ENUM}
296
- * @required
297
- * @visibleWhen RemediationIncluded = ["YES"]
298
- */
299
- SafeToProceedOnRemediationWork: string;
300
- /**
301
- * AsbestosRegisterPhoto
302
- *
303
- * Data field for SiteSpecificRiskAssessmentOutcomeForm records. Used by Field Operations team.
304
- * @type {FILE_MULTIPLE}
305
- * @required
306
- * @visibleWhen BusinessInstallSurveyCompleted = ["YES"]
307
- */
308
- AsbestosRegisterPhoto: string;
309
- /**
310
- * AsbestosRegisterExplanation
311
- *
312
- * Data field for SiteSpecificRiskAssessmentOutcomeForm records. Used by Field Operations team.
313
- * @type {TEXT_LONG}
314
- * @required
315
- * @visibleWhen BusinessInstallSurveyCompleted = ["YES"]
316
- */
317
- AsbestosRegisterExplanation: string;
318
- /**
319
- * PhotoOfSetupBeforeWork
320
- *
321
- * Please add photo (Field Operations - SiteSpecificRiskAssessmentOutcomeForm)
322
- * @type {FILE_MULTIPLE}
323
- * @required
324
- */
325
- PhotoOfSetupBeforeWork: string;
326
- /**
327
- * AdditionalHazardsOnSite
328
- *
329
- * Data field for SiteSpecificRiskAssessmentOutcomeForm records. Used by Field Operations team.
330
- * @type {TEXT_LONG}
331
- * @required
332
- */
333
- AdditionalHazardsOnSite: string;
334
- /**
335
- * AdditionalHazardsOnSitePhoto
336
- *
337
- * Data field for SiteSpecificRiskAssessmentOutcomeForm records. Used by Field Operations team.
338
- * @type {FILE_MULTIPLE}
339
- * @required
340
- */
341
- AdditionalHazardsOnSitePhoto: string;
131
+ AreThereAnyAdditionalHazards: string;
342
132
  /**
343
133
  * AdditionalControlsOnSite
344
134
  *
345
135
  * Data field for SiteSpecificRiskAssessmentOutcomeForm records. Used by Field Operations team.
346
136
  * @type {TEXT_LONG}
347
137
  * @required
138
+ * @visibleWhen AreThereAnyAdditionalHazards = ["YES"]
348
139
  */
349
140
  AdditionalControlsOnSite: string;
350
141
  /**
@@ -353,6 +144,7 @@ export interface CreateSsraProperties {
353
144
  * Data field for SiteSpecificRiskAssessmentOutcomeForm records. Used by Field Operations team.
354
145
  * @type {FILE_MULTIPLE}
355
146
  * @required
147
+ * @visibleWhen AreThereAnyAdditionalHazards = ["YES"]
356
148
  */
357
149
  AdditionalControlsOnSitePhoto: string;
358
150
  /**
@@ -395,14 +187,6 @@ export interface CreateSsraProperties {
395
187
  * @visibleWhen CorrectPpe = ["NO"]
396
188
  */
397
189
  PpeAlert?: string | null;
398
- /**
399
- * AnimalsAndPetsAlert
400
- *
401
- * Data field for SiteSpecificRiskAssessmentOutcomeForm records. Used by Field Operations team.
402
- * @type {TEXT}
403
- * @visibleWhen AnimalsAndPetsLockedAway = ["NO"]
404
- */
405
- AnimalsAndPetsAlert?: string | null;
406
190
  /**
407
191
  * EquipmentDefectiveAlert
408
192
  *
@@ -411,31 +195,13 @@ export interface CreateSsraProperties {
411
195
  * @visibleWhen EquipmentDefects = ["DEFECTIVE"]
412
196
  */
413
197
  EquipmentDefectiveAlert?: string | null;
414
- /**
415
- * BusinessInstallSurveyCompleted
416
- *
417
- * Data field for SiteSpecificRiskAssessmentOutcomeForm records. Used by Field Operations team.
418
- * @type {ENUM}
419
- */
420
- BusinessInstallSurveyCompleted?: string | null;
421
- /**
422
- * BusinessInstallSurveyAlert
423
- *
424
- * Data field for SiteSpecificRiskAssessmentOutcomeForm records. Used by Field Operations team.
425
- * @type {TEXT}
426
- * @visibleWhen BusinessInstallSurveyCompleted = ["NO"]
427
- */
428
- BusinessInstallSurveyAlert?: string | null;
429
198
  }
430
199
  /**
431
200
  * CreateSsra
432
201
  *
433
- * Create Site Specific Risk Assessment Outcome Form
434
- *
435
202
  * @actionType CREATE - Creates a new SiteSpecificRiskAssessmentOutcomeForm record
436
203
  * @module FieldServiceModule
437
204
  * @entity SiteSpecificRiskAssessmentOutcomeForm
438
- * @entityType OUTCOME_FORM (outcome form)
439
205
  * @event k1.t-hEOJjsDb.FieldServiceModule.SiteSpecificRiskAssessmentOutcomeForm.Create.CreateSsra
440
206
  * @permission schema.action.createssra.trigger
441
207
  * @benchmark This action is tracked for performance benchmarks
@@ -446,15 +212,12 @@ export declare class CreateSsraDto extends OdinRecordCreateDto<CreateSsraPropert
446
212
  static readonly ACTION_KEY = "CreateSsra";
447
213
  static readonly MODULE_NAME = "FieldServiceModule";
448
214
  static readonly ENTITIES: string[];
449
- static readonly ENTITY_TYPE = "OUTCOME_FORM";
450
215
  static readonly EVENT_NAME = "k1.t-hEOJjsDb.FieldServiceModule.SiteSpecificRiskAssessmentOutcomeForm.Create.CreateSsra";
451
216
  static readonly PERMISSION = "schema.action.createssra.trigger";
452
217
  /** Step metadata - entity this action targets */
453
218
  static readonly STEP_ENTITY = "FieldServiceModule:SiteSpecificRiskAssessmentOutcomeForm";
454
219
  static readonly STEP_SCHEMA_ID = "6380e75c-a0cc-43e8-a57e-dabc00310d16";
455
220
  static readonly STEP_SCHEMA_ACTION_ID = "a17ac2ef-f23e-4183-8aba-92ea3debd5fb";
456
- static readonly STEP_SCHEMA_TYPE_ID = "738369fe-e7c8-4d10-b651-73d69fda5fd0";
457
- static readonly STEP_TYPE = "OUTCOME_FORM";
458
221
  static readonly AUTO_LINK_PARENT = true;
459
222
  readonly actionName: string;
460
223
  readonly schemaActionId: string;
@@ -18,12 +18,9 @@ const core_1 = require("@d19n/odin-types/dist/core");
18
18
  /**
19
19
  * CreateSsra
20
20
  *
21
- * Create Site Specific Risk Assessment Outcome Form
22
- *
23
21
  * @actionType CREATE - Creates a new SiteSpecificRiskAssessmentOutcomeForm record
24
22
  * @module FieldServiceModule
25
23
  * @entity SiteSpecificRiskAssessmentOutcomeForm
26
- * @entityType OUTCOME_FORM (outcome form)
27
24
  * @event k1.t-hEOJjsDb.FieldServiceModule.SiteSpecificRiskAssessmentOutcomeForm.Create.CreateSsra
28
25
  * @permission schema.action.createssra.trigger
29
26
  * @benchmark This action is tracked for performance benchmarks
@@ -32,7 +29,7 @@ class CreateSsraDto extends core_1.OdinRecordCreateDto {
32
29
  constructor(properties, options) {
33
30
  super({
34
31
  entity: 'FieldServiceModule:SiteSpecificRiskAssessmentOutcomeForm',
35
- type: 'OUTCOME_FORM',
32
+ type: undefined,
36
33
  properties,
37
34
  journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
38
35
  });
@@ -47,15 +44,12 @@ CreateSsraDto.ACTION_TYPE = 'CREATE';
47
44
  CreateSsraDto.ACTION_KEY = 'CreateSsra';
48
45
  CreateSsraDto.MODULE_NAME = 'FieldServiceModule';
49
46
  CreateSsraDto.ENTITIES = ['SiteSpecificRiskAssessmentOutcomeForm'];
50
- CreateSsraDto.ENTITY_TYPE = 'OUTCOME_FORM';
51
47
  CreateSsraDto.EVENT_NAME = 'k1.t-hEOJjsDb.FieldServiceModule.SiteSpecificRiskAssessmentOutcomeForm.Create.CreateSsra';
52
48
  CreateSsraDto.PERMISSION = 'schema.action.createssra.trigger';
53
49
  /** Step metadata - entity this action targets */
54
50
  CreateSsraDto.STEP_ENTITY = 'FieldServiceModule:SiteSpecificRiskAssessmentOutcomeForm';
55
51
  CreateSsraDto.STEP_SCHEMA_ID = '6380e75c-a0cc-43e8-a57e-dabc00310d16';
56
52
  CreateSsraDto.STEP_SCHEMA_ACTION_ID = 'a17ac2ef-f23e-4183-8aba-92ea3debd5fb';
57
- CreateSsraDto.STEP_SCHEMA_TYPE_ID = '738369fe-e7c8-4d10-b651-73d69fda5fd0';
58
- CreateSsraDto.STEP_TYPE = 'OUTCOME_FORM';
59
53
  CreateSsraDto.AUTO_LINK_PARENT = true;
60
54
  /**
61
55
  * Type-safe step keys for MoveInspectionWorkOrderToInProgressSubstantial