@d19n/youfibre-odin-sdk 2.0.359 → 2.0.360
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/README.md +1 -1
- package/dist/actions-v2/CreateCollectionAmcoFollowOnWorkOrderDto.d.ts +105 -20
- package/dist/actions-v2/CreateCollectionAmcoFollowOnWorkOrderDto.js +14 -16
- package/dist/entities-v2/WorkOrder.d.ts +99 -1
- package/dist/entities-v2/WorkOrder.js +2 -0
- package/dist/records-v2/WorkOrderRecord.d.ts +28 -27
- package/dist/records-v2/WorkOrderRecord.js +36 -37
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -503,7 +503,7 @@ This SDK includes **933** actions.
|
|
|
503
503
|
| `CompleteServiceWorkOrderFlow` | STAGE_TRANSITION | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Update.CompleteServiceWorkOrder |
|
|
504
504
|
| `CompleteServiceWorkOrderFlowSupplier` | STAGE_TRANSITION | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.CompleteServiceWorkOrderFlowSupplier |
|
|
505
505
|
| `CreateCancelCollectionAmco` | CREATE | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Create.CreateCancelCollectionAmco |
|
|
506
|
-
| `CreateCollectionAmcoFollowOnWorkOrder` |
|
|
506
|
+
| `CreateCollectionAmcoFollowOnWorkOrder` | CREATE | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Create.CreateCollectionAmcoFollowOnWorkOrder |
|
|
507
507
|
| `CreateCollectionAmcoReplacementWorkOrder` | CREATE | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Create.CreateCollectionAmcoReplacementWorkOrder |
|
|
508
508
|
| `CreateCollectionAmcoReplacementWorkOrderFromWorkOrder` | CREATE | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Create.CreateCollectionAmcoReplacementWorkOrder |
|
|
509
509
|
| `CreateCollectionAmcoWorkOrder` | CREATE | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Create.CreateCollectionAmcoWorkOrder |
|
|
@@ -1,68 +1,153 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* CreateCollectionAmcoFollowOnWorkOrder Action DTO
|
|
3
3
|
*
|
|
4
|
-
* Send the customer another bag for the devices a failed inspection found missing. Creates a linked 3PL collection for only those devices
|
|
4
|
+
* Send the customer another bag for the devices a failed inspection found missing. Creates a linked 3PL collection for only those devices; the first one then moves to Complete.
|
|
5
5
|
*
|
|
6
6
|
* @module FieldServiceModule
|
|
7
7
|
* @entity WorkOrder
|
|
8
8
|
* @entityType COLLECTION_AMCO
|
|
9
9
|
* @actionKey CreateCollectionAmcoFollowOnWorkOrder
|
|
10
|
-
* @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.
|
|
10
|
+
* @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Create.CreateCollectionAmcoFollowOnWorkOrder
|
|
11
11
|
*
|
|
12
12
|
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
13
13
|
*/
|
|
14
|
-
import {
|
|
14
|
+
import { OdinRecordCreateDto, OdinRecordCreatedEvent } from '@d19n/odin-types/dist/core';
|
|
15
15
|
/**
|
|
16
|
-
* RabbitMQ message payload for CreateCollectionAmcoFollowOnWorkOrder
|
|
16
|
+
* RabbitMQ message payload for CreateCollectionAmcoFollowOnWorkOrder created events
|
|
17
17
|
*
|
|
18
|
-
* @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.
|
|
18
|
+
* @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Create.CreateCollectionAmcoFollowOnWorkOrder
|
|
19
19
|
*/
|
|
20
|
-
export interface CreateCollectionAmcoFollowOnWorkOrderMessage extends
|
|
20
|
+
export interface CreateCollectionAmcoFollowOnWorkOrderMessage extends OdinRecordCreatedEvent<CreateCollectionAmcoFollowOnWorkOrderDto, CreateCollectionAmcoFollowOnWorkOrderProperties> {
|
|
21
21
|
}
|
|
22
22
|
/**
|
|
23
23
|
* Properties for CreateCollectionAmcoFollowOnWorkOrder action
|
|
24
24
|
*
|
|
25
|
+
* @property Required fields: 0
|
|
26
|
+
* @property Optional fields: 11
|
|
25
27
|
*/
|
|
26
28
|
export interface CreateCollectionAmcoFollowOnWorkOrderProperties {
|
|
29
|
+
/**
|
|
30
|
+
* FollowOnOfWorkOrderId
|
|
31
|
+
*
|
|
32
|
+
* On a follow-on COLLECTION_AMCO (a second bag for a partial return): the id of the collection whose missing devices it collects. Set from that collection by CreateCollectionAmcoFollowOnWorkOrder. Null on every other work order
|
|
33
|
+
* @type {UUID}
|
|
34
|
+
* @default Dynamic: {source_record_id}
|
|
35
|
+
*/
|
|
36
|
+
FollowOnOfWorkOrderId?: string | null;
|
|
37
|
+
/**
|
|
38
|
+
* OrderId
|
|
39
|
+
*
|
|
40
|
+
* Reference identifier for WorkOrder relationships. Used for data integrity.
|
|
41
|
+
* @type {LOOKUP}
|
|
42
|
+
* @default Dynamic: {source_record_properties_OrderId}
|
|
43
|
+
*/
|
|
44
|
+
OrderId?: string | null;
|
|
45
|
+
/**
|
|
46
|
+
* UseAlternativeAddress
|
|
47
|
+
*
|
|
48
|
+
* Use an Alternative Address instead of the linked order's address (Field Operations - WorkOrder)
|
|
49
|
+
* @type {BOOLEAN}
|
|
50
|
+
* @default Dynamic: {source_record_properties_UseAlternativeAddress}
|
|
51
|
+
*/
|
|
52
|
+
UseAlternativeAddress?: boolean | null;
|
|
53
|
+
/**
|
|
54
|
+
* UseAlternativeAddressManual
|
|
55
|
+
*
|
|
56
|
+
* UseAlternativeAddressManual (Field Operations - WorkOrder)
|
|
57
|
+
* @type {BOOLEAN}
|
|
58
|
+
* @default Dynamic: {source_record_properties_UseAlternativeAddressManual}
|
|
59
|
+
*/
|
|
60
|
+
UseAlternativeAddressManual?: boolean | null;
|
|
61
|
+
/**
|
|
62
|
+
* AlternativeAddress
|
|
63
|
+
*
|
|
64
|
+
* Alternative Address (Field Operations - WorkOrder)
|
|
65
|
+
* @type {LOOKUP}
|
|
66
|
+
* @default Dynamic: {source_record_properties_AlternativeAddress}
|
|
67
|
+
*/
|
|
68
|
+
AlternativeAddress?: string | null;
|
|
69
|
+
/**
|
|
70
|
+
* AlternativeAddressLine1
|
|
71
|
+
*
|
|
72
|
+
* Contact information field for WorkOrder. Used by Field Operations team for communication.
|
|
73
|
+
* @type {TEXT}
|
|
74
|
+
* @default Dynamic: {source_record_properties_AlternativeAddressLine1}
|
|
75
|
+
*/
|
|
76
|
+
AlternativeAddressLine1?: string | null;
|
|
77
|
+
/**
|
|
78
|
+
* AlternativeAddressLine2
|
|
79
|
+
*
|
|
80
|
+
* Contact information field for WorkOrder. Used by Field Operations team for communication.
|
|
81
|
+
* @type {TEXT}
|
|
82
|
+
* @default Dynamic: {source_record_properties_AlternativeAddressLine2}
|
|
83
|
+
*/
|
|
84
|
+
AlternativeAddressLine2?: string | null;
|
|
85
|
+
/**
|
|
86
|
+
* AlternativeAddressCityTown
|
|
87
|
+
*
|
|
88
|
+
* Contact information field for WorkOrder. Used by Field Operations team for communication.
|
|
89
|
+
* @type {TEXT}
|
|
90
|
+
* @default Dynamic: {source_record_properties_AlternativeAddressCityTown}
|
|
91
|
+
*/
|
|
92
|
+
AlternativeAddressCityTown?: string | null;
|
|
93
|
+
/**
|
|
94
|
+
* AlternativeAddressPostCode
|
|
95
|
+
*
|
|
96
|
+
* Contact information field for WorkOrder. Used by Field Operations team for communication.
|
|
97
|
+
* @type {TEXT}
|
|
98
|
+
* @default Dynamic: {source_record_properties_AlternativeAddressPostCode}
|
|
99
|
+
*/
|
|
100
|
+
AlternativeAddressPostCode?: string | null;
|
|
101
|
+
/**
|
|
102
|
+
* UseAlternativeContact
|
|
103
|
+
*
|
|
104
|
+
* Use Alternative Contact (Field Operations - WorkOrder)
|
|
105
|
+
* @type {BOOLEAN}
|
|
106
|
+
* @default Dynamic: {source_record_properties_UseAlternativeContact}
|
|
107
|
+
*/
|
|
108
|
+
UseAlternativeContact?: boolean | null;
|
|
109
|
+
/**
|
|
110
|
+
* AlternativeContact
|
|
111
|
+
*
|
|
112
|
+
* Alternative Contact (Field Operations - WorkOrder)
|
|
113
|
+
* @type {LOOKUP}
|
|
114
|
+
* @default Dynamic: {source_record_properties_AlternativeContact}
|
|
115
|
+
*/
|
|
116
|
+
AlternativeContact?: string | null;
|
|
27
117
|
}
|
|
28
118
|
/**
|
|
29
119
|
* Send Another Bag
|
|
30
120
|
*
|
|
31
|
-
* Send the customer another bag for the devices a failed inspection found missing. Creates a linked 3PL collection for only those devices
|
|
121
|
+
* Send the customer another bag for the devices a failed inspection found missing. Creates a linked 3PL collection for only those devices; the first one then moves to Complete.
|
|
32
122
|
*
|
|
33
|
-
* @actionType
|
|
123
|
+
* @actionType CREATE - Creates a new WorkOrder record
|
|
34
124
|
* @module FieldServiceModule
|
|
35
125
|
* @entity WorkOrder
|
|
36
126
|
* @entityType COLLECTION_AMCO ( 3PL Collection)
|
|
37
|
-
* @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.
|
|
127
|
+
* @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Create.CreateCollectionAmcoFollowOnWorkOrder
|
|
38
128
|
* @permission schema.action.createcollectionamcofollowonworkorder.trigger
|
|
39
129
|
* @benchmark This action is tracked for performance benchmarks
|
|
40
130
|
*/
|
|
41
|
-
export declare class CreateCollectionAmcoFollowOnWorkOrderDto extends
|
|
131
|
+
export declare class CreateCollectionAmcoFollowOnWorkOrderDto extends OdinRecordCreateDto<CreateCollectionAmcoFollowOnWorkOrderProperties> {
|
|
42
132
|
/** Used by SDK generators to identify action type */
|
|
43
|
-
static readonly ACTION_TYPE = "
|
|
133
|
+
static readonly ACTION_TYPE = "CREATE";
|
|
44
134
|
static readonly ACTION_KEY = "CreateCollectionAmcoFollowOnWorkOrder";
|
|
45
135
|
static readonly MODULE_NAME = "FieldServiceModule";
|
|
46
136
|
static readonly ENTITIES: string[];
|
|
47
137
|
static readonly ENTITY_TYPE = "COLLECTION_AMCO";
|
|
48
|
-
static readonly EVENT_NAME = "k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.
|
|
138
|
+
static readonly EVENT_NAME = "k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Create.CreateCollectionAmcoFollowOnWorkOrder";
|
|
49
139
|
static readonly PERMISSION = "schema.action.createcollectionamcofollowonworkorder.trigger";
|
|
50
140
|
/** Step metadata - entity this action targets */
|
|
51
141
|
static readonly STEP_ENTITY = "FieldServiceModule:WorkOrder";
|
|
52
142
|
static readonly STEP_SCHEMA_ID = "966bf5d9-163e-4132-85e2-56a5f801c9de";
|
|
53
|
-
static readonly STEP_SCHEMA_ACTION_ID = "
|
|
143
|
+
static readonly STEP_SCHEMA_ACTION_ID = "54b76d67-a8ea-410a-b157-3f0dc20ab092";
|
|
54
144
|
static readonly STEP_SCHEMA_TYPE_ID = "0bf773b2-9054-457e-a282-5ae8fdfa7f7c";
|
|
55
145
|
static readonly STEP_TYPE = "COLLECTION_AMCO";
|
|
56
|
-
static readonly AUTO_LINK_PARENT =
|
|
146
|
+
static readonly AUTO_LINK_PARENT = true;
|
|
57
147
|
readonly actionName: string;
|
|
58
148
|
readonly schemaActionId: string;
|
|
59
149
|
readonly entity: string;
|
|
60
|
-
constructor(
|
|
61
|
-
id: string;
|
|
62
|
-
entity: string;
|
|
63
|
-
type?: string;
|
|
64
|
-
}, properties: CreateCollectionAmcoFollowOnWorkOrderProperties, options?: {
|
|
150
|
+
constructor(properties: CreateCollectionAmcoFollowOnWorkOrderProperties, options?: {
|
|
65
151
|
journeyId?: string;
|
|
66
|
-
stageKey?: string;
|
|
67
152
|
});
|
|
68
153
|
}
|
|
@@ -2,13 +2,13 @@
|
|
|
2
2
|
/**
|
|
3
3
|
* CreateCollectionAmcoFollowOnWorkOrder Action DTO
|
|
4
4
|
*
|
|
5
|
-
* Send the customer another bag for the devices a failed inspection found missing. Creates a linked 3PL collection for only those devices
|
|
5
|
+
* Send the customer another bag for the devices a failed inspection found missing. Creates a linked 3PL collection for only those devices; the first one then moves to Complete.
|
|
6
6
|
*
|
|
7
7
|
* @module FieldServiceModule
|
|
8
8
|
* @entity WorkOrder
|
|
9
9
|
* @entityType COLLECTION_AMCO
|
|
10
10
|
* @actionKey CreateCollectionAmcoFollowOnWorkOrder
|
|
11
|
-
* @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.
|
|
11
|
+
* @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Create.CreateCollectionAmcoFollowOnWorkOrder
|
|
12
12
|
*
|
|
13
13
|
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
14
14
|
*/
|
|
@@ -18,44 +18,42 @@ const core_1 = require("@d19n/odin-types/dist/core");
|
|
|
18
18
|
/**
|
|
19
19
|
* Send Another Bag
|
|
20
20
|
*
|
|
21
|
-
* Send the customer another bag for the devices a failed inspection found missing. Creates a linked 3PL collection for only those devices
|
|
21
|
+
* Send the customer another bag for the devices a failed inspection found missing. Creates a linked 3PL collection for only those devices; the first one then moves to Complete.
|
|
22
22
|
*
|
|
23
|
-
* @actionType
|
|
23
|
+
* @actionType CREATE - Creates a new WorkOrder record
|
|
24
24
|
* @module FieldServiceModule
|
|
25
25
|
* @entity WorkOrder
|
|
26
26
|
* @entityType COLLECTION_AMCO ( 3PL Collection)
|
|
27
|
-
* @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.
|
|
27
|
+
* @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Create.CreateCollectionAmcoFollowOnWorkOrder
|
|
28
28
|
* @permission schema.action.createcollectionamcofollowonworkorder.trigger
|
|
29
29
|
* @benchmark This action is tracked for performance benchmarks
|
|
30
30
|
*/
|
|
31
|
-
class CreateCollectionAmcoFollowOnWorkOrderDto extends core_1.
|
|
32
|
-
constructor(
|
|
31
|
+
class CreateCollectionAmcoFollowOnWorkOrderDto extends core_1.OdinRecordCreateDto {
|
|
32
|
+
constructor(properties, options) {
|
|
33
33
|
super({
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
type: record.type,
|
|
34
|
+
entity: 'FieldServiceModule:WorkOrder',
|
|
35
|
+
type: 'COLLECTION_AMCO',
|
|
37
36
|
properties,
|
|
38
37
|
journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
|
|
39
|
-
stageKey: options === null || options === void 0 ? void 0 : options.stageKey,
|
|
40
38
|
});
|
|
41
39
|
this.actionName = 'CreateCollectionAmcoFollowOnWorkOrder';
|
|
42
|
-
this.schemaActionId = '
|
|
40
|
+
this.schemaActionId = '54b76d67-a8ea-410a-b157-3f0dc20ab092';
|
|
43
41
|
this.entity = 'FieldServiceModule:WorkOrder';
|
|
44
42
|
}
|
|
45
43
|
}
|
|
46
44
|
exports.CreateCollectionAmcoFollowOnWorkOrderDto = CreateCollectionAmcoFollowOnWorkOrderDto;
|
|
47
45
|
/** Used by SDK generators to identify action type */
|
|
48
|
-
CreateCollectionAmcoFollowOnWorkOrderDto.ACTION_TYPE = '
|
|
46
|
+
CreateCollectionAmcoFollowOnWorkOrderDto.ACTION_TYPE = 'CREATE';
|
|
49
47
|
CreateCollectionAmcoFollowOnWorkOrderDto.ACTION_KEY = 'CreateCollectionAmcoFollowOnWorkOrder';
|
|
50
48
|
CreateCollectionAmcoFollowOnWorkOrderDto.MODULE_NAME = 'FieldServiceModule';
|
|
51
49
|
CreateCollectionAmcoFollowOnWorkOrderDto.ENTITIES = ['WorkOrder'];
|
|
52
50
|
CreateCollectionAmcoFollowOnWorkOrderDto.ENTITY_TYPE = 'COLLECTION_AMCO';
|
|
53
|
-
CreateCollectionAmcoFollowOnWorkOrderDto.EVENT_NAME = 'k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.
|
|
51
|
+
CreateCollectionAmcoFollowOnWorkOrderDto.EVENT_NAME = 'k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Create.CreateCollectionAmcoFollowOnWorkOrder';
|
|
54
52
|
CreateCollectionAmcoFollowOnWorkOrderDto.PERMISSION = 'schema.action.createcollectionamcofollowonworkorder.trigger';
|
|
55
53
|
/** Step metadata - entity this action targets */
|
|
56
54
|
CreateCollectionAmcoFollowOnWorkOrderDto.STEP_ENTITY = 'FieldServiceModule:WorkOrder';
|
|
57
55
|
CreateCollectionAmcoFollowOnWorkOrderDto.STEP_SCHEMA_ID = '966bf5d9-163e-4132-85e2-56a5f801c9de';
|
|
58
|
-
CreateCollectionAmcoFollowOnWorkOrderDto.STEP_SCHEMA_ACTION_ID = '
|
|
56
|
+
CreateCollectionAmcoFollowOnWorkOrderDto.STEP_SCHEMA_ACTION_ID = '54b76d67-a8ea-410a-b157-3f0dc20ab092';
|
|
59
57
|
CreateCollectionAmcoFollowOnWorkOrderDto.STEP_SCHEMA_TYPE_ID = '0bf773b2-9054-457e-a282-5ae8fdfa7f7c';
|
|
60
58
|
CreateCollectionAmcoFollowOnWorkOrderDto.STEP_TYPE = 'COLLECTION_AMCO';
|
|
61
|
-
CreateCollectionAmcoFollowOnWorkOrderDto.AUTO_LINK_PARENT =
|
|
59
|
+
CreateCollectionAmcoFollowOnWorkOrderDto.AUTO_LINK_PARENT = true;
|
|
@@ -1699,7 +1699,9 @@ export declare enum WorkOrderPropertyKeys {
|
|
|
1699
1699
|
/** Whole pounds owed for the expected devices the Returns v2 inspection recorded as not returned, priced with the same table as EquipmentCharge. Stamped when the inspection is submitted: 0 when everything came back. Grade (damage) does not count. EquipmentCharge stays the quote made when the collection was raised. */
|
|
1700
1700
|
InspectionCharge = "InspectionCharge",
|
|
1701
1701
|
/** The missing devices behind InspectionCharge, counted by kind, same shape as EquipmentChargeBreakdown: {"MESH":1}. {} when everything came back. Kinds that cost nothing (ATA) are left out. */
|
|
1702
|
-
InspectionChargeBreakdown = "InspectionChargeBreakdown"
|
|
1702
|
+
InspectionChargeBreakdown = "InspectionChargeBreakdown",
|
|
1703
|
+
/** On a follow-on COLLECTION_AMCO (a second bag for a partial return): the id of the collection whose missing devices it collects. Set from that collection by CreateCollectionAmcoFollowOnWorkOrder. Null on every other work order */
|
|
1704
|
+
FollowOnOfWorkOrderId = "FollowOnOfWorkOrderId"
|
|
1703
1705
|
}
|
|
1704
1706
|
/**
|
|
1705
1707
|
* Properties for WorkOrder records
|
|
@@ -2524,6 +2526,12 @@ export interface WorkOrderProperties {
|
|
|
2524
2526
|
* @default
|
|
2525
2527
|
*/
|
|
2526
2528
|
InspectionChargeBreakdown: string;
|
|
2529
|
+
/** On a follow-on COLLECTION_AMCO (a second bag for a partial return): the id of the collection whose missing devices it collects. Set from that collection by CreateCollectionAmcoFollowOnWorkOrder. Null on every other work order
|
|
2530
|
+
*
|
|
2531
|
+
* @type {UUID}
|
|
2532
|
+
* @default
|
|
2533
|
+
*/
|
|
2534
|
+
FollowOnOfWorkOrderId: string;
|
|
2527
2535
|
}
|
|
2528
2536
|
/**
|
|
2529
2537
|
* Properties for COLLECTION WorkOrder records
|
|
@@ -3348,6 +3356,12 @@ export interface CollectionWorkOrderProperties {
|
|
|
3348
3356
|
* @default
|
|
3349
3357
|
*/
|
|
3350
3358
|
InspectionChargeBreakdown: string;
|
|
3359
|
+
/** On a follow-on COLLECTION_AMCO (a second bag for a partial return): the id of the collection whose missing devices it collects. Set from that collection by CreateCollectionAmcoFollowOnWorkOrder. Null on every other work order
|
|
3360
|
+
*
|
|
3361
|
+
* @type {UUID}
|
|
3362
|
+
* @default
|
|
3363
|
+
*/
|
|
3364
|
+
FollowOnOfWorkOrderId: string;
|
|
3351
3365
|
}
|
|
3352
3366
|
/**
|
|
3353
3367
|
* Properties for COLLECTION_AMCO WorkOrder records
|
|
@@ -4172,6 +4186,12 @@ export interface CollectionAmcoWorkOrderProperties {
|
|
|
4172
4186
|
* @default
|
|
4173
4187
|
*/
|
|
4174
4188
|
InspectionChargeBreakdown: string;
|
|
4189
|
+
/** On a follow-on COLLECTION_AMCO (a second bag for a partial return): the id of the collection whose missing devices it collects. Set from that collection by CreateCollectionAmcoFollowOnWorkOrder. Null on every other work order
|
|
4190
|
+
*
|
|
4191
|
+
* @type {UUID}
|
|
4192
|
+
* @default
|
|
4193
|
+
*/
|
|
4194
|
+
FollowOnOfWorkOrderId: string;
|
|
4175
4195
|
}
|
|
4176
4196
|
/**
|
|
4177
4197
|
* Properties for DISPATCH_AMCO WorkOrder records
|
|
@@ -4996,6 +5016,12 @@ export interface DispatchAmcoWorkOrderProperties {
|
|
|
4996
5016
|
* @default
|
|
4997
5017
|
*/
|
|
4998
5018
|
InspectionChargeBreakdown: string;
|
|
5019
|
+
/** On a follow-on COLLECTION_AMCO (a second bag for a partial return): the id of the collection whose missing devices it collects. Set from that collection by CreateCollectionAmcoFollowOnWorkOrder. Null on every other work order
|
|
5020
|
+
*
|
|
5021
|
+
* @type {UUID}
|
|
5022
|
+
* @default
|
|
5023
|
+
*/
|
|
5024
|
+
FollowOnOfWorkOrderId: string;
|
|
4999
5025
|
}
|
|
5000
5026
|
/**
|
|
5001
5027
|
* Properties for FINANCE WorkOrder records
|
|
@@ -5820,6 +5846,12 @@ export interface FinanceWorkOrderProperties {
|
|
|
5820
5846
|
* @default
|
|
5821
5847
|
*/
|
|
5822
5848
|
InspectionChargeBreakdown: string;
|
|
5849
|
+
/** On a follow-on COLLECTION_AMCO (a second bag for a partial return): the id of the collection whose missing devices it collects. Set from that collection by CreateCollectionAmcoFollowOnWorkOrder. Null on every other work order
|
|
5850
|
+
*
|
|
5851
|
+
* @type {UUID}
|
|
5852
|
+
* @default
|
|
5853
|
+
*/
|
|
5854
|
+
FollowOnOfWorkOrderId: string;
|
|
5823
5855
|
}
|
|
5824
5856
|
/**
|
|
5825
5857
|
* Properties for INSPECTION WorkOrder records
|
|
@@ -6644,6 +6676,12 @@ export interface InspectionWorkOrderProperties {
|
|
|
6644
6676
|
* @default
|
|
6645
6677
|
*/
|
|
6646
6678
|
InspectionChargeBreakdown: string;
|
|
6679
|
+
/** On a follow-on COLLECTION_AMCO (a second bag for a partial return): the id of the collection whose missing devices it collects. Set from that collection by CreateCollectionAmcoFollowOnWorkOrder. Null on every other work order
|
|
6680
|
+
*
|
|
6681
|
+
* @type {UUID}
|
|
6682
|
+
* @default
|
|
6683
|
+
*/
|
|
6684
|
+
FollowOnOfWorkOrderId: string;
|
|
6647
6685
|
}
|
|
6648
6686
|
/**
|
|
6649
6687
|
* Properties for INSTALL WorkOrder records
|
|
@@ -7468,6 +7506,12 @@ export interface InstallWorkOrderProperties {
|
|
|
7468
7506
|
* @default
|
|
7469
7507
|
*/
|
|
7470
7508
|
InspectionChargeBreakdown: string;
|
|
7509
|
+
/** On a follow-on COLLECTION_AMCO (a second bag for a partial return): the id of the collection whose missing devices it collects. Set from that collection by CreateCollectionAmcoFollowOnWorkOrder. Null on every other work order
|
|
7510
|
+
*
|
|
7511
|
+
* @type {UUID}
|
|
7512
|
+
* @default
|
|
7513
|
+
*/
|
|
7514
|
+
FollowOnOfWorkOrderId: string;
|
|
7471
7515
|
}
|
|
7472
7516
|
/**
|
|
7473
7517
|
* Properties for INSTALL_BUSINESS WorkOrder records
|
|
@@ -8292,6 +8336,12 @@ export interface InstallBusinessWorkOrderProperties {
|
|
|
8292
8336
|
* @default
|
|
8293
8337
|
*/
|
|
8294
8338
|
InspectionChargeBreakdown: string;
|
|
8339
|
+
/** On a follow-on COLLECTION_AMCO (a second bag for a partial return): the id of the collection whose missing devices it collects. Set from that collection by CreateCollectionAmcoFollowOnWorkOrder. Null on every other work order
|
|
8340
|
+
*
|
|
8341
|
+
* @type {UUID}
|
|
8342
|
+
* @default
|
|
8343
|
+
*/
|
|
8344
|
+
FollowOnOfWorkOrderId: string;
|
|
8295
8345
|
}
|
|
8296
8346
|
/**
|
|
8297
8347
|
* Properties for INSTALL_SERVICE WorkOrder records
|
|
@@ -9116,6 +9166,12 @@ export interface InstallServiceWorkOrderProperties {
|
|
|
9116
9166
|
* @default
|
|
9117
9167
|
*/
|
|
9118
9168
|
InspectionChargeBreakdown: string;
|
|
9169
|
+
/** On a follow-on COLLECTION_AMCO (a second bag for a partial return): the id of the collection whose missing devices it collects. Set from that collection by CreateCollectionAmcoFollowOnWorkOrder. Null on every other work order
|
|
9170
|
+
*
|
|
9171
|
+
* @type {UUID}
|
|
9172
|
+
* @default
|
|
9173
|
+
*/
|
|
9174
|
+
FollowOnOfWorkOrderId: string;
|
|
9119
9175
|
}
|
|
9120
9176
|
/**
|
|
9121
9177
|
* Properties for NETWORK_ADJUSTMENT WorkOrder records
|
|
@@ -9940,6 +9996,12 @@ export interface NetworkAdjustmentWorkOrderProperties {
|
|
|
9940
9996
|
* @default
|
|
9941
9997
|
*/
|
|
9942
9998
|
InspectionChargeBreakdown: string;
|
|
9999
|
+
/** On a follow-on COLLECTION_AMCO (a second bag for a partial return): the id of the collection whose missing devices it collects. Set from that collection by CreateCollectionAmcoFollowOnWorkOrder. Null on every other work order
|
|
10000
|
+
*
|
|
10001
|
+
* @type {UUID}
|
|
10002
|
+
* @default
|
|
10003
|
+
*/
|
|
10004
|
+
FollowOnOfWorkOrderId: string;
|
|
9943
10005
|
}
|
|
9944
10006
|
/**
|
|
9945
10007
|
* Properties for PLANNING WorkOrder records
|
|
@@ -10764,6 +10826,12 @@ export interface PlanningWorkOrderProperties {
|
|
|
10764
10826
|
* @default
|
|
10765
10827
|
*/
|
|
10766
10828
|
InspectionChargeBreakdown: string;
|
|
10829
|
+
/** On a follow-on COLLECTION_AMCO (a second bag for a partial return): the id of the collection whose missing devices it collects. Set from that collection by CreateCollectionAmcoFollowOnWorkOrder. Null on every other work order
|
|
10830
|
+
*
|
|
10831
|
+
* @type {UUID}
|
|
10832
|
+
* @default
|
|
10833
|
+
*/
|
|
10834
|
+
FollowOnOfWorkOrderId: string;
|
|
10767
10835
|
}
|
|
10768
10836
|
/**
|
|
10769
10837
|
* Properties for PRE_PULL WorkOrder records
|
|
@@ -11588,6 +11656,12 @@ export interface PrePullWorkOrderProperties {
|
|
|
11588
11656
|
* @default
|
|
11589
11657
|
*/
|
|
11590
11658
|
InspectionChargeBreakdown: string;
|
|
11659
|
+
/** On a follow-on COLLECTION_AMCO (a second bag for a partial return): the id of the collection whose missing devices it collects. Set from that collection by CreateCollectionAmcoFollowOnWorkOrder. Null on every other work order
|
|
11660
|
+
*
|
|
11661
|
+
* @type {UUID}
|
|
11662
|
+
* @default
|
|
11663
|
+
*/
|
|
11664
|
+
FollowOnOfWorkOrderId: string;
|
|
11591
11665
|
}
|
|
11592
11666
|
/**
|
|
11593
11667
|
* Properties for REMEDIATION WorkOrder records
|
|
@@ -12412,6 +12486,12 @@ export interface RemediationWorkOrderProperties {
|
|
|
12412
12486
|
* @default
|
|
12413
12487
|
*/
|
|
12414
12488
|
InspectionChargeBreakdown: string;
|
|
12489
|
+
/** On a follow-on COLLECTION_AMCO (a second bag for a partial return): the id of the collection whose missing devices it collects. Set from that collection by CreateCollectionAmcoFollowOnWorkOrder. Null on every other work order
|
|
12490
|
+
*
|
|
12491
|
+
* @type {UUID}
|
|
12492
|
+
* @default
|
|
12493
|
+
*/
|
|
12494
|
+
FollowOnOfWorkOrderId: string;
|
|
12415
12495
|
}
|
|
12416
12496
|
/**
|
|
12417
12497
|
* Properties for REPLACEMENT_AMCO WorkOrder records
|
|
@@ -13236,6 +13316,12 @@ export interface ReplacementAmcoWorkOrderProperties {
|
|
|
13236
13316
|
* @default
|
|
13237
13317
|
*/
|
|
13238
13318
|
InspectionChargeBreakdown: string;
|
|
13319
|
+
/** On a follow-on COLLECTION_AMCO (a second bag for a partial return): the id of the collection whose missing devices it collects. Set from that collection by CreateCollectionAmcoFollowOnWorkOrder. Null on every other work order
|
|
13320
|
+
*
|
|
13321
|
+
* @type {UUID}
|
|
13322
|
+
* @default
|
|
13323
|
+
*/
|
|
13324
|
+
FollowOnOfWorkOrderId: string;
|
|
13239
13325
|
}
|
|
13240
13326
|
/**
|
|
13241
13327
|
* Properties for SERVICE WorkOrder records
|
|
@@ -14060,6 +14146,12 @@ export interface ServiceWorkOrderProperties {
|
|
|
14060
14146
|
* @default
|
|
14061
14147
|
*/
|
|
14062
14148
|
InspectionChargeBreakdown: string;
|
|
14149
|
+
/** On a follow-on COLLECTION_AMCO (a second bag for a partial return): the id of the collection whose missing devices it collects. Set from that collection by CreateCollectionAmcoFollowOnWorkOrder. Null on every other work order
|
|
14150
|
+
*
|
|
14151
|
+
* @type {UUID}
|
|
14152
|
+
* @default
|
|
14153
|
+
*/
|
|
14154
|
+
FollowOnOfWorkOrderId: string;
|
|
14063
14155
|
}
|
|
14064
14156
|
/**
|
|
14065
14157
|
* Properties for WAYLEAVE WorkOrder records
|
|
@@ -14884,6 +14976,12 @@ export interface WayleaveWorkOrderProperties {
|
|
|
14884
14976
|
* @default
|
|
14885
14977
|
*/
|
|
14886
14978
|
InspectionChargeBreakdown: string;
|
|
14979
|
+
/** On a follow-on COLLECTION_AMCO (a second bag for a partial return): the id of the collection whose missing devices it collects. Set from that collection by CreateCollectionAmcoFollowOnWorkOrder. Null on every other work order
|
|
14980
|
+
*
|
|
14981
|
+
* @type {UUID}
|
|
14982
|
+
* @default
|
|
14983
|
+
*/
|
|
14984
|
+
FollowOnOfWorkOrderId: string;
|
|
14887
14985
|
}
|
|
14888
14986
|
/**
|
|
14889
14987
|
* WorkOrder entity from FieldServiceModule
|
|
@@ -1700,6 +1700,8 @@ var WorkOrderPropertyKeys;
|
|
|
1700
1700
|
WorkOrderPropertyKeys["InspectionCharge"] = "InspectionCharge";
|
|
1701
1701
|
/** The missing devices behind InspectionCharge, counted by kind, same shape as EquipmentChargeBreakdown: {"MESH":1}. {} when everything came back. Kinds that cost nothing (ATA) are left out. */
|
|
1702
1702
|
WorkOrderPropertyKeys["InspectionChargeBreakdown"] = "InspectionChargeBreakdown";
|
|
1703
|
+
/** On a follow-on COLLECTION_AMCO (a second bag for a partial return): the id of the collection whose missing devices it collects. Set from that collection by CreateCollectionAmcoFollowOnWorkOrder. Null on every other work order */
|
|
1704
|
+
WorkOrderPropertyKeys["FollowOnOfWorkOrderId"] = "FollowOnOfWorkOrderId";
|
|
1703
1705
|
})(WorkOrderPropertyKeys = exports.WorkOrderPropertyKeys || (exports.WorkOrderPropertyKeys = {}));
|
|
1704
1706
|
/**
|
|
1705
1707
|
* WorkOrder entity from FieldServiceModule
|
|
@@ -4022,6 +4022,34 @@ export declare class WorkOrderRecord<TProps = WorkOrderProperties> {
|
|
|
4022
4022
|
journeyId?: string;
|
|
4023
4023
|
stageKey?: string;
|
|
4024
4024
|
}): ActionBuilder;
|
|
4025
|
+
/**
|
|
4026
|
+
* CreateCollectionAmcoFollowOnWorkOrder
|
|
4027
|
+
*
|
|
4028
|
+
* Creates a new WorkOrder record with the specified properties.
|
|
4029
|
+
* Returns an ActionBuilder - call .execute() to create or .dryRun() for debugging.
|
|
4030
|
+
*
|
|
4031
|
+
* @remarks Record type: COLLECTION_AMCO
|
|
4032
|
+
*
|
|
4033
|
+
* @param properties - The properties for the new record
|
|
4034
|
+
* @param options - Optional settings
|
|
4035
|
+
* @param options.journeyId - Associate with a journey
|
|
4036
|
+
* @param options.stageKey - Set initial pipeline stage
|
|
4037
|
+
* @returns ActionBuilder - call .execute() to create or .dryRun() for payload
|
|
4038
|
+
*
|
|
4039
|
+
* @example
|
|
4040
|
+
* ```typescript
|
|
4041
|
+
* // Create with properties
|
|
4042
|
+
* const record = odinClient.workOrders.new();
|
|
4043
|
+
* await record.createCollectionAmcoFollowOnWorkOrder({ ... }).execute();
|
|
4044
|
+
*
|
|
4045
|
+
* // Dry run (for debugging)
|
|
4046
|
+
* const payload = record.createCollectionAmcoFollowOnWorkOrder({ ... }).dryRun();
|
|
4047
|
+
* ```
|
|
4048
|
+
*/
|
|
4049
|
+
createCollectionAmcoFollowOnWorkOrder(properties?: CreateCollectionAmcoFollowOnWorkOrderProperties, options?: {
|
|
4050
|
+
journeyId?: string;
|
|
4051
|
+
stageKey?: string;
|
|
4052
|
+
}): ActionBuilder;
|
|
4025
4053
|
/**
|
|
4026
4054
|
* CreateCollectionAmcoReplacementWorkOrder
|
|
4027
4055
|
*
|
|
@@ -5144,33 +5172,6 @@ export declare class WorkOrderRecord<TProps = WorkOrderProperties> {
|
|
|
5144
5172
|
completeServiceWorkOrderFlowSupplier(options?: {
|
|
5145
5173
|
journeyId?: string;
|
|
5146
5174
|
}): ActionBuilder;
|
|
5147
|
-
/**
|
|
5148
|
-
* CreateCollectionAmcoFollowOnWorkOrder
|
|
5149
|
-
*
|
|
5150
|
-
* Updates this WorkOrder record.
|
|
5151
|
-
* Returns an ActionBuilder - call .execute() to update or .dryRun() for debugging.
|
|
5152
|
-
*
|
|
5153
|
-
* @param propertiesOrOptions - Properties to update, or options object
|
|
5154
|
-
* @param options - Optional settings (journeyId, stageKey)
|
|
5155
|
-
* @returns ActionBuilder - call .execute() to update or .dryRun() for payload
|
|
5156
|
-
* @throws Error if called on a new (unsaved) record
|
|
5157
|
-
*
|
|
5158
|
-
* @example
|
|
5159
|
-
* ```typescript
|
|
5160
|
-
* const record = await odinClient.workOrders.get(id);
|
|
5161
|
-
* await record.createCollectionAmcoFollowOnWorkOrder({ ... }).execute();
|
|
5162
|
-
*
|
|
5163
|
-
* // Dry run (for debugging)
|
|
5164
|
-
* const payload = record.createCollectionAmcoFollowOnWorkOrder({ ... }).dryRun();
|
|
5165
|
-
* ```
|
|
5166
|
-
*/
|
|
5167
|
-
createCollectionAmcoFollowOnWorkOrder(propertiesOrOptions?: CreateCollectionAmcoFollowOnWorkOrderProperties | {
|
|
5168
|
-
journeyId?: string;
|
|
5169
|
-
stageKey?: string;
|
|
5170
|
-
}, options?: {
|
|
5171
|
-
journeyId?: string;
|
|
5172
|
-
stageKey?: string;
|
|
5173
|
-
}): ActionBuilder;
|
|
5174
5175
|
/**
|
|
5175
5176
|
* CreateCollectionAmcoReplacementWorkOrderFromWorkOrder
|
|
5176
5177
|
*
|
|
@@ -6480,6 +6480,42 @@ class WorkOrderRecord {
|
|
|
6480
6480
|
};
|
|
6481
6481
|
return new ActionBuilder(this._provider, 'FieldServiceModule', 'WorkOrder', payload, () => { this._pendingLinks = []; });
|
|
6482
6482
|
}
|
|
6483
|
+
/**
|
|
6484
|
+
* CreateCollectionAmcoFollowOnWorkOrder
|
|
6485
|
+
*
|
|
6486
|
+
* Creates a new WorkOrder record with the specified properties.
|
|
6487
|
+
* Returns an ActionBuilder - call .execute() to create or .dryRun() for debugging.
|
|
6488
|
+
*
|
|
6489
|
+
* @remarks Record type: COLLECTION_AMCO
|
|
6490
|
+
*
|
|
6491
|
+
* @param properties - The properties for the new record
|
|
6492
|
+
* @param options - Optional settings
|
|
6493
|
+
* @param options.journeyId - Associate with a journey
|
|
6494
|
+
* @param options.stageKey - Set initial pipeline stage
|
|
6495
|
+
* @returns ActionBuilder - call .execute() to create or .dryRun() for payload
|
|
6496
|
+
*
|
|
6497
|
+
* @example
|
|
6498
|
+
* ```typescript
|
|
6499
|
+
* // Create with properties
|
|
6500
|
+
* const record = odinClient.workOrders.new();
|
|
6501
|
+
* await record.createCollectionAmcoFollowOnWorkOrder({ ... }).execute();
|
|
6502
|
+
*
|
|
6503
|
+
* // Dry run (for debugging)
|
|
6504
|
+
* const payload = record.createCollectionAmcoFollowOnWorkOrder({ ... }).dryRun();
|
|
6505
|
+
* ```
|
|
6506
|
+
*/
|
|
6507
|
+
createCollectionAmcoFollowOnWorkOrder(properties, options) {
|
|
6508
|
+
const payload = {
|
|
6509
|
+
entity: 'FieldServiceModule:WorkOrder',
|
|
6510
|
+
type: 'COLLECTION_AMCO',
|
|
6511
|
+
actionName: 'CreateCollectionAmcoFollowOnWorkOrder',
|
|
6512
|
+
properties: properties || {},
|
|
6513
|
+
associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined,
|
|
6514
|
+
journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
|
|
6515
|
+
stageKey: options === null || options === void 0 ? void 0 : options.stageKey,
|
|
6516
|
+
};
|
|
6517
|
+
return new ActionBuilder(this._provider, 'FieldServiceModule', 'WorkOrder', payload, () => { this._pendingLinks = []; });
|
|
6518
|
+
}
|
|
6483
6519
|
/**
|
|
6484
6520
|
* CreateCollectionAmcoReplacementWorkOrder
|
|
6485
6521
|
*
|
|
@@ -7877,43 +7913,6 @@ class WorkOrderRecord {
|
|
|
7877
7913
|
const payload = Object.assign({ id: this._record.id, entity: this._record.entity, type: this._record.type, actionName: 'CompleteServiceWorkOrderFlowSupplier', associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined, stageKey: 'WorkOrderStageDone' }, options);
|
|
7878
7914
|
return new ActionBuilder(this._provider, 'FieldServiceModule', 'WorkOrder', payload, () => { this._pendingLinks = []; });
|
|
7879
7915
|
}
|
|
7880
|
-
/**
|
|
7881
|
-
* CreateCollectionAmcoFollowOnWorkOrder
|
|
7882
|
-
*
|
|
7883
|
-
* Updates this WorkOrder record.
|
|
7884
|
-
* Returns an ActionBuilder - call .execute() to update or .dryRun() for debugging.
|
|
7885
|
-
*
|
|
7886
|
-
* @param propertiesOrOptions - Properties to update, or options object
|
|
7887
|
-
* @param options - Optional settings (journeyId, stageKey)
|
|
7888
|
-
* @returns ActionBuilder - call .execute() to update or .dryRun() for payload
|
|
7889
|
-
* @throws Error if called on a new (unsaved) record
|
|
7890
|
-
*
|
|
7891
|
-
* @example
|
|
7892
|
-
* ```typescript
|
|
7893
|
-
* const record = await odinClient.workOrders.get(id);
|
|
7894
|
-
* await record.createCollectionAmcoFollowOnWorkOrder({ ... }).execute();
|
|
7895
|
-
*
|
|
7896
|
-
* // Dry run (for debugging)
|
|
7897
|
-
* const payload = record.createCollectionAmcoFollowOnWorkOrder({ ... }).dryRun();
|
|
7898
|
-
* ```
|
|
7899
|
-
*/
|
|
7900
|
-
createCollectionAmcoFollowOnWorkOrder(propertiesOrOptions, options) {
|
|
7901
|
-
var _a;
|
|
7902
|
-
if (!((_a = this._record) === null || _a === void 0 ? void 0 : _a.id))
|
|
7903
|
-
throw new Error('createCollectionAmcoFollowOnWorkOrder requires an existing record. Use accessor.get() first.');
|
|
7904
|
-
let properties = {};
|
|
7905
|
-
let opts = options;
|
|
7906
|
-
if (propertiesOrOptions) {
|
|
7907
|
-
if ('journeyId' in propertiesOrOptions || 'stageKey' in propertiesOrOptions) {
|
|
7908
|
-
opts = propertiesOrOptions;
|
|
7909
|
-
}
|
|
7910
|
-
else {
|
|
7911
|
-
properties = propertiesOrOptions;
|
|
7912
|
-
}
|
|
7913
|
-
}
|
|
7914
|
-
const payload = Object.assign({ id: this._record.id, entity: this._record.entity, type: this._record.type, actionName: 'CreateCollectionAmcoFollowOnWorkOrder', properties, associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined }, opts);
|
|
7915
|
-
return new ActionBuilder(this._provider, 'FieldServiceModule', 'WorkOrder', payload, () => { this._pendingLinks = []; });
|
|
7916
|
-
}
|
|
7917
7916
|
/**
|
|
7918
7917
|
* CreateCollectionAmcoReplacementWorkOrderFromWorkOrder
|
|
7919
7918
|
*
|