@d19n/youfibre-odin-sdk 2.0.264 → 2.0.265
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 +3 -1
- package/dist/actions-v2/CreateReplacementAmcoWorkOrderDto.d.ts +237 -0
- package/dist/actions-v2/CreateReplacementAmcoWorkOrderDto.js +59 -0
- package/dist/actions-v2/CreateReplacementAmcoWorkOrderFromOrderDto.d.ts +329 -0
- package/dist/actions-v2/CreateReplacementAmcoWorkOrderFromOrderDto.js +118 -0
- package/dist/db-sdk-v2/FileDb.d.ts +122 -122
- package/dist/db-sdk-v2/FileDb.js +247 -247
- package/dist/entities-v2/File.d.ts +0 -6
- package/dist/entities-v2/File.js +1 -5
- package/dist/entities-v2/WorkOrder.d.ts +262 -262
- package/dist/entities-v2/WorkOrder.js +6 -6
- package/dist/records-v2/OrderRecord.d.ts +85 -0
- package/dist/records-v2/OrderRecord.js +128 -1
- package/dist/records-v2/WorkOrderRecord.d.ts +29 -0
- package/dist/records-v2/WorkOrderRecord.js +36 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -364,7 +364,7 @@ This SDK includes **176** entities across **12** modules.
|
|
|
364
364
|
|
|
365
365
|
## Actions
|
|
366
366
|
|
|
367
|
-
This SDK includes **
|
|
367
|
+
This SDK includes **800** actions.
|
|
368
368
|
|
|
369
369
|
### Action Types
|
|
370
370
|
|
|
@@ -491,6 +491,8 @@ This SDK includes **798** actions.
|
|
|
491
491
|
| `CreatePlanningWorkOrder` | CREATE | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Create.CreatePlanningWorkOrder |
|
|
492
492
|
| `CreatePrePullWorkOrder` | CREATE | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Create.CreatePre_PullWorkOrder |
|
|
493
493
|
| `CreateRemediationWorkOrder` | CREATE | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Create.CreateRemediationWorkOrder |
|
|
494
|
+
| `CreateReplacementAmcoWorkOrder` | CREATE | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Create.CreateReplacementAmcoWorkOrder |
|
|
495
|
+
| `CreateReplacementAmcoWorkOrderFromOrder` | CREATE | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Create.CreateReplacementAmcoWorkOrder |
|
|
494
496
|
| `CreateServiceWorkOrder` | CREATE | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Create.CreateServiceWorkOrder |
|
|
495
497
|
| `CreateWayleaveWorkOrder` | CREATE | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Create.CreateWayleaveWorkOrder |
|
|
496
498
|
| `DefaultInstallWorkOrderEditForm` | UPDATE | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Update.DefaultInstallWorkOrderEditForm |
|
|
@@ -0,0 +1,237 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* CreateReplacementAmcoWorkOrder Action DTO
|
|
3
|
+
*
|
|
4
|
+
* Creates a REPLACEMENT_AMCO work order (dispatch + returns bag in one AMCO order).
|
|
5
|
+
*
|
|
6
|
+
* @module FieldServiceModule
|
|
7
|
+
* @entity WorkOrder
|
|
8
|
+
* @entityType REPLACEMENT_AMCO
|
|
9
|
+
* @actionKey CreateReplacementAmcoWorkOrder
|
|
10
|
+
* @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Create.CreateReplacementAmcoWorkOrder
|
|
11
|
+
*
|
|
12
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
13
|
+
*/
|
|
14
|
+
import { OdinRecordCreateDto, OdinRecordCreatedEvent } from '@d19n/odin-types/dist/core';
|
|
15
|
+
/**
|
|
16
|
+
* RabbitMQ message payload for CreateReplacementAmcoWorkOrder created events
|
|
17
|
+
*
|
|
18
|
+
* @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Create.CreateReplacementAmcoWorkOrder
|
|
19
|
+
*/
|
|
20
|
+
export interface CreateReplacementAmcoWorkOrderMessage extends OdinRecordCreatedEvent<CreateReplacementAmcoWorkOrderDto, CreateReplacementAmcoWorkOrderProperties> {
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Properties for CreateReplacementAmcoWorkOrder action
|
|
24
|
+
*
|
|
25
|
+
* @property Required fields: 1
|
|
26
|
+
* @property Optional fields: 23
|
|
27
|
+
*/
|
|
28
|
+
export interface CreateReplacementAmcoWorkOrderProperties {
|
|
29
|
+
/**
|
|
30
|
+
* Dispatch Reason
|
|
31
|
+
*
|
|
32
|
+
* Dispatch Reason
|
|
33
|
+
* @type {ENUM}
|
|
34
|
+
* @required
|
|
35
|
+
*/
|
|
36
|
+
DispatchReason: string;
|
|
37
|
+
/**
|
|
38
|
+
* PendingAmcoOrder
|
|
39
|
+
*
|
|
40
|
+
* PendingAmcoOrder
|
|
41
|
+
* @type {BOOLEAN}
|
|
42
|
+
* @default Dynamic: {source_record_properties_PendingAmcoReplacement}
|
|
43
|
+
* @hidden This field is not visible in the UI
|
|
44
|
+
*/
|
|
45
|
+
PendingAmcoOrder?: boolean | null;
|
|
46
|
+
/**
|
|
47
|
+
* Expected Return Date
|
|
48
|
+
*
|
|
49
|
+
* ExpectedReturnDate
|
|
50
|
+
* @type {DATE}
|
|
51
|
+
*/
|
|
52
|
+
ExpectedReturnDate?: string | null;
|
|
53
|
+
/**
|
|
54
|
+
* DispatchedRouterProduct
|
|
55
|
+
*
|
|
56
|
+
* Router Device (Field Operations - WorkOrder)
|
|
57
|
+
* @type {LOOKUP}
|
|
58
|
+
*/
|
|
59
|
+
DispatchedRouterProduct?: string | null;
|
|
60
|
+
/**
|
|
61
|
+
* Order
|
|
62
|
+
*
|
|
63
|
+
* Reference identifier for WorkOrder relationships. Used for data integrity.
|
|
64
|
+
* @type {LOOKUP}
|
|
65
|
+
* @default Dynamic: {source_record_id}
|
|
66
|
+
* @hidden This field is not visible in the UI
|
|
67
|
+
*/
|
|
68
|
+
OrderId?: string | null;
|
|
69
|
+
/**
|
|
70
|
+
* ContactId
|
|
71
|
+
*
|
|
72
|
+
* Associated contact ID (Field Operations - WorkOrder)
|
|
73
|
+
* @type {LOOKUP}
|
|
74
|
+
* @default Dynamic: {source_record_Contact_id}
|
|
75
|
+
* @hidden This field is not visible in the UI
|
|
76
|
+
*/
|
|
77
|
+
ContactId?: string | null;
|
|
78
|
+
/**
|
|
79
|
+
* AddressId
|
|
80
|
+
*
|
|
81
|
+
* Reference identifier for WorkOrder relationships. Used for data integrity.
|
|
82
|
+
* @type {LOOKUP}
|
|
83
|
+
* @default Dynamic: {source_record_Address_id}
|
|
84
|
+
* @hidden This field is not visible in the UI
|
|
85
|
+
*/
|
|
86
|
+
AddressId?: string | null;
|
|
87
|
+
/**
|
|
88
|
+
* DispatchedMeshProductCount
|
|
89
|
+
*
|
|
90
|
+
* Number of Mesh Devices (Field Operations - WorkOrder)
|
|
91
|
+
* @type {NUMBER}
|
|
92
|
+
* @default 0
|
|
93
|
+
*/
|
|
94
|
+
DispatchedMeshProductCount?: number | null;
|
|
95
|
+
/**
|
|
96
|
+
* DispatchedMeshProduct
|
|
97
|
+
*
|
|
98
|
+
* Mesh Device (Field Operations - WorkOrder)
|
|
99
|
+
* @type {LOOKUP}
|
|
100
|
+
* @visibleWhen DispatchedMeshProductCount = ["1","2","3","4","5"]
|
|
101
|
+
* @requiredWhen DispatchedMeshProductCount = ["1","2","3","4","5"]
|
|
102
|
+
* @validWhen DispatchedMeshProductCount lte ["5"]
|
|
103
|
+
*/
|
|
104
|
+
DispatchedMeshProduct?: string | null;
|
|
105
|
+
/**
|
|
106
|
+
* DispatchedMiscProduct1
|
|
107
|
+
*
|
|
108
|
+
* DispatchedMiscProduct1 (Field Operations - WorkOrder)
|
|
109
|
+
* @type {LOOKUP}
|
|
110
|
+
*/
|
|
111
|
+
DispatchedMiscProduct1?: string | null;
|
|
112
|
+
/**
|
|
113
|
+
* OtherProductRequired
|
|
114
|
+
*
|
|
115
|
+
* Other Product Required
|
|
116
|
+
* @type {BOOLEAN}
|
|
117
|
+
*/
|
|
118
|
+
OtherProductRequired?: boolean | null;
|
|
119
|
+
/**
|
|
120
|
+
* OtherProductRequestedNotes
|
|
121
|
+
*
|
|
122
|
+
* Other Product Requested Notes
|
|
123
|
+
* @type {TEXT_LONG}
|
|
124
|
+
* @visibleWhen OtherProductRequired = ["true"]
|
|
125
|
+
* @requiredWhen OtherProductRequired = ["true"]
|
|
126
|
+
*/
|
|
127
|
+
OtherProductRequestedNotes?: string | null;
|
|
128
|
+
/**
|
|
129
|
+
* UseAlternativeAddress
|
|
130
|
+
*
|
|
131
|
+
* Use an Alternative Address instead of the linked order's address (Field Operations - WorkOrder)
|
|
132
|
+
* @type {BOOLEAN}
|
|
133
|
+
*/
|
|
134
|
+
UseAlternativeAddress?: boolean | null;
|
|
135
|
+
/**
|
|
136
|
+
* Alternative Address
|
|
137
|
+
*
|
|
138
|
+
* Alternative Address (Field Operations - WorkOrder)
|
|
139
|
+
* @type {LOOKUP}
|
|
140
|
+
* @visibleWhen UseAlternativeAddress = ["*"]
|
|
141
|
+
*/
|
|
142
|
+
AlternativeAddress?: string | null;
|
|
143
|
+
/**
|
|
144
|
+
* UseAlternativeAddressManual
|
|
145
|
+
*
|
|
146
|
+
* UseAlternativeAddressManual (Field Operations - WorkOrder)
|
|
147
|
+
* @type {BOOLEAN}
|
|
148
|
+
* @visibleWhen UseAlternativeAddress = ["*"]
|
|
149
|
+
*/
|
|
150
|
+
UseAlternativeAddressManual?: boolean | null;
|
|
151
|
+
/**
|
|
152
|
+
* Line 1
|
|
153
|
+
*
|
|
154
|
+
* Contact information field for WorkOrder. Used by Field Operations team for communication.
|
|
155
|
+
* @type {TEXT}
|
|
156
|
+
* @visibleWhen UseAlternativeAddressManual = ["*"]
|
|
157
|
+
* @requiredWhen UseAlternativeAddressManual = ["*"]
|
|
158
|
+
*/
|
|
159
|
+
AlternativeAddressLine1?: string | null;
|
|
160
|
+
/**
|
|
161
|
+
* Line 2
|
|
162
|
+
*
|
|
163
|
+
* Contact information field for WorkOrder. Used by Field Operations team for communication.
|
|
164
|
+
* @type {TEXT}
|
|
165
|
+
* @visibleWhen UseAlternativeAddressManual = ["*"]
|
|
166
|
+
*/
|
|
167
|
+
AlternativeAddressLine2?: string | null;
|
|
168
|
+
/**
|
|
169
|
+
* Town
|
|
170
|
+
*
|
|
171
|
+
* Contact information field for WorkOrder. Used by Field Operations team for communication.
|
|
172
|
+
* @type {TEXT}
|
|
173
|
+
* @visibleWhen UseAlternativeAddressManual = ["*"]
|
|
174
|
+
* @requiredWhen UseAlternativeAddressManual = ["*"]
|
|
175
|
+
*/
|
|
176
|
+
AlternativeAddressCityTown?: string | null;
|
|
177
|
+
/**
|
|
178
|
+
* Postcode
|
|
179
|
+
*
|
|
180
|
+
* Contact information field for WorkOrder. Used by Field Operations team for communication.
|
|
181
|
+
* @type {TEXT}
|
|
182
|
+
* @visibleWhen UseAlternativeAddressManual = ["*"]
|
|
183
|
+
* @requiredWhen UseAlternativeAddressManual = ["*"]
|
|
184
|
+
*/
|
|
185
|
+
AlternativeAddressPostCode?: string | null;
|
|
186
|
+
/**
|
|
187
|
+
* UseAlternativeContact
|
|
188
|
+
*
|
|
189
|
+
* Use Alternative Contact (Field Operations - WorkOrder)
|
|
190
|
+
* @type {BOOLEAN}
|
|
191
|
+
*/
|
|
192
|
+
UseAlternativeContact?: boolean | null;
|
|
193
|
+
/**
|
|
194
|
+
* Alternative Contact
|
|
195
|
+
*
|
|
196
|
+
* Alternative Contact (Field Operations - WorkOrder)
|
|
197
|
+
* @type {LOOKUP}
|
|
198
|
+
* @visibleWhen UseAlternativeContact = ["*"]
|
|
199
|
+
*/
|
|
200
|
+
AlternativeContact?: string | null;
|
|
201
|
+
}
|
|
202
|
+
/**
|
|
203
|
+
* Create 3PL Replacement
|
|
204
|
+
*
|
|
205
|
+
* Creates a REPLACEMENT_AMCO work order (dispatch + returns bag in one AMCO order).
|
|
206
|
+
*
|
|
207
|
+
* @actionType CREATE - Creates a new WorkOrder record
|
|
208
|
+
* @module FieldServiceModule
|
|
209
|
+
* @entity WorkOrder
|
|
210
|
+
* @entityType REPLACEMENT_AMCO (Amco Replacement)
|
|
211
|
+
* @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Create.CreateReplacementAmcoWorkOrder
|
|
212
|
+
* @permission schema.action.createreplacementamcoworkorder.trigger
|
|
213
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
214
|
+
*/
|
|
215
|
+
export declare class CreateReplacementAmcoWorkOrderDto extends OdinRecordCreateDto<CreateReplacementAmcoWorkOrderProperties> {
|
|
216
|
+
/** Used by SDK generators to identify action type */
|
|
217
|
+
static readonly ACTION_TYPE = "CREATE";
|
|
218
|
+
static readonly ACTION_KEY = "CreateReplacementAmcoWorkOrder";
|
|
219
|
+
static readonly MODULE_NAME = "FieldServiceModule";
|
|
220
|
+
static readonly ENTITIES: string[];
|
|
221
|
+
static readonly ENTITY_TYPE = "REPLACEMENT_AMCO";
|
|
222
|
+
static readonly EVENT_NAME = "k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Create.CreateReplacementAmcoWorkOrder";
|
|
223
|
+
static readonly PERMISSION = "schema.action.createreplacementamcoworkorder.trigger";
|
|
224
|
+
/** Step metadata - entity this action targets */
|
|
225
|
+
static readonly STEP_ENTITY = "FieldServiceModule:WorkOrder";
|
|
226
|
+
static readonly STEP_SCHEMA_ID = "966bf5d9-163e-4132-85e2-56a5f801c9de";
|
|
227
|
+
static readonly STEP_SCHEMA_ACTION_ID = "f87f3996-c248-4967-8da1-22e56974ae92";
|
|
228
|
+
static readonly STEP_SCHEMA_TYPE_ID = "96ed201c-9f91-41e1-b451-1ebba7c96e39";
|
|
229
|
+
static readonly STEP_TYPE = "REPLACEMENT_AMCO";
|
|
230
|
+
static readonly AUTO_LINK_PARENT = true;
|
|
231
|
+
readonly actionName: string;
|
|
232
|
+
readonly schemaActionId: string;
|
|
233
|
+
readonly entity: string;
|
|
234
|
+
constructor(properties: CreateReplacementAmcoWorkOrderProperties, options?: {
|
|
235
|
+
journeyId?: string;
|
|
236
|
+
});
|
|
237
|
+
}
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* CreateReplacementAmcoWorkOrder Action DTO
|
|
4
|
+
*
|
|
5
|
+
* Creates a REPLACEMENT_AMCO work order (dispatch + returns bag in one AMCO order).
|
|
6
|
+
*
|
|
7
|
+
* @module FieldServiceModule
|
|
8
|
+
* @entity WorkOrder
|
|
9
|
+
* @entityType REPLACEMENT_AMCO
|
|
10
|
+
* @actionKey CreateReplacementAmcoWorkOrder
|
|
11
|
+
* @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Create.CreateReplacementAmcoWorkOrder
|
|
12
|
+
*
|
|
13
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.CreateReplacementAmcoWorkOrderDto = void 0;
|
|
17
|
+
const core_1 = require("@d19n/odin-types/dist/core");
|
|
18
|
+
/**
|
|
19
|
+
* Create 3PL Replacement
|
|
20
|
+
*
|
|
21
|
+
* Creates a REPLACEMENT_AMCO work order (dispatch + returns bag in one AMCO order).
|
|
22
|
+
*
|
|
23
|
+
* @actionType CREATE - Creates a new WorkOrder record
|
|
24
|
+
* @module FieldServiceModule
|
|
25
|
+
* @entity WorkOrder
|
|
26
|
+
* @entityType REPLACEMENT_AMCO (Amco Replacement)
|
|
27
|
+
* @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Create.CreateReplacementAmcoWorkOrder
|
|
28
|
+
* @permission schema.action.createreplacementamcoworkorder.trigger
|
|
29
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
30
|
+
*/
|
|
31
|
+
class CreateReplacementAmcoWorkOrderDto extends core_1.OdinRecordCreateDto {
|
|
32
|
+
constructor(properties, options) {
|
|
33
|
+
super({
|
|
34
|
+
entity: 'FieldServiceModule:WorkOrder',
|
|
35
|
+
type: 'REPLACEMENT_AMCO',
|
|
36
|
+
properties,
|
|
37
|
+
journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
|
|
38
|
+
});
|
|
39
|
+
this.actionName = 'CreateReplacementAmcoWorkOrder';
|
|
40
|
+
this.schemaActionId = 'f87f3996-c248-4967-8da1-22e56974ae92';
|
|
41
|
+
this.entity = 'FieldServiceModule:WorkOrder';
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
exports.CreateReplacementAmcoWorkOrderDto = CreateReplacementAmcoWorkOrderDto;
|
|
45
|
+
/** Used by SDK generators to identify action type */
|
|
46
|
+
CreateReplacementAmcoWorkOrderDto.ACTION_TYPE = 'CREATE';
|
|
47
|
+
CreateReplacementAmcoWorkOrderDto.ACTION_KEY = 'CreateReplacementAmcoWorkOrder';
|
|
48
|
+
CreateReplacementAmcoWorkOrderDto.MODULE_NAME = 'FieldServiceModule';
|
|
49
|
+
CreateReplacementAmcoWorkOrderDto.ENTITIES = ['WorkOrder'];
|
|
50
|
+
CreateReplacementAmcoWorkOrderDto.ENTITY_TYPE = 'REPLACEMENT_AMCO';
|
|
51
|
+
CreateReplacementAmcoWorkOrderDto.EVENT_NAME = 'k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Create.CreateReplacementAmcoWorkOrder';
|
|
52
|
+
CreateReplacementAmcoWorkOrderDto.PERMISSION = 'schema.action.createreplacementamcoworkorder.trigger';
|
|
53
|
+
/** Step metadata - entity this action targets */
|
|
54
|
+
CreateReplacementAmcoWorkOrderDto.STEP_ENTITY = 'FieldServiceModule:WorkOrder';
|
|
55
|
+
CreateReplacementAmcoWorkOrderDto.STEP_SCHEMA_ID = '966bf5d9-163e-4132-85e2-56a5f801c9de';
|
|
56
|
+
CreateReplacementAmcoWorkOrderDto.STEP_SCHEMA_ACTION_ID = 'f87f3996-c248-4967-8da1-22e56974ae92';
|
|
57
|
+
CreateReplacementAmcoWorkOrderDto.STEP_SCHEMA_TYPE_ID = '96ed201c-9f91-41e1-b451-1ebba7c96e39';
|
|
58
|
+
CreateReplacementAmcoWorkOrderDto.STEP_TYPE = 'REPLACEMENT_AMCO';
|
|
59
|
+
CreateReplacementAmcoWorkOrderDto.AUTO_LINK_PARENT = true;
|
|
@@ -0,0 +1,329 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* CreateReplacementAmcoWorkOrderFromOrder Action DTO
|
|
3
|
+
*
|
|
4
|
+
* Order-side flow wrapper for CreateReplacementAmcoWorkOrder.
|
|
5
|
+
*
|
|
6
|
+
* @module OrderModule
|
|
7
|
+
* @entity Order
|
|
8
|
+
* @actionKey CreateReplacementAmcoWorkOrderFromOrder
|
|
9
|
+
* @event k1.t-hEOJjsDb.OrderModule.Order.Flow.CreateReplacementAmcoWorkOrderFromOrder
|
|
10
|
+
*
|
|
11
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
12
|
+
*/
|
|
13
|
+
import { OdinRecord, OdinRecordCreateDto, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
|
|
14
|
+
/**
|
|
15
|
+
* Properties for CreateReplacementAmcoWorkOrder action
|
|
16
|
+
*
|
|
17
|
+
* @property Required fields: 1
|
|
18
|
+
* @property Optional fields: 23
|
|
19
|
+
*/
|
|
20
|
+
export interface CreateReplacementAmcoWorkOrderProperties {
|
|
21
|
+
/**
|
|
22
|
+
* Dispatch Reason
|
|
23
|
+
*
|
|
24
|
+
* Dispatch Reason
|
|
25
|
+
* @type {ENUM}
|
|
26
|
+
* @required
|
|
27
|
+
*/
|
|
28
|
+
DispatchReason: string;
|
|
29
|
+
/**
|
|
30
|
+
* PendingAmcoOrder
|
|
31
|
+
*
|
|
32
|
+
* PendingAmcoOrder
|
|
33
|
+
* @type {BOOLEAN}
|
|
34
|
+
* @default Dynamic: {source_record_properties_PendingAmcoReplacement}
|
|
35
|
+
* @hidden This field is not visible in the UI
|
|
36
|
+
*/
|
|
37
|
+
PendingAmcoOrder?: boolean | null;
|
|
38
|
+
/**
|
|
39
|
+
* Expected Return Date
|
|
40
|
+
*
|
|
41
|
+
* ExpectedReturnDate
|
|
42
|
+
* @type {DATE}
|
|
43
|
+
*/
|
|
44
|
+
ExpectedReturnDate?: string | null;
|
|
45
|
+
/**
|
|
46
|
+
* DispatchedRouterProduct
|
|
47
|
+
*
|
|
48
|
+
* Router Device (Field Operations - WorkOrder)
|
|
49
|
+
* @type {LOOKUP}
|
|
50
|
+
*/
|
|
51
|
+
DispatchedRouterProduct?: string | null;
|
|
52
|
+
/**
|
|
53
|
+
* Order
|
|
54
|
+
*
|
|
55
|
+
* Reference identifier for WorkOrder relationships. Used for data integrity.
|
|
56
|
+
* @type {LOOKUP}
|
|
57
|
+
* @default Dynamic: {source_record_id}
|
|
58
|
+
* @hidden This field is not visible in the UI
|
|
59
|
+
*/
|
|
60
|
+
OrderId?: string | null;
|
|
61
|
+
/**
|
|
62
|
+
* ContactId
|
|
63
|
+
*
|
|
64
|
+
* Associated contact ID (Field Operations - WorkOrder)
|
|
65
|
+
* @type {LOOKUP}
|
|
66
|
+
* @default Dynamic: {source_record_Contact_id}
|
|
67
|
+
* @hidden This field is not visible in the UI
|
|
68
|
+
*/
|
|
69
|
+
ContactId?: string | null;
|
|
70
|
+
/**
|
|
71
|
+
* AddressId
|
|
72
|
+
*
|
|
73
|
+
* Reference identifier for WorkOrder relationships. Used for data integrity.
|
|
74
|
+
* @type {LOOKUP}
|
|
75
|
+
* @default Dynamic: {source_record_Address_id}
|
|
76
|
+
* @hidden This field is not visible in the UI
|
|
77
|
+
*/
|
|
78
|
+
AddressId?: string | null;
|
|
79
|
+
/**
|
|
80
|
+
* DispatchedMeshProductCount
|
|
81
|
+
*
|
|
82
|
+
* Number of Mesh Devices (Field Operations - WorkOrder)
|
|
83
|
+
* @type {NUMBER}
|
|
84
|
+
* @default 0
|
|
85
|
+
*/
|
|
86
|
+
DispatchedMeshProductCount?: number | null;
|
|
87
|
+
/**
|
|
88
|
+
* DispatchedMeshProduct
|
|
89
|
+
*
|
|
90
|
+
* Mesh Device (Field Operations - WorkOrder)
|
|
91
|
+
* @type {LOOKUP}
|
|
92
|
+
* @visibleWhen DispatchedMeshProductCount = ["1","2","3","4","5"]
|
|
93
|
+
* @requiredWhen DispatchedMeshProductCount = ["1","2","3","4","5"]
|
|
94
|
+
* @validWhen DispatchedMeshProductCount lte ["5"]
|
|
95
|
+
*/
|
|
96
|
+
DispatchedMeshProduct?: string | null;
|
|
97
|
+
/**
|
|
98
|
+
* DispatchedMiscProduct1
|
|
99
|
+
*
|
|
100
|
+
* DispatchedMiscProduct1 (Field Operations - WorkOrder)
|
|
101
|
+
* @type {LOOKUP}
|
|
102
|
+
*/
|
|
103
|
+
DispatchedMiscProduct1?: string | null;
|
|
104
|
+
/**
|
|
105
|
+
* OtherProductRequired
|
|
106
|
+
*
|
|
107
|
+
* Other Product Required
|
|
108
|
+
* @type {BOOLEAN}
|
|
109
|
+
*/
|
|
110
|
+
OtherProductRequired?: boolean | null;
|
|
111
|
+
/**
|
|
112
|
+
* OtherProductRequestedNotes
|
|
113
|
+
*
|
|
114
|
+
* Other Product Requested Notes
|
|
115
|
+
* @type {TEXT_LONG}
|
|
116
|
+
* @visibleWhen OtherProductRequired = ["true"]
|
|
117
|
+
* @requiredWhen OtherProductRequired = ["true"]
|
|
118
|
+
*/
|
|
119
|
+
OtherProductRequestedNotes?: string | null;
|
|
120
|
+
/**
|
|
121
|
+
* UseAlternativeAddress
|
|
122
|
+
*
|
|
123
|
+
* Use an Alternative Address instead of the linked order's address (Field Operations - WorkOrder)
|
|
124
|
+
* @type {BOOLEAN}
|
|
125
|
+
*/
|
|
126
|
+
UseAlternativeAddress?: boolean | null;
|
|
127
|
+
/**
|
|
128
|
+
* Alternative Address
|
|
129
|
+
*
|
|
130
|
+
* Alternative Address (Field Operations - WorkOrder)
|
|
131
|
+
* @type {LOOKUP}
|
|
132
|
+
* @visibleWhen UseAlternativeAddress = ["*"]
|
|
133
|
+
*/
|
|
134
|
+
AlternativeAddress?: string | null;
|
|
135
|
+
/**
|
|
136
|
+
* UseAlternativeAddressManual
|
|
137
|
+
*
|
|
138
|
+
* UseAlternativeAddressManual (Field Operations - WorkOrder)
|
|
139
|
+
* @type {BOOLEAN}
|
|
140
|
+
* @visibleWhen UseAlternativeAddress = ["*"]
|
|
141
|
+
*/
|
|
142
|
+
UseAlternativeAddressManual?: boolean | null;
|
|
143
|
+
/**
|
|
144
|
+
* Line 1
|
|
145
|
+
*
|
|
146
|
+
* Contact information field for WorkOrder. Used by Field Operations team for communication.
|
|
147
|
+
* @type {TEXT}
|
|
148
|
+
* @visibleWhen UseAlternativeAddressManual = ["*"]
|
|
149
|
+
* @requiredWhen UseAlternativeAddressManual = ["*"]
|
|
150
|
+
*/
|
|
151
|
+
AlternativeAddressLine1?: string | null;
|
|
152
|
+
/**
|
|
153
|
+
* Line 2
|
|
154
|
+
*
|
|
155
|
+
* Contact information field for WorkOrder. Used by Field Operations team for communication.
|
|
156
|
+
* @type {TEXT}
|
|
157
|
+
* @visibleWhen UseAlternativeAddressManual = ["*"]
|
|
158
|
+
*/
|
|
159
|
+
AlternativeAddressLine2?: string | null;
|
|
160
|
+
/**
|
|
161
|
+
* Town
|
|
162
|
+
*
|
|
163
|
+
* Contact information field for WorkOrder. Used by Field Operations team for communication.
|
|
164
|
+
* @type {TEXT}
|
|
165
|
+
* @visibleWhen UseAlternativeAddressManual = ["*"]
|
|
166
|
+
* @requiredWhen UseAlternativeAddressManual = ["*"]
|
|
167
|
+
*/
|
|
168
|
+
AlternativeAddressCityTown?: string | null;
|
|
169
|
+
/**
|
|
170
|
+
* Postcode
|
|
171
|
+
*
|
|
172
|
+
* Contact information field for WorkOrder. Used by Field Operations team for communication.
|
|
173
|
+
* @type {TEXT}
|
|
174
|
+
* @visibleWhen UseAlternativeAddressManual = ["*"]
|
|
175
|
+
* @requiredWhen UseAlternativeAddressManual = ["*"]
|
|
176
|
+
*/
|
|
177
|
+
AlternativeAddressPostCode?: string | null;
|
|
178
|
+
/**
|
|
179
|
+
* UseAlternativeContact
|
|
180
|
+
*
|
|
181
|
+
* Use Alternative Contact (Field Operations - WorkOrder)
|
|
182
|
+
* @type {BOOLEAN}
|
|
183
|
+
*/
|
|
184
|
+
UseAlternativeContact?: boolean | null;
|
|
185
|
+
/**
|
|
186
|
+
* Alternative Contact
|
|
187
|
+
*
|
|
188
|
+
* Alternative Contact (Field Operations - WorkOrder)
|
|
189
|
+
* @type {LOOKUP}
|
|
190
|
+
* @visibleWhen UseAlternativeContact = ["*"]
|
|
191
|
+
*/
|
|
192
|
+
AlternativeContact?: string | null;
|
|
193
|
+
}
|
|
194
|
+
/**
|
|
195
|
+
* Create 3PL Replacement
|
|
196
|
+
*
|
|
197
|
+
* Creates a REPLACEMENT_AMCO work order (dispatch + returns bag in one AMCO order).
|
|
198
|
+
*
|
|
199
|
+
* @actionType CREATE - Creates a new WorkOrder record
|
|
200
|
+
* @module FieldServiceModule
|
|
201
|
+
* @entity WorkOrder
|
|
202
|
+
* @entityType REPLACEMENT_AMCO (Amco Replacement)
|
|
203
|
+
* @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Create.CreateReplacementAmcoWorkOrder
|
|
204
|
+
* @permission schema.action.createreplacementamcoworkorder.trigger
|
|
205
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
206
|
+
*/
|
|
207
|
+
export declare class CreateReplacementAmcoWorkOrderDto extends OdinRecordCreateDto<CreateReplacementAmcoWorkOrderProperties> {
|
|
208
|
+
/** Used by SDK generators to identify action type */
|
|
209
|
+
static readonly ACTION_TYPE = "CREATE";
|
|
210
|
+
static readonly ACTION_KEY = "CreateReplacementAmcoWorkOrder";
|
|
211
|
+
static readonly MODULE_NAME = "FieldServiceModule";
|
|
212
|
+
static readonly ENTITIES: string[];
|
|
213
|
+
static readonly ENTITY_TYPE = "REPLACEMENT_AMCO";
|
|
214
|
+
static readonly EVENT_NAME = "k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Create.CreateReplacementAmcoWorkOrder";
|
|
215
|
+
static readonly PERMISSION = "schema.action.createreplacementamcoworkorder.trigger";
|
|
216
|
+
/** Step metadata - entity this action targets */
|
|
217
|
+
static readonly STEP_ENTITY = "FieldServiceModule:WorkOrder";
|
|
218
|
+
static readonly STEP_SCHEMA_ID = "966bf5d9-163e-4132-85e2-56a5f801c9de";
|
|
219
|
+
static readonly STEP_SCHEMA_ACTION_ID = "f87f3996-c248-4967-8da1-22e56974ae92";
|
|
220
|
+
static readonly STEP_SCHEMA_TYPE_ID = "96ed201c-9f91-41e1-b451-1ebba7c96e39";
|
|
221
|
+
static readonly STEP_TYPE = "REPLACEMENT_AMCO";
|
|
222
|
+
static readonly AUTO_LINK_PARENT = true;
|
|
223
|
+
readonly actionName: string;
|
|
224
|
+
readonly schemaActionId: string;
|
|
225
|
+
readonly entity: string;
|
|
226
|
+
constructor(properties: CreateReplacementAmcoWorkOrderProperties, options?: {
|
|
227
|
+
journeyId?: string;
|
|
228
|
+
});
|
|
229
|
+
}
|
|
230
|
+
declare type StepClassMap = {
|
|
231
|
+
CreateReplacementAmcoWorkOrderDto: CreateReplacementAmcoWorkOrderDto;
|
|
232
|
+
};
|
|
233
|
+
/**
|
|
234
|
+
* Link definition for connecting steps in CreateReplacementAmcoWorkOrderFromOrder
|
|
235
|
+
*/
|
|
236
|
+
export interface CreateReplacementAmcoWorkOrderFromOrderStepLink {
|
|
237
|
+
/**
|
|
238
|
+
* The stepKey of the target step to link TO
|
|
239
|
+
* Must reference another step's stepKey in the same flow
|
|
240
|
+
*/
|
|
241
|
+
stepKey: string;
|
|
242
|
+
/**
|
|
243
|
+
* The schema association ID (UUID) defining the relationship
|
|
244
|
+
* Use the association.id from the schema association definition
|
|
245
|
+
* @example "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
|
|
246
|
+
*/
|
|
247
|
+
schemaAssociationId: string;
|
|
248
|
+
}
|
|
249
|
+
/**
|
|
250
|
+
* Step definition with linking metadata for CreateReplacementAmcoWorkOrderFromOrder
|
|
251
|
+
*/
|
|
252
|
+
export interface CreateReplacementAmcoWorkOrderFromOrderStepDefinition {
|
|
253
|
+
/** Unique identifier for this step */
|
|
254
|
+
stepKey: string;
|
|
255
|
+
/** The DTO class name for this step */
|
|
256
|
+
dtoClass: string;
|
|
257
|
+
/** The entity this step creates (Module:Entity format) */
|
|
258
|
+
entity: string;
|
|
259
|
+
/** Links to create after this step executes */
|
|
260
|
+
linksTo: CreateReplacementAmcoWorkOrderFromOrderStepLink[] | null;
|
|
261
|
+
}
|
|
262
|
+
/**
|
|
263
|
+
* Type-safe step keys for CreateReplacementAmcoWorkOrderFromOrder
|
|
264
|
+
*/
|
|
265
|
+
export declare const CreateReplacementAmcoWorkOrderFromOrderSteps: {
|
|
266
|
+
readonly step_1: "step_1";
|
|
267
|
+
};
|
|
268
|
+
export declare type CreateReplacementAmcoWorkOrderFromOrderStepKey = typeof CreateReplacementAmcoWorkOrderFromOrderSteps[keyof typeof CreateReplacementAmcoWorkOrderFromOrderSteps];
|
|
269
|
+
/**
|
|
270
|
+
* RabbitMQ message payload for CreateReplacementAmcoWorkOrderFromOrder step flow events
|
|
271
|
+
*
|
|
272
|
+
* @event k1.t-hEOJjsDb.OrderModule.Order.Flow.CreateReplacementAmcoWorkOrderFromOrder
|
|
273
|
+
*/
|
|
274
|
+
export interface CreateReplacementAmcoWorkOrderFromOrderMessage extends OdinRecordUpdatedEvent<CreateReplacementAmcoWorkOrderFromOrderDto, {}> {
|
|
275
|
+
}
|
|
276
|
+
/**
|
|
277
|
+
* Properties for CreateReplacementAmcoWorkOrderFromOrder action
|
|
278
|
+
*
|
|
279
|
+
*/
|
|
280
|
+
export interface CreateReplacementAmcoWorkOrderFromOrderProperties {
|
|
281
|
+
}
|
|
282
|
+
/**
|
|
283
|
+
* Create 3PL Replacement (from Order)
|
|
284
|
+
*
|
|
285
|
+
* Order-side flow wrapper for CreateReplacementAmcoWorkOrder.
|
|
286
|
+
*
|
|
287
|
+
* @actionType MULTI_STEP_FLOW - Multi-step workflow action
|
|
288
|
+
* @module OrderModule
|
|
289
|
+
* @entity Order
|
|
290
|
+
* @event k1.t-hEOJjsDb.OrderModule.Order.Flow.CreateReplacementAmcoWorkOrderFromOrder
|
|
291
|
+
* @permission schema.action.createreplacementamcoworkorderfromorder.trigger
|
|
292
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
293
|
+
*/
|
|
294
|
+
export declare class CreateReplacementAmcoWorkOrderFromOrderDto extends OdinRecordUpdateDto<Record<string, any>> {
|
|
295
|
+
/** Used by SDK generators to identify action type */
|
|
296
|
+
static readonly ACTION_TYPE = "UPDATE";
|
|
297
|
+
static readonly ACTION_KEY = "CreateReplacementAmcoWorkOrderFromOrder";
|
|
298
|
+
static readonly MODULE_NAME = "OrderModule";
|
|
299
|
+
static readonly ENTITIES: string[];
|
|
300
|
+
static readonly EVENT_NAME = "k1.t-hEOJjsDb.OrderModule.Order.Flow.CreateReplacementAmcoWorkOrderFromOrder";
|
|
301
|
+
static readonly SCHEMA_ACTION_ID = "0d8690c6-fe18-4ef7-9e2f-d818d0444c17";
|
|
302
|
+
static readonly PERMISSION = "schema.action.createreplacementamcoworkorderfromorder.trigger";
|
|
303
|
+
static readonly IS_STAGE_TRANSITION = false;
|
|
304
|
+
static readonly IS_MULTI_STEP_FLOW = true;
|
|
305
|
+
static readonly HAS_STEP_LINKS = false;
|
|
306
|
+
/**
|
|
307
|
+
* Step definitions with linking metadata
|
|
308
|
+
* Used by SDK and backend for auto-linking after step execution
|
|
309
|
+
*/
|
|
310
|
+
static readonly stepDefinitions: CreateReplacementAmcoWorkOrderFromOrderStepDefinition[];
|
|
311
|
+
/** Type-safe step key accessor */
|
|
312
|
+
static readonly Steps: {
|
|
313
|
+
readonly step_1: "step_1";
|
|
314
|
+
};
|
|
315
|
+
readonly actionName: string;
|
|
316
|
+
readonly schemaActionId: string;
|
|
317
|
+
readonly entity: string;
|
|
318
|
+
constructor(record: OdinRecord<any> | {
|
|
319
|
+
id: string;
|
|
320
|
+
entity: string;
|
|
321
|
+
type?: string;
|
|
322
|
+
}, options?: {
|
|
323
|
+
journeyId?: string;
|
|
324
|
+
});
|
|
325
|
+
/** Step classes that can be used with this action */
|
|
326
|
+
static readonly stepClasses: readonly ["CreateReplacementAmcoWorkOrderDto"];
|
|
327
|
+
steps: StepClassMap[(typeof CreateReplacementAmcoWorkOrderFromOrderDto.stepClasses)[number]][];
|
|
328
|
+
}
|
|
329
|
+
export {};
|