@d19n/youfibre-odin-sdk 1.0.293 → 1.0.295

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 (3) hide show
  1. package/README.md +1749 -44
  2. package/dist/runner.js +105 -28
  3. package/package.json +2 -2
package/README.md CHANGED
@@ -52,11 +52,18 @@ await cboRec
52
52
  })
53
53
  .execute();
54
54
 
55
- // Create a new record with links
55
+ // Create a new record with generic links
56
56
  const note = odin.notes.new();
57
57
  await note
58
58
  .link({ id: orderId, entity: "OrderModule:Order" })
59
59
  .createNote({ Body: "Customer called about billing" });
60
+
61
+ // Create a record with typed associations (builder pattern)
62
+ await odin.referrals.new()
63
+ .createOrderReferral({})
64
+ .linkCampaignReferrals(campaign) // Typed association method
65
+ .linkOrderReferral({ id: orderId, entity: "OrderModule:Order" })
66
+ .execute();
60
67
  ```
61
68
 
62
69
  ### DB Client (Backend Services)
@@ -117,11 +124,327 @@ await workOrder.completeWorkOrder({ ... });
117
124
 
118
125
  ## Entities
119
126
 
120
- This SDK includes **0** entities across **0** modules.
127
+ This SDK includes **256** entities across **12** modules.
128
+
129
+ ### CrmModule
130
+
131
+ | Entity | Description | Types |
132
+ |--------|-------------|-------|
133
+ | **Account** | Account Entity Definition | BUSINESS, MULTIPLE, PRIMARY... |
134
+ | **Address** | Address Entity Definition | DEFAULT |
135
+ | **AddressCrmDataset** | Address CrmDataset Entity Definition | DEFAULT |
136
+ | **AffiliateCode** | AffiliateCode Entity Definition | DEFAULT |
137
+ | **Appointment** | Appointment Entity Definition | DEFAULT |
138
+ | **AppointmentCalendar** | AppointmentCalendar Entity Definition | DEFAULT |
139
+ | **BusinessAccount** | Business Account Entity Definition | DEFAULT |
140
+ | **Campaign** | Campaign Entity Definition | ORDER |
141
+ | **CashbackReward** | CASHBACK Reward Entity Definition | DEFAULT |
142
+ | **Contact** | Contact Entity Definition | DEFAULT |
143
+ | **ContactCrmDataset** | Contact CrmDataset Entity Definition | DEFAULT |
144
+ | **ContactIdentity** | ContactIdentity Entity Definition | DEFAULT |
145
+ | **CrmDataset** | CrmDataset Entity Definition | ADDRESS, CONTACT, LEAD |
146
+ | **FieldSalesSalesTerritory** | Field sales SalesTerritory Entity Definition | DEFAULT |
147
+ | **Fingerprint** | Fingerprint Entity Definition | DEFAULT |
148
+ | **Lead** | Lead Entity Definition | DEFAULT |
149
+ | **LeadCrmDataset** | Lead CrmDataset Entity Definition | DEFAULT |
150
+ | **MultipleAccount** | Multiple Account Entity Definition | DEFAULT |
151
+ | **Organization** | Organization Entity Definition | DEFAULT |
152
+ | **PhoneNumber** | PhoneNumber Entity Definition | DEFAULT |
153
+ | **Premise** | Premise Entity Definition | DEFAULT |
154
+ | **Premise2** | Premise2 Entity Definition | DEFAULT |
155
+ | **PrimaryAccount** | Primary Account Entity Definition | DEFAULT |
156
+ | **Referral** | Referral Entity Definition | ORDER |
157
+ | **ResellerAccount** | Reseller Account Entity Definition | DEFAULT |
158
+ | **Reward** | Reward Entity Definition | CASHBACK |
159
+ | **SalesLeaderBoard** | SalesLeaderBoard Entity Definition | DEFAULT |
160
+ | **SalesTerritory** | SalesTerritory Entity Definition | FIELD_SALES, TELESALES |
161
+ | **ServiceAccount** | Service Account Entity Definition | DEFAULT |
162
+ | **TelesalesDashboard** | TelesalesDashboard Entity Definition | DEFAULT |
163
+ | **TelesalesSalesTerritory** | Telesales SalesTerritory Entity Definition | DEFAULT |
164
+ | **Visit** | Visit Entity Definition | DEFAULT |
165
+
166
+ ### SchemaModule
167
+
168
+ | Entity | Description | Types |
169
+ |--------|-------------|-------|
170
+ | **Activity** | Activity Entity Definition | EVENT, NOTIFICATION, TASK |
171
+ | **AfpInvoiceFile** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
172
+ | **Config** | Config Entity Definition | DEFAULT |
173
+ | **CsvFile** | CSV File Entity Definition | DEFAULT |
174
+ | **EmailFile** | Email File Entity Definition | DEFAULT |
175
+ | **EventActivity** | Event Activity Entity Definition | DEFAULT |
176
+ | **File** | File Entity Definition | AFP_INVOICE, CSV, EMAIL... |
177
+ | **InvoiceFile** | Invoice File Entity Definition | DEFAULT |
178
+ | **NaProblemEvidenceFile** | Problem Evidence File Entity Definition | DEFAULT |
179
+ | **NaSolutionEvidenceFile** | Solution Evidence File Entity Definition | DEFAULT |
180
+ | **NotificationActivity** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
181
+ | **OpenreachA55File** | Openreach A55 File Entity Definition | DEFAULT |
182
+ | **OtdrFile** | OTDR File Entity Definition | DEFAULT |
183
+ | **TaskActivity** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
184
+
185
+ ### AuditModule
186
+
187
+ | Entity | Description | Types |
188
+ |--------|-------------|-------|
189
+ | **ActivityLog** | ActivityLog Entity Definition | DEFAULT |
190
+ | **PgLog** | PgLog Entity Definition | DEFAULT |
191
+ | **PgWebhook** | PgWebhook Entity Definition | DEFAULT |
192
+ | **PgWebhookAttempt** | PgWebhookAttempt Entity Definition | DEFAULT |
193
+
194
+ ### OrderModule
195
+
196
+ | Entity | Description | Types |
197
+ |--------|-------------|-------|
198
+ | **BillingAdjustment** | BillingAdjustment Entity Definition | DEFAULT |
199
+ | **ChurnRequest** | ChurnRequest Entity Definition | DEFAULT |
200
+ | **ContractBuyOut** | ContractBuyOut Entity Definition | DEFAULT |
201
+ | **DeactivationApproval** | DeactivationApproval Entity Definition | DEFAULT |
202
+ | **GainingOneTouchSwitch** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
203
+ | **LosingOneTouchSwitch** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
204
+ | **OneTouchSwitch** | OneTouchSwitch Entity Definition | GAINING, LOSING |
205
+ | **Order** | Order Entity Definition | DEFAULT |
206
+ | **PICRequest** | PICRequest Entity Definition | DEFAULT |
207
+ | **ReturnOrder** | ReturnOrder Entity Definition | DEFAULT |
208
+ | **SplitOrder** | SplitOrder Entity Definition | DEFAULT |
209
+
210
+ ### BillingModule
211
+
212
+ | Entity | Description | Types |
213
+ |--------|-------------|-------|
214
+ | **BillingRequest** | BillingRequest Entity Definition | MANDATE, PAYMENT |
215
+ | **ChargePgTransaction** | Charge PgTransaction Entity Definition | DEFAULT |
216
+ | **Commission** | Commission Entity Definition | DEFAULT |
217
+ | **CreditNote** | CreditNote Entity Definition | DEFAULT |
218
+ | **EtfInvoice** | ETF Invoice Entity Definition | DEFAULT |
219
+ | **Invoice** | Invoice Entity Definition | ETF |
220
+ | **InvoiceItem** | InvoiceItem Entity Definition | DEFAULT |
221
+ | **MandateBillingRequest** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
222
+ | **Payment** | Payment Entity Definition | DEFAULT |
223
+ | **PaymentBillingRequest** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
224
+ | **PaymentMethod** | PaymentMethod Entity Definition | DEFAULT |
225
+ | **PaymentMethodRefund** | PaymentMethodRefund Entity Definition | DEFAULT |
226
+ | **PgAccountValidation** | PgAccountValidation Entity Definition | DEFAULT |
227
+ | **PgContact** | PgContact Entity Definition | DEFAULT |
228
+ | **PgDirectDebitFile** | PgDirectDebitFile Entity Definition | RESPONSE, SUBMISSION |
229
+ | **PgDispute** | PgDispute Entity Definition | DEFAULT |
230
+ | **PgFileAllocation** | PgFileAllocation Entity Definition | REPORT, SUBMISSION |
231
+ | **PgPaymentMethod** | PgPaymentMethod Entity Definition | DEFAULT |
232
+ | **PgSortCodeSubstitution** | PgSortCodeSubstitution Entity Definition | DEFAULT |
233
+ | **PgTransaction** | PgTransaction Entity Definition | CHARGE, REFUND |
234
+ | **PgVocalink** | PgVocalink Entity Definition | DEFAULT |
235
+ | **RefundPgTransaction** | Refund PgTransaction Entity Definition | DEFAULT |
236
+ | **ReportPgFileAllocation** | Report PgFileAllocation Entity Definition | DEFAULT |
237
+ | **ResponsePgDirectDebitFile** | Response PgDirectDebitFile Entity Definition | DEFAULT |
238
+ | **SubmissionPgDirectDebitFile** | Submission PgDirectDebitFile Entity Definition | DEFAULT |
239
+ | **SubmissionPgFileAllocation** | Submission PgFileAllocation Entity Definition | DEFAULT |
240
+ | **Transaction** | Transaction Entity Definition | DEFAULT |
241
+
242
+ ### FieldServiceModule
243
+
244
+ | Entity | Description | Types |
245
+ |--------|-------------|-------|
246
+ | **BlockageA55** | BlockageA55 Entity Definition | OUTCOME_FORM |
247
+ | **BlockageReportA55** | BlockageReportA55 Entity Definition | OUTCOME_FORM |
248
+ | **Calendar** | Calendar Entity Definition | DEFAULT |
249
+ | **ChangeReason** | ChangeReason Entity Definition | SA_CANCEL, SA_DELAY, SA_INFORM... |
250
+ | **CpeRouterFieldServiceDispatchedProduct** | CPE Router FieldServiceDispatchedProduct Entity Definition | DEFAULT |
251
+ | **CpeRouterFieldServiceProduct** | CPE Router FieldServiceProduct Entity Definition | DEFAULT |
252
+ | **Engineer** | Engineer Entity Definition | DEFAULT |
253
+ | **FieldServiceDispatchedProduct** | FieldServiceDispatchedProduct Entity Definition | CPE_ROUTER, MESH |
254
+ | **FieldServiceProduct** | FieldServiceProduct Entity Definition | CPE_ROUTER, MESH, MISC |
255
+ | **FinanceServiceAppointmentConfig** | Finance ServiceAppointmentConfig Entity Definition | DEFAULT |
256
+ | **InspectionServiceAppointmentConfig** | Inspection ServiceAppointmentConfig Entity Definition | DEFAULT |
257
+ | **InstallServiceAppointmentConfig** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
258
+ | **InstallServiceServiceAppointmentConfig** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
259
+ | **InternalInstallAudit** | InternalInstallAudit Entity Definition | OUTCOME_FORM |
260
+ | **MeshFieldServiceDispatchedProduct** | Mesh Device FieldServiceDispatchedProduct Entity Definition | DEFAULT |
261
+ | **MeshFieldServiceProduct** | MEsh FieldServiceProduct Entity Definition | DEFAULT |
262
+ | **MiscFieldServiceProduct** | MISC FieldServiceProduct Entity Definition | DEFAULT |
263
+ | **NetomniaFtth1StageInstallAudit** | NetomniaFtth1StageInstallAudit Entity Definition | OUTCOME_FORM |
264
+ | **NetomniaFtth2StageInstallAudit** | NetomniaFtth2StageInstallAudit Entity Definition | OUTCOME_FORM |
265
+ | **NetomniaFtthServiceVisitSheet** | NetomniaFtthServiceVisitSheet Entity Definition | OUTCOME_FORM |
266
+ | **NetomniaInstallVerification** | NetomniaInstallVerification Entity Definition | OUTCOME_FORM |
267
+ | **NetworkAdjustmentServiceAppointmentConfig** | Network adjustment ServiceAppointmentConfig Entity Definition | DEFAULT |
268
+ | **Noinstall3AuditOfInstallationSheet** | Noinstall3AuditOfInstallationSheet Entity Definition | OUTCOME_FORM |
269
+ | **OhAuditOfInstallation** | OhAuditOfInstallation Entity Definition | OUTCOME_FORM |
270
+ | **OhExternalAudit** | OhExternalAudit Entity Definition | OUTCOME_FORM |
271
+ | **OhInProgressAudit** | OhInProgressAudit Entity Definition | OUTCOME_FORM |
272
+ | **OhInstallationAudit** | OhInstallationAudit Entity Definition | OUTCOME_FORM |
273
+ | **OhRetroAudit** | OhRetroAudit Entity Definition | OUTCOME_FORM |
274
+ | **OntReplacementApproval** | OntReplacementApproval Entity Definition | DEFAULT |
275
+ | **OutcomeFormBlockageA55** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
276
+ | **OutcomeFormBlockageReportA55** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
277
+ | **OutcomeFormInternalInstallAudit** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
278
+ | **OutcomeFormNetomniaFtth1StageInstallAudit** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
279
+ | **OutcomeFormNetomniaFtth2StageInstallAudit** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
280
+ | **OutcomeFormNetomniaFtthServiceVisitSheet** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
281
+ | **OutcomeFormNetomniaInstallVerification** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
282
+ | **OutcomeFormNoinstall3AuditOfInstallationSheet** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
283
+ | **OutcomeFormOhAuditOfInstallation** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
284
+ | **OutcomeFormOhExternalAudit** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
285
+ | **OutcomeFormOhInProgressAudit** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
286
+ | **OutcomeFormOhInstallationAudit** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
287
+ | **OutcomeFormOhRetroAudit** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
288
+ | **OutcomeFormOverlayRealA55** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
289
+ | **OutcomeFormRemediationOutcomeForm** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
290
+ | **OutcomeFormRemediationRequiredReason** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
291
+ | **OutcomeFormServiceVisitAudit** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
292
+ | **OutcomeFormSiteSpecificRiskAssessmentOutcomeForm** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
293
+ | **OutcomeFormSweeperMaintenanceAudit** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
294
+ | **OutcomeFormUgAuditOfInstallation** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
295
+ | **OutcomeFormUgExternalAudit** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
296
+ | **OutcomeFormUgInProgressAudit** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
297
+ | **OutcomeFormUgInstallationAudit** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
298
+ | **OutcomeFormUgRetroAudit** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
299
+ | **OutcomeFormWayleaveAudit** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
300
+ | **OutcomeFormYfEquipmentCollection** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
301
+ | **OutcomeFormYfFieldServiceVisit** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
302
+ | **OutcomeFormYfStockCount** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
303
+ | **OutcomeFormYfToolAudit** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
304
+ | **OutcomeFormYfVanAudit** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
305
+ | **OverlayRealA55** | OverlayRealA55 Entity Definition | OUTCOME_FORM |
306
+ | **PermissionToFail** | PermissionToFail Entity Definition | DEFAULT |
307
+ | **PlanningServiceAppointmentConfig** | Planning ServiceAppointmentConfig Entity Definition | DEFAULT |
308
+ | **PrePullServiceAppointmentConfig** | Pre-pull ServiceAppointmentConfig Entity Definition | DEFAULT |
309
+ | **RemediationOutcomeForm** | RemediationOutcomeForm Entity Definition | OUTCOME_FORM |
310
+ | **RemediationRequiredReason** | RemediationRequiredReason Entity Definition | OUTCOME_FORM |
311
+ | **RemediationServiceAppointmentConfig** | Remediation ServiceAppointmentConfig Entity Definition | DEFAULT |
312
+ | **Returns** | Returns Entity Definition | DEFAULT |
313
+ | **SaCancelChangeReason** | Cancel ChangeReason Entity Definition | DEFAULT |
314
+ | **SaDelayChangeReason** | Delay ChangeReason Entity Definition | DEFAULT |
315
+ | **SaInformChangeReason** | Inform ChangeReason Entity Definition | DEFAULT |
316
+ | **SaRescheduleChangeReason** | Reschedule ChangeReason Entity Definition | DEFAULT |
317
+ | **ScheduleSlot** | ScheduleSlot Entity Definition | DEFAULT |
318
+ | **ServiceAppointment** | ServiceAppointment Entity Definition | DEFAULT |
319
+ | **ServiceAppointmentConfig** | ServiceAppointmentConfig Entity Definition | FINANCE, INSPECTION, INSTALL... |
320
+ | **ServiceServiceAppointmentConfig** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
321
+ | **ServiceVisitAudit** | ServiceVisitAudit Entity Definition | OUTCOME_FORM |
322
+ | **SiteSpecificRiskAssessmentOutcomeForm** | SiteSpecificRiskAssessmentOutcomeForm Entity Definition | OUTCOME_FORM |
323
+ | **SweeperMaintenanceAudit** | SweeperMaintenanceAudit Entity Definition | OUTCOME_FORM |
324
+ | **UgAuditOfInstallation** | UgAuditOfInstallation Entity Definition | OUTCOME_FORM |
325
+ | **UgExternalAudit** | UgExternalAudit Entity Definition | OUTCOME_FORM |
326
+ | **UgInProgressAudit** | UgInProgressAudit Entity Definition | OUTCOME_FORM |
327
+ | **UgInstallationAudit** | UgInstallationAudit Entity Definition | OUTCOME_FORM |
328
+ | **UgRetroAudit** | UgRetroAudit Entity Definition | OUTCOME_FORM |
329
+ | **WayleaveAudit** | WayleaveAudit Entity Definition | OUTCOME_FORM |
330
+ | **WayleaveServiceAppointmentConfig** | Wayleave ServiceAppointmentConfig Entity Definition | DEFAULT |
331
+ | **WorkOrder** | WorkOrder Entity Definition | COLLECTION, COLLECTION_AMCO, DISPATCH_AMCO... |
332
+ | **YfEquipmentCollection** | YfEquipmentCollection Entity Definition | OUTCOME_FORM |
333
+ | **YfFieldServiceVisit** | YfFieldServiceVisit Entity Definition | OUTCOME_FORM |
334
+ | **YfStockCount** | YfStockCount Entity Definition | OUTCOME_FORM |
335
+ | **YfToolAudit** | YfToolAudit Entity Definition | OUTCOME_FORM |
336
+ | **YfVanAudit** | YfVanAudit Entity Definition | OUTCOME_FORM |
337
+
338
+ ### ProductModule
339
+
340
+ | Entity | Description | Types |
341
+ |--------|-------------|-------|
342
+ | **BundleProduct** | Bundle Product Entity Definition | DEFAULT |
343
+ | **ConsumptionRate** | ConsumptionRate Entity Definition | DEFAULT |
344
+ | **ConsumptionSchedule** | ConsumptionSchedule Entity Definition | DEFAULT |
345
+ | **Discount** | Discount Entity Definition | DEFAULT |
346
+ | **InternetProduct** | Internet Product Entity Definition | DEFAULT |
347
+ | **LaborProduct** | Labor Product Entity Definition | DEFAULT |
348
+ | **LandlineProduct** | Landline Product Entity Definition | DEFAULT |
349
+ | **MeshProduct** | Mesh Product Entity Definition | DEFAULT |
350
+ | **MobileProduct** | Mobile Product Entity Definition | DEFAULT |
351
+ | **Offer** | Offer Entity Definition | RECONTRACT, STANDARD |
352
+ | **PriceBook** | PriceBook Entity Definition | DEFAULT |
353
+ | **Product** | Product Entity Definition | BUNDLE, INTERNET, LABOR... |
354
+ | **ProductComponent** | ProductComponent Entity Definition | DEFAULT |
355
+ | **RecontractOffer** | RECONTRACT Offer Entity Definition | DEFAULT |
356
+ | **Restriction** | Restriction Entity Definition | DEFAULT |
357
+ | **StandardOffer** | STANDARD Offer Entity Definition | DEFAULT |
358
+ | **Vendor** | Vendor Entity Definition | DEFAULT |
359
+
360
+ ### NotificationModule
361
+
362
+ | Entity | Description | Types |
363
+ |--------|-------------|-------|
364
+ | **Call** | Call Entity Definition | DEFAULT |
365
+ | **CallEvent** | CallEvent Entity Definition | DEFAULT |
366
+ | **CallLeg** | CallLeg Entity Definition | DEFAULT |
367
+ | **CallTransfer** | CallTransfer Entity Definition | DEFAULT |
368
+ | **CallUpdates** | CallUpdates Entity Definition | DEFAULT |
369
+ | **Conversation** | Conversation Entity Definition | DEFAULT |
370
+ | **CustomerDeviceConfiguration** | CustomerDeviceConfiguration Entity Definition | DEFAULT |
371
+ | **Email** | Email Entity Definition | SUPPORT |
372
+ | **EmailTemplate** | EmailTemplate Entity Definition | DEFAULT |
373
+ | **EventMessage** | AUTO-GENERATED - DO NOT EDIT DIRECTLY | DEFAULT |
374
+ | **InboundSmsMessage** | Inbound SmsMessage Entity Definition | DEFAULT |
375
+ | **Message** | Message Entity Definition | EVENT |
376
+ | **NotificationTemplate** | NotificationTemplate Entity Definition | DEFAULT |
377
+ | **OutboundSmsMessage** | Outbound SmsMessage Entity Definition | DEFAULT |
378
+ | **PushNotification** | PushNotification Entity Definition | DEFAULT |
379
+ | **SmsMessage** | SmsMessage Entity Definition | INBOUND, OUTBOUND |
380
+ | **SmsTemplate** | SmsTemplate Entity Definition | DEFAULT |
381
+ | **SupportEmail** | Support Email Entity Definition | DEFAULT |
382
+ | **TwilioUserUpdate** | TwilioUserUpdate Entity Definition | DEFAULT |
383
+
384
+ ### SupportModule
385
+
386
+ | Entity | Description | Types |
387
+ |--------|-------------|-------|
388
+ | **Case** | Case Entity Definition | OUTAGE |
389
+ | **CaseAction** | CaseAction Entity Definition | DEFAULT |
390
+ | **CaseQueueListView** | CaseQueueListView Entity Definition | DEFAULT |
391
+ | **KnowledgeArticle** | KnowledgeArticle Entity Definition | RELEASE_NOTE, USER_GUIDE |
392
+ | **LinearIssue** | LinearIssue Entity Definition | DEFAULT |
393
+ | **Note** | Note Entity Definition | DEFAULT |
394
+ | **OutageCase** | Outage Case Entity Definition | DEFAULT |
395
+ | **Queue** | Queue Entity Definition | DEFAULT |
396
+ | **QueueChange** | QueueChange Entity Definition | DEFAULT |
397
+ | **ReleaseNoteKnowledgeArticle** | Release Note KnowledgeArticle Entity Definition | DEFAULT |
398
+ | **SupportTask** | SupportTask Entity Definition | DEFAULT |
399
+ | **UserGuideKnowledgeArticle** | User Guide KnowledgeArticle Entity Definition | DEFAULT |
400
+
401
+ ### ServiceModule
402
+
403
+ | Entity | Description | Types |
404
+ |--------|-------------|-------|
405
+ | **CustomerDeviceAta** | CustomerDeviceAta Entity Definition | DEFAULT |
406
+ | **CustomerDeviceOnt** | CustomerDeviceOnt Entity Definition | DEFAULT |
407
+ | **CustomerDeviceOntRemoval** | CustomerDeviceOntRemoval Entity Definition | DEFAULT |
408
+ | **CustomerDeviceRouter** | CustomerDeviceRouter Entity Definition | DEFAULT |
409
+ | **CustomerPhonePorting** | CustomerPhonePorting Entity Definition | DEFAULT |
410
+ | **McPendingEvent** | McPendingEvent Entity Definition | DEFAULT |
411
+ | **MobileCdr** | MobileCdr Entity Definition | DEFAULT |
412
+ | **MobileConfiguration** | MobileConfiguration Entity Definition | DEFAULT |
413
+ | **MobileCountryRate** | MobileCountryRate Entity Definition | DEFAULT |
414
+ | **MobileEdr** | MobileEdr Entity Definition | DEFAULT |
415
+ | **MobileSubscriber** | MobileSubscriber Entity Definition | DEFAULT |
416
+ | **MsPendingEvent** | MsPendingEvent Entity Definition | DEFAULT |
417
+ | **NetworkDevice** | NetworkDevice Entity Definition | OLT |
418
+ | **OltNetworkDevice** | Olt NetworkDevice Entity Definition | DEFAULT |
419
+ | **OltSnapshot** | OltSnapshot Entity Definition | DEFAULT |
420
+ | **Outage** | Outage Entity Definition | DEFAULT |
421
+ | **Service** | Service Entity Definition | DEFAULT |
422
+ | **VoiceConfiguration** | VoiceConfiguration Entity Definition | DEFAULT |
423
+
424
+ ### ProjectModule
425
+
426
+ | Entity | Description | Types |
427
+ |--------|-------------|-------|
428
+ | **Exchange** | Exchange Entity Definition | DEFAULT |
429
+ | **Milestone** | Milestone Entity Definition | DEFAULT |
430
+ | **Program** | Program Entity Definition | DEFAULT |
431
+ | **Project** | Project Entity Definition | DEFAULT |
432
+ | **Region** | Region Entity Definition | DEFAULT |
433
+ | **Subtask** | Subtask Entity Definition | DEFAULT |
434
+ | **Task** | Task Entity Definition | DEFAULT |
435
+
436
+ ### IdentityModule
437
+
438
+ | Entity | Description | Types |
439
+ |--------|-------------|-------|
440
+ | **ImpersonationTracker** | ImpersonationTracker Entity Definition | DEFAULT |
441
+ | **Team** | Team Entity Definition | DEFAULT |
442
+ | **TimeSlot** | TimeSlot Entity Definition | DEFAULT |
443
+ | **User** | User Entity Definition | DEFAULT |
121
444
 
122
445
  ## Actions
123
446
 
124
- This SDK includes **0** actions.
447
+ This SDK includes **477** actions.
125
448
 
126
449
  ### Action Types
127
450
 
@@ -129,10 +452,1211 @@ This SDK includes **0** actions.
129
452
  |------|-------------|
130
453
  | `CREATE` | Creates a new record (no existing record required) |
131
454
  | `UPDATE` | Updates an existing record |
132
- | `STEP_FLOW` | Multi-step workflow with FlowBuilder pattern |
455
+ | `STAGE_TRANSITION` | Moves a record to a new pipeline stage (has TARGET_STAGES) |
456
+ | `MULTI_STEP_FLOW` | Multi-step workflow creating/updating multiple records (has stepClasses) |
133
457
 
134
458
  ### Actions by Entity
135
459
 
460
+ #### Order
461
+
462
+ | Action | Type | Event |
463
+ |--------|------|-------|
464
+ | `ActivateOrder` | UPDATE | OrderModule.Order.Update.ActivateOrder |
465
+ | `ActivateRecontractOrder` | STAGE_TRANSITION | OrderModule.Order.Transition.ActivateRecontractOrder |
466
+ | `CancelOrderForRecontract` | STAGE_TRANSITION | OrderModule.Order.Transition.CancelOrderForRecontract |
467
+ | `CancelOrderForRollback` | STAGE_TRANSITION | OrderModule.Order.Transition.CancelOrderForRollback |
468
+ | `ChangeBillingDay` | UPDATE | OrderModule.Order.Update.ChangeBillingDay |
469
+ | `ClearOrderDeactivateOnDate` | UPDATE | OrderModule.Order.Update.ClearOrderDeactivateOnDate |
470
+ | `CreateInstallWorkOrderFlow` | UPDATE | OrderModule.Order.Flow.CreateInstallWorkOrderFlow |
471
+ | `CreateRecontractOrder` | CREATE | OrderModule.Order.Create.CreateRecontractOrder |
472
+ | `DeactivateOrderDunning` | STAGE_TRANSITION | OrderModule.Order.Transition.DeactivateOrderDunning |
473
+ | `ManageCommision` | UPDATE | OrderModule.Order.Update.ManageCommision |
474
+ | `MoveOrderFromAcceptedToScheduled` | STAGE_TRANSITION | OrderModule.Order.Transition.MoveOrderFromAcceptedToScheduled |
475
+ | `MoveOrderFromActiveToPendingCancellation` | STAGE_TRANSITION | OrderModule.Order.Transition.MoveOrderFromActiveToPendingCancellation |
476
+ | `MoveOrderFromCancelledToActive` | STAGE_TRANSITION | OrderModule.Order.Transition.MoveOrderFromCancelledToActive |
477
+ | `MoveOrderFromDeactivatedToActive` | STAGE_TRANSITION | OrderModule.Order.Transition.MoveOrderFromDeactivatedToActive |
478
+ | `MoveOrderFromDraftToAnyStage` | STAGE_TRANSITION | OrderModule.Order.Transition.MoveOrderFromDraftToAnyStage |
479
+ | `MoveOrderFromPendingCancellationToActive` | STAGE_TRANSITION | OrderModule.Order.Transition.MoveOrderFromPendingCancellationToActive |
480
+ | `MoveOrderFromPreOrderToCancelled` | STAGE_TRANSITION | OrderModule.Order.Transition.MoveOrderFromPreOrderToCancelled |
481
+ | `MoveOrderToActive` | STAGE_TRANSITION | OrderModule.Order.Update.ActivateOrder |
482
+ | `MoveOrderToDeactivatedFromActive` | STAGE_TRANSITION | OrderModule.Order.Transition.MoveOrderToDeactivatedFromActive |
483
+ | `OderUpdate` | UPDATE | OrderModule.Order.Update.OderUpdate |
484
+ | `ReactivateOrderAfterRollback` | STAGE_TRANSITION | OrderModule.Order.Transition.ReactivateOrderAfterRollback |
485
+ | `SetOrderCancelOnDate` | UPDATE | OrderModule.Order.Update.SetOrderCancelOnDate |
486
+ | `SetOrderDeactivateOnDate` | UPDATE | OrderModule.Order.Update.SetOrderDeactivateOnDate |
487
+ | `SetPendingAmcoWorkOrder` | UPDATE | OrderModule.Order.Update.SetPendingAmcoWorkOrder |
488
+ | `UpdateOrder` | UPDATE | OrderModule.Order.Update.UpdateOrder |
489
+
490
+ **ActivateRecontractOrder Target Stages:** `OrderStageActive`
491
+
492
+ **CancelOrderForRecontract Target Stages:** `OrderStageCancelled`
493
+
494
+ **CancelOrderForRollback Target Stages:** `OrderStageCancelled`
495
+
496
+ **DeactivateOrderDunning Target Stages:** `OrderStageDeactivated`
497
+
498
+ **MoveOrderFromAcceptedToScheduled Target Stages:** `OrderStageSupply`
499
+
500
+ **MoveOrderFromActiveToPendingCancellation Target Stages:** `OrderStagePendingCancellation`
501
+
502
+ **MoveOrderFromCancelledToActive Target Stages:** `OrderStageActive`
503
+
504
+ **MoveOrderFromDeactivatedToActive Target Stages:** `OrderStageActive`
505
+
506
+ **MoveOrderFromDraftToAnyStage Target Stages:** `OrderStageSupply`
507
+
508
+ **MoveOrderFromPendingCancellationToActive Target Stages:** `OrderStageActive`
509
+
510
+ **MoveOrderFromPreOrderToCancelled Target Stages:** `OrderStageCancelled`
511
+
512
+ **MoveOrderToActive Target Stages:** `OrderStageActive`
513
+
514
+ **MoveOrderToDeactivatedFromActive Target Stages:** `OrderStageDeactivated`
515
+
516
+ **ReactivateOrderAfterRollback Target Stages:** `OrderStageActive`
517
+
518
+ #### WorkOrder
519
+
520
+ | Action | Type | Event |
521
+ |--------|------|-------|
522
+ | `AddAmcoResponseData` | UPDATE | FieldServiceModule.WorkOrder.Update.AddAmcoResponseData |
523
+ | `AssignEngineer` | UPDATE | FieldServiceModule.WorkOrder.Update.AssignEngineer |
524
+ | `AssignWorkOrder` | UPDATE | FieldServiceModule.WorkOrder.Update.AssignWorkOrder |
525
+ | `ChangeWorkOrderStatus` | UPDATE | FieldServiceModule.WorkOrder.Update.ChangeWorkOrderStatus |
526
+ | `CompleteCollectionInspectionDetails` | UPDATE | FieldServiceModule.WorkOrder.Update.CompleteCollectionInspectionDetails |
527
+ | `CompleteInstallWorkOrder` | UPDATE | FieldServiceModule.WorkOrder.Update.CompleteInstallWorkOrder |
528
+ | `CompletePrePullWorkOrder` | UPDATE | FieldServiceModule.WorkOrder.Update.CompletePrePullWorkOrder |
529
+ | `CompleteRemediationWorkOrder` | UPDATE | FieldServiceModule.WorkOrder.Update.CompleteRemediationWorkOrder |
530
+ | `CompleteServiceWorkOrder` | UPDATE | FieldServiceModule.WorkOrder.Update.CompleteServiceWorkOrder |
531
+ | `CreateCancelCollectionAmco` | CREATE | FieldServiceModule.WorkOrder.Create.CreateCancelCollectionAmco |
532
+ | `CreateCollectionAmcoReplacementWorkOrder` | CREATE | FieldServiceModule.WorkOrder.Create.CreateCollectionAmcoReplacementWorkOrder |
533
+ | `CreateCollectionAmcoReplacementWorkOrderFromWorkOrder` | CREATE | FieldServiceModule.WorkOrder.Create.CreateCollectionAmcoReplacementWorkOrder |
534
+ | `CreateCollectionAmcoWorkOrder` | CREATE | FieldServiceModule.WorkOrder.Create.CreateCollectionAmcoWorkOrder |
535
+ | `CreateCollectionAmcoWorkOrderFromOrder` | CREATE | FieldServiceModule.WorkOrder.Create.CreateCollectionAmcoWorkOrder |
536
+ | `CreateCollectionWorkOrder` | CREATE | FieldServiceModule.WorkOrder.Create.CreateCollectionWorkOrder |
537
+ | `CreateCollectionWorkOrderFromOrder` | CREATE | FieldServiceModule.WorkOrder.Create.CreateCollectionWorkOrder |
538
+ | `CreateDispatchAmcoWorkOrder` | CREATE | FieldServiceModule.WorkOrder.Create.CreateDispatchAmcoWorkOrder |
539
+ | `CreateDispatchAmcoWorkOrderFromOrder` | CREATE | FieldServiceModule.WorkOrder.Create.CreateDispatchAmcoWorkOrder |
540
+ | `CreateFinanceWorkOrder` | CREATE | FieldServiceModule.WorkOrder.Create.CreateFinanceWorkOrder |
541
+ | `CreateInspectionWorkOrder` | CREATE | FieldServiceModule.WorkOrder.Create.CreateInspectionWorkOrder |
542
+ | `CreateInstallBusinessWorkOrder` | CREATE | FieldServiceModule.WorkOrder.Create.CreateInstall_BusinessWorkOrder |
543
+ | `CreateInstallWorkOrder` | CREATE | FieldServiceModule.WorkOrder.Create.CreateInstallWorkOrder |
544
+ | `CreateLinkedWorkOrder` | CREATE | FieldServiceModule.WorkOrder.Create.CreateLinkedWorkOrder |
545
+ | `CreateLinkedWorkOrderFlow` | CREATE | FieldServiceModule.WorkOrder.Create.CreateCollectionWorkOrder |
546
+ | `CreateNetworkAdjustmentWorkOrder` | CREATE | FieldServiceModule.WorkOrder.Create.CreateNetwork_AdjustmentWorkOrder |
547
+ | `CreatePlanningWorkOrder` | CREATE | FieldServiceModule.WorkOrder.Create.CreatePlanningWorkOrder |
548
+ | `CreatePrePullWorkOrder` | CREATE | FieldServiceModule.WorkOrder.Create.CreatePre_PullWorkOrder |
549
+ | `CreateRemediationWorkOrder` | CREATE | FieldServiceModule.WorkOrder.Create.CreateRemediationWorkOrder |
550
+ | `CreateServiceWorkOrder` | CREATE | FieldServiceModule.WorkOrder.Create.CreateServiceWorkOrder |
551
+ | `CreateWayleaveWorkOrder` | CREATE | FieldServiceModule.WorkOrder.Create.CreateWayleaveWorkOrder |
552
+ | `DefaultInstallWorkOrderEditForm` | UPDATE | FieldServiceModule.WorkOrder.Update.DefaultInstallWorkOrderEditForm |
553
+ | `DefaultServiceWorkOrderEditForm` | UPDATE | FieldServiceModule.WorkOrder.Update.DefaultServiceWorkOrderEditForm |
554
+ | `EditCollectionAmcoWorkOrder` | UPDATE | FieldServiceModule.WorkOrder.Update.EditCollectionAmcoWorkOrder |
555
+ | `FlowStepCompleteCollectionConfirmation` | UPDATE | FieldServiceModule.WorkOrder.Update.FlowStepCompleteCollectionConfirmation |
556
+ | `FlowStepEnRouteCallConfirmation` | UPDATE | FieldServiceModule.WorkOrder.Update.FlowStepEnRouteCallConfirmation |
557
+ | `FlowStepEnRouteCollectionConfirmation` | UPDATE | FieldServiceModule.WorkOrder.Update.FlowStepEnRouteCollectionConfirmation |
558
+ | `InProgressWorkOrderConfirmation` | UPDATE | FieldServiceModule.WorkOrder.Update.InProgressWorkOrderConfirmation |
559
+ | `ManageSla` | UPDATE | FieldServiceModule.WorkOrder.Update.ManageSLA |
560
+ | `MoveBusinessInstallToCancelled` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveBusinessInstallToCancelled |
561
+ | `MoveBusinessInstallToComplete` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveBusinessInstallToComplete |
562
+ | `MoveBusinessInstallToEnRoute` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveBusinessInstallToEnRoute |
563
+ | `MoveBusinessInstallToInProgress` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveBusinessInstallToInProgress |
564
+ | `MoveBusinessInstallToReadyForInstallation` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveBusinessInstallToReadyForInstallation |
565
+ | `MoveBusinessInstallToSiteSurveyRequired` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveBusinessInstallToSiteSurveyRequired |
566
+ | `MoveBusinessInstallWorkOrderFromReadyToInstallationToScheduled` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveBusinessInstallWorkOrderFromReadyToInstallationToScheduled |
567
+ | `MoveCollectionAmcoToCancelled` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveCollectionAmcoToCancelled |
568
+ | `MoveCollectionAmcoToComplete` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveCollectionAmcoToComplete |
569
+ | `MoveCollectionAmcoToError` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveCollectionAmcoToError |
570
+ | `MoveCollectionAmcoToOverridden` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveCollectionAmcoToOverridden |
571
+ | `MoveCollectionAmcoToPendingInspection` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveCollectionAmcoToPendingInspection |
572
+ | `MoveCollectionAmcoToPendingReturn` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveCollectionAmcoToPendingReturn |
573
+ | `MoveCollectionAmcoToReceived` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveCollectionAmcoToReceived |
574
+ | `MoveCollectionWorkOrderFromAcceptedToEnRoute` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Update.FlowStepEnRouteCollectionConfirmation |
575
+ | `MoveCollectionWorkOrderFromEnRouteToReceived` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveCollectionWorkOrderFromEnRouteToReceived |
576
+ | `MoveCollectionWorkOrderFromReceivedToComplete` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Update.FlowStepCompleteCollectionConfirmation |
577
+ | `MoveCollectionWorkOrderToCancelled` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveCollectionWorkOrderToCancelled |
578
+ | `MoveCollectionWorkOrderToComplete` | CREATE | FieldServiceModule.WorkOrder.Create.MoveCollectionWorkOrderToComplete |
579
+ | `MoveDispatchAmcoToCancelled` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveDispatchAmcoToCancelled |
580
+ | `MoveDispatchAmcoToComplete` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveDispatchAmcoToComplete |
581
+ | `MoveDispatchAmcoToEnRoute` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveDispatchAmcoToEnRoute |
582
+ | `MoveDispatchAmcoToError` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveDispatchAmcoToError |
583
+ | `MoveDispatchAmcoToOverridden` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveDispatchAmcoToOverridden |
584
+ | `MoveDispatchAmcoToProcessed` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveDispatchAmcoToProcessed |
585
+ | `MoveDispatchAmcoToReceived` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveDispatchAmcoToReceived |
586
+ | `MoveFinanceWorkOrderToApproval` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveFinanceWorkOrderToApproval |
587
+ | `MoveFinanceWorkOrderToCancelled` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveFinanceWorkOrderToCancelled |
588
+ | `MoveFinanceWorkOrderToComplete` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveFinanceWorkOrderToComplete |
589
+ | `MoveFinanceWorkOrderToNeedInformation` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveFinanceWorkOrderToNeedInformation |
590
+ | `MoveFinanceWorkOrderToPurchaseOrder` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveFinanceWorkOrderToPurchaseOrder |
591
+ | `MoveInspectionWorkOrderToCancelled` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveInspectionWorkOrderToCancelled |
592
+ | `MoveInspectionWorkOrderToComplete` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveInspectionWorkOrderToComplete |
593
+ | `MoveInspectionWorkOrderToEnRoute` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveInspectionWorkOrderToEnRoute |
594
+ | `MoveInspectionWorkOrderToInProgress` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Update.InProgressWorkOrderConfirmation |
595
+ | `MoveInspectionWorkOrderToRemediation` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveInspectionWorkOrderToRemediation |
596
+ | `MoveInstallWorkOrderFromInProgressToComplete` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveInstallWorkOrderFromInProgressToComplete |
597
+ | `MoveInstallWorkOrderToEnRoute` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Update.FlowStepEnRouteCallConfirmation |
598
+ | `MoveInstallWorkOrderToInProgress` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Update.InProgressWorkOrderConfirmation |
599
+ | `MoveInstallWorkOrderToScheduled` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveInstallWorkOrderToScheduled |
600
+ | `MoveNetworkAdjustmentWorkOrderToCancelled` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveNetworkAdjustmentWorkOrderToCancelled |
601
+ | `MoveNetworkAdjustmentWorkOrderToComplete` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveNetworkAdjustmentWorkOrderToComplete |
602
+ | `MoveNetworkAdjustmentWorkOrderToNaRaised` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveNetworkAdjustmentWorkOrderToNaRaised |
603
+ | `MoveNetworkAdjustmentWorkOrderToNaRejected` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveNetworkAdjustmentWorkOrderToNaRejected |
604
+ | `MovePlanningWorkOrderToCancelled` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MovePlanningWorkOrderToCancelled |
605
+ | `MovePlanningWorkOrderToDesignComplete` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MovePlanningWorkOrderToDesignComplete |
606
+ | `MovePlanningWorkOrderToDesignInProgress` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MovePlanningWorkOrderToDesignInProgress |
607
+ | `MovePlanningWorkOrderToDesignQc` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MovePlanningWorkOrderToDesignQc |
608
+ | `MovePlanningWorkOrderToMoreInformationRequired` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MovePlanningWorkOrderToMoreInformationRequired |
609
+ | `MovePlanningWorkOrderToOnHold` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MovePlanningWorkOrderToOnHold |
610
+ | `MovePrePullWorkOrderToEnRoute` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MovePrePullWorkOrderToEnRoute |
611
+ | `MovePrePullWorkOrderToInProgress` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Update.InProgressWorkOrderConfirmation |
612
+ | `MoveRemediationWorkOrderToEnRoute` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveRemediationWorkOrderToEnRoute |
613
+ | `MoveRemediationWorkOrderToInProgress` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Update.InProgressWorkOrderConfirmation |
614
+ | `MoveServiceWorkOrderFromAcceptedToScheduled` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveServiceWorkOrderFromAcceptedToScheduled |
615
+ | `MoveServiceWorkOrderToCancelled` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveServiceWorkOrderToCancelled |
616
+ | `MoveServiceWorkOrderToEnRoute` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveServiceWorkOrderToEnRoute |
617
+ | `MoveServiceWorkOrderToInProgress` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Update.InProgressWorkOrderConfirmation |
618
+ | `MoveWayleaveWorkOrderToAwaitingPtd` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveWayleaveWorkOrderToAwaitingPtd |
619
+ | `MoveWayleaveWorkOrderToCancelled` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveWayleaveWorkOrderToCancelled |
620
+ | `MoveWayleaveWorkOrderToComplete` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveWayleaveWorkOrderToComplete |
621
+ | `MoveWayleaveWorkOrderToInReview` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveWayleaveWorkOrderToInReview |
622
+ | `MoveWayleaveWorkOrderToNeedInformation` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveWayleaveWorkOrderToNeedInformation |
623
+ | `MoveWayleaveWorkOrderToSubmitted` | STAGE_TRANSITION | FieldServiceModule.WorkOrder.Transition.MoveWayleaveWorkOrderToSubmitted |
624
+ | `ResendCollectionAmcoWorkOrderToAmco` | UPDATE | FieldServiceModule.WorkOrder.Update.ResendCollectionAmcoWorkOrderToAmco |
625
+ | `ResendDispatchAmcoWorkOrderToAmco` | UPDATE | FieldServiceModule.WorkOrder.Update.ResendDispatchAmcoWorkOrderToAmco |
626
+ | `TestAction123321` | CREATE | FieldServiceModule.WorkOrder.Create.TestAction123321 |
627
+ | `UpdateDefaultWorkOrder` | UPDATE | FieldServiceModule.WorkOrder.Update.UpdateDefaultWorkOrder |
628
+ | `UpdateDispatchAmcoWorkOrder` | UPDATE | FieldServiceModule.WorkOrder.Update.UpdateDispatchAmcoWorkOrder |
629
+ | `UpdateInspectionWorkOrder` | UPDATE | FieldServiceModule.WorkOrder.Update.UpdateInspectionWorkOrder |
630
+ | `UpdateOverrideCollectionAmcoOrder` | UPDATE | FieldServiceModule.WorkOrder.Update.UpdateOverrideCollectionAmcoOrder |
631
+ | `UpdateOverrideDispatchAmcoOrder` | UPDATE | FieldServiceModule.WorkOrder.Update.UpdateOverrideDispatchAmcoOrder |
632
+ | `UpdateRemediationWorkOrder` | UPDATE | FieldServiceModule.WorkOrder.Update.UpdateRemediationWorkOrder |
633
+ | `UpdateWayleaveWorkOrder` | UPDATE | FieldServiceModule.WorkOrder.Update.UpdateWayleaveWorkOrder |
634
+
635
+ **MoveBusinessInstallToCancelled Target Stages:** `BusinessInstallPipelineStageCancelled`
636
+
637
+ **MoveBusinessInstallToComplete Target Stages:** `BusinessInstallPipelineStageComplete`
638
+
639
+ **MoveBusinessInstallToEnRoute Target Stages:** `BusinessInstallPipelineStageEnRoute`
640
+
641
+ **MoveBusinessInstallToInProgress Target Stages:** `BusinessInstallPipelineStageInProgress`
642
+
643
+ **MoveBusinessInstallToReadyForInstallation Target Stages:** `BusinessInstallPipelineStageReadyForInstallation`
644
+
645
+ **MoveBusinessInstallToSiteSurveyRequired Target Stages:** `BusinessInstallPipelineStageSiteSurveyRequired`
646
+
647
+ **MoveBusinessInstallWorkOrderFromReadyToInstallationToScheduled Target Stages:** `BusinessInstallPipelineStageScheduled`
648
+
649
+ **MoveCollectionAmcoToCancelled Target Stages:** `CollectionAmcoStageCancelled`
650
+
651
+ **MoveCollectionAmcoToComplete Target Stages:** `CollectionAmcoStageComplete`
652
+
653
+ **MoveCollectionAmcoToError Target Stages:** `CollectionAmcoStageError`
654
+
655
+ **MoveCollectionAmcoToOverridden Target Stages:** `CollectionAmcoStageOverridden`
656
+
657
+ **MoveCollectionAmcoToPendingInspection Target Stages:** `CollectionAmcoStagePendingInspection`
658
+
659
+ **MoveCollectionAmcoToPendingReturn Target Stages:** `CollectionAmcoStagePendingReturn`
660
+
661
+ **MoveCollectionAmcoToReceived Target Stages:** `CollectionAmcoStageReceived`
662
+
663
+ **MoveCollectionWorkOrderFromAcceptedToEnRoute Target Stages:** `CollectionPipelineStageEnRoute`
664
+
665
+ **MoveCollectionWorkOrderFromEnRouteToReceived Target Stages:** `CollectionPipelineStageReceived`
666
+
667
+ **MoveCollectionWorkOrderFromReceivedToComplete Target Stages:** `CollectionPipelineStageComplete`
668
+
669
+ **MoveCollectionWorkOrderToCancelled Target Stages:** `CollectionPipelineStageCancelled`
670
+
671
+ **MoveDispatchAmcoToCancelled Target Stages:** `DispatchAmcoStageCancelled`
672
+
673
+ **MoveDispatchAmcoToComplete Target Stages:** `DispatchAmcoStageComplete`
674
+
675
+ **MoveDispatchAmcoToEnRoute Target Stages:** `DispatchAmcoStageEnRoute`
676
+
677
+ **MoveDispatchAmcoToError Target Stages:** `DispatchAmcoStageError`
678
+
679
+ **MoveDispatchAmcoToOverridden Target Stages:** `DispatchAmcoStageOverridden`
680
+
681
+ **MoveDispatchAmcoToProcessed Target Stages:** `DispatchAmcoStageProcessed`
682
+
683
+ **MoveDispatchAmcoToReceived Target Stages:** `DispatchAmcoStageReceived`
684
+
685
+ **MoveFinanceWorkOrderToApproval Target Stages:** `FinancePipelineStageApproval`
686
+
687
+ **MoveFinanceWorkOrderToCancelled Target Stages:** `FinancePipelineStageCancelled`
688
+
689
+ **MoveFinanceWorkOrderToComplete Target Stages:** `FinancePipelineStageComplete`
690
+
691
+ **MoveFinanceWorkOrderToNeedInformation Target Stages:** `FinancePipelineStageNeedInformation`
692
+
693
+ **MoveFinanceWorkOrderToPurchaseOrder Target Stages:** `FinancePipelineStagePurchaseOrder`
694
+
695
+ **MoveInspectionWorkOrderToCancelled Target Stages:** `WorkOrderStageCancelled`
696
+
697
+ **MoveInspectionWorkOrderToComplete Target Stages:** `WorkOrderStageDone`
698
+
699
+ **MoveInspectionWorkOrderToEnRoute Target Stages:** `WorkOrderStageEnRoute`
700
+
701
+ **MoveInspectionWorkOrderToInProgress Target Stages:** `WorkOrderStageInProgress`
702
+
703
+ **MoveInspectionWorkOrderToRemediation Target Stages:** `WorkOrderRemediationRequired`
704
+
705
+ **MoveInstallWorkOrderFromInProgressToComplete Target Stages:** `WorkOrderStageDone`
706
+
707
+ **MoveInstallWorkOrderToEnRoute Target Stages:** `WorkOrderStageEnRoute`
708
+
709
+ **MoveInstallWorkOrderToInProgress Target Stages:** `WorkOrderStageInProgress`
710
+
711
+ **MoveInstallWorkOrderToScheduled Target Stages:** `WorkOrderStageScheduled`
712
+
713
+ **MoveNetworkAdjustmentWorkOrderToCancelled Target Stages:** `NetworkAdjustmentPipelineStageCancelled`
714
+
715
+ **MoveNetworkAdjustmentWorkOrderToComplete Target Stages:** `NetworkAdjustmentPipelineStageComplete`
716
+
717
+ **MoveNetworkAdjustmentWorkOrderToNaRaised Target Stages:** `NetworkAdjustmentPipelineStageNaRaised`
718
+
719
+ **MoveNetworkAdjustmentWorkOrderToNaRejected Target Stages:** `NetworkAdjustmentPipelineStageNaRejected`
720
+
721
+ **MovePlanningWorkOrderToCancelled Target Stages:** `PlanningPipelineStageCancelled`
722
+
723
+ **MovePlanningWorkOrderToDesignComplete Target Stages:** `PlanningPipelineStageDesignComplete`
724
+
725
+ **MovePlanningWorkOrderToDesignInProgress Target Stages:** `PlanningPipelineStageDesignInProgress`
726
+
727
+ **MovePlanningWorkOrderToDesignQc Target Stages:** `PlanningPipelineStageDesignQc`
728
+
729
+ **MovePlanningWorkOrderToMoreInformationRequired Target Stages:** `PlanningPipelineStageMoreInformationRequired`
730
+
731
+ **MovePlanningWorkOrderToOnHold Target Stages:** `PlanningPipelineStageOnHold`
732
+
733
+ **MovePrePullWorkOrderToEnRoute Target Stages:** `WorkOrderStageEnRoute`
734
+
735
+ **MovePrePullWorkOrderToInProgress Target Stages:** `WorkOrderStageInProgress`
736
+
737
+ **MoveRemediationWorkOrderToEnRoute Target Stages:** `WorkOrderStageEnRoute`
738
+
739
+ **MoveRemediationWorkOrderToInProgress Target Stages:** `WorkOrderStageInProgress`
740
+
741
+ **MoveServiceWorkOrderFromAcceptedToScheduled Target Stages:** `WorkOrderStageScheduled`
742
+
743
+ **MoveServiceWorkOrderToCancelled Target Stages:** `WorkOrderStageCancelled`
744
+
745
+ **MoveServiceWorkOrderToEnRoute Target Stages:** `WorkOrderStageEnRoute`
746
+
747
+ **MoveServiceWorkOrderToInProgress Target Stages:** `WorkOrderStageInProgress`
748
+
749
+ **MoveWayleaveWorkOrderToAwaitingPtd Target Stages:** `WayleavePipelineStageAwaitingPtd`
750
+
751
+ **MoveWayleaveWorkOrderToCancelled Target Stages:** `WayleavePipelineStageCancelled`
752
+
753
+ **MoveWayleaveWorkOrderToComplete Target Stages:** `WayleavePipelineStageComplete`
754
+
755
+ **MoveWayleaveWorkOrderToInReview Target Stages:** `WayleavePipelineStageInReview`
756
+
757
+ **MoveWayleaveWorkOrderToNeedInformation Target Stages:** `WayleavePipelineStageNeedInformation`
758
+
759
+ **MoveWayleaveWorkOrderToSubmitted Target Stages:** `WayleavePipelineStageSubmitted`
760
+
761
+ #### Address
762
+
763
+ | Action | Type | Event |
764
+ |--------|------|-------|
765
+ | `AddressCreate` | CREATE | CrmModule.Address.Create.AddressCreate |
766
+ | `AddressUpdate` | UPDATE | CrmModule.Address.Update.AddressUpdate |
767
+
768
+ #### ContractBuyOut
769
+
770
+ | Action | Type | Event |
771
+ |--------|------|-------|
772
+ | `ApproveCbo` | UPDATE | OrderModule.ContractBuyOut.Update.ApproveCBO |
773
+ | `CboCreate` | CREATE | OrderModule.ContractBuyOut.Create.CboCreate |
774
+ | `CboUpdate` | UPDATE | OrderModule.ContractBuyOut.Update.CboUpdate |
775
+ | `FlowStepMoreInforRequiredToVerifiedConfirmation` | UPDATE | OrderModule.ContractBuyOut.Update.FlowStepMoreInforRequiredToVerifiedConfirmation |
776
+ | `FlowStepReceivedConfirmation` | UPDATE | OrderModule.ContractBuyOut.Update.FlowStepReceivedConfirmation |
777
+ | `FlowStepReceivedToVerifiedConfirmation` | UPDATE | OrderModule.ContractBuyOut.Update.FlowStepReceivedToVerifiedConfirmation |
778
+ | `FlowStepUpdateToAdditionalApprovalRequired` | UPDATE | OrderModule.ContractBuyOut.Update.FlowStepUpdateToAdditionalApprovalRequired |
779
+ | `FlowStepVerifiedToApproved` | UPDATE | OrderModule.ContractBuyOut.Update.FlowStepVerifiedToApproved |
780
+ | `MoveCboToAdditionalApprovalRequired` | STAGE_TRANSITION | OrderModule.ContractBuyOut.Transition.MoveCboToAdditionalApprovalRequired |
781
+ | `MoveCboToApproved` | STAGE_TRANSITION | OrderModule.ContractBuyOut.Update.ApproveCBO |
782
+ | `MoveCboToCancelled` | STAGE_TRANSITION | OrderModule.ContractBuyOut.Transition.MoveCboToCancelled |
783
+ | `MoveCboToMoreInfoRequired` | STAGE_TRANSITION | OrderModule.ContractBuyOut.Transition.MoveCboToMoreInfoRequired |
784
+ | `MoveCboToReceived` | STAGE_TRANSITION | OrderModule.ContractBuyOut.Update.FlowStepReceivedConfirmation |
785
+ | `MoveCboToRefundProcessed` | STAGE_TRANSITION | OrderModule.ContractBuyOut.Transition.MoveCboToRefundProcessed |
786
+ | `MoveCboToVerified` | STAGE_TRANSITION | OrderModule.ContractBuyOut.Transition.MoveCboToVerified |
787
+ | `SelectRelatedPaymentmethod` | CREATE | OrderModule.ContractBuyOut.Create.SelectRelatedPaymentmethod |
788
+ | `SentToVoyager` | UPDATE | OrderModule.ContractBuyOut.Update.SentToVoyager |
789
+
790
+ **MoveCboToAdditionalApprovalRequired Target Stages:** `CreditBuyOutStageAdditionalApprovalRequired`
791
+
792
+ **MoveCboToApproved Target Stages:** `CreditBuyOutStageApproved`
793
+
794
+ **MoveCboToCancelled Target Stages:** `CreditBuyOutStageCancelled`
795
+
796
+ **MoveCboToMoreInfoRequired Target Stages:** `CreditBuyOutStageMoreInfoRequired`
797
+
798
+ **MoveCboToReceived Target Stages:** `CreditBuyOutStageReceived`
799
+
800
+ **MoveCboToRefundProcessed Target Stages:** `CreditBuyOutStageRefundProcessed`
801
+
802
+ **MoveCboToVerified Target Stages:** `CreditBuyOutStageVerified`
803
+
804
+ #### Case
805
+
806
+ | Action | Type | Event |
807
+ |--------|------|-------|
808
+ | `AssignCase` | UPDATE | SupportModule.Case.Update.AssignCase |
809
+ | `AssignCaseWithNoteFlow` | MULTI_STEP_FLOW | SupportModule.Case.Update.AssignCase |
810
+ | `CaseDefaultStageEscalated` | STAGE_TRANSITION | SupportModule.Case.Update.EscalateCaseAction |
811
+ | `CaseDefaultStageSolved` | STAGE_TRANSITION | SupportModule.Case.Transition.CaseDefaultStageSolved |
812
+ | `Casedefaultstageblocked` | STAGE_TRANSITION | SupportModule.Case.Update.MoveCaseToBlockedAction |
813
+ | `ChangeCaseChannel` | UPDATE | SupportModule.Case.Update.ChangeCaseChannel |
814
+ | `CreateCase` | CREATE | SupportModule.Case.Create.CreateCase |
815
+ | `CreateCaseForChat` | CREATE | SupportModule.Case.Create.CreateSocialMediaCase |
816
+ | `CreateCaseFromContact` | CREATE | SupportModule.Case.Create.CreateCase |
817
+ | `CreateSocialMediaCase` | CREATE | SupportModule.Case.Create.CreateSocialMediaCase |
818
+ | `EditCaseForm` | UPDATE | SupportModule.Case.Update.EditCaseForm |
819
+ | `EscalateCaseAction` | UPDATE | SupportModule.Case.Update.EscalateCaseAction |
820
+ | `EscalateCaseTransition` | STAGE_TRANSITION | SupportModule.Case.Update.EscalateCaseAction |
821
+ | `MarkCaseClosed` | UPDATE | SupportModule.Case.Update.MarkCaseClosed |
822
+ | `MarkCaseResolved` | UPDATE | SupportModule.Case.Update.MarkCaseResolved |
823
+ | `MoveCaseOutageToSolvedAction2` | UPDATE | SupportModule.Case.Update.MoveCaseOutageToSolvedAction2 |
824
+ | `MoveCaseOutageToSolvedAction` | UPDATE | SupportModule.Case.Update.MoveCaseOutageToSolvedAction |
825
+ | `MoveCaseOutageToSolvedTransition` | STAGE_TRANSITION | SupportModule.Case.Transition.MoveCaseOutageToSolvedTransition |
826
+ | `MoveCaseToBlockedAction` | UPDATE | SupportModule.Case.Update.MoveCaseToBlockedAction |
827
+ | `MoveCaseToBlockedTransition` | STAGE_TRANSITION | SupportModule.Case.Update.MoveCaseToBlockedAction |
828
+ | `MoveCaseToPendingAgentTransition` | STAGE_TRANSITION | SupportModule.Case.Transition.MoveCaseToPendingAgentTransition |
829
+ | `MoveCaseToPendingReviewAction` | UPDATE | SupportModule.Case.Update.MoveCaseToPendingReviewAction |
830
+ | `MoveCaseToPendingReviewTransition` | STAGE_TRANSITION | SupportModule.Case.Update.MoveCaseToPendingReviewAction |
831
+ | `MoveCaseToSolvedAction` | UPDATE | SupportModule.Case.Update.MoveCaseToSolvedAction |
832
+ | `MoveCaseToSolvedTransition` | STAGE_TRANSITION | SupportModule.Case.Transition.MoveCaseToSolvedTransition |
833
+ | `MoveDefaultCaseFromOpenToClosed` | STAGE_TRANSITION | SupportModule.Case.Update.MarkCaseClosed |
834
+ | `RemoveAssignmentFromCase` | UPDATE | SupportModule.Case.Update.RemoveAssignmentFromCase |
835
+ | `UpdateFormalComplaint` | UPDATE | SupportModule.Case.Update.UpdateFormalComplaint |
836
+ | `UpdateSentiment` | UPDATE | SupportModule.Case.Update.UpdateSentiment |
837
+ | `UpdateTags` | UPDATE | SupportModule.Case.Update.UpdateTags |
838
+
839
+ **CaseDefaultStageEscalated Target Stages:** `CaseDefaultStageEscalated`
840
+
841
+ **CaseDefaultStageSolved Target Stages:** `CaseDefaultStageSolved`
842
+
843
+ **Casedefaultstageblocked Target Stages:** `CaseDefaultStageBlocked`
844
+
845
+ **EscalateCaseTransition Target Stages:** `CaseDefaultStageEscalated`
846
+
847
+ **MoveCaseOutageToSolvedTransition Target Stages:** `OutagePipelineStageSolved`
848
+
849
+ **MoveCaseToBlockedTransition Target Stages:** `CaseDefaultStageBlocked`
850
+
851
+ **MoveCaseToPendingAgentTransition Target Stages:** `CaseDefaultStagePendingAgent`
852
+
853
+ **MoveCaseToPendingReviewTransition Target Stages:** `CaseDefaultStagePendingReview`
854
+
855
+ **MoveCaseToSolvedTransition Target Stages:** `CaseDefaultStageSolved`
856
+
857
+ **MoveDefaultCaseFromOpenToClosed Target Stages:** `CaseDefaultStageClosed`
858
+
859
+ **AssignCaseWithNoteFlow Steps:**
860
+
861
+ | Step Method | Type | Signature |
862
+ |-------------|------|-----------|
863
+ | `assignCase` | UPDATE | `(id, properties, options?)` |
864
+ | `createNoteForCaseAssignment` | CREATE | `(properties, options?)` |
865
+
866
+ #### CrmDataset
867
+
868
+ | Action | Type | Event |
869
+ |--------|------|-------|
870
+ | `AssignOwner` | UPDATE | CrmModule.CrmDataset.Update.AssignOwner |
871
+ | `CrmDatasetDefaultUpdate` | UPDATE | CrmModule.CrmDataset.Update.CrmDatasetDefaultUpdate |
872
+ | `UpdateAddressDataSet` | UPDATE | CrmModule.CrmDataset.Update.UpdateAddressDataSet |
873
+
874
+ #### ServiceAppointmentConfig
875
+
876
+ | Action | Type | Event |
877
+ |--------|------|-------|
878
+ | `AssignUsers` | UPDATE | FieldServiceModule.ServiceAppointmentConfig.Update.AssignUsers |
879
+ | `CreateInspection` | CREATE | FieldServiceModule.ServiceAppointmentConfig.Create.Create INSPECTION |
880
+ | `CreateInstall` | CREATE | FieldServiceModule.ServiceAppointmentConfig.Create.Create INSTALL |
881
+ | `CreateInstallService` | CREATE | FieldServiceModule.ServiceAppointmentConfig.Create.Create INSTALL_SERVICE |
882
+ | `CreatePrePull` | CREATE | FieldServiceModule.ServiceAppointmentConfig.Create.Create PRE_PULL |
883
+ | `CreateRemediation` | CREATE | FieldServiceModule.ServiceAppointmentConfig.Create.Create REMEDIATION |
884
+ | `CreateService` | CREATE | FieldServiceModule.ServiceAppointmentConfig.Create.Create SERVICE |
885
+ | `CreateWayleave` | CREATE | FieldServiceModule.ServiceAppointmentConfig.Create.Create WAYLEAVE |
886
+ | `UpdateInspection` | UPDATE | FieldServiceModule.ServiceAppointmentConfig.Update.Update INSPECTION |
887
+ | `UpdateInstallSchedule` | UPDATE | FieldServiceModule.ServiceAppointmentConfig.Update.UpdateInstallSchedule |
888
+ | `UpdatePrePullSchedule` | UPDATE | FieldServiceModule.ServiceAppointmentConfig.Update.UpdatePrePullSchedule |
889
+ | `UpdateRemediation` | UPDATE | FieldServiceModule.ServiceAppointmentConfig.Update.Update REMEDIATION |
890
+ | `UpdateServiceSchedule` | UPDATE | FieldServiceModule.ServiceAppointmentConfig.Update.UpdateServiceSchedule |
891
+
892
+ #### BillingAdjustment
893
+
894
+ | Action | Type | Event |
895
+ |--------|------|-------|
896
+ | `BillingAdjustmentCreate` | CREATE | OrderModule.BillingAdjustment.Create.BillingAdjustmentCreate |
897
+ | `BillingAdjustmentUpdate` | UPDATE | OrderModule.BillingAdjustment.Update.BillingAdjustmentUpdate |
898
+
899
+ #### BillingRequest
900
+
901
+ | Action | Type | Event |
902
+ |--------|------|-------|
903
+ | `BillingRequestMandateUpdate` | UPDATE | BillingModule.BillingRequest.Update.BillingRequestMandateUpdate |
904
+ | `BillingRequestPaymentCreate` | CREATE | BillingModule.BillingRequest.Create.BillingRequestPaymentCreate |
905
+ | `BillingRequestPaymentUpdate` | UPDATE | BillingModule.BillingRequest.Update.BillingRequestPaymentUpdate |
906
+ | `CancelBillingRequest` | UPDATE | BillingModule.BillingRequest.Update.CancelBillingRequest |
907
+ | `CancelBillingRequestFromPayment` | UPDATE | BillingModule.BillingRequest.Update.CancelBillingRequestFromPayment |
908
+ | `CreateBillingRequestForInvoices` | CREATE | BillingModule.BillingRequest.Create.CreateBillingRequestForInvoices |
909
+ | `StartBillingRequestFlow` | UPDATE | BillingModule.BillingRequest.Update.StartBillingRequestFlow |
910
+
911
+ #### ChurnRequest
912
+
913
+ | Action | Type | Event |
914
+ |--------|------|-------|
915
+ | `CancelActiveOrder` | CREATE | OrderModule.ChurnRequest.Create.CreateChurnRequest |
916
+ | `CompleteChurnRequest` | UPDATE | OrderModule.ChurnRequest.Update.CompleteChurnRequest |
917
+ | `CompleteChurnRequestFlow` | STAGE_TRANSITION | OrderModule.ChurnRequest.Update.CompleteChurnRequest |
918
+ | `CreateChurnRequest` | CREATE | OrderModule.ChurnRequest.Create.CreateChurnRequest |
919
+ | `DefaultUpdateChurnRequest` | UPDATE | OrderModule.ChurnRequest.Update.DefaultUpdateChurnRequest |
920
+ | `MoveOrderFromDeactivatedToCancelled` | CREATE | OrderModule.ChurnRequest.Create.CreateChurnRequest |
921
+ | `MoveOrderFromPendingCancellationToCancelled` | CREATE | OrderModule.ChurnRequest.Create.CreateChurnRequest |
922
+
923
+ **CompleteChurnRequestFlow Target Stages:** `ChurnRequestStageDone`
924
+
925
+ #### ChangeReason
926
+
927
+ | Action | Type | Event |
928
+ |--------|------|-------|
929
+ | `CancelInstallWorkOrderFlowSupplier` | CREATE | FieldServiceModule.ChangeReason.Create.CreateInstallCancelledChangeReasonSupplier |
930
+ | `CancelInstallWorkOrderFlowTenant` | CREATE | FieldServiceModule.ChangeReason.Create.CreateInstallCancelledChangeReasonTenant |
931
+ | `CancelPrePullWorkOrderFlowSupplier` | CREATE | FieldServiceModule.ChangeReason.Create.CreatePrePullCancelledChangeReasonSupplier |
932
+ | `CancelRemediationWorkOrderSupplier` | CREATE | FieldServiceModule.ChangeReason.Create.CreateRemediationCancelledChangeReasonSupplier |
933
+ | `CancelServiceWorkOrderFlowSupplier` | CREATE | FieldServiceModule.ChangeReason.Create.CreateServiceCancelledChangeReasonSupplier |
934
+ | `CancelServiceWorkOrderFlowTenant` | CREATE | FieldServiceModule.ChangeReason.Create.CreateServiceCancelledChangeReasonTenant |
935
+ | `CancelServiceWorkOrderSupplier` | CREATE | FieldServiceModule.ChangeReason.Create.CancelServiceWorkOrderSupplier |
936
+ | `CancelServiceWorkOrderTenant` | CREATE | FieldServiceModule.ChangeReason.Create.CancelServiceWorkOrderTenant |
937
+ | `CreateCollectionRescheduledChangeReasonTenant` | CREATE | FieldServiceModule.ChangeReason.Create.CreateCollectionRescheduledChangeReasonTenant |
938
+ | `CreateInstallCancelledChangeReasonSupplier` | CREATE | FieldServiceModule.ChangeReason.Create.CreateInstallCancelledChangeReasonSupplier |
939
+ | `CreateInstallCancelledChangeReasonTenant` | CREATE | FieldServiceModule.ChangeReason.Create.CreateInstallCancelledChangeReasonTenant |
940
+ | `CreateInstallRescheduledChangeReasonSupplier` | CREATE | FieldServiceModule.ChangeReason.Create.CreateInstallRescheduledChangeReasonSupplier |
941
+ | `CreateInstallRescheduledChangeReasonTenant` | CREATE | FieldServiceModule.ChangeReason.Create.CreateInstallRescheduledChangeReasonTenant |
942
+ | `CreatePrePullCancelledChangeReasonSupplier` | CREATE | FieldServiceModule.ChangeReason.Create.CreatePrePullCancelledChangeReasonSupplier |
943
+ | `CreatePrePullRescheduledChangeReasonSupplier` | CREATE | FieldServiceModule.ChangeReason.Create.CreatePrePullRescheduledChangeReasonSupplier |
944
+ | `CreateRemediationCancelledChangeReasonSupplier` | CREATE | FieldServiceModule.ChangeReason.Create.CreateRemediationCancelledChangeReasonSupplier |
945
+ | `CreateRemediationRescheduledChangeReasonSupplier` | CREATE | FieldServiceModule.ChangeReason.Create.CreateRemediationRescheduledChangeReasonSupplier |
946
+ | `CreateServiceCancelledChangeReasonSupplier` | CREATE | FieldServiceModule.ChangeReason.Create.CreateServiceCancelledChangeReasonSupplier |
947
+ | `CreateServiceCancelledChangeReasonTenant` | CREATE | FieldServiceModule.ChangeReason.Create.CreateServiceCancelledChangeReasonTenant |
948
+ | `CreateServiceRescheduledChangeReasonSupplier` | CREATE | FieldServiceModule.ChangeReason.Create.CreateServiceRescheduledChangeReasonSupplier |
949
+ | `CreateServiceRescheduledChangeReasonTenant` | CREATE | FieldServiceModule.ChangeReason.Create.CreateServiceRescheduledChangeReasonTenant |
950
+ | `RescheduleBusinessInstallWorkOrderSupplier` | CREATE | FieldServiceModule.ChangeReason.Create.CreateInstallRescheduledChangeReasonSupplier |
951
+ | `RescheduleBusinessInstallWorkOrderTenant` | CREATE | FieldServiceModule.ChangeReason.Create.CreateInstallRescheduledChangeReasonTenant |
952
+ | `RescheduleCollectionWorkOrderTenant` | CREATE | FieldServiceModule.ChangeReason.Create.CreateCollectionRescheduledChangeReasonTenant |
953
+ | `RescheduleInspectionWorkOrderSupplier` | CREATE | FieldServiceModule.ChangeReason.Create.CreateInstallRescheduledChangeReasonSupplier |
954
+ | `RescheduleInstallWorkOrderSupplier` | CREATE | FieldServiceModule.ChangeReason.Create.CreateInstallRescheduledChangeReasonSupplier |
955
+ | `RescheduleInstallWorkOrderTenant` | CREATE | FieldServiceModule.ChangeReason.Create.CreateInstallRescheduledChangeReasonTenant |
956
+ | `ReschedulePrePullWorkOrderSupplier` | CREATE | FieldServiceModule.ChangeReason.Create.CreatePrePullRescheduledChangeReasonSupplier |
957
+ | `RescheduleRemediationWorkOrderSupplier` | CREATE | FieldServiceModule.ChangeReason.Create.CreateRemediationRescheduledChangeReasonSupplier |
958
+ | `RescheduleServiceWorkOrderSupplier` | CREATE | FieldServiceModule.ChangeReason.Create.CreateServiceRescheduledChangeReasonSupplier |
959
+ | `RescheduleServiceWorkOrderTenant` | CREATE | FieldServiceModule.ChangeReason.Create.CreateServiceRescheduledChangeReasonTenant |
960
+ | `UpdateCancellationReasonDefault` | UPDATE | FieldServiceModule.ChangeReason.Update.UpdateCancellationReasonDefault |
961
+ | `UpdateSaDelayReasonDefault` | UPDATE | FieldServiceModule.ChangeReason.Update.UpdateSA_DELAYReasonDefault |
962
+ | `UpdateSaInformReasonDefault` | UPDATE | FieldServiceModule.ChangeReason.Update.UpdateSA_INFORMReasonDefault |
963
+ | `UpdateSaRescheduleReasonDefault` | UPDATE | FieldServiceModule.ChangeReason.Update.UpdateSA_RESCHEDULEReasonDefault |
964
+
965
+ #### PICRequest
966
+
967
+ | Action | Type | Event |
968
+ |--------|------|-------|
969
+ | `CancelOrderPreInstall` | CREATE | OrderModule.PICRequest.Create.CreatePICRequest |
970
+ | `CompletePicRequest` | UPDATE | OrderModule.PICRequest.Update.CompletePICRequest |
971
+ | `CompletePicRequestFlow` | STAGE_TRANSITION | OrderModule.PICRequest.Update.CompletePICRequest |
972
+ | `CreatePicRequest` | CREATE | OrderModule.PICRequest.Create.CreatePICRequest |
973
+ | `DefaultUpdatePicRequest` | UPDATE | OrderModule.PICRequest.Update.DefaultUpdatePICRequest |
974
+ | `OverrideMovePicToInProgress` | STAGE_TRANSITION | OrderModule.PICRequest.Transition.OverrideMovePICToInProgress |
975
+
976
+ **CompletePicRequestFlow Target Stages:** `PICRequestStageDone`
977
+
978
+ **OverrideMovePicToInProgress Target Stages:** `PICRequestStageInProgress`
979
+
980
+ #### Payment
981
+
982
+ | Action | Type | Event |
983
+ |--------|------|-------|
984
+ | `CancelPayment` | STAGE_TRANSITION | BillingModule.Payment.Transition.CancelPayment |
985
+ | `ConfirmPaymentSuccess` | STAGE_TRANSITION | BillingModule.Payment.Transition.ConfirmPaymentSuccess |
986
+ | `CreatePayment` | CREATE | BillingModule.Payment.Create.Create payment |
987
+ | `CreatePaymentForInvoices` | CREATE | BillingModule.Payment.Create.CreatePaymentForInvoices |
988
+ | `FailPayment` | STAGE_TRANSITION | BillingModule.Payment.Transition.FailPayment |
989
+ | `SetPaymentLink` | UPDATE | BillingModule.Payment.Update.SetPaymentLink |
990
+ | `SetPaymentPending` | STAGE_TRANSITION | BillingModule.Payment.Update.SetPaymentPending |
991
+ | `SetPaymentProcessing` | STAGE_TRANSITION | BillingModule.Payment.Transition.SetPaymentProcessing |
992
+ | `VoidPayment` | STAGE_TRANSITION | BillingModule.Payment.Transition.VoidPayment |
993
+
994
+ **CancelPayment Target Stages:** `PaymentStageCancelled`
995
+
996
+ **ConfirmPaymentSuccess Target Stages:** `PaymentStageProcessed`
997
+
998
+ **FailPayment Target Stages:** `PaymentStageError`
999
+
1000
+ **SetPaymentPending Target Stages:** `PaymentStagePending`
1001
+
1002
+ **SetPaymentProcessing Target Stages:** `PaymentStageProcessing`
1003
+
1004
+ **VoidPayment Target Stages:** `PaymentStageVoided`
1005
+
1006
+ #### Transaction
1007
+
1008
+ | Action | Type | Event |
1009
+ |--------|------|-------|
1010
+ | `CancelTransaction` | UPDATE | BillingModule.Transaction.Update.CancelTransaction |
1011
+ | `ConfirmTransaction` | UPDATE | BillingModule.Transaction.Update.ConfirmTransaction |
1012
+ | `CreateBillingRequestTransaction` | CREATE | BillingModule.Transaction.Create.CreateBillingRequestTransaction |
1013
+ | `CreateOtpTransaction` | CREATE | BillingModule.Transaction.Create.CreateOtpTransaction |
1014
+ | `FailTransaction` | UPDATE | BillingModule.Transaction.Update.FailTransaction |
1015
+ | `TransactionCreate` | CREATE | BillingModule.Transaction.Create.TransactionCreate |
1016
+ | `TransactionUpdate` | UPDATE | BillingModule.Transaction.Update.TransactionUpdate |
1017
+ | `UpdateBillingRequestTransactionStatus` | UPDATE | BillingModule.Transaction.Update.UpdateBillingRequestTransactionStatus |
1018
+ | `UpdateTransactionExternalRef` | UPDATE | BillingModule.Transaction.Update.UpdateTransactionExternalRef |
1019
+
1020
+ #### Note
1021
+
1022
+ | Action | Type | Event |
1023
+ |--------|------|-------|
1024
+ | `CaseCreateNote` | CREATE | SupportModule.Note.Create.CaseCreateNote |
1025
+ | `CreateNote` | CREATE | SupportModule.Note.Create.CreateNote |
1026
+ | `CreateNoteForCaseAssignment` | CREATE | SupportModule.Note.Create.CreateNoteForCaseAssignment |
1027
+ | `UpdateNote` | UPDATE | SupportModule.Note.Update.UpdateNote |
1028
+
1029
+ #### PermissionToFail
1030
+
1031
+ | Action | Type | Event |
1032
+ |--------|------|-------|
1033
+ | `ChangeApprovalStatus` | UPDATE | FieldServiceModule.PermissionToFail.Update.ChangeApprovalStatus |
1034
+ | `CreatePermissionToFail` | CREATE | FieldServiceModule.PermissionToFail.Create.CreatePermissionToFail |
1035
+ | `MoveBusinessInstallToRemediation` | CREATE | FieldServiceModule.PermissionToFail.Create.CreatePermissionToFail |
1036
+ | `MoveInstallWorkOrderToRemediation` | CREATE | FieldServiceModule.PermissionToFail.Create.CreatePermissionToFail |
1037
+ | `MovePrePullWorkOrderToRemediation` | CREATE | FieldServiceModule.PermissionToFail.Create.CreatePermissionToFail |
1038
+ | `MoveRemediationWorkOrderToRemediation` | CREATE | FieldServiceModule.PermissionToFail.Create.CreatePermissionToFail |
1039
+ | `MoveServiceWorkOrderToRemediation` | CREATE | FieldServiceModule.PermissionToFail.Create.CreatePermissionToFail |
1040
+
1041
+ #### Account
1042
+
1043
+ | Action | Type | Event |
1044
+ |--------|------|-------|
1045
+ | `ChangeBillingMode` | UPDATE | CrmModule.Account.Update.ChangeBillingMode |
1046
+ | `CreateBusinessAccount` | CREATE | CrmModule.Account.Create.CreateBusinessAccount |
1047
+ | `CreatePrimaryAccount` | CREATE | CrmModule.Account.Create.CreatePrimaryAccount |
1048
+ | `CreateResellerAccount` | CREATE | CrmModule.Account.Create.CreateResellerAccount |
1049
+ | `UpdateBusinessAccount` | UPDATE | CrmModule.Account.Update.UpdateBusinessAccount |
1050
+ | `UpdatePrimaryAccount` | UPDATE | CrmModule.Account.Update.UpdatePrimaryAccount |
1051
+ | `UpdateResellerAccount` | UPDATE | CrmModule.Account.Update.UpdateResellerAccount |
1052
+
1053
+ #### OntReplacementApproval
1054
+
1055
+ | Action | Type | Event |
1056
+ |--------|------|-------|
1057
+ | `ChangeOntReplacementRequestApprovalStatus` | UPDATE | FieldServiceModule.OntReplacementApproval.Update.ChangeOntReplacementRequestApprovalStatus |
1058
+ | `CreateOntReplacementApproval` | CREATE | FieldServiceModule.OntReplacementApproval.Create.CreateOntReplacementApproval |
1059
+ | `RequestToReplaceOnt` | CREATE | FieldServiceModule.OntReplacementApproval.Create.CreateOntReplacementApproval |
1060
+
1061
+ #### UgAuditOfInstallation
1062
+
1063
+ | Action | Type | Event |
1064
+ |--------|------|-------|
1065
+ | `CompleteInstallWorkOrderFlow` | CREATE | FieldServiceModule.UgAuditOfInstallation.Create.UG Audit Of Installation |
1066
+
1067
+ #### PaymentMethodRefund
1068
+
1069
+ | Action | Type | Event |
1070
+ |--------|------|-------|
1071
+ | `CompletePaymentMethodRefund` | UPDATE | BillingModule.PaymentMethodRefund.Update.CompletePaymentMethodRefund |
1072
+ | `CompletePaymentMethodRefundFlow` | STAGE_TRANSITION | BillingModule.PaymentMethodRefund.Update.CompletePaymentMethodRefund |
1073
+ | `CreatePaymentMethodRefund` | CREATE | BillingModule.PaymentMethodRefund.Create.CreatePaymentMethodRefund |
1074
+
1075
+ **CompletePaymentMethodRefundFlow Target Stages:** `PaymentMethodRefundStageDone`
1076
+
1077
+ #### UgExternalAudit
1078
+
1079
+ | Action | Type | Event |
1080
+ |--------|------|-------|
1081
+ | `CompletePrePullWorkOrderFlow` | CREATE | FieldServiceModule.UgExternalAudit.Create.UgExternalAuditCreate |
1082
+
1083
+ #### RemediationOutcomeForm
1084
+
1085
+ | Action | Type | Event |
1086
+ |--------|------|-------|
1087
+ | `CompleteRemediationWorkOrderFlow` | CREATE | FieldServiceModule.RemediationOutcomeForm.Create.Remediation Outcome Form |
1088
+
1089
+ #### YfFieldServiceVisit
1090
+
1091
+ | Action | Type | Event |
1092
+ |--------|------|-------|
1093
+ | `CompleteServiceWorkOrderFlow` | CREATE | FieldServiceModule.YfFieldServiceVisit.Create.YfFieldServiceVisitAudit |
1094
+
1095
+ #### ActivityLog
1096
+
1097
+ | Action | Type | Event |
1098
+ |--------|------|-------|
1099
+ | `CreateActivityLogEntry` | CREATE | AuditModule.ActivityLog.Create.CreateActivityLogEntry |
1100
+
1101
+ #### AffiliateCode
1102
+
1103
+ | Action | Type | Event |
1104
+ |--------|------|-------|
1105
+ | `CreateAffiliateCode` | CREATE | CrmModule.AffiliateCode.Create.CreateAffiliateCode |
1106
+
1107
+ #### Appointment
1108
+
1109
+ | Action | Type | Event |
1110
+ |--------|------|-------|
1111
+ | `CreateAppointment` | CREATE | CrmModule.Appointment.Create.CreateAppointment |
1112
+
1113
+ #### PgFileAllocation
1114
+
1115
+ | Action | Type | Event |
1116
+ |--------|------|-------|
1117
+ | `CreateAuddisPgSubmissionAllocation` | CREATE | BillingModule.PgFileAllocation.Create.CreateAuddisPgSubmissionAllocation |
1118
+ | `CreateBacsPgSubmissionAllocation` | CREATE | BillingModule.PgFileAllocation.Create.CreateBacsPgSubmissionAllocation |
1119
+ | `UpdatePgAllocationWithAcknowledgementFile` | UPDATE | BillingModule.PgFileAllocation.Update.UpdatePgAllocationWithAcknowledgementFile |
1120
+ | `UpdatePgAllocationWithBacsReport` | UPDATE | BillingModule.PgFileAllocation.Update.UpdatePgAllocationWithBacsReport |
1121
+
1122
+ #### Product
1123
+
1124
+ | Action | Type | Event |
1125
+ |--------|------|-------|
1126
+ | `CreateBundleProductAction` | CREATE | ProductModule.Product.Create.CreateBundleProductAction |
1127
+ | `CreateInternetProductAction` | CREATE | ProductModule.Product.Create.CreateInternetProductAction |
1128
+ | `CreateLaborProductAction` | CREATE | ProductModule.Product.Create.CreateLaborProductAction |
1129
+ | `CreateLandlineProductAction` | CREATE | ProductModule.Product.Create.CreateLandlineProductAction |
1130
+ | `CreateMeshProductAction` | CREATE | ProductModule.Product.Create.CreateMeshProductAction |
1131
+ | `CreateMobileProductAction` | CREATE | ProductModule.Product.Create.CreateMobileProductAction |
1132
+ | `UpdateBundleProductAction` | UPDATE | ProductModule.Product.Update.UpdateBundleProductAction |
1133
+ | `UpdateInternetProductAction` | UPDATE | ProductModule.Product.Update.UpdateInternetProductAction |
1134
+ | `UpdateLaborProductAction` | UPDATE | ProductModule.Product.Update.UpdateLaborProductAction |
1135
+ | `UpdateLandlineProductAction` | UPDATE | ProductModule.Product.Update.UpdateLandlineProductAction |
1136
+ | `UpdateMeshProductAction` | UPDATE | ProductModule.Product.Update.UpdateMeshProductAction |
1137
+ | `UpdateMobileProductAction` | UPDATE | ProductModule.Product.Update.UpdateMobileProductAction |
1138
+
1139
+ #### Reward
1140
+
1141
+ | Action | Type | Event |
1142
+ |--------|------|-------|
1143
+ | `CreateCashbackReward` | CREATE | CrmModule.Reward.Create.CreateCashbackReward |
1144
+
1145
+ #### Config
1146
+
1147
+ | Action | Type | Event |
1148
+ |--------|------|-------|
1149
+ | `CreateConfig` | CREATE | SchemaModule.Config.Create.CreateConfig |
1150
+ | `CreateNavigationConfig` | CREATE | SchemaModule.Config.Create.CreateNavigationConfig |
1151
+ | `UpdateConfig` | UPDATE | SchemaModule.Config.Update.UpdateConfig |
1152
+
1153
+ #### Contact
1154
+
1155
+ | Action | Type | Event |
1156
+ |--------|------|-------|
1157
+ | `CreateContact` | CREATE | CrmModule.Contact.Create.CreateContact |
1158
+ | `UpdateAdditionalCare` | UPDATE | CrmModule.Contact.Update.UpdateAdditionalCare |
1159
+ | `UpdateContact` | UPDATE | CrmModule.Contact.Update.UpdateContact |
1160
+ | `UpdateReferralCode` | UPDATE | CrmModule.Contact.Update.UpdateReferralCode |
1161
+
1162
+ #### Conversation
1163
+
1164
+ | Action | Type | Event |
1165
+ |--------|------|-------|
1166
+ | `CreateConversation` | CREATE | NotificationModule.Conversation.Create.CreateConversation |
1167
+ | `UpdateConversation` | UPDATE | NotificationModule.Conversation.Update.UpdateConversation |
1168
+
1169
+ #### CustomerDeviceOnt
1170
+
1171
+ | Action | Type | Event |
1172
+ |--------|------|-------|
1173
+ | `CreateCustomerDeviceOnt` | CREATE | ServiceModule.CustomerDeviceOnt.Create.CreateCustomerDeviceOnt |
1174
+ | `UpdateCustomerDeviceOnt` | UPDATE | ServiceModule.CustomerDeviceOnt.Update.UpdateCustomerDeviceONT |
1175
+
1176
+ #### EmailTemplate
1177
+
1178
+ | Action | Type | Event |
1179
+ |--------|------|-------|
1180
+ | `CreateEmailTemplate` | CREATE | NotificationModule.EmailTemplate.Create.CreateEmailTemplate |
1181
+ | `UpdateEmailTemplate` | UPDATE | NotificationModule.EmailTemplate.Update.UpdateEmailTemplate |
1182
+
1183
+ #### FieldServiceDispatchedProduct
1184
+
1185
+ | Action | Type | Event |
1186
+ |--------|------|-------|
1187
+ | `CreateFieldServiceDispatchedProduct` | CREATE | FieldServiceModule.FieldServiceDispatchedProduct.Create.CreateFieldServiceDispatchedProduct |
1188
+
1189
+ #### FieldServiceProduct
1190
+
1191
+ | Action | Type | Event |
1192
+ |--------|------|-------|
1193
+ | `CreateFieldServiceMeshProduct` | CREATE | FieldServiceModule.FieldServiceProduct.Create.CreateFieldServiceMeshProduct |
1194
+ | `CreateFieldServiceProduct` | CREATE | FieldServiceModule.FieldServiceProduct.Create.CreateFieldServiceProduct |
1195
+ | `CreateFieldServiceRouterProduct` | CREATE | FieldServiceModule.FieldServiceProduct.Create.CreateFieldServiceRouterProduct |
1196
+ | `EditFieldServiceProduct` | UPDATE | FieldServiceModule.FieldServiceProduct.Update.EditFieldServiceProduct |
1197
+
1198
+ #### Activity
1199
+
1200
+ | Action | Type | Event |
1201
+ |--------|------|-------|
1202
+ | `CreateFinalNoticeActivity` | CREATE | SchemaModule.Activity.Create.CreateFinalNoticeActivity |
1203
+ | `UpdateActivityDate` | UPDATE | SchemaModule.Activity.Update.UpdateActivityDate |
1204
+
1205
+ #### ImpersonationTracker
1206
+
1207
+ | Action | Type | Event |
1208
+ |--------|------|-------|
1209
+ | `CreateImpersonationTracker` | CREATE | IdentityModule.ImpersonationTracker.Create.CreateImpersonationTracker |
1210
+
1211
+ #### Lead
1212
+
1213
+ | Action | Type | Event |
1214
+ |--------|------|-------|
1215
+ | `CreateLead` | CREATE | CrmModule.Lead.Create.CreateLead |
1216
+ | `CreateLeadFromAddress` | CREATE | CrmModule.Lead.Create.CreateLead |
1217
+ | `MoveLeadToContacted` | STAGE_TRANSITION | CrmModule.Lead.Transition.MoveLeadToContacted |
1218
+ | `MoveLeadToLost` | STAGE_TRANSITION | CrmModule.Lead.Transition.MoveLeadToLost |
1219
+ | `MoveLeadToQualified` | STAGE_TRANSITION | CrmModule.Lead.Transition.MoveLeadToQualified |
1220
+ | `MoveLeadToWon` | STAGE_TRANSITION | CrmModule.Lead.Transition.MoveLeadToWon |
1221
+ | `UpdateLead` | UPDATE | CrmModule.Lead.Update.UpdateLead |
1222
+
1223
+ **MoveLeadToContacted Target Stages:** `LeadStageContacted`
1224
+
1225
+ **MoveLeadToLost Target Stages:** `LeadStageLost`
1226
+
1227
+ **MoveLeadToQualified Target Stages:** `LeadStageQualified`
1228
+
1229
+ **MoveLeadToWon Target Stages:** `LeadStageWon`
1230
+
1231
+ #### Message
1232
+
1233
+ | Action | Type | Event |
1234
+ |--------|------|-------|
1235
+ | `CreateMessage` | CREATE | NotificationModule.Message.Create.CreateMessage |
1236
+
1237
+ #### NetworkDevice
1238
+
1239
+ | Action | Type | Event |
1240
+ |--------|------|-------|
1241
+ | `CreateNetworkDevice` | CREATE | ServiceModule.NetworkDevice.Create.CreateNetworkDevice |
1242
+ | `EditNetworkDevice` | UPDATE | ServiceModule.NetworkDevice.Update.EditNetworkDevice |
1243
+
1244
+ #### Returns
1245
+
1246
+ | Action | Type | Event |
1247
+ |--------|------|-------|
1248
+ | `CreateNewReturn` | CREATE | FieldServiceModule.Returns.Create.CreateNewReturn |
1249
+ | `EditReturn` | UPDATE | FieldServiceModule.Returns.Update.EditReturn |
1250
+ | `ReActionReturnCompletion` | UPDATE | FieldServiceModule.Returns.Update.ReActionReturnCompletion |
1251
+
1252
+ #### OneTouchSwitch
1253
+
1254
+ | Action | Type | Event |
1255
+ |--------|------|-------|
1256
+ | `CreateOneTouchSwitchOrder` | CREATE | OrderModule.OneTouchSwitch.Create.CreateOneTouchSwitchOrder |
1257
+ | `UpdateLosingOneTouchSwitchOrder` | UPDATE | OrderModule.OneTouchSwitch.Update.UpdateLosingOneTouchSwitchOrder |
1258
+ | `UpdateOneTouchSwitchOrder` | UPDATE | OrderModule.OneTouchSwitch.Update.UpdateOneTouchSwitchOrder |
1259
+
1260
+ #### OrderCheck
1261
+
1262
+ | Action | Type | Event |
1263
+ |--------|------|-------|
1264
+ | `CreateOrderCheck` | CREATE | ServiceModule.OrderCheck.Create.CreateOrderCheck |
1265
+ | `Update` | UPDATE | ServiceModule.OrderCheck.Update.Update |
1266
+
1267
+ #### Referral
1268
+
1269
+ | Action | Type | Event |
1270
+ |--------|------|-------|
1271
+ | `CreateOrderReferral` | CREATE | CrmModule.Referral.Create.CreateOrderReferral |
1272
+
1273
+ #### PaymentMethod
1274
+
1275
+ | Action | Type | Event |
1276
+ |--------|------|-------|
1277
+ | `CreatePaymentMethod` | CREATE | BillingModule.PaymentMethod.Create.CreatePaymentMethod |
1278
+ | `UpdatePaymentMethod` | UPDATE | BillingModule.PaymentMethod.Update.UpdatePaymentMethod |
1279
+
1280
+ #### PgContact
1281
+
1282
+ | Action | Type | Event |
1283
+ |--------|------|-------|
1284
+ | `CreatePgContact` | CREATE | BillingModule.PgContact.Create.CreatePgContact |
1285
+ | `UpdatePgContact` | UPDATE | BillingModule.PgContact.Update.UpdatePgContact |
1286
+
1287
+ #### PgDispute
1288
+
1289
+ | Action | Type | Event |
1290
+ |--------|------|-------|
1291
+ | `CreatePgDispute` | CREATE | BillingModule.PgDispute.Create.CreatePgDispute |
1292
+ | `MovePgDisputeToClosed` | STAGE_TRANSITION | BillingModule.PgDispute.Transition.MovePgDisputeToClosed |
1293
+ | `MovePgDisputeToLost` | STAGE_TRANSITION | BillingModule.PgDispute.Transition.MovePgDisputeToLost |
1294
+ | `MovePgDisputeToUnderReview` | STAGE_TRANSITION | BillingModule.PgDispute.Transition.MovePgDisputeToUnderReview |
1295
+ | `MovePgDisputeToWon` | STAGE_TRANSITION | BillingModule.PgDispute.Transition.MovePgDisputeToWon |
1296
+
1297
+ **MovePgDisputeToClosed Target Stages:** `StatusStageClosed`
1298
+
1299
+ **MovePgDisputeToLost Target Stages:** `StatusStageLost`
1300
+
1301
+ **MovePgDisputeToUnderReview Target Stages:** `StatusStageUnderReview`
1302
+
1303
+ **MovePgDisputeToWon Target Stages:** `StatusStageWon`
1304
+
1305
+ #### PgLog
1306
+
1307
+ | Action | Type | Event |
1308
+ |--------|------|-------|
1309
+ | `CreatePgLog` | CREATE | AuditModule.PgLog.Create.CreatePgLog |
1310
+
1311
+ #### PgPaymentMethod
1312
+
1313
+ | Action | Type | Event |
1314
+ |--------|------|-------|
1315
+ | `CreatePgPaymentMethod` | CREATE | BillingModule.PgPaymentMethod.Create.CreatePgPaymentMethod |
1316
+ | `MovePgPaymentMethodToActive` | STAGE_TRANSITION | BillingModule.PgPaymentMethod.Transition.MovePgPaymentMethodToActive |
1317
+ | `MovePgPaymentMethodToAllocated` | STAGE_TRANSITION | BillingModule.PgPaymentMethod.Transition.MovePgPaymentMethodToAllocated |
1318
+ | `MovePgPaymentMethodToCancellationPending` | STAGE_TRANSITION | BillingModule.PgPaymentMethod.Transition.MovePgPaymentMethodToCancellationPending |
1319
+ | `MovePgPaymentMethodToCancelled` | STAGE_TRANSITION | BillingModule.PgPaymentMethod.Transition.MovePgPaymentMethodToCancelled |
1320
+ | `MovePgPaymentMethodToFailedFormatting` | STAGE_TRANSITION | BillingModule.PgPaymentMethod.Transition.MovePgPaymentMethodToFailedFormatting |
1321
+ | `MovePgPaymentMethodToFailedSubmission` | STAGE_TRANSITION | BillingModule.PgPaymentMethod.Transition.MovePgPaymentMethodToFailedSubmission |
1322
+ | `MovePgPaymentMethodToInvalid` | STAGE_TRANSITION | BillingModule.PgPaymentMethod.Transition.MovePgPaymentMethodToInvalid |
1323
+ | `MovePgPaymentMethodToProcessing` | STAGE_TRANSITION | BillingModule.PgPaymentMethod.Transition.MovePgPaymentMethodToProcessing |
1324
+ | `MovePgPaymentMethodToSubmitted` | STAGE_TRANSITION | BillingModule.PgPaymentMethod.Transition.MovePgPaymentMethodToSubmitted |
1325
+ | `MovePgPaymentMethodToValidated` | STAGE_TRANSITION | BillingModule.PgPaymentMethod.Transition.MovePgPaymentMethodToValidated |
1326
+ | `UpdatePgPaymentMethodActivatedDatetime` | UPDATE | BillingModule.PgPaymentMethod.Update.UpdatePgPaymentMethodActivatedDatetime |
1327
+ | `UpdatePgPaymentMethodFailedReason` | UPDATE | BillingModule.PgPaymentMethod.Update.UpdatePgPaymentMethodFailedReason |
1328
+ | `UpdatePgPaymentMethodFirstTransactionProcessed` | UPDATE | BillingModule.PgPaymentMethod.Update.UpdatePgPaymentMethodFirstTransactionProcessed |
1329
+ | `UpdatePgPaymentMethodValidatedDatetime` | UPDATE | BillingModule.PgPaymentMethod.Update.UpdatePgPaymentMethodValidatedDatetime |
1330
+
1331
+ **MovePgPaymentMethodToActive Target Stages:** `StatusStageActive`
1332
+
1333
+ **MovePgPaymentMethodToAllocated Target Stages:** `StatusStageAllocated`
1334
+
1335
+ **MovePgPaymentMethodToCancellationPending Target Stages:** `StatusStageCancellationPending`
1336
+
1337
+ **MovePgPaymentMethodToCancelled Target Stages:** `StatusStageCancelled`
1338
+
1339
+ **MovePgPaymentMethodToFailedFormatting Target Stages:** `StatusStageFailedFormatting`
1340
+
1341
+ **MovePgPaymentMethodToFailedSubmission Target Stages:** `StatusStageFailedSubmission`
1342
+
1343
+ **MovePgPaymentMethodToInvalid Target Stages:** `StatusStageInvalid`
1344
+
1345
+ **MovePgPaymentMethodToProcessing Target Stages:** `StatusStageProcessing`
1346
+
1347
+ **MovePgPaymentMethodToSubmitted Target Stages:** `StatusStageSubmitted`
1348
+
1349
+ **MovePgPaymentMethodToValidated Target Stages:** `StatusStageValidated`
1350
+
1351
+ #### PgDirectDebitFile
1352
+
1353
+ | Action | Type | Event |
1354
+ |--------|------|-------|
1355
+ | `CreatePgResponse` | CREATE | BillingModule.PgDirectDebitFile.Create.CreatePgResponse |
1356
+ | `CreatePgSubmission` | CREATE | BillingModule.PgDirectDebitFile.Create.CreatePgSubmission |
1357
+ | `MovePgResponseToFailed` | STAGE_TRANSITION | BillingModule.PgDirectDebitFile.Transition.MovePgResponseToFailed |
1358
+ | `MovePgResponseToProcessed` | STAGE_TRANSITION | BillingModule.PgDirectDebitFile.Transition.MovePgResponseToProcessed |
1359
+ | `MovePgResponseToSaved` | STAGE_TRANSITION | BillingModule.PgDirectDebitFile.Transition.MovePgResponseToSaved |
1360
+ | `MovePgSubmissionToClosed` | STAGE_TRANSITION | BillingModule.PgDirectDebitFile.Transition.MovePgSubmissionToClosed |
1361
+ | `MovePgSubmissionToFailedFormatting` | STAGE_TRANSITION | BillingModule.PgDirectDebitFile.Transition.MovePgSubmissionToFailedFormatting |
1362
+ | `MovePgSubmissionToFailedSubmission` | STAGE_TRANSITION | BillingModule.PgDirectDebitFile.Transition.MovePgSubmissionToFailedSubmission |
1363
+ | `MovePgSubmissionToProcessing` | STAGE_TRANSITION | BillingModule.PgDirectDebitFile.Transition.MovePgSubmissionToProcessing |
1364
+ | `MovePgSubmissionToSubmitted` | STAGE_TRANSITION | BillingModule.PgDirectDebitFile.Transition.MovePgSubmissionToSubmitted |
1365
+ | `MovePgSubmissionToSucceeded` | STAGE_TRANSITION | BillingModule.PgDirectDebitFile.Transition.MovePgSubmissionToSucceeded |
1366
+ | `UpdatePgResponse` | UPDATE | BillingModule.PgDirectDebitFile.Update.UpdatePgResponse |
1367
+ | `UpdatePgSubmission` | UPDATE | BillingModule.PgDirectDebitFile.Update.UpdatePgSubmission |
1368
+
1369
+ **MovePgResponseToFailed Target Stages:** `ResponseStatusStageFailed`
1370
+
1371
+ **MovePgResponseToProcessed Target Stages:** `ResponseStatusStageProcessed`
1372
+
1373
+ **MovePgResponseToSaved Target Stages:** `ResponseStatusStageSaved`
1374
+
1375
+ **MovePgSubmissionToClosed Target Stages:** `SubmissionStatusStageClosed`
1376
+
1377
+ **MovePgSubmissionToFailedFormatting Target Stages:** `SubmissionStatusStageFailedFormatting`
1378
+
1379
+ **MovePgSubmissionToFailedSubmission Target Stages:** `SubmissionStatusStageFailedSubmission`
1380
+
1381
+ **MovePgSubmissionToProcessing Target Stages:** `SubmissionStatusStageProcessing`
1382
+
1383
+ **MovePgSubmissionToSubmitted Target Stages:** `SubmissionStatusStageSubmitted`
1384
+
1385
+ **MovePgSubmissionToSucceeded Target Stages:** `SubmissionStatusStageSucceeded`
1386
+
1387
+ #### PgVocalink
1388
+
1389
+ | Action | Type | Event |
1390
+ |--------|------|-------|
1391
+ | `CreatePgSortCode` | CREATE | BillingModule.PgVocalink.Create.CreatePgSortCode |
1392
+
1393
+ #### PgSortCodeSubstitution
1394
+
1395
+ | Action | Type | Event |
1396
+ |--------|------|-------|
1397
+ | `CreatePgSubstitutionRule` | CREATE | BillingModule.PgSortCodeSubstitution.Create.CreatePgSubstitutionRule |
1398
+
1399
+ #### PgTransaction
1400
+
1401
+ | Action | Type | Event |
1402
+ |--------|------|-------|
1403
+ | `CreatePgTransactionCharge` | CREATE | BillingModule.PgTransaction.Create.CreatePgTransactionCharge |
1404
+ | `MovePgTransactionChargeToAllocated` | STAGE_TRANSITION | BillingModule.PgTransaction.Transition.MovePgTransactionChargeToAllocated |
1405
+ | `MovePgTransactionChargeToFailed` | STAGE_TRANSITION | BillingModule.PgTransaction.Transition.MovePgTransactionChargeToFailed |
1406
+ | `MovePgTransactionChargeToFailedFormatting` | STAGE_TRANSITION | BillingModule.PgTransaction.Transition.MovePgTransactionChargeToFailedFormatting |
1407
+ | `MovePgTransactionChargeToFailedSubmission` | STAGE_TRANSITION | BillingModule.PgTransaction.Transition.MovePgTransactionChargeToFailedSubmission |
1408
+ | `MovePgTransactionChargeToProcessing` | STAGE_TRANSITION | BillingModule.PgTransaction.Transition.MovePgTransactionChargeToProcessing |
1409
+ | `MovePgTransactionChargeToReady` | STAGE_TRANSITION | BillingModule.PgTransaction.Transition.MovePgTransactionChargeToReady |
1410
+ | `MovePgTransactionChargeToSubmitted` | STAGE_TRANSITION | BillingModule.PgTransaction.Transition.MovePgTransactionChargeToSubmitted |
1411
+ | `MovePgTransactionChargeToSucceeded` | STAGE_TRANSITION | BillingModule.PgTransaction.Transition.MovePgTransactionChargeToSucceeded |
1412
+ | `UpdatePgTransactionFailedReason` | UPDATE | BillingModule.PgTransaction.Update.UpdatePgTransactionFailedReason |
1413
+
1414
+ **MovePgTransactionChargeToAllocated Target Stages:** `ChargeStatusStageAllocated`
1415
+
1416
+ **MovePgTransactionChargeToFailed Target Stages:** `ChargeStatusStageFailed`
1417
+
1418
+ **MovePgTransactionChargeToFailedFormatting Target Stages:** `ChargeStatusStageFailedFormatting`
1419
+
1420
+ **MovePgTransactionChargeToFailedSubmission Target Stages:** `ChargeStatusStageFailedSubmission`
1421
+
1422
+ **MovePgTransactionChargeToProcessing Target Stages:** `ChargeStatusStageProcessing`
1423
+
1424
+ **MovePgTransactionChargeToReady Target Stages:** `ChargeStatusStageReady`
1425
+
1426
+ **MovePgTransactionChargeToSubmitted Target Stages:** `ChargeStatusStageSubmitted`
1427
+
1428
+ **MovePgTransactionChargeToSucceeded Target Stages:** `ChargeStatusStageSucceeded`
1429
+
1430
+ #### PgAccountValidation
1431
+
1432
+ | Action | Type | Event |
1433
+ |--------|------|-------|
1434
+ | `CreatePgValidationRule` | CREATE | BillingModule.PgAccountValidation.Create.CreatePgValidationRule |
1435
+
1436
+ #### PgWebhookAttempt
1437
+
1438
+ | Action | Type | Event |
1439
+ |--------|------|-------|
1440
+ | `CreatePgWebhookAttempt` | CREATE | AuditModule.PgWebhookAttempt.Create.CreatePgWebhookAttempt |
1441
+
1442
+ #### PgWebhook
1443
+
1444
+ | Action | Type | Event |
1445
+ |--------|------|-------|
1446
+ | `CreatePgWebhook` | CREATE | AuditModule.PgWebhook.Create.CreatePgWebhook |
1447
+ | `MovePgWebhookToFailed` | STAGE_TRANSITION | AuditModule.PgWebhook.Transition.MovePgWebhookToFailed |
1448
+ | `MovePgWebhookToRetrying` | STAGE_TRANSITION | AuditModule.PgWebhook.Transition.MovePgWebhookToRetrying |
1449
+ | `MovePgWebhookToSucceeded` | STAGE_TRANSITION | AuditModule.PgWebhook.Transition.MovePgWebhookToSucceeded |
1450
+
1451
+ **MovePgWebhookToFailed Target Stages:** `StatusStageFailed`
1452
+
1453
+ **MovePgWebhookToRetrying Target Stages:** `StatusStageRetrying`
1454
+
1455
+ **MovePgWebhookToSucceeded Target Stages:** `StatusStageSucceeded`
1456
+
1457
+ #### PushNotification
1458
+
1459
+ | Action | Type | Event |
1460
+ |--------|------|-------|
1461
+ | `CreatePushNotification` | CREATE | NotificationModule.PushNotification.Create.CreatePushNotification |
1462
+
1463
+ #### OrderItem
1464
+
1465
+ | Action | Type | Event |
1466
+ |--------|------|-------|
1467
+ | `CreateRecontractOrderItem` | CREATE | OrderModule.OrderItem.Create.CreateRecontractOrderItem |
1468
+ | `OrderItemUpdate` | UPDATE | OrderModule.OrderItem.Update.OrderItemUpdate |
1469
+ | `PriceMatch` | UPDATE | OrderModule.OrderItem.Update.Price Match |
1470
+ | `ReassociateOrderItemDevices` | UPDATE | OrderModule.OrderItem.Update.ReassociateOrderItemDevices |
1471
+
1472
+ #### VoiceConfiguration
1473
+
1474
+ | Action | Type | Event |
1475
+ |--------|------|-------|
1476
+ | `CreateRecontractVoiceConfiguration` | CREATE | ServiceModule.VoiceConfiguration.Create.CreateRecontractVoiceConfiguration |
1477
+ | `UpdateVoiceConfiguration` | UPDATE | ServiceModule.VoiceConfiguration.Update.UpdateVoiceConfiguration |
1478
+
1479
+ #### SalesTerritory
1480
+
1481
+ | Action | Type | Event |
1482
+ |--------|------|-------|
1483
+ | `CreateSalesTerritory` | CREATE | CrmModule.SalesTerritory.Create.CreateSalesTerritory |
1484
+ | `EditSalesTerritory` | UPDATE | CrmModule.SalesTerritory.Update.EditSalesTerritory |
1485
+
1486
+ #### Team
1487
+
1488
+ | Action | Type | Event |
1489
+ |--------|------|-------|
1490
+ | `CreateTeam` | CREATE | IdentityModule.Team.Create.CreateTeam |
1491
+ | `UpdateTeam` | UPDATE | IdentityModule.Team.Update.UpdateTeam |
1492
+
1493
+ #### TimeSlot
1494
+
1495
+ | Action | Type | Event |
1496
+ |--------|------|-------|
1497
+ | `CreateTimeSlot` | CREATE | IdentityModule.TimeSlot.Create.CreateTimeSlot |
1498
+ | `UpdateTimeSlot` | UPDATE | IdentityModule.TimeSlot.Update.UpdateTimeSlot |
1499
+
1500
+ #### WayleaveAudit
1501
+
1502
+ | Action | Type | Event |
1503
+ |--------|------|-------|
1504
+ | `CreateWayleaveWorkOrderFlow` | CREATE | FieldServiceModule.WayleaveAudit.Create.WayleaveAuditCreate |
1505
+
1506
+ #### WorkOrderStatusUpdate
1507
+
1508
+ | Action | Type | Event |
1509
+ |--------|------|-------|
1510
+ | `CreateWorkOrderStatusUpdate` | CREATE | FieldServiceModule.WorkOrderStatusUpdate.Create.CreateWorkOrderStatusUpdate |
1511
+
1512
+ #### TwilioUserUpdate
1513
+
1514
+ | Action | Type | Event |
1515
+ |--------|------|-------|
1516
+ | `Createtwiliouserupdate` | CREATE | NotificationModule.TwilioUserUpdate.Create.Createtwiliouserupdate |
1517
+
1518
+ #### CreditNote
1519
+
1520
+ | Action | Type | Event |
1521
+ |--------|------|-------|
1522
+ | `CreditNoteCreate` | CREATE | BillingModule.CreditNote.Create.CreditNoteCreate |
1523
+ | `CreditNoteUpdate` | UPDATE | BillingModule.CreditNote.Update.CreditNoteUpdate |
1524
+
1525
+ #### CustomerDeviceAta
1526
+
1527
+ | Action | Type | Event |
1528
+ |--------|------|-------|
1529
+ | `CustomerDeviceAtaUpdate` | UPDATE | ServiceModule.CustomerDeviceAta.Update.CustomerDeviceAtaUpdate |
1530
+
1531
+ #### CustomerDeviceRouter
1532
+
1533
+ | Action | Type | Event |
1534
+ |--------|------|-------|
1535
+ | `CustomerDeviceRouterCreate` | CREATE | ServiceModule.CustomerDeviceRouter.Create.CustomerDeviceRouterCreate |
1536
+ | `CustomerDeviceRouterUpdate` | UPDATE | ServiceModule.CustomerDeviceRouter.Update.CustomerDeviceRouterUpdate |
1537
+
1538
+ #### Discount
1539
+
1540
+ | Action | Type | Event |
1541
+ |--------|------|-------|
1542
+ | `DiscountCreate` | CREATE | ProductModule.Discount.Create.DiscountCreate |
1543
+ | `DiscountUpdate` | UPDATE | ProductModule.Discount.Update.DiscountUpdate |
1544
+
1545
+ #### Invoice
1546
+
1547
+ | Action | Type | Event |
1548
+ |--------|------|-------|
1549
+ | `InvoiceCreate` | CREATE | BillingModule.Invoice.Create.InvoiceCreate |
1550
+ | `InvoiceUpdate` | UPDATE | BillingModule.Invoice.Update.InvoiceUpdate |
1551
+ | `SetInvoiceDunningBrqRequest` | UPDATE | BillingModule.Invoice.Update.SetInvoiceDunningBrqRequest |
1552
+ | `SetInvoiceDunningOtpCreated` | UPDATE | BillingModule.Invoice.Update.SetInvoiceDunningOtpCreated |
1553
+ | `SetInvoiceDunningPaymentFailed` | UPDATE | BillingModule.Invoice.Update.SetInvoiceDunningPaymentFailed |
1554
+ | `SetInvoiceFinalDunningReminder` | UPDATE | BillingModule.Invoice.Update.SetInvoiceFinalDunningReminder |
1555
+ | `SetInvoiceInitialDunningReminder` | UPDATE | BillingModule.Invoice.Update.SetInvoiceInitialDunningReminder |
1556
+ | `SetInvoicePaidFromOtp` | UPDATE | BillingModule.Invoice.Update.SetInvoicePaidFromOtp |
1557
+
1558
+ #### KnowledgeArticle
1559
+
1560
+ | Action | Type | Event |
1561
+ |--------|------|-------|
1562
+ | `KnowledgeArticleReleaseNoteCreate` | CREATE | SupportModule.KnowledgeArticle.Create.KnowledgeArticleReleaseNoteCreate |
1563
+ | `KnowledgeArticleUserGuideCreate` | CREATE | SupportModule.KnowledgeArticle.Create.KnowledgeArticleUserGuideCreate |
1564
+
1565
+ #### SiteSpecificRiskAssessmentOutcomeForm
1566
+
1567
+ | Action | Type | Event |
1568
+ |--------|------|-------|
1569
+ | `MoveInspectionWorkOrderToInProgressSubstantial` | CREATE | FieldServiceModule.SiteSpecificRiskAssessmentOutcomeForm.Create.CreateSsra |
1570
+ | `MoveInstallWorkOrderToInProgressSubstantial` | CREATE | FieldServiceModule.SiteSpecificRiskAssessmentOutcomeForm.Create.CreateSsra |
1571
+ | `MovePrePullWorkOrderToInProgressSubstantial` | CREATE | FieldServiceModule.SiteSpecificRiskAssessmentOutcomeForm.Create.CreateSsra |
1572
+ | `MoveRemediationWorkOrderToInProgressSubstantial` | CREATE | FieldServiceModule.SiteSpecificRiskAssessmentOutcomeForm.Create.CreateSsra |
1573
+ | `MoveServiceWorkOrderToInProgressSubstantial` | CREATE | FieldServiceModule.SiteSpecificRiskAssessmentOutcomeForm.Create.CreateSsra |
1574
+ | `UpdateSsra` | UPDATE | FieldServiceModule.SiteSpecificRiskAssessmentOutcomeForm.Update.UpdateSsra |
1575
+
1576
+ #### Outage
1577
+
1578
+ | Action | Type | Event |
1579
+ |--------|------|-------|
1580
+ | `MoveOutageToSolvedAction` | STAGE_TRANSITION | ServiceModule.Outage.Transition.MoveOutageToSolvedAction |
1581
+
1582
+ **MoveOutageToSolvedAction Target Stages:** `OutageDefaultStageSolved`
1583
+
1584
+ #### ServiceAppointment
1585
+
1586
+ | Action | Type | Event |
1587
+ |--------|------|-------|
1588
+ | `NewAppointment` | CREATE | FieldServiceModule.ServiceAppointment.Create.NewAppointment |
1589
+
1590
+ #### Offer
1591
+
1592
+ | Action | Type | Event |
1593
+ |--------|------|-------|
1594
+ | `OfferCreate` | CREATE | ProductModule.Offer.Create.OfferCreate |
1595
+ | `OfferUpdate` | UPDATE | ProductModule.Offer.Update.OfferUpdate |
1596
+
1597
+ #### OverlayRealA55
1598
+
1599
+ | Action | Type | Event |
1600
+ |--------|------|-------|
1601
+ | `OverlayA55Update` | UPDATE | FieldServiceModule.OverlayRealA55.Update.Overlay A55 Update |
1602
+
1603
+ #### PriceBook
1604
+
1605
+ | Action | Type | Event |
1606
+ |--------|------|-------|
1607
+ | `PriceBookCreateAction` | CREATE | ProductModule.PriceBook.Create.PriceBookCreateAction |
1608
+ | `PriceBookUpdateAction` | UPDATE | ProductModule.PriceBook.Update.PriceBookUpdateAction |
1609
+
1610
+ #### ScheduleSlot
1611
+
1612
+ | Action | Type | Event |
1613
+ |--------|------|-------|
1614
+ | `ScheduleSlotCreate` | CREATE | FieldServiceModule.ScheduleSlot.Create.ScheduleSlotCreate |
1615
+ | `ScheduleSlotUpdate` | UPDATE | FieldServiceModule.ScheduleSlot.Update.ScheduleSlotUpdate |
1616
+
1617
+ #### CallLeg
1618
+
1619
+ | Action | Type | Event |
1620
+ |--------|------|-------|
1621
+ | `UpdateCall` | UPDATE | NotificationModule.CallLeg.Update.UpdateCall |
1622
+
1623
+ #### Call
1624
+
1625
+ | Action | Type | Event |
1626
+ |--------|------|-------|
1627
+ | `UpdateCallTranscriptionUrl` | UPDATE | NotificationModule.Call.Update.UpdateCallTranscriptionUrl |
1628
+
1629
+ #### Service
1630
+
1631
+ | Action | Type | Event |
1632
+ |--------|------|-------|
1633
+ | `UpdateService` | UPDATE | ServiceModule.Service.Update.UpdateService |
1634
+
1635
+ #### Email
1636
+
1637
+ | Action | Type | Event |
1638
+ |--------|------|-------|
1639
+ | `UpdateSupportEmail` | UPDATE | NotificationModule.Email.Update.Update Support Email |
1640
+
1641
+ #### User
1642
+
1643
+ | Action | Type | Event |
1644
+ |--------|------|-------|
1645
+ | `UpdateUser` | UPDATE | IdentityModule.User.Update.UpdateUser |
1646
+
1647
+ #### Visit
1648
+
1649
+ | Action | Type | Event |
1650
+ |--------|------|-------|
1651
+ | `VisitCreate` | CREATE | CrmModule.Visit.Create.VisitCreate |
1652
+ | `VisitUpdate` | UPDATE | CrmModule.Visit.Update.VisitUpdate |
1653
+
1654
+ #### CustomerPhonePorting
1655
+
1656
+ | Action | Type | Event |
1657
+ |--------|------|-------|
1658
+ | `VoiceConfigUpdate` | UPDATE | ServiceModule.CustomerPhonePorting.Update.VoiceConfigUpdate |
1659
+
136
1660
  ## Record Wrappers
137
1661
 
138
1662
  Record wrappers provide typed access to record data and action methods.
@@ -146,7 +1670,7 @@ const order = await odin.orders.get(orderId);
146
1670
  // Access typed properties
147
1671
  console.log(order.id); // string
148
1672
  console.log(order.properties); // OrderProperties
149
- console.log(order.raw); // Full OdinRecord
1673
+ console.log(order.record); // Full OdinRecord
150
1674
 
151
1675
  // Check if record is new (unsaved)
152
1676
  if (order.isNew) {
@@ -160,6 +1684,8 @@ if (order.isNew) {
160
1684
 
161
1685
  ### Link Management
162
1686
 
1687
+ #### Generic Links (.link())
1688
+
163
1689
  ```typescript
164
1690
  // Queue links to be sent with next action
165
1691
  const note = odin.notes.new();
@@ -172,52 +1698,102 @@ await note
172
1698
  await order.unlink(contactId);
173
1699
  ```
174
1700
 
175
- ### STEP_FLOW Actions (Multi-Step Workflows)
1701
+ #### Named Associations (Builder Pattern)
176
1702
 
177
- STEP_FLOW actions allow executing multiple steps in a single transaction using a FlowBuilder pattern.
1703
+ Actions with association fields generate typed `.link*()` methods:
178
1704
 
179
- #### Basic Usage
1705
+ ```typescript
1706
+ // IDE autocomplete shows available association methods
1707
+ await odin.referrals.new()
1708
+ .createOrderReferral({})
1709
+ .linkCampaignReferrals({ id: campaignId, entity: "CrmModule:Campaign" })
1710
+ .linkOrderReferral(order) // Pass OdinRecord directly
1711
+ .execute();
1712
+ ```
1713
+
1714
+ ### Stage Transition Actions
1715
+
1716
+ Stage transitions move a record to a new pipeline stage. They have `TARGET_STAGES` and optionally collect additional properties.
180
1717
 
181
1718
  ```typescript
182
- // Get the record
183
- const cboRec = await odin.contractBuyOuts.get(cbo.id);
1719
+ // Simple stage transition
1720
+ const caseRec = await odin.cases.get(caseId);
1721
+ await caseRec.moveCaseToSolved({
1722
+ Category: "BILLING",
1723
+ SubCategory: "PAYMENT_ISSUE",
1724
+ AdditionalNotes: "Customer confirmed resolution",
1725
+ });
184
1726
 
185
- // Execute a multi-step flow
186
- await cboRec
187
- .moveCboToApproved({ journeyId: order.id }) // Start flow (returns FlowBuilder)
188
- .approveCbo(cbo.id, { // UPDATE step - id required first
189
- Amount: cbo.properties.Amount,
190
- FinalBillVerified: cbo.properties.FinalBillVerified,
191
- PreviousProvider: cbo.properties.PreviousProvider,
1727
+ // Stage transition with journey tracking
1728
+ await workOrderRec.moveCollectionWorkOrderToCancelled({
1729
+ CancellationReason: "Customer request",
1730
+ }, { journeyId: order.id });
1731
+ ```
1732
+
1733
+ Stage transitions have a `stageKey` that determines the target stage:
1734
+ ```typescript
1735
+ // DTO has TARGET_STAGES constant
1736
+ MoveCaseToSolvedActionDto.TARGET_STAGES // ["SolvedStage"]
1737
+ ```
1738
+
1739
+ ### Multi-Step Flow Actions
1740
+
1741
+ Multi-step flows execute multiple actions in a single transaction using a FlowBuilder pattern.
1742
+ Unlike stage transitions, they create/update multiple records across different entities.
1743
+
1744
+ #### Basic Usage
1745
+
1746
+ ```typescript
1747
+ // CreateCaseForChat - creates Case, Conversation, and Message in one transaction
1748
+ await odin.cases.new()
1749
+ .createCaseForChat({ journeyId: contactId })
1750
+ .createSocialMediaCase({ // Step 1: Create the case
1751
+ Channel: "CHAT",
1752
+ Subject: "Billing inquiry",
1753
+ Description: "Customer has question about invoice",
1754
+ SocialMediaExternalId: externalId,
1755
+ ContactId: contactId,
1756
+ })
1757
+ .createConversation({ // Step 2: Create conversation
1758
+ Channel: "CHAT",
1759
+ Status: "CREATED",
1760
+ ExternalId: conversationSid,
1761
+ Source: "TWILIO",
1762
+ })
1763
+ .createMessage({ // Step 3: Create first message
1764
+ Body: "Hello, I need help with my bill",
1765
+ SenderType: "CUSTOMER",
1766
+ From: customerPhone,
1767
+ To: supportNumber,
192
1768
  })
193
- .execute(); // Execute the flow
1769
+ .execute();
194
1770
  ```
195
1771
 
196
1772
  #### Step Method Signatures
197
1773
 
198
1774
  Step methods have different signatures based on their action type:
199
1775
 
200
- **UPDATE steps** - Require record `id` as first parameter:
1776
+ **CREATE steps** - No `id` parameter (creates new record):
201
1777
  ```typescript
202
- // UPDATE step signature: (id, properties, options?)
203
- .approveCbo(id: string, properties: ApproveCboProperties, options?)
204
- .updateWorkOrder(id: string, properties: UpdateWorkOrderProperties, options?)
1778
+ // CREATE step signature: (properties, options?)
1779
+ .createSocialMediaCase(properties: CreateSocialMediaCaseProperties)
1780
+ .createConversation(properties: CreateConversationProperties)
1781
+ .createMessage(properties: CreateMessageProperties)
205
1782
  ```
206
1783
 
207
- **CREATE steps** - No `id` parameter (creates new record):
1784
+ **UPDATE steps** - Require record `id` as first parameter:
208
1785
  ```typescript
209
- // CREATE step signature: (properties, options?)
210
- .createFollowUp(properties: CreateFollowUpProperties, options?)
211
- .createNote(properties: CreateNoteProperties, options?)
1786
+ // UPDATE step signature: (id, properties, options?)
1787
+ .updateWorkOrder(id: string, properties: UpdateWorkOrderProperties)
1788
+ .approveCbo(id: string, properties: ApproveCboProperties)
212
1789
  ```
213
1790
 
214
1791
  #### Complex Multi-Step Example
215
1792
 
216
1793
  ```typescript
217
- // Get the work order record
1794
+ // Flow with both UPDATE and CREATE steps
218
1795
  const workOrderRec = await odin.workOrders.get(workOrderId);
219
1796
 
220
- // Flow with both UPDATE and CREATE steps
221
1797
  await workOrderRec
222
1798
  .completeWorkOrderFlow({ journeyId: parentOrder.id })
223
1799
  .updateWorkOrder(workOrderRec.id, { // UPDATE step - id required
@@ -232,14 +1808,14 @@ await workOrderRec
232
1808
  .execute();
233
1809
  ```
234
1810
 
235
- #### With Associations
1811
+ #### With Associations (Generic .link())
236
1812
 
237
1813
  ```typescript
238
- // Link records during flow execution
1814
+ // Queue generic links to be sent with next action
239
1815
  const invoiceRec = await odin.invoices.get(invoiceId);
240
1816
 
241
1817
  await invoiceRec
242
- .link({ id: contactId, entity: "CrmModule:Contact" }) // Queue link
1818
+ .link({ id: contactId, entity: "CrmModule:Contact" }) // Generic link
243
1819
  .processInvoiceFlow({ journeyId: orderId })
244
1820
  .approveInvoice(invoiceRec.id, {
245
1821
  ApprovedBy: userId,
@@ -248,25 +1824,154 @@ await invoiceRec
248
1824
  .execute(); // Links are sent with the action
249
1825
  ```
250
1826
 
1827
+ #### With Named Associations (Builder Pattern)
1828
+
1829
+ Actions with association fields generate typed `.link*()` methods:
1830
+
1831
+ ```typescript
1832
+ // Typed association methods - IDE autocomplete shows available links
1833
+ await odin.referrals.new()
1834
+ .createOrderReferral({})
1835
+ .linkCampaignReferrals({ id: campaignId, entity: "CrmModule:Campaign" })
1836
+ .linkOrderReferral(order) // Can pass OdinRecord directly
1837
+ .execute();
1838
+
1839
+ // Mix generic .link() with named associations
1840
+ await odin.referrals.new()
1841
+ .link({ id: accountId, entity: "CrmModule:Account" }) // Generic link
1842
+ .createOrderReferral({})
1843
+ .linkCampaignReferrals(campaign) // Named association
1844
+ .execute();
1845
+
1846
+ // Inspect payload before executing
1847
+ const builder = odin.referrals.new()
1848
+ .createOrderReferral({})
1849
+ .linkCampaignReferrals({ id: campaignId, entity: "CrmModule:Campaign" });
1850
+
1851
+ console.log(builder.getData()); // View what will be sent
1852
+ await builder.execute(); // Then execute
1853
+ ```
1854
+
251
1855
  ## Events
252
1856
 
253
- Subscribe to RabbitMQ events using the exported routing keys:
1857
+ Subscribe to RabbitMQ events using `@RabbitSubscribe`. The SDK provides typed routing keys for all actions and entities.
1858
+
1859
+ ### Action-Specific Events (Recommended)
1860
+
1861
+ Use `Dto.EVENT_NAME` static constants for type-safe routing keys:
254
1862
 
255
1863
  ```typescript
256
- import { ROUTING_KEY_ORDER_CREATED, ROUTING_KEY_ORDER_UPDATED } from '@d19n/youfibre-odin-sdk/entities';
257
- import { ROUTING_KEY_ACTIVATE_ORDER } from '@d19n/youfibre-odin-sdk/actions';
1864
+ import { MoveCollectionWorkOrderToCancelledDto } from '@d19n/youfibre-odin-sdk/actions';
1865
+ import { MoveCaseToSolvedActionDto } from '@d19n/youfibre-odin-sdk/actions';
1866
+ import { CreateCaseForChatDto } from '@d19n/youfibre-odin-sdk/actions';
1867
+ import { IDbRecordUpdated } from '@d19n/odin-types/dist/core';
1868
+
1869
+ // Subscribe to a specific stage transition action
1870
+ @RabbitSubscribe({
1871
+ exchange: process.env.ODIN_ORG_ID,
1872
+ routingKey: MoveCollectionWorkOrderToCancelledDto.EVENT_NAME,
1873
+ queue: `${process.env.DOMAIN}.FieldService.WorkOrder.Cancelled`,
1874
+ errorHandler: SubscriberErrorHandler.handleError,
1875
+ })
1876
+ private async handleWorkOrderCancelled(msg: IDbRecordUpdated) {
1877
+ try {
1878
+ const { id, entity, properties, stage } = msg;
1879
+ // Handle cancelled work order
1880
+ } catch (e) {
1881
+ this.logger.error("Failed to handle work order cancellation", e);
1882
+ }
1883
+ }
258
1884
 
259
- // Entity events
260
- await channel.consume(ROUTING_KEY_ORDER_CREATED, (msg) => {
261
- const event: OrderCreatedEvent = JSON.parse(msg.content.toString());
262
- // Handle event
263
- });
1885
+ // Subscribe to a multi-step flow completion
1886
+ @RabbitSubscribe({
1887
+ exchange: process.env.ODIN_ORG_ID,
1888
+ routingKey: CreateCaseForChatDto.EVENT_NAME,
1889
+ queue: `${process.env.DOMAIN}.Support.Case.ChatCreated`,
1890
+ errorHandler: SubscriberErrorHandler.handleError,
1891
+ })
1892
+ private async handleChatCaseCreated(msg: IDbRecordUpdated) {
1893
+ try {
1894
+ const { id, entity, properties } = msg;
1895
+ // Handle new chat case
1896
+ } catch (e) {
1897
+ this.logger.error("Failed to handle chat case creation", e);
1898
+ }
1899
+ }
1900
+ ```
264
1901
 
265
- // Action events
266
- await channel.consume(ROUTING_KEY_ACTIVATE_ORDER, (msg) => {
267
- const event: ActivateOrderMessage = JSON.parse(msg.content.toString());
268
- // Handle action completion
269
- });
1902
+ ### Entity Lifecycle Events
1903
+
1904
+ For general record lifecycle events (created, updated, deleted):
1905
+
1906
+ ```typescript
1907
+ import {
1908
+ WORK_ORDER,
1909
+ SUB_DB_RECORD_UPDATED,
1910
+ SUB_DB_RECORD_CREATED,
1911
+ SUB_DB_RECORD_DELETED,
1912
+ } from '@d19n/youfibre-odin-sdk/entities';
1913
+ import { IDbRecordUpdated, IDbRecordCreated } from '@d19n/odin-types/dist/core';
1914
+ import { LogsConstants } from '@d19n/logs/dist/constants';
1915
+
1916
+ // Subscribe to all WorkOrder updates
1917
+ @RabbitSubscribe({
1918
+ exchange: process.env.ODIN_ORG_ID,
1919
+ routingKey: `FieldServiceModule.${WORK_ORDER}.${SUB_DB_RECORD_UPDATED}`,
1920
+ queue: `${process.env.DOMAIN}.FieldService.WorkOrder.Updated`,
1921
+ errorHandler: SubscriberErrorHandler.handleError,
1922
+ })
1923
+ private async handleWorkOrderUpdated(msg: IDbRecordUpdated) {
1924
+ try {
1925
+ // Check for specific event types
1926
+ if (msg.event === LogsConstants.DB_RECORD_STAGE_UPDATED) {
1927
+ // Handle stage transition
1928
+ } else if (msg.event === LogsConstants.DB_RECORD_UPDATED) {
1929
+ // Handle property update
1930
+ }
1931
+ } catch (e) {
1932
+ this.logger.error("Failed to handle work order update", e);
1933
+ }
1934
+ }
1935
+ ```
1936
+
1937
+ ### Queue Naming Conventions
1938
+
1939
+ Use consistent, descriptive queue names that indicate domain ownership:
1940
+
1941
+ ```typescript
1942
+ // Pattern: ${DOMAIN}.${Module}.${Entity}.${EventDescription}
1943
+
1944
+ // Good examples:
1945
+ queue: `${process.env.DOMAIN}.FieldService.WorkOrder.Cancelled`
1946
+ queue: `${process.env.DOMAIN}.Support.Case.ChatCreated`
1947
+ queue: `${process.env.DOMAIN}.Billing.Invoice.Approved`
1948
+ queue: `${process.env.DOMAIN}.Orders.Order.Activated`
1949
+
1950
+ // Avoid generic names that don't indicate purpose:
1951
+ // ❌ queue: `${process.env.DOMAIN}.Handler.handleEvent`
1952
+ // ❌ queue: `${process.env.DOMAIN}.WorkOrderHandler.handle`
1953
+ ```
1954
+
1955
+ ### Event Name Reference
1956
+
1957
+ ```typescript
1958
+ // Action DTOs have EVENT_NAME constants
1959
+ MoveCollectionWorkOrderToCancelledDto.EVENT_NAME
1960
+ // => "FieldServiceModule.WorkOrder.Transition.MoveCollectionWorkOrderToCancelled"
1961
+
1962
+ MoveCaseToSolvedActionDto.EVENT_NAME
1963
+ // => "SupportModule.Case.Update.MoveCaseToSolvedAction"
1964
+
1965
+ CreateCaseForChatDto.EVENT_NAME
1966
+ // => "SupportModule.Case.Flow.CreateCaseForChat"
1967
+
1968
+ // Entity lifecycle event patterns
1969
+ SUB_DB_RECORD_CREATED // "DbRecordCreated"
1970
+ SUB_DB_RECORD_UPDATED // "DbRecordUpdated"
1971
+ SUB_DB_RECORD_DELETED // "DbRecordDeleted"
1972
+
1973
+ // Full routing key: {Module}.{Entity}.{EventConstant}
1974
+ // e.g., "FieldServiceModule.WorkOrder.DbRecordUpdated"
270
1975
  ```
271
1976
 
272
1977
  ## Migration Guide