@d19n/youfibre-odin-sdk 2.0.372 → 2.0.374
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -1
- package/dist/actions-v2/CreateLinkedWorkOrderFlowDto.d.ts +18 -18
- package/dist/actions-v2/CreateNetworkAdjustmentWorkOrderDto.d.ts +18 -18
- package/dist/actions-v2/CreateOutboundDialCampaignDto.d.ts +8 -1
- package/dist/actions-v2/CreateOutboundDialSessionDto.d.ts +8 -1
- package/dist/actions-v2/EditNetworkDeviceDto.d.ts +11 -11
- package/dist/actions-v2/OrderBuilderCreateContactDto.d.ts +98 -0
- package/dist/actions-v2/OrderBuilderCreateContactDto.js +54 -0
- package/dist/actions-v2/OrderBuilderUpdateContactDto.d.ts +14 -19
- package/dist/actions-v2/UpdateOutboundDialSessionDto.d.ts +8 -1
- package/dist/actions-v2/UpdateWorkOrderWithdrawEquipmentChargeDto.d.ts +73 -0
- package/dist/actions-v2/UpdateWorkOrderWithdrawEquipmentChargeDto.js +56 -0
- package/dist/actions-v2/UpdateoutbounddialcampaignDto.d.ts +8 -1
- package/dist/entities-v2/BillingAdjustment.d.ts +3 -1
- package/dist/entities-v2/BillingAdjustment.js +3 -1
- package/dist/entities-v2/OutboundDialCampaign.d.ts +9 -1
- package/dist/entities-v2/OutboundDialCampaign.js +2 -0
- package/dist/entities-v2/OutboundDialSession.d.ts +9 -1
- package/dist/entities-v2/OutboundDialSession.js +2 -0
- package/dist/records-v2/ContactRecord.d.ts +29 -0
- package/dist/records-v2/ContactRecord.js +36 -0
- package/dist/records-v2/WorkOrderRecord.d.ts +27 -0
- package/dist/records-v2/WorkOrderRecord.js +29 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -398,7 +398,7 @@ This SDK includes **205** entities across **13** modules.
|
|
|
398
398
|
|
|
399
399
|
## Actions
|
|
400
400
|
|
|
401
|
-
This SDK includes **
|
|
401
|
+
This SDK includes **937** actions.
|
|
402
402
|
|
|
403
403
|
### Action Types
|
|
404
404
|
|
|
@@ -658,6 +658,7 @@ This SDK includes **935** actions.
|
|
|
658
658
|
| `UpdateRemediationWorkOrder` | UPDATE | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Update.UpdateRemediationWorkOrder |
|
|
659
659
|
| `UpdateSetReturnedLegacy` | UPDATE | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Update.UpdateSetReturnedLegacy |
|
|
660
660
|
| `UpdateWayleaveWorkOrder` | UPDATE | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Update.UpdateWayleaveWorkOrder |
|
|
661
|
+
| `UpdateWorkOrderWithdrawEquipmentCharge` | UPDATE | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Update.UpdateWorkOrderWithdrawEquipmentCharge |
|
|
661
662
|
|
|
662
663
|
**CancelInstallWorkOrderFlowSupplier Target Stages:** `WorkOrderStageCancelled`
|
|
663
664
|
|
|
@@ -1638,6 +1639,7 @@ This SDK includes **935** actions.
|
|
|
1638
1639
|
|--------|------|-------|
|
|
1639
1640
|
| `CreateContact` | CREATE | k1.t-hEOJjsDb.CrmModule.Contact.Create.CreateContact |
|
|
1640
1641
|
| `CreateContactSalesApp` | CREATE | k1.t-hEOJjsDb.CrmModule.Contact.Create.CreateContactSalesApp |
|
|
1642
|
+
| `OrderBuilderCreateContact` | CREATE | k1.t-hEOJjsDb.CrmModule.Contact.Create.OrderBuilderCreateContact |
|
|
1641
1643
|
| `OrderBuilderUpdateContact` | UPDATE | k1.t-hEOJjsDb.CrmModule.Contact.Update.OrderBuilderUpdateContact |
|
|
1642
1644
|
| `UpdateAdditionalCare` | UPDATE | k1.t-hEOJjsDb.CrmModule.Contact.Update.UpdateAdditionalCare |
|
|
1643
1645
|
| `UpdateContactAppPreferences` | UPDATE | k1.t-hEOJjsDb.CrmModule.Contact.Update.UpdateContactAppPreferences |
|
|
@@ -479,20 +479,6 @@ export declare class CreatePrePullWorkOrderDto extends OdinRecordCreateDto<Creat
|
|
|
479
479
|
* @property Optional fields: 5
|
|
480
480
|
*/
|
|
481
481
|
export interface CreateNetworkAdjustmentWorkOrderProperties {
|
|
482
|
-
/**
|
|
483
|
-
* EarlierAvailability
|
|
484
|
-
*
|
|
485
|
-
* Earlier Availability (Field Operations - WorkOrder)
|
|
486
|
-
* @type {BOOLEAN}
|
|
487
|
-
*/
|
|
488
|
-
EarlierAvailability?: boolean | null;
|
|
489
|
-
/**
|
|
490
|
-
* Provider
|
|
491
|
-
*
|
|
492
|
-
* network to provision service to (Field Operations - WorkOrder)
|
|
493
|
-
* @type {ENUM}
|
|
494
|
-
*/
|
|
495
|
-
Provider?: string | null;
|
|
496
482
|
/**
|
|
497
483
|
* Description
|
|
498
484
|
*
|
|
@@ -500,6 +486,13 @@ export interface CreateNetworkAdjustmentWorkOrderProperties {
|
|
|
500
486
|
* @type {TEXT_LONG}
|
|
501
487
|
*/
|
|
502
488
|
Description?: string | null;
|
|
489
|
+
/**
|
|
490
|
+
* SLADays
|
|
491
|
+
*
|
|
492
|
+
* Data field for WorkOrder records. Used by Field Operations team.
|
|
493
|
+
* @type {NUMBER}
|
|
494
|
+
*/
|
|
495
|
+
SLADays?: number | null;
|
|
503
496
|
/**
|
|
504
497
|
* IsVIP
|
|
505
498
|
*
|
|
@@ -508,12 +501,19 @@ export interface CreateNetworkAdjustmentWorkOrderProperties {
|
|
|
508
501
|
*/
|
|
509
502
|
IsVIP?: boolean | null;
|
|
510
503
|
/**
|
|
511
|
-
*
|
|
504
|
+
* Provider
|
|
512
505
|
*
|
|
513
|
-
*
|
|
514
|
-
* @type {
|
|
506
|
+
* network to provision service to (Field Operations - WorkOrder)
|
|
507
|
+
* @type {ENUM}
|
|
515
508
|
*/
|
|
516
|
-
|
|
509
|
+
Provider?: string | null;
|
|
510
|
+
/**
|
|
511
|
+
* EarlierAvailability
|
|
512
|
+
*
|
|
513
|
+
* Earlier Availability (Field Operations - WorkOrder)
|
|
514
|
+
* @type {BOOLEAN}
|
|
515
|
+
*/
|
|
516
|
+
EarlierAvailability?: boolean | null;
|
|
517
517
|
}
|
|
518
518
|
/**
|
|
519
519
|
* Create Network Adjustment Work Order
|
|
@@ -26,20 +26,6 @@ export interface CreateNetworkAdjustmentWorkOrderMessage extends OdinRecordCreat
|
|
|
26
26
|
* @property Optional fields: 5
|
|
27
27
|
*/
|
|
28
28
|
export interface CreateNetworkAdjustmentWorkOrderProperties {
|
|
29
|
-
/**
|
|
30
|
-
* EarlierAvailability
|
|
31
|
-
*
|
|
32
|
-
* Earlier Availability (Field Operations - WorkOrder)
|
|
33
|
-
* @type {BOOLEAN}
|
|
34
|
-
*/
|
|
35
|
-
EarlierAvailability?: boolean | null;
|
|
36
|
-
/**
|
|
37
|
-
* Provider
|
|
38
|
-
*
|
|
39
|
-
* network to provision service to (Field Operations - WorkOrder)
|
|
40
|
-
* @type {ENUM}
|
|
41
|
-
*/
|
|
42
|
-
Provider?: string | null;
|
|
43
29
|
/**
|
|
44
30
|
* Description
|
|
45
31
|
*
|
|
@@ -47,6 +33,13 @@ export interface CreateNetworkAdjustmentWorkOrderProperties {
|
|
|
47
33
|
* @type {TEXT_LONG}
|
|
48
34
|
*/
|
|
49
35
|
Description?: string | null;
|
|
36
|
+
/**
|
|
37
|
+
* SLADays
|
|
38
|
+
*
|
|
39
|
+
* Data field for WorkOrder records. Used by Field Operations team.
|
|
40
|
+
* @type {NUMBER}
|
|
41
|
+
*/
|
|
42
|
+
SLADays?: number | null;
|
|
50
43
|
/**
|
|
51
44
|
* IsVIP
|
|
52
45
|
*
|
|
@@ -55,12 +48,19 @@ export interface CreateNetworkAdjustmentWorkOrderProperties {
|
|
|
55
48
|
*/
|
|
56
49
|
IsVIP?: boolean | null;
|
|
57
50
|
/**
|
|
58
|
-
*
|
|
51
|
+
* Provider
|
|
59
52
|
*
|
|
60
|
-
*
|
|
61
|
-
* @type {
|
|
53
|
+
* network to provision service to (Field Operations - WorkOrder)
|
|
54
|
+
* @type {ENUM}
|
|
62
55
|
*/
|
|
63
|
-
|
|
56
|
+
Provider?: string | null;
|
|
57
|
+
/**
|
|
58
|
+
* EarlierAvailability
|
|
59
|
+
*
|
|
60
|
+
* Earlier Availability (Field Operations - WorkOrder)
|
|
61
|
+
* @type {BOOLEAN}
|
|
62
|
+
*/
|
|
63
|
+
EarlierAvailability?: boolean | null;
|
|
64
64
|
}
|
|
65
65
|
/**
|
|
66
66
|
* Create Network Adjustment Work Order
|
|
@@ -23,7 +23,7 @@ export interface CreateOutboundDialCampaignMessage extends OdinRecordCreatedEven
|
|
|
23
23
|
* Properties for CreateOutboundDialCampaign action
|
|
24
24
|
*
|
|
25
25
|
* @property Required fields: 6
|
|
26
|
-
* @property Optional fields:
|
|
26
|
+
* @property Optional fields: 4
|
|
27
27
|
*/
|
|
28
28
|
export interface CreateOutboundDialCampaignProperties {
|
|
29
29
|
/**
|
|
@@ -95,6 +95,13 @@ export interface CreateOutboundDialCampaignProperties {
|
|
|
95
95
|
* @type {BOOLEAN}
|
|
96
96
|
*/
|
|
97
97
|
RetentionCampaign?: boolean | null;
|
|
98
|
+
/**
|
|
99
|
+
* NewCasesPerOwnCase
|
|
100
|
+
*
|
|
101
|
+
* Round-robin: new cases handed out before each of the agent's own cases, e.g. 2 gives new, new, own (CASES-1986). Empty or 0 keeps own cases first.
|
|
102
|
+
* @type {NUMBER}
|
|
103
|
+
*/
|
|
104
|
+
NewCasesPerOwnCase?: number | null;
|
|
98
105
|
}
|
|
99
106
|
/**
|
|
100
107
|
* CreateOutboundDialCampaign
|
|
@@ -22,7 +22,7 @@ export interface CreateOutboundDialSessionMessage extends OdinRecordCreatedEvent
|
|
|
22
22
|
* Properties for CreateOutboundDialSession action
|
|
23
23
|
*
|
|
24
24
|
* @property Required fields: 9
|
|
25
|
-
* @property Optional fields:
|
|
25
|
+
* @property Optional fields: 5
|
|
26
26
|
*/
|
|
27
27
|
export interface CreateOutboundDialSessionProperties {
|
|
28
28
|
/**
|
|
@@ -129,6 +129,13 @@ export interface CreateOutboundDialSessionProperties {
|
|
|
129
129
|
* @type {DATE_TIME}
|
|
130
130
|
*/
|
|
131
131
|
LastCaseRequestAt?: string | null;
|
|
132
|
+
/**
|
|
133
|
+
* NewSinceOwnCase
|
|
134
|
+
*
|
|
135
|
+
* New cases this session has been handed since its last own case; drives the campaign's own-case ratio (CASES-1986).
|
|
136
|
+
* @type {NUMBER}
|
|
137
|
+
*/
|
|
138
|
+
NewSinceOwnCase?: number | null;
|
|
132
139
|
}
|
|
133
140
|
/**
|
|
134
141
|
* CreateOutboundDialSession
|
|
@@ -26,6 +26,14 @@ export interface EditNetworkDeviceMessage extends OdinRecordUpdatedEvent<EditNet
|
|
|
26
26
|
* @property Optional fields: 2
|
|
27
27
|
*/
|
|
28
28
|
export interface EditNetworkDeviceProperties {
|
|
29
|
+
/**
|
|
30
|
+
* IpAddress
|
|
31
|
+
*
|
|
32
|
+
* ip address for the olt (Network Operations - NetworkDevice)
|
|
33
|
+
* @type {TEXT}
|
|
34
|
+
* @required
|
|
35
|
+
*/
|
|
36
|
+
IpAddress: string;
|
|
29
37
|
/**
|
|
30
38
|
* Model
|
|
31
39
|
*
|
|
@@ -35,13 +43,12 @@ export interface EditNetworkDeviceProperties {
|
|
|
35
43
|
*/
|
|
36
44
|
Model: string;
|
|
37
45
|
/**
|
|
38
|
-
*
|
|
46
|
+
* Name
|
|
39
47
|
*
|
|
40
|
-
*
|
|
48
|
+
* Network Device Name (Network Operations - NetworkDevice)
|
|
41
49
|
* @type {TEXT}
|
|
42
|
-
* @required
|
|
43
50
|
*/
|
|
44
|
-
|
|
51
|
+
Name?: string | null;
|
|
45
52
|
/**
|
|
46
53
|
* ExPolygonId
|
|
47
54
|
*
|
|
@@ -49,13 +56,6 @@ export interface EditNetworkDeviceProperties {
|
|
|
49
56
|
* @type {TEXT}
|
|
50
57
|
*/
|
|
51
58
|
ExPolygonId?: string | null;
|
|
52
|
-
/**
|
|
53
|
-
* Name
|
|
54
|
-
*
|
|
55
|
-
* Network Device Name (Network Operations - NetworkDevice)
|
|
56
|
-
* @type {TEXT}
|
|
57
|
-
*/
|
|
58
|
-
Name?: string | null;
|
|
59
59
|
}
|
|
60
60
|
/**
|
|
61
61
|
* EditNetworkDevice
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* OrderBuilderCreateContact Action DTO
|
|
3
|
+
*
|
|
4
|
+
* Collects a new Contact in Order Builder V2 step 2. Loaded by name by the desktop builder and rendered through CoreForm; the contact is created by the order batch, so this action is the form and its rules rather than the save. The fields the builder asks for are therefore set here rather than in React. A sibling of CreateContact, which keeps serving every other create journey: this one is not the default form and is not a record-header button. Form copied from CreateContact. CORE-1516.
|
|
5
|
+
*
|
|
6
|
+
* @module CrmModule
|
|
7
|
+
* @entity Contact
|
|
8
|
+
* @actionKey OrderBuilderCreateContact
|
|
9
|
+
* @event k1.t-hEOJjsDb.CrmModule.Contact.Create.OrderBuilderCreateContact
|
|
10
|
+
*
|
|
11
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
12
|
+
*/
|
|
13
|
+
import { OdinRecordCreateDto, OdinRecordCreatedEvent } from '@d19n/odin-types/dist/core';
|
|
14
|
+
/**
|
|
15
|
+
* RabbitMQ message payload for OrderBuilderCreateContact created events
|
|
16
|
+
*
|
|
17
|
+
* @event k1.t-hEOJjsDb.CrmModule.Contact.Create.OrderBuilderCreateContact
|
|
18
|
+
*/
|
|
19
|
+
export interface OrderBuilderCreateContactMessage extends OdinRecordCreatedEvent<OrderBuilderCreateContactDto, OrderBuilderCreateContactProperties> {
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Properties for OrderBuilderCreateContact action
|
|
23
|
+
*
|
|
24
|
+
* @property Required fields: 3
|
|
25
|
+
* @property Optional fields: 3
|
|
26
|
+
*/
|
|
27
|
+
export interface OrderBuilderCreateContactProperties {
|
|
28
|
+
/**
|
|
29
|
+
* FirstName
|
|
30
|
+
*
|
|
31
|
+
* Contacts First Name (Sales - Contact)
|
|
32
|
+
* @type {TEXT}
|
|
33
|
+
* @required
|
|
34
|
+
*/
|
|
35
|
+
FirstName: string;
|
|
36
|
+
/**
|
|
37
|
+
* LastName
|
|
38
|
+
*
|
|
39
|
+
* Contacts Last Name (Sales - Contact)
|
|
40
|
+
* @type {TEXT}
|
|
41
|
+
* @required
|
|
42
|
+
*/
|
|
43
|
+
LastName: string;
|
|
44
|
+
/**
|
|
45
|
+
* EmailAddress
|
|
46
|
+
*
|
|
47
|
+
* Contacts Email Address (Sales - Contact)
|
|
48
|
+
* @type {EMAIL}
|
|
49
|
+
* @required
|
|
50
|
+
*/
|
|
51
|
+
EmailAddress: string;
|
|
52
|
+
/**
|
|
53
|
+
* MarketingConsent
|
|
54
|
+
*
|
|
55
|
+
* I am happy to hear from YouFibre by email, WhatsApp and SMS about YouFibre’s broadband packages and any special offers. I am aware that I can opt-out at any time. For details on how we manage your data, please see our privacy policy.
|
|
56
|
+
* @type {BOOLEAN}
|
|
57
|
+
*/
|
|
58
|
+
MarketingConsent?: boolean | null;
|
|
59
|
+
/**
|
|
60
|
+
* Phone
|
|
61
|
+
*
|
|
62
|
+
* Phone number (Sales - Contact)
|
|
63
|
+
* @type {PHONE_NUMBER_E164_GB}
|
|
64
|
+
*/
|
|
65
|
+
Phone?: string | null;
|
|
66
|
+
}
|
|
67
|
+
/**
|
|
68
|
+
* OrderBuilderCreateContact
|
|
69
|
+
*
|
|
70
|
+
* Collects a new Contact in Order Builder V2 step 2. Loaded by name by the desktop builder and rendered through CoreForm; the contact is created by the order batch, so this action is the form and its rules rather than the save. The fields the builder asks for are therefore set here rather than in React. A sibling of CreateContact, which keeps serving every other create journey: this one is not the default form and is not a record-header button. Form copied from CreateContact. CORE-1516.
|
|
71
|
+
*
|
|
72
|
+
* @actionType CREATE - Creates a new Contact record
|
|
73
|
+
* @module CrmModule
|
|
74
|
+
* @entity Contact
|
|
75
|
+
* @event k1.t-hEOJjsDb.CrmModule.Contact.Create.OrderBuilderCreateContact
|
|
76
|
+
* @permission schema.action.orderbuildercreatecontact.trigger
|
|
77
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
78
|
+
*/
|
|
79
|
+
export declare class OrderBuilderCreateContactDto extends OdinRecordCreateDto<OrderBuilderCreateContactProperties> {
|
|
80
|
+
/** Used by SDK generators to identify action type */
|
|
81
|
+
static readonly ACTION_TYPE = "CREATE";
|
|
82
|
+
static readonly ACTION_KEY = "OrderBuilderCreateContact";
|
|
83
|
+
static readonly MODULE_NAME = "CrmModule";
|
|
84
|
+
static readonly ENTITIES: string[];
|
|
85
|
+
static readonly EVENT_NAME = "k1.t-hEOJjsDb.CrmModule.Contact.Create.OrderBuilderCreateContact";
|
|
86
|
+
static readonly PERMISSION = "schema.action.orderbuildercreatecontact.trigger";
|
|
87
|
+
/** Step metadata - entity this action targets */
|
|
88
|
+
static readonly STEP_ENTITY = "CrmModule:Contact";
|
|
89
|
+
static readonly STEP_SCHEMA_ID = "33643a0d-5b77-4895-a2da-991e0fd3432f";
|
|
90
|
+
static readonly STEP_SCHEMA_ACTION_ID = "2d295a37-7256-4303-b490-d3de6e9a32ff";
|
|
91
|
+
static readonly AUTO_LINK_PARENT = true;
|
|
92
|
+
readonly actionName: string;
|
|
93
|
+
readonly schemaActionId: string;
|
|
94
|
+
readonly entity: string;
|
|
95
|
+
constructor(properties: OrderBuilderCreateContactProperties, options?: {
|
|
96
|
+
journeyId?: string;
|
|
97
|
+
});
|
|
98
|
+
}
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* OrderBuilderCreateContact Action DTO
|
|
4
|
+
*
|
|
5
|
+
* Collects a new Contact in Order Builder V2 step 2. Loaded by name by the desktop builder and rendered through CoreForm; the contact is created by the order batch, so this action is the form and its rules rather than the save. The fields the builder asks for are therefore set here rather than in React. A sibling of CreateContact, which keeps serving every other create journey: this one is not the default form and is not a record-header button. Form copied from CreateContact. CORE-1516.
|
|
6
|
+
*
|
|
7
|
+
* @module CrmModule
|
|
8
|
+
* @entity Contact
|
|
9
|
+
* @actionKey OrderBuilderCreateContact
|
|
10
|
+
* @event k1.t-hEOJjsDb.CrmModule.Contact.Create.OrderBuilderCreateContact
|
|
11
|
+
*
|
|
12
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
13
|
+
*/
|
|
14
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
|
+
exports.OrderBuilderCreateContactDto = void 0;
|
|
16
|
+
const core_1 = require("@d19n/odin-types/dist/core");
|
|
17
|
+
/**
|
|
18
|
+
* OrderBuilderCreateContact
|
|
19
|
+
*
|
|
20
|
+
* Collects a new Contact in Order Builder V2 step 2. Loaded by name by the desktop builder and rendered through CoreForm; the contact is created by the order batch, so this action is the form and its rules rather than the save. The fields the builder asks for are therefore set here rather than in React. A sibling of CreateContact, which keeps serving every other create journey: this one is not the default form and is not a record-header button. Form copied from CreateContact. CORE-1516.
|
|
21
|
+
*
|
|
22
|
+
* @actionType CREATE - Creates a new Contact record
|
|
23
|
+
* @module CrmModule
|
|
24
|
+
* @entity Contact
|
|
25
|
+
* @event k1.t-hEOJjsDb.CrmModule.Contact.Create.OrderBuilderCreateContact
|
|
26
|
+
* @permission schema.action.orderbuildercreatecontact.trigger
|
|
27
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
28
|
+
*/
|
|
29
|
+
class OrderBuilderCreateContactDto extends core_1.OdinRecordCreateDto {
|
|
30
|
+
constructor(properties, options) {
|
|
31
|
+
super({
|
|
32
|
+
entity: 'CrmModule:Contact',
|
|
33
|
+
type: undefined,
|
|
34
|
+
properties,
|
|
35
|
+
journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
|
|
36
|
+
});
|
|
37
|
+
this.actionName = 'OrderBuilderCreateContact';
|
|
38
|
+
this.schemaActionId = '2d295a37-7256-4303-b490-d3de6e9a32ff';
|
|
39
|
+
this.entity = 'CrmModule:Contact';
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
exports.OrderBuilderCreateContactDto = OrderBuilderCreateContactDto;
|
|
43
|
+
/** Used by SDK generators to identify action type */
|
|
44
|
+
OrderBuilderCreateContactDto.ACTION_TYPE = 'CREATE';
|
|
45
|
+
OrderBuilderCreateContactDto.ACTION_KEY = 'OrderBuilderCreateContact';
|
|
46
|
+
OrderBuilderCreateContactDto.MODULE_NAME = 'CrmModule';
|
|
47
|
+
OrderBuilderCreateContactDto.ENTITIES = ['Contact'];
|
|
48
|
+
OrderBuilderCreateContactDto.EVENT_NAME = 'k1.t-hEOJjsDb.CrmModule.Contact.Create.OrderBuilderCreateContact';
|
|
49
|
+
OrderBuilderCreateContactDto.PERMISSION = 'schema.action.orderbuildercreatecontact.trigger';
|
|
50
|
+
/** Step metadata - entity this action targets */
|
|
51
|
+
OrderBuilderCreateContactDto.STEP_ENTITY = 'CrmModule:Contact';
|
|
52
|
+
OrderBuilderCreateContactDto.STEP_SCHEMA_ID = '33643a0d-5b77-4895-a2da-991e0fd3432f';
|
|
53
|
+
OrderBuilderCreateContactDto.STEP_SCHEMA_ACTION_ID = '2d295a37-7256-4303-b490-d3de6e9a32ff';
|
|
54
|
+
OrderBuilderCreateContactDto.AUTO_LINK_PARENT = true;
|
|
@@ -21,8 +21,8 @@ export interface OrderBuilderUpdateContactMessage extends OdinRecordUpdatedEvent
|
|
|
21
21
|
/**
|
|
22
22
|
* Properties for OrderBuilderUpdateContact action
|
|
23
23
|
*
|
|
24
|
-
* @property Required fields:
|
|
25
|
-
* @property Optional fields:
|
|
24
|
+
* @property Required fields: 5
|
|
25
|
+
* @property Optional fields: 11
|
|
26
26
|
*/
|
|
27
27
|
export interface OrderBuilderUpdateContactProperties {
|
|
28
28
|
/**
|
|
@@ -50,12 +50,21 @@ export interface OrderBuilderUpdateContactProperties {
|
|
|
50
50
|
*/
|
|
51
51
|
LastName: string;
|
|
52
52
|
/**
|
|
53
|
-
*
|
|
53
|
+
* Are you medically dependent on your broadband?
|
|
54
54
|
*
|
|
55
|
-
*
|
|
55
|
+
* Is the customer medically dependant on their broadband (Sales - Contact)
|
|
56
56
|
* @type {ENUM}
|
|
57
|
+
* @required
|
|
57
58
|
*/
|
|
58
|
-
|
|
59
|
+
MedicallyDependant: string;
|
|
60
|
+
/**
|
|
61
|
+
* Do any members of your household rely on a Telecare Alarm?
|
|
62
|
+
*
|
|
63
|
+
* Does the customer use a Telecare Alarm (Sales - Contact)
|
|
64
|
+
* @type {ENUM}
|
|
65
|
+
* @required
|
|
66
|
+
*/
|
|
67
|
+
TelecareAlarm: string;
|
|
59
68
|
/**
|
|
60
69
|
* Phone
|
|
61
70
|
*
|
|
@@ -106,20 +115,6 @@ export interface OrderBuilderUpdateContactProperties {
|
|
|
106
115
|
* @type {TEXT}
|
|
107
116
|
*/
|
|
108
117
|
CurrentContractType?: string | null;
|
|
109
|
-
/**
|
|
110
|
-
* Are you medically dependent on your broadband?
|
|
111
|
-
*
|
|
112
|
-
* Is the customer medically dependant on their broadband (Sales - Contact)
|
|
113
|
-
* @type {ENUM}
|
|
114
|
-
*/
|
|
115
|
-
MedicallyDependant?: string | null;
|
|
116
|
-
/**
|
|
117
|
-
* Do any members of your household rely on a Telecare Alarm?
|
|
118
|
-
*
|
|
119
|
-
* Does the customer use a Telecare Alarm (Sales - Contact)
|
|
120
|
-
* @type {ENUM}
|
|
121
|
-
*/
|
|
122
|
-
TelecareAlarm?: string | null;
|
|
123
118
|
/**
|
|
124
119
|
* Additional care requirements?
|
|
125
120
|
*
|
|
@@ -22,7 +22,7 @@ export interface UpdateOutboundDialSessionMessage extends OdinRecordUpdatedEvent
|
|
|
22
22
|
* Properties for UpdateOutboundDialSession action
|
|
23
23
|
*
|
|
24
24
|
* @property Required fields: 0
|
|
25
|
-
* @property Optional fields:
|
|
25
|
+
* @property Optional fields: 7
|
|
26
26
|
*/
|
|
27
27
|
export interface UpdateOutboundDialSessionProperties {
|
|
28
28
|
/**
|
|
@@ -67,6 +67,13 @@ export interface UpdateOutboundDialSessionProperties {
|
|
|
67
67
|
* @type {DATE_TIME}
|
|
68
68
|
*/
|
|
69
69
|
LastCaseRequestAt?: string | null;
|
|
70
|
+
/**
|
|
71
|
+
* NewSinceOwnCase
|
|
72
|
+
*
|
|
73
|
+
* New cases this session has been handed since its last own case; drives the campaign's own-case ratio (CASES-1986).
|
|
74
|
+
* @type {NUMBER}
|
|
75
|
+
*/
|
|
76
|
+
NewSinceOwnCase?: number | null;
|
|
70
77
|
}
|
|
71
78
|
/**
|
|
72
79
|
* UpdateOutboundDialSession
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* UpdateWorkOrderWithdrawEquipmentCharge Action DTO
|
|
3
|
+
*
|
|
4
|
+
* Withdraws an equipment charge no payment has been taken for: billing credits the invoice, then cancels this work order. A paid or part-paid charge goes through the normal credit and refund process instead. BILL-1005.
|
|
5
|
+
*
|
|
6
|
+
* @module FieldServiceModule
|
|
7
|
+
* @entity WorkOrder
|
|
8
|
+
* @actionKey UpdateWorkOrderWithdrawEquipmentCharge
|
|
9
|
+
* @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Update.UpdateWorkOrderWithdrawEquipmentCharge
|
|
10
|
+
*
|
|
11
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
12
|
+
*/
|
|
13
|
+
import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
|
|
14
|
+
/**
|
|
15
|
+
* RabbitMQ message payload for UpdateWorkOrderWithdrawEquipmentCharge updated events
|
|
16
|
+
*
|
|
17
|
+
* @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Update.UpdateWorkOrderWithdrawEquipmentCharge
|
|
18
|
+
*/
|
|
19
|
+
export interface UpdateWorkOrderWithdrawEquipmentChargeMessage extends OdinRecordUpdatedEvent<UpdateWorkOrderWithdrawEquipmentChargeDto, UpdateWorkOrderWithdrawEquipmentChargeProperties> {
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Properties for UpdateWorkOrderWithdrawEquipmentCharge action
|
|
23
|
+
*
|
|
24
|
+
* @property Required fields: 1
|
|
25
|
+
* @property Optional fields: 0
|
|
26
|
+
*/
|
|
27
|
+
export interface UpdateWorkOrderWithdrawEquipmentChargeProperties {
|
|
28
|
+
/**
|
|
29
|
+
* Why is the charge being withdrawn?
|
|
30
|
+
*
|
|
31
|
+
* StatusReason (Field Operations - WorkOrder)
|
|
32
|
+
* @type {TEXT_LONG}
|
|
33
|
+
* @required
|
|
34
|
+
*/
|
|
35
|
+
StatusReason: string;
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* Withdraw equipment charge
|
|
39
|
+
*
|
|
40
|
+
* Withdraws an equipment charge no payment has been taken for: billing credits the invoice, then cancels this work order. A paid or part-paid charge goes through the normal credit and refund process instead. BILL-1005.
|
|
41
|
+
*
|
|
42
|
+
* @actionType UPDATE - Updates an existing WorkOrder record
|
|
43
|
+
* @module FieldServiceModule
|
|
44
|
+
* @entity WorkOrder
|
|
45
|
+
* @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Update.UpdateWorkOrderWithdrawEquipmentCharge
|
|
46
|
+
* @permission schema.action.updateworkorderwithdrawequipmentcharge.trigger
|
|
47
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
48
|
+
*/
|
|
49
|
+
export declare class UpdateWorkOrderWithdrawEquipmentChargeDto extends OdinRecordUpdateDto<UpdateWorkOrderWithdrawEquipmentChargeProperties> {
|
|
50
|
+
/** Used by SDK generators to identify action type */
|
|
51
|
+
static readonly ACTION_TYPE = "UPDATE";
|
|
52
|
+
static readonly ACTION_KEY = "UpdateWorkOrderWithdrawEquipmentCharge";
|
|
53
|
+
static readonly MODULE_NAME = "FieldServiceModule";
|
|
54
|
+
static readonly ENTITIES: string[];
|
|
55
|
+
static readonly EVENT_NAME = "k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Update.UpdateWorkOrderWithdrawEquipmentCharge";
|
|
56
|
+
static readonly PERMISSION = "schema.action.updateworkorderwithdrawequipmentcharge.trigger";
|
|
57
|
+
/** Step metadata - entity this action targets */
|
|
58
|
+
static readonly STEP_ENTITY = "FieldServiceModule:WorkOrder";
|
|
59
|
+
static readonly STEP_SCHEMA_ID = "966bf5d9-163e-4132-85e2-56a5f801c9de";
|
|
60
|
+
static readonly STEP_SCHEMA_ACTION_ID = "e4fbb5bf-aaff-4783-98ea-6ae58b67d596";
|
|
61
|
+
static readonly AUTO_LINK_PARENT = false;
|
|
62
|
+
readonly actionName: string;
|
|
63
|
+
readonly schemaActionId: string;
|
|
64
|
+
readonly entity: string;
|
|
65
|
+
constructor(record: OdinRecord<any> | {
|
|
66
|
+
id: string;
|
|
67
|
+
entity: string;
|
|
68
|
+
type?: string;
|
|
69
|
+
}, properties: UpdateWorkOrderWithdrawEquipmentChargeProperties, options?: {
|
|
70
|
+
journeyId?: string;
|
|
71
|
+
stageKey?: string;
|
|
72
|
+
});
|
|
73
|
+
}
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* UpdateWorkOrderWithdrawEquipmentCharge Action DTO
|
|
4
|
+
*
|
|
5
|
+
* Withdraws an equipment charge no payment has been taken for: billing credits the invoice, then cancels this work order. A paid or part-paid charge goes through the normal credit and refund process instead. BILL-1005.
|
|
6
|
+
*
|
|
7
|
+
* @module FieldServiceModule
|
|
8
|
+
* @entity WorkOrder
|
|
9
|
+
* @actionKey UpdateWorkOrderWithdrawEquipmentCharge
|
|
10
|
+
* @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Update.UpdateWorkOrderWithdrawEquipmentCharge
|
|
11
|
+
*
|
|
12
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
13
|
+
*/
|
|
14
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
|
+
exports.UpdateWorkOrderWithdrawEquipmentChargeDto = void 0;
|
|
16
|
+
const core_1 = require("@d19n/odin-types/dist/core");
|
|
17
|
+
/**
|
|
18
|
+
* Withdraw equipment charge
|
|
19
|
+
*
|
|
20
|
+
* Withdraws an equipment charge no payment has been taken for: billing credits the invoice, then cancels this work order. A paid or part-paid charge goes through the normal credit and refund process instead. BILL-1005.
|
|
21
|
+
*
|
|
22
|
+
* @actionType UPDATE - Updates an existing WorkOrder record
|
|
23
|
+
* @module FieldServiceModule
|
|
24
|
+
* @entity WorkOrder
|
|
25
|
+
* @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Update.UpdateWorkOrderWithdrawEquipmentCharge
|
|
26
|
+
* @permission schema.action.updateworkorderwithdrawequipmentcharge.trigger
|
|
27
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
28
|
+
*/
|
|
29
|
+
class UpdateWorkOrderWithdrawEquipmentChargeDto extends core_1.OdinRecordUpdateDto {
|
|
30
|
+
constructor(record, properties, options) {
|
|
31
|
+
super({
|
|
32
|
+
id: record.id,
|
|
33
|
+
entity: record.entity,
|
|
34
|
+
type: record.type,
|
|
35
|
+
properties,
|
|
36
|
+
journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
|
|
37
|
+
stageKey: options === null || options === void 0 ? void 0 : options.stageKey,
|
|
38
|
+
});
|
|
39
|
+
this.actionName = 'UpdateWorkOrderWithdrawEquipmentCharge';
|
|
40
|
+
this.schemaActionId = 'e4fbb5bf-aaff-4783-98ea-6ae58b67d596';
|
|
41
|
+
this.entity = 'FieldServiceModule:WorkOrder';
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
exports.UpdateWorkOrderWithdrawEquipmentChargeDto = UpdateWorkOrderWithdrawEquipmentChargeDto;
|
|
45
|
+
/** Used by SDK generators to identify action type */
|
|
46
|
+
UpdateWorkOrderWithdrawEquipmentChargeDto.ACTION_TYPE = 'UPDATE';
|
|
47
|
+
UpdateWorkOrderWithdrawEquipmentChargeDto.ACTION_KEY = 'UpdateWorkOrderWithdrawEquipmentCharge';
|
|
48
|
+
UpdateWorkOrderWithdrawEquipmentChargeDto.MODULE_NAME = 'FieldServiceModule';
|
|
49
|
+
UpdateWorkOrderWithdrawEquipmentChargeDto.ENTITIES = ['WorkOrder'];
|
|
50
|
+
UpdateWorkOrderWithdrawEquipmentChargeDto.EVENT_NAME = 'k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Update.UpdateWorkOrderWithdrawEquipmentCharge';
|
|
51
|
+
UpdateWorkOrderWithdrawEquipmentChargeDto.PERMISSION = 'schema.action.updateworkorderwithdrawequipmentcharge.trigger';
|
|
52
|
+
/** Step metadata - entity this action targets */
|
|
53
|
+
UpdateWorkOrderWithdrawEquipmentChargeDto.STEP_ENTITY = 'FieldServiceModule:WorkOrder';
|
|
54
|
+
UpdateWorkOrderWithdrawEquipmentChargeDto.STEP_SCHEMA_ID = '966bf5d9-163e-4132-85e2-56a5f801c9de';
|
|
55
|
+
UpdateWorkOrderWithdrawEquipmentChargeDto.STEP_SCHEMA_ACTION_ID = 'e4fbb5bf-aaff-4783-98ea-6ae58b67d596';
|
|
56
|
+
UpdateWorkOrderWithdrawEquipmentChargeDto.AUTO_LINK_PARENT = false;
|
|
@@ -22,7 +22,7 @@ export interface UpdateoutbounddialcampaignMessage extends OdinRecordUpdatedEven
|
|
|
22
22
|
* Properties for Updateoutbounddialcampaign action
|
|
23
23
|
*
|
|
24
24
|
* @property Required fields: 0
|
|
25
|
-
* @property Optional fields:
|
|
25
|
+
* @property Optional fields: 10
|
|
26
26
|
*/
|
|
27
27
|
export interface UpdateoutbounddialcampaignProperties {
|
|
28
28
|
/**
|
|
@@ -88,6 +88,13 @@ export interface UpdateoutbounddialcampaignProperties {
|
|
|
88
88
|
* @type {BOOLEAN}
|
|
89
89
|
*/
|
|
90
90
|
RetentionCampaign?: boolean | null;
|
|
91
|
+
/**
|
|
92
|
+
* NewCasesPerOwnCase
|
|
93
|
+
*
|
|
94
|
+
* Round-robin: new cases handed out before each of the agent's own cases, e.g. 2 gives new, new, own (CASES-1986). Empty or 0 keeps own cases first.
|
|
95
|
+
* @type {NUMBER}
|
|
96
|
+
*/
|
|
97
|
+
NewCasesPerOwnCase?: number | null;
|
|
91
98
|
}
|
|
92
99
|
/**
|
|
93
100
|
* Updateoutbounddialcampaign
|
|
@@ -61,6 +61,7 @@ export declare enum BillingAdjustmentProrationType {
|
|
|
61
61
|
* - `BRSK_REWARD_ADJUSTMENT` - Brsk Reward Adjustment
|
|
62
62
|
* - `CONTRACT_BUY_OUT` - Contract Buy Out
|
|
63
63
|
* - `GOODWILL_GESTURE` - Goodwill Gesture
|
|
64
|
+
* - `HOME_MOVE` - Home Move
|
|
64
65
|
* - `OUTAGE_COMPENSATION` - Outage Compensation
|
|
65
66
|
* - `PAYMENT_ARRANGEMENT` - Payment Arrangement
|
|
66
67
|
* - `PRICE_MATCH_ADJUSTMENT` - Price Match Adjustment
|
|
@@ -68,7 +69,7 @@ export declare enum BillingAdjustmentProrationType {
|
|
|
68
69
|
* - `RECONTRACTING_ADJUSTMENT` - Recontracting Adjustment
|
|
69
70
|
* - `REFERRAL` - Referral
|
|
70
71
|
* - `RETENTION_DEAL` - Retention Deal
|
|
71
|
-
* -
|
|
72
|
+
* - ... and 1 more
|
|
72
73
|
*/
|
|
73
74
|
export declare enum BillingAdjustmentReason {
|
|
74
75
|
BILLING_DATE_CHANGE = "BILLING_DATE_CHANGE",
|
|
@@ -78,6 +79,7 @@ export declare enum BillingAdjustmentReason {
|
|
|
78
79
|
BRSK_REWARD_ADJUSTMENT = "BRSK_REWARD_ADJUSTMENT",
|
|
79
80
|
CONTRACT_BUY_OUT = "CONTRACT_BUY_OUT",
|
|
80
81
|
GOODWILL_GESTURE = "GOODWILL_GESTURE",
|
|
82
|
+
HOME_MOVE = "HOME_MOVE",
|
|
81
83
|
OUTAGE_COMPENSATION = "OUTAGE_COMPENSATION",
|
|
82
84
|
PAYMENT_ARRANGEMENT = "PAYMENT_ARRANGEMENT",
|
|
83
85
|
PRICE_MATCH_ADJUSTMENT = "PRICE_MATCH_ADJUSTMENT",
|
|
@@ -63,6 +63,7 @@ var BillingAdjustmentProrationType;
|
|
|
63
63
|
* - `BRSK_REWARD_ADJUSTMENT` - Brsk Reward Adjustment
|
|
64
64
|
* - `CONTRACT_BUY_OUT` - Contract Buy Out
|
|
65
65
|
* - `GOODWILL_GESTURE` - Goodwill Gesture
|
|
66
|
+
* - `HOME_MOVE` - Home Move
|
|
66
67
|
* - `OUTAGE_COMPENSATION` - Outage Compensation
|
|
67
68
|
* - `PAYMENT_ARRANGEMENT` - Payment Arrangement
|
|
68
69
|
* - `PRICE_MATCH_ADJUSTMENT` - Price Match Adjustment
|
|
@@ -70,7 +71,7 @@ var BillingAdjustmentProrationType;
|
|
|
70
71
|
* - `RECONTRACTING_ADJUSTMENT` - Recontracting Adjustment
|
|
71
72
|
* - `REFERRAL` - Referral
|
|
72
73
|
* - `RETENTION_DEAL` - Retention Deal
|
|
73
|
-
* -
|
|
74
|
+
* - ... and 1 more
|
|
74
75
|
*/
|
|
75
76
|
var BillingAdjustmentReason;
|
|
76
77
|
(function (BillingAdjustmentReason) {
|
|
@@ -81,6 +82,7 @@ var BillingAdjustmentReason;
|
|
|
81
82
|
BillingAdjustmentReason["BRSK_REWARD_ADJUSTMENT"] = "BRSK_REWARD_ADJUSTMENT";
|
|
82
83
|
BillingAdjustmentReason["CONTRACT_BUY_OUT"] = "CONTRACT_BUY_OUT";
|
|
83
84
|
BillingAdjustmentReason["GOODWILL_GESTURE"] = "GOODWILL_GESTURE";
|
|
85
|
+
BillingAdjustmentReason["HOME_MOVE"] = "HOME_MOVE";
|
|
84
86
|
BillingAdjustmentReason["OUTAGE_COMPENSATION"] = "OUTAGE_COMPENSATION";
|
|
85
87
|
BillingAdjustmentReason["PAYMENT_ARRANGEMENT"] = "PAYMENT_ARRANGEMENT";
|
|
86
88
|
BillingAdjustmentReason["PRICE_MATCH_ADJUSTMENT"] = "PRICE_MATCH_ADJUSTMENT";
|
|
@@ -58,7 +58,9 @@ export declare enum OutboundDialCampaignPropertyKeys {
|
|
|
58
58
|
/** How cases reach agents: SELF_SELECT (agents pick from the queue) or ROUND_ROBIN (the dialler hands new cases to agents in turn, CASES-1984). Empty means SELF_SELECT. */
|
|
59
59
|
DistributionMode = "DistributionMode",
|
|
60
60
|
/** When true, agents on this campaign record the retention RET outcomes and give a reason when they skip a case (CASES-1993). Empty means false. */
|
|
61
|
-
RetentionCampaign = "RetentionCampaign"
|
|
61
|
+
RetentionCampaign = "RetentionCampaign",
|
|
62
|
+
/** Round-robin: new cases handed out before each of the agent's own cases, e.g. 2 gives new, new, own (CASES-1986). Empty or 0 keeps own cases first. */
|
|
63
|
+
NewCasesPerOwnCase = "NewCasesPerOwnCase"
|
|
62
64
|
}
|
|
63
65
|
/**
|
|
64
66
|
* Properties for OutboundDialCampaign records
|
|
@@ -118,6 +120,12 @@ export interface OutboundDialCampaignProperties {
|
|
|
118
120
|
* @default
|
|
119
121
|
*/
|
|
120
122
|
RetentionCampaign: boolean;
|
|
123
|
+
/** Round-robin: new cases handed out before each of the agent's own cases, e.g. 2 gives new, new, own (CASES-1986). Empty or 0 keeps own cases first.
|
|
124
|
+
*
|
|
125
|
+
* @type {NUMBER}
|
|
126
|
+
* @default
|
|
127
|
+
*/
|
|
128
|
+
NewCasesPerOwnCase: number;
|
|
121
129
|
}
|
|
122
130
|
/**
|
|
123
131
|
* OutboundDialCampaign entity from SupportModule
|
|
@@ -60,6 +60,8 @@ var OutboundDialCampaignPropertyKeys;
|
|
|
60
60
|
OutboundDialCampaignPropertyKeys["DistributionMode"] = "DistributionMode";
|
|
61
61
|
/** When true, agents on this campaign record the retention RET outcomes and give a reason when they skip a case (CASES-1993). Empty means false. */
|
|
62
62
|
OutboundDialCampaignPropertyKeys["RetentionCampaign"] = "RetentionCampaign";
|
|
63
|
+
/** Round-robin: new cases handed out before each of the agent's own cases, e.g. 2 gives new, new, own (CASES-1986). Empty or 0 keeps own cases first. */
|
|
64
|
+
OutboundDialCampaignPropertyKeys["NewCasesPerOwnCase"] = "NewCasesPerOwnCase";
|
|
63
65
|
})(OutboundDialCampaignPropertyKeys = exports.OutboundDialCampaignPropertyKeys || (exports.OutboundDialCampaignPropertyKeys = {}));
|
|
64
66
|
/**
|
|
65
67
|
* OutboundDialCampaign entity from SupportModule
|
|
@@ -90,7 +90,9 @@ export declare enum OutboundDialSessionPropertyKeys {
|
|
|
90
90
|
/** New (previously unassigned) cases the dialler has handed this session on a ROUND_ROBIN campaign. The turn rule gives the next new case to the session with the fewest (CASES-1984). */
|
|
91
91
|
CasesAssigned = "CasesAssigned",
|
|
92
92
|
/** When the agent last asked for their next case. A session that has not asked for 5 minutes is left out of the round-robin turn rule until it asks again (CASES-1984). */
|
|
93
|
-
LastCaseRequestAt = "LastCaseRequestAt"
|
|
93
|
+
LastCaseRequestAt = "LastCaseRequestAt",
|
|
94
|
+
/** New cases this session has been handed since its last own case; drives the campaign's own-case ratio (CASES-1986). */
|
|
95
|
+
NewSinceOwnCase = "NewSinceOwnCase"
|
|
94
96
|
}
|
|
95
97
|
/**
|
|
96
98
|
* Properties for OutboundDialSession records
|
|
@@ -184,6 +186,12 @@ export interface OutboundDialSessionProperties {
|
|
|
184
186
|
* @default
|
|
185
187
|
*/
|
|
186
188
|
LastCaseRequestAt: string;
|
|
189
|
+
/** New cases this session has been handed since its last own case; drives the campaign's own-case ratio (CASES-1986).
|
|
190
|
+
*
|
|
191
|
+
* @type {NUMBER}
|
|
192
|
+
* @default 0
|
|
193
|
+
*/
|
|
194
|
+
NewSinceOwnCase: number;
|
|
187
195
|
}
|
|
188
196
|
/**
|
|
189
197
|
* OutboundDialSession entity from SupportModule
|
|
@@ -94,6 +94,8 @@ var OutboundDialSessionPropertyKeys;
|
|
|
94
94
|
OutboundDialSessionPropertyKeys["CasesAssigned"] = "CasesAssigned";
|
|
95
95
|
/** When the agent last asked for their next case. A session that has not asked for 5 minutes is left out of the round-robin turn rule until it asks again (CASES-1984). */
|
|
96
96
|
OutboundDialSessionPropertyKeys["LastCaseRequestAt"] = "LastCaseRequestAt";
|
|
97
|
+
/** New cases this session has been handed since its last own case; drives the campaign's own-case ratio (CASES-1986). */
|
|
98
|
+
OutboundDialSessionPropertyKeys["NewSinceOwnCase"] = "NewSinceOwnCase";
|
|
97
99
|
})(OutboundDialSessionPropertyKeys = exports.OutboundDialSessionPropertyKeys || (exports.OutboundDialSessionPropertyKeys = {}));
|
|
98
100
|
/**
|
|
99
101
|
* OutboundDialSession entity from SupportModule
|
|
@@ -24,6 +24,7 @@ import { ContactProperties } from '../entities-v2/Contact';
|
|
|
24
24
|
import { CreateCaseProperties } from '../actions-v2/CreateCaseFromContactDto';
|
|
25
25
|
import { CreateContactProperties } from '../actions-v2/CreateContactDto';
|
|
26
26
|
import { CreateContactSalesAppProperties } from '../actions-v2/CreateContactSalesAppDto';
|
|
27
|
+
import { OrderBuilderCreateContactProperties } from '../actions-v2/OrderBuilderCreateContactDto';
|
|
27
28
|
import { OrderBuilderUpdateContactProperties } from '../actions-v2/OrderBuilderUpdateContactDto';
|
|
28
29
|
import { UpdateAdditionalCareProperties } from '../actions-v2/UpdateAdditionalCareDto';
|
|
29
30
|
import { UpdateContactAppPreferencesProperties } from '../actions-v2/UpdateContactAppPreferencesDto';
|
|
@@ -817,6 +818,34 @@ export declare class ContactRecord<TProps = ContactProperties> {
|
|
|
817
818
|
journeyId?: string;
|
|
818
819
|
stageKey?: string;
|
|
819
820
|
}): ActionBuilder;
|
|
821
|
+
/**
|
|
822
|
+
* OrderBuilderCreateContact
|
|
823
|
+
*
|
|
824
|
+
* Creates a new Contact record with the specified properties.
|
|
825
|
+
* Returns an ActionBuilder - call .execute() to create or .dryRun() for debugging.
|
|
826
|
+
*
|
|
827
|
+
* @param properties - The properties for the new record
|
|
828
|
+
* @param options - Optional settings
|
|
829
|
+
* @param options.type - Override the record type
|
|
830
|
+
* @param options.journeyId - Associate with a journey
|
|
831
|
+
* @param options.stageKey - Set initial pipeline stage
|
|
832
|
+
* @returns ActionBuilder - call .execute() to create or .dryRun() for payload
|
|
833
|
+
*
|
|
834
|
+
* @example
|
|
835
|
+
* ```typescript
|
|
836
|
+
* // Create with properties
|
|
837
|
+
* const record = odinClient.contacts.new();
|
|
838
|
+
* await record.orderBuilderCreateContact({ ... }).execute();
|
|
839
|
+
*
|
|
840
|
+
* // Dry run (for debugging)
|
|
841
|
+
* const payload = record.orderBuilderCreateContact({ ... }).dryRun();
|
|
842
|
+
* ```
|
|
843
|
+
*/
|
|
844
|
+
orderBuilderCreateContact(properties: OrderBuilderCreateContactProperties, options?: {
|
|
845
|
+
type?: string;
|
|
846
|
+
journeyId?: string;
|
|
847
|
+
stageKey?: string;
|
|
848
|
+
}): ActionBuilder;
|
|
820
849
|
/**
|
|
821
850
|
* CreateCaseFromContact
|
|
822
851
|
*
|
|
@@ -1222,6 +1222,42 @@ class ContactRecord {
|
|
|
1222
1222
|
};
|
|
1223
1223
|
return new ActionBuilder(this._provider, 'CrmModule', 'Contact', payload, () => { this._pendingLinks = []; });
|
|
1224
1224
|
}
|
|
1225
|
+
/**
|
|
1226
|
+
* OrderBuilderCreateContact
|
|
1227
|
+
*
|
|
1228
|
+
* Creates a new Contact record with the specified properties.
|
|
1229
|
+
* Returns an ActionBuilder - call .execute() to create or .dryRun() for debugging.
|
|
1230
|
+
*
|
|
1231
|
+
* @param properties - The properties for the new record
|
|
1232
|
+
* @param options - Optional settings
|
|
1233
|
+
* @param options.type - Override the record type
|
|
1234
|
+
* @param options.journeyId - Associate with a journey
|
|
1235
|
+
* @param options.stageKey - Set initial pipeline stage
|
|
1236
|
+
* @returns ActionBuilder - call .execute() to create or .dryRun() for payload
|
|
1237
|
+
*
|
|
1238
|
+
* @example
|
|
1239
|
+
* ```typescript
|
|
1240
|
+
* // Create with properties
|
|
1241
|
+
* const record = odinClient.contacts.new();
|
|
1242
|
+
* await record.orderBuilderCreateContact({ ... }).execute();
|
|
1243
|
+
*
|
|
1244
|
+
* // Dry run (for debugging)
|
|
1245
|
+
* const payload = record.orderBuilderCreateContact({ ... }).dryRun();
|
|
1246
|
+
* ```
|
|
1247
|
+
*/
|
|
1248
|
+
orderBuilderCreateContact(properties, options) {
|
|
1249
|
+
var _a, _b;
|
|
1250
|
+
const payload = {
|
|
1251
|
+
entity: 'CrmModule:Contact',
|
|
1252
|
+
type: (_a = options === null || options === void 0 ? void 0 : options.type) !== null && _a !== void 0 ? _a : (_b = this._record) === null || _b === void 0 ? void 0 : _b.type,
|
|
1253
|
+
actionName: 'OrderBuilderCreateContact',
|
|
1254
|
+
properties: properties || {},
|
|
1255
|
+
associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined,
|
|
1256
|
+
journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
|
|
1257
|
+
stageKey: options === null || options === void 0 ? void 0 : options.stageKey,
|
|
1258
|
+
};
|
|
1259
|
+
return new ActionBuilder(this._provider, 'CrmModule', 'Contact', payload, () => { this._pendingLinks = []; });
|
|
1260
|
+
}
|
|
1225
1261
|
// ============================================
|
|
1226
1262
|
// UPDATE ACTIONS (require existing record)
|
|
1227
1263
|
// ============================================
|
|
@@ -96,6 +96,7 @@ import { UpdateOverrideDispatchAmcoOrderProperties } from '../actions-v2/UpdateO
|
|
|
96
96
|
import { UpdateRemediationWorkOrderProperties } from '../actions-v2/UpdateRemediationWorkOrderDto';
|
|
97
97
|
import { UpdateSetReturnedLegacyProperties } from '../actions-v2/UpdateSetReturnedLegacyDto';
|
|
98
98
|
import { UpdateWayleaveWorkOrderProperties } from '../actions-v2/UpdateWayleaveWorkOrderDto';
|
|
99
|
+
import { UpdateWorkOrderWithdrawEquipmentChargeProperties } from '../actions-v2/UpdateWorkOrderWithdrawEquipmentChargeDto';
|
|
99
100
|
import { OverlayRealA55Record } from './OverlayRealA55Record';
|
|
100
101
|
import { OntReplacementApprovalRecord } from './OntReplacementApprovalRecord';
|
|
101
102
|
import { ActivityLogRecord } from './ActivityLogRecord';
|
|
@@ -8974,6 +8975,32 @@ export declare class WorkOrderRecord<TProps = WorkOrderProperties> {
|
|
|
8974
8975
|
journeyId?: string;
|
|
8975
8976
|
stageKey?: string;
|
|
8976
8977
|
}): ActionBuilder;
|
|
8978
|
+
/**
|
|
8979
|
+
* UpdateWorkOrderWithdrawEquipmentCharge
|
|
8980
|
+
*
|
|
8981
|
+
* Updates this WorkOrder record with the specified properties.
|
|
8982
|
+
* Returns an ActionBuilder - call .execute() to update or .dryRun() for debugging.
|
|
8983
|
+
*
|
|
8984
|
+
* @param properties - Required properties for this action
|
|
8985
|
+
* @param options - Optional settings
|
|
8986
|
+
* @param options.journeyId - Associate with a journey
|
|
8987
|
+
* @param options.stageKey - Transition to pipeline stage
|
|
8988
|
+
* @returns ActionBuilder - call .execute() to update or .dryRun() for payload
|
|
8989
|
+
* @throws Error if called on a new (unsaved) record
|
|
8990
|
+
*
|
|
8991
|
+
* @example
|
|
8992
|
+
* ```typescript
|
|
8993
|
+
* const record = await odinClient.workOrders.get(id);
|
|
8994
|
+
* await record.updateWorkOrderWithdrawEquipmentCharge({ ... }).execute();
|
|
8995
|
+
*
|
|
8996
|
+
* // Dry run (for debugging)
|
|
8997
|
+
* const payload = record.updateWorkOrderWithdrawEquipmentCharge({ ... }).dryRun();
|
|
8998
|
+
* ```
|
|
8999
|
+
*/
|
|
9000
|
+
updateWorkOrderWithdrawEquipmentCharge(properties: UpdateWorkOrderWithdrawEquipmentChargeProperties, options?: {
|
|
9001
|
+
journeyId?: string;
|
|
9002
|
+
stageKey?: string;
|
|
9003
|
+
}): ActionBuilder;
|
|
8977
9004
|
}
|
|
8978
9005
|
/** Type guard to check if an object is a WorkOrderRecord */
|
|
8979
9006
|
export declare function isWorkOrderRecord(obj: any): obj is WorkOrderRecord;
|
|
@@ -12351,6 +12351,35 @@ class WorkOrderRecord {
|
|
|
12351
12351
|
const payload = Object.assign({ id: this._record.id, entity: this._record.entity, type: this._record.type, actionName: 'UpdateWayleaveWorkOrder', properties, associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined }, opts);
|
|
12352
12352
|
return new ActionBuilder(this._provider, 'FieldServiceModule', 'WorkOrder', payload, () => { this._pendingLinks = []; });
|
|
12353
12353
|
}
|
|
12354
|
+
/**
|
|
12355
|
+
* UpdateWorkOrderWithdrawEquipmentCharge
|
|
12356
|
+
*
|
|
12357
|
+
* Updates this WorkOrder record with the specified properties.
|
|
12358
|
+
* Returns an ActionBuilder - call .execute() to update or .dryRun() for debugging.
|
|
12359
|
+
*
|
|
12360
|
+
* @param properties - Required properties for this action
|
|
12361
|
+
* @param options - Optional settings
|
|
12362
|
+
* @param options.journeyId - Associate with a journey
|
|
12363
|
+
* @param options.stageKey - Transition to pipeline stage
|
|
12364
|
+
* @returns ActionBuilder - call .execute() to update or .dryRun() for payload
|
|
12365
|
+
* @throws Error if called on a new (unsaved) record
|
|
12366
|
+
*
|
|
12367
|
+
* @example
|
|
12368
|
+
* ```typescript
|
|
12369
|
+
* const record = await odinClient.workOrders.get(id);
|
|
12370
|
+
* await record.updateWorkOrderWithdrawEquipmentCharge({ ... }).execute();
|
|
12371
|
+
*
|
|
12372
|
+
* // Dry run (for debugging)
|
|
12373
|
+
* const payload = record.updateWorkOrderWithdrawEquipmentCharge({ ... }).dryRun();
|
|
12374
|
+
* ```
|
|
12375
|
+
*/
|
|
12376
|
+
updateWorkOrderWithdrawEquipmentCharge(properties, options) {
|
|
12377
|
+
var _a;
|
|
12378
|
+
if (!((_a = this._record) === null || _a === void 0 ? void 0 : _a.id))
|
|
12379
|
+
throw new Error('updateWorkOrderWithdrawEquipmentCharge requires an existing record. Use accessor.get() first.');
|
|
12380
|
+
const payload = Object.assign({ id: this._record.id, entity: this._record.entity, type: this._record.type, actionName: 'UpdateWorkOrderWithdrawEquipmentCharge', properties, associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined }, options);
|
|
12381
|
+
return new ActionBuilder(this._provider, 'FieldServiceModule', 'WorkOrder', payload, () => { this._pendingLinks = []; });
|
|
12382
|
+
}
|
|
12354
12383
|
}
|
|
12355
12384
|
exports.WorkOrderRecord = WorkOrderRecord;
|
|
12356
12385
|
// ============================================
|