@d19n/youfibre-odin-sdk 2.0.373 → 2.0.375
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 +2 -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 +165 -0
- package/dist/actions-v2/OrderBuilderCreateContactDto.js +54 -0
- package/dist/actions-v2/OrderBuilderUpdateContactDto.d.ts +18 -30
- package/dist/actions-v2/UpdateOutboundDialSessionDto.d.ts +8 -1
- package/dist/actions-v2/UpdateWorkOrderWithdrawEquipmentChargeDto.d.ts +54 -4
- package/dist/actions-v2/UpdateWorkOrderWithdrawEquipmentChargeDto.js +2 -2
- package/dist/actions-v2/UpdateoutbounddialcampaignDto.d.ts +8 -1
- package/dist/db-sdk-v2/FileDb.d.ts +132 -132
- package/dist/db-sdk-v2/FileDb.js +268 -268
- 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/entities-v2/WorkOrder.d.ts +99 -1
- package/dist/entities-v2/WorkOrder.js +2 -0
- package/dist/records-v2/ContactRecord.d.ts +29 -0
- package/dist/records-v2/ContactRecord.js +36 -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
|
|
|
@@ -1639,6 +1639,7 @@ This SDK includes **936** actions.
|
|
|
1639
1639
|
|--------|------|-------|
|
|
1640
1640
|
| `CreateContact` | CREATE | k1.t-hEOJjsDb.CrmModule.Contact.Create.CreateContact |
|
|
1641
1641
|
| `CreateContactSalesApp` | CREATE | k1.t-hEOJjsDb.CrmModule.Contact.Create.CreateContactSalesApp |
|
|
1642
|
+
| `OrderBuilderCreateContact` | CREATE | k1.t-hEOJjsDb.CrmModule.Contact.Create.OrderBuilderCreateContact |
|
|
1642
1643
|
| `OrderBuilderUpdateContact` | UPDATE | k1.t-hEOJjsDb.CrmModule.Contact.Update.OrderBuilderUpdateContact |
|
|
1643
1644
|
| `UpdateAdditionalCare` | UPDATE | k1.t-hEOJjsDb.CrmModule.Contact.Update.UpdateAdditionalCare |
|
|
1644
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,165 @@
|
|
|
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: 5
|
|
25
|
+
* @property Optional fields: 10
|
|
26
|
+
*/
|
|
27
|
+
export interface OrderBuilderCreateContactProperties {
|
|
28
|
+
/**
|
|
29
|
+
* First Name
|
|
30
|
+
*
|
|
31
|
+
* Contacts First Name (Sales - Contact)
|
|
32
|
+
* @type {TEXT}
|
|
33
|
+
* @required
|
|
34
|
+
*/
|
|
35
|
+
FirstName: string;
|
|
36
|
+
/**
|
|
37
|
+
* Last Name
|
|
38
|
+
*
|
|
39
|
+
* Contacts Last Name (Sales - Contact)
|
|
40
|
+
* @type {TEXT}
|
|
41
|
+
* @required
|
|
42
|
+
*/
|
|
43
|
+
LastName: string;
|
|
44
|
+
/**
|
|
45
|
+
* Email Address
|
|
46
|
+
*
|
|
47
|
+
* Contacts Email Address (Sales - Contact)
|
|
48
|
+
* @type {EMAIL}
|
|
49
|
+
* @required
|
|
50
|
+
*/
|
|
51
|
+
EmailAddress: string;
|
|
52
|
+
/**
|
|
53
|
+
* Are you medically dependent on your broadband?
|
|
54
|
+
*
|
|
55
|
+
* Is the customer medically dependant on their broadband (Sales - Contact)
|
|
56
|
+
* @type {ENUM}
|
|
57
|
+
* @required
|
|
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;
|
|
68
|
+
/**
|
|
69
|
+
* Phone
|
|
70
|
+
*
|
|
71
|
+
* Phone number (Sales - Contact)
|
|
72
|
+
* @type {PHONE_NUMBER_E164_GB}
|
|
73
|
+
*/
|
|
74
|
+
Phone?: string | null;
|
|
75
|
+
/**
|
|
76
|
+
* Referral Email
|
|
77
|
+
*
|
|
78
|
+
* referral email (Sales - Contact)
|
|
79
|
+
* @type {TEXT}
|
|
80
|
+
*/
|
|
81
|
+
ReferralEmail?: string | null;
|
|
82
|
+
/**
|
|
83
|
+
* MarketingConsent
|
|
84
|
+
*
|
|
85
|
+
* 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.
|
|
86
|
+
* @type {BOOLEAN}
|
|
87
|
+
*/
|
|
88
|
+
MarketingConsent?: boolean | null;
|
|
89
|
+
/**
|
|
90
|
+
* In Contract Until
|
|
91
|
+
*
|
|
92
|
+
* the date the customer is in contract with another provider (Sales - Contact)
|
|
93
|
+
* @type {DATE}
|
|
94
|
+
* @format DD/MM/YYYY
|
|
95
|
+
*/
|
|
96
|
+
InContractUntil?: string | null;
|
|
97
|
+
/**
|
|
98
|
+
* Previous Provider
|
|
99
|
+
*
|
|
100
|
+
* previous/current provider (Sales - Contact)
|
|
101
|
+
* @type {ENUM}
|
|
102
|
+
*/
|
|
103
|
+
PreviousProvider?: string | null;
|
|
104
|
+
/**
|
|
105
|
+
* Current Contract Type
|
|
106
|
+
*
|
|
107
|
+
* current contract type (Sales - Contact)
|
|
108
|
+
* @type {TEXT}
|
|
109
|
+
*/
|
|
110
|
+
CurrentContractType?: string | null;
|
|
111
|
+
/**
|
|
112
|
+
* Additional care requirements?
|
|
113
|
+
*
|
|
114
|
+
* Select a care requirement
|
|
115
|
+
* @type {ENUM_MULTI_SELECT}
|
|
116
|
+
*/
|
|
117
|
+
AdditionalCareReason?: string | null;
|
|
118
|
+
/**
|
|
119
|
+
* Additional care notes
|
|
120
|
+
*
|
|
121
|
+
* Any additional information
|
|
122
|
+
* @type {TEXT_LONG}
|
|
123
|
+
*/
|
|
124
|
+
AdditionalCareNotes?: string | null;
|
|
125
|
+
/**
|
|
126
|
+
* Additional Care Consent
|
|
127
|
+
*
|
|
128
|
+
* Customer consent for recording additional care requirements (Sales - Contact)
|
|
129
|
+
* @type {BOOLEAN}
|
|
130
|
+
* @requiredWhen MedicallyDependant = ["YES"] AND TelecareAlarm = ["YES"]
|
|
131
|
+
*/
|
|
132
|
+
AdditionalCareConsent?: boolean | null;
|
|
133
|
+
}
|
|
134
|
+
/**
|
|
135
|
+
* OrderBuilderCreateContact
|
|
136
|
+
*
|
|
137
|
+
* 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.
|
|
138
|
+
*
|
|
139
|
+
* @actionType CREATE - Creates a new Contact record
|
|
140
|
+
* @module CrmModule
|
|
141
|
+
* @entity Contact
|
|
142
|
+
* @event k1.t-hEOJjsDb.CrmModule.Contact.Create.OrderBuilderCreateContact
|
|
143
|
+
* @permission schema.action.orderbuildercreatecontact.trigger
|
|
144
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
145
|
+
*/
|
|
146
|
+
export declare class OrderBuilderCreateContactDto extends OdinRecordCreateDto<OrderBuilderCreateContactProperties> {
|
|
147
|
+
/** Used by SDK generators to identify action type */
|
|
148
|
+
static readonly ACTION_TYPE = "CREATE";
|
|
149
|
+
static readonly ACTION_KEY = "OrderBuilderCreateContact";
|
|
150
|
+
static readonly MODULE_NAME = "CrmModule";
|
|
151
|
+
static readonly ENTITIES: string[];
|
|
152
|
+
static readonly EVENT_NAME = "k1.t-hEOJjsDb.CrmModule.Contact.Create.OrderBuilderCreateContact";
|
|
153
|
+
static readonly PERMISSION = "schema.action.orderbuildercreatecontact.trigger";
|
|
154
|
+
/** Step metadata - entity this action targets */
|
|
155
|
+
static readonly STEP_ENTITY = "CrmModule:Contact";
|
|
156
|
+
static readonly STEP_SCHEMA_ID = "33643a0d-5b77-4895-a2da-991e0fd3432f";
|
|
157
|
+
static readonly STEP_SCHEMA_ACTION_ID = "2d295a37-7256-4303-b490-d3de6e9a32ff";
|
|
158
|
+
static readonly AUTO_LINK_PARENT = true;
|
|
159
|
+
readonly actionName: string;
|
|
160
|
+
readonly schemaActionId: string;
|
|
161
|
+
readonly entity: string;
|
|
162
|
+
constructor(properties: OrderBuilderCreateContactProperties, options?: {
|
|
163
|
+
journeyId?: string;
|
|
164
|
+
});
|
|
165
|
+
}
|
|
@@ -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: 10
|
|
26
26
|
*/
|
|
27
27
|
export interface OrderBuilderUpdateContactProperties {
|
|
28
28
|
/**
|
|
@@ -33,6 +33,14 @@ export interface OrderBuilderUpdateContactProperties {
|
|
|
33
33
|
* @required
|
|
34
34
|
*/
|
|
35
35
|
FirstName: string;
|
|
36
|
+
/**
|
|
37
|
+
* Last Name
|
|
38
|
+
*
|
|
39
|
+
* Contacts Last Name (Sales - Contact)
|
|
40
|
+
* @type {TEXT}
|
|
41
|
+
* @required
|
|
42
|
+
*/
|
|
43
|
+
LastName: string;
|
|
36
44
|
/**
|
|
37
45
|
* Email Address
|
|
38
46
|
*
|
|
@@ -42,20 +50,21 @@ export interface OrderBuilderUpdateContactProperties {
|
|
|
42
50
|
*/
|
|
43
51
|
EmailAddress: string;
|
|
44
52
|
/**
|
|
45
|
-
*
|
|
53
|
+
* Are you medically dependent on your broadband?
|
|
46
54
|
*
|
|
47
|
-
*
|
|
48
|
-
* @type {
|
|
55
|
+
* Is the customer medically dependant on their broadband (Sales - Contact)
|
|
56
|
+
* @type {ENUM}
|
|
49
57
|
* @required
|
|
50
58
|
*/
|
|
51
|
-
|
|
59
|
+
MedicallyDependant: string;
|
|
52
60
|
/**
|
|
53
|
-
*
|
|
61
|
+
* Do any members of your household rely on a Telecare Alarm?
|
|
54
62
|
*
|
|
55
|
-
*
|
|
63
|
+
* Does the customer use a Telecare Alarm (Sales - Contact)
|
|
56
64
|
* @type {ENUM}
|
|
65
|
+
* @required
|
|
57
66
|
*/
|
|
58
|
-
|
|
67
|
+
TelecareAlarm: string;
|
|
59
68
|
/**
|
|
60
69
|
* Phone
|
|
61
70
|
*
|
|
@@ -63,13 +72,6 @@ export interface OrderBuilderUpdateContactProperties {
|
|
|
63
72
|
* @type {PHONE_NUMBER_E164_GB}
|
|
64
73
|
*/
|
|
65
74
|
Phone?: string | null;
|
|
66
|
-
/**
|
|
67
|
-
* Mobile
|
|
68
|
-
*
|
|
69
|
-
* Mobile phone (Sales - Contact)
|
|
70
|
-
* @type {TEXT}
|
|
71
|
-
*/
|
|
72
|
-
Mobile?: string | null;
|
|
73
75
|
/**
|
|
74
76
|
* Referral Email
|
|
75
77
|
*
|
|
@@ -106,20 +108,6 @@ export interface OrderBuilderUpdateContactProperties {
|
|
|
106
108
|
* @type {TEXT}
|
|
107
109
|
*/
|
|
108
110
|
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
111
|
/**
|
|
124
112
|
* Additional care requirements?
|
|
125
113
|
*
|
|
@@ -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
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* UpdateWorkOrderWithdrawEquipmentCharge Action DTO
|
|
3
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.
|
|
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. Can send the customer another collection bag. BILL-1005.
|
|
5
5
|
*
|
|
6
6
|
* @module FieldServiceModule
|
|
7
7
|
* @entity WorkOrder
|
|
@@ -21,8 +21,8 @@ export interface UpdateWorkOrderWithdrawEquipmentChargeMessage extends OdinRecor
|
|
|
21
21
|
/**
|
|
22
22
|
* Properties for UpdateWorkOrderWithdrawEquipmentCharge action
|
|
23
23
|
*
|
|
24
|
-
* @property Required fields:
|
|
25
|
-
* @property Optional fields:
|
|
24
|
+
* @property Required fields: 4
|
|
25
|
+
* @property Optional fields: 3
|
|
26
26
|
*/
|
|
27
27
|
export interface UpdateWorkOrderWithdrawEquipmentChargeProperties {
|
|
28
28
|
/**
|
|
@@ -33,11 +33,61 @@ export interface UpdateWorkOrderWithdrawEquipmentChargeProperties {
|
|
|
33
33
|
* @required
|
|
34
34
|
*/
|
|
35
35
|
StatusReason: string;
|
|
36
|
+
/**
|
|
37
|
+
* Address line 1
|
|
38
|
+
*
|
|
39
|
+
* Contact information field for WorkOrder. Used by Field Operations team for communication.
|
|
40
|
+
* @type {TEXT}
|
|
41
|
+
* @required
|
|
42
|
+
* @visibleWhen SendAnotherBag = ["*"] AND UseAlternativeAddressManual = ["*"]
|
|
43
|
+
*/
|
|
44
|
+
AlternativeAddressLine1: string;
|
|
45
|
+
/**
|
|
46
|
+
* Town or city
|
|
47
|
+
*
|
|
48
|
+
* Contact information field for WorkOrder. Used by Field Operations team for communication.
|
|
49
|
+
* @type {TEXT}
|
|
50
|
+
* @required
|
|
51
|
+
* @visibleWhen SendAnotherBag = ["*"] AND UseAlternativeAddressManual = ["*"]
|
|
52
|
+
*/
|
|
53
|
+
AlternativeAddressCityTown: string;
|
|
54
|
+
/**
|
|
55
|
+
* Postcode
|
|
56
|
+
*
|
|
57
|
+
* Contact information field for WorkOrder. Used by Field Operations team for communication.
|
|
58
|
+
* @type {TEXT}
|
|
59
|
+
* @required
|
|
60
|
+
* @visibleWhen SendAnotherBag = ["*"] AND UseAlternativeAddressManual = ["*"]
|
|
61
|
+
*/
|
|
62
|
+
AlternativeAddressPostCode: string;
|
|
63
|
+
/**
|
|
64
|
+
* Send another collection bag
|
|
65
|
+
*
|
|
66
|
+
* Set by the "Withdraw equipment charge" form. When the collection is cancelled, field-service raises a new collection, to the alternative address when one is given (BILL-1005).
|
|
67
|
+
* @type {BOOLEAN}
|
|
68
|
+
*/
|
|
69
|
+
SendAnotherBag?: boolean | null;
|
|
70
|
+
/**
|
|
71
|
+
* Send it to a different address
|
|
72
|
+
*
|
|
73
|
+
* UseAlternativeAddressManual (Field Operations - WorkOrder)
|
|
74
|
+
* @type {BOOLEAN}
|
|
75
|
+
* @visibleWhen SendAnotherBag = ["*"]
|
|
76
|
+
*/
|
|
77
|
+
UseAlternativeAddressManual?: boolean | null;
|
|
78
|
+
/**
|
|
79
|
+
* Address line 2
|
|
80
|
+
*
|
|
81
|
+
* Contact information field for WorkOrder. Used by Field Operations team for communication.
|
|
82
|
+
* @type {TEXT}
|
|
83
|
+
* @visibleWhen SendAnotherBag = ["*"] AND UseAlternativeAddressManual = ["*"]
|
|
84
|
+
*/
|
|
85
|
+
AlternativeAddressLine2?: string | null;
|
|
36
86
|
}
|
|
37
87
|
/**
|
|
38
88
|
* Withdraw equipment charge
|
|
39
89
|
*
|
|
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.
|
|
90
|
+
* 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. Can send the customer another collection bag. BILL-1005.
|
|
41
91
|
*
|
|
42
92
|
* @actionType UPDATE - Updates an existing WorkOrder record
|
|
43
93
|
* @module FieldServiceModule
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/**
|
|
3
3
|
* UpdateWorkOrderWithdrawEquipmentCharge Action DTO
|
|
4
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.
|
|
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. Can send the customer another collection bag. BILL-1005.
|
|
6
6
|
*
|
|
7
7
|
* @module FieldServiceModule
|
|
8
8
|
* @entity WorkOrder
|
|
@@ -17,7 +17,7 @@ const core_1 = require("@d19n/odin-types/dist/core");
|
|
|
17
17
|
/**
|
|
18
18
|
* Withdraw equipment charge
|
|
19
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.
|
|
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. Can send the customer another collection bag. BILL-1005.
|
|
21
21
|
*
|
|
22
22
|
* @actionType UPDATE - Updates an existing WorkOrder record
|
|
23
23
|
* @module FieldServiceModule
|
|
@@ -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
|