@d19n/youfibre-odin-sdk 1.0.303 → 1.0.304
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 +9 -8
- package/dist/actions-v2/CreateCollectionAmcoWorkOrderDto.d.ts +1 -1
- package/dist/actions-v2/CreateCollectionAmcoWorkOrderFromOrderDto.d.ts +1 -1
- package/dist/actions-v2/CreateDispatchAmcoWorkOrderDto.d.ts +1 -1
- package/dist/actions-v2/CreateDispatchAmcoWorkOrderFromOrderDto.d.ts +1 -1
- package/dist/actions-v2/CreateTransactionalEmailDto.d.ts +186 -0
- package/dist/actions-v2/CreateTransactionalEmailDto.js +59 -0
- package/dist/entities-v2/Case.d.ts +6 -8
- package/dist/entities-v2/Case.js +5 -7
- package/dist/entities-v2/Config.d.ts +8 -8
- package/dist/entities-v2/Config.js +4 -4
- package/dist/entities-v2/Conversation.d.ts +4 -6
- package/dist/entities-v2/Conversation.js +4 -6
- package/dist/entities-v2/Email.d.ts +97 -1
- package/dist/entities-v2/Email.js +2 -0
- package/dist/entities-v2/Order.d.ts +8 -1
- package/dist/entities-v2/Order.js +2 -0
- package/dist/entities-v2/Reward.d.ts +13 -13
- package/dist/entities-v2/Reward.js +2 -2
- package/dist/records-v2/EmailRecord.d.ts +50 -3
- package/dist/records-v2/EmailRecord.js +61 -1
- package/dist/records-v2/index.d.ts +1 -1
- package/dist/records-v2/index.js +4 -4
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -264,7 +264,7 @@ This SDK includes **158** entities across **12** modules.
|
|
|
264
264
|
| **CallUpdates** | CallUpdates Entity Definition | DEFAULT |
|
|
265
265
|
| **Conversation** | Conversation Entity Definition | DEFAULT |
|
|
266
266
|
| **CustomerDeviceConfiguration** | CustomerDeviceConfiguration Entity Definition | DEFAULT |
|
|
267
|
-
| **Email** | Email Entity Definition | SUPPORT |
|
|
267
|
+
| **Email** | Email Entity Definition | SUPPORT, TRANSACTIONAL |
|
|
268
268
|
| **EmailTemplate** | EmailTemplate Entity Definition | DEFAULT |
|
|
269
269
|
| **Message** | Message Entity Definition | EVENT |
|
|
270
270
|
| **NotificationTemplate** | NotificationTemplate Entity Definition | DEFAULT |
|
|
@@ -346,7 +346,7 @@ This SDK includes **158** entities across **12** modules.
|
|
|
346
346
|
|
|
347
347
|
## Actions
|
|
348
348
|
|
|
349
|
-
This SDK includes **
|
|
349
|
+
This SDK includes **490** actions.
|
|
350
350
|
|
|
351
351
|
### Action Types
|
|
352
352
|
|
|
@@ -1439,6 +1439,13 @@ This SDK includes **489** actions.
|
|
|
1439
1439
|
| `CreateTimeSlot` | CREATE | IdentityModule.TimeSlot.Create.CreateTimeSlot |
|
|
1440
1440
|
| `UpdateTimeSlot` | UPDATE | IdentityModule.TimeSlot.Update.UpdateTimeSlot |
|
|
1441
1441
|
|
|
1442
|
+
#### Email
|
|
1443
|
+
|
|
1444
|
+
| Action | Type | Event |
|
|
1445
|
+
|--------|------|-------|
|
|
1446
|
+
| `CreateTransactionalEmail` | CREATE | NotificationModule.Email.Create.CreateTransactionalEmail |
|
|
1447
|
+
| `UpdateSupportEmail` | UPDATE | NotificationModule.Email.Update.Update Support Email |
|
|
1448
|
+
|
|
1442
1449
|
#### WayleaveAudit
|
|
1443
1450
|
|
|
1444
1451
|
| Action | Type | Event |
|
|
@@ -1567,12 +1574,6 @@ This SDK includes **489** actions.
|
|
|
1567
1574
|
|--------|------|-------|
|
|
1568
1575
|
| `UpdateService` | UPDATE | ServiceModule.Service.Update.UpdateService |
|
|
1569
1576
|
|
|
1570
|
-
#### Email
|
|
1571
|
-
|
|
1572
|
-
| Action | Type | Event |
|
|
1573
|
-
|--------|------|-------|
|
|
1574
|
-
| `UpdateSupportEmail` | UPDATE | NotificationModule.Email.Update.Update Support Email |
|
|
1575
|
-
|
|
1576
1577
|
#### User
|
|
1577
1578
|
|
|
1578
1579
|
| Action | Type | Event |
|
|
@@ -48,7 +48,7 @@ export interface CreateCollectionAmcoWorkOrderProperties {
|
|
|
48
48
|
*
|
|
49
49
|
* Reference identifier for WorkOrder relationships. Used for data integrity.
|
|
50
50
|
* @type {LOOKUP}
|
|
51
|
-
* @default Dynamic: {
|
|
51
|
+
* @default Dynamic: {source_record_Order_id}
|
|
52
52
|
* @hidden This field is not visible in the UI
|
|
53
53
|
*/
|
|
54
54
|
OrderId?: string | null;
|
|
@@ -40,7 +40,7 @@ export interface CreateCollectionAmcoWorkOrderProperties {
|
|
|
40
40
|
*
|
|
41
41
|
* Reference identifier for WorkOrder relationships. Used for data integrity.
|
|
42
42
|
* @type {LOOKUP}
|
|
43
|
-
* @default Dynamic: {
|
|
43
|
+
* @default Dynamic: {source_record_Order_id}
|
|
44
44
|
* @hidden This field is not visible in the UI
|
|
45
45
|
*/
|
|
46
46
|
OrderId?: string | null;
|
|
@@ -47,7 +47,7 @@ export interface CreateDispatchAmcoWorkOrderProperties {
|
|
|
47
47
|
*
|
|
48
48
|
* Reference identifier for WorkOrder relationships. Used for data integrity.
|
|
49
49
|
* @type {LOOKUP}
|
|
50
|
-
* @default Dynamic: {
|
|
50
|
+
* @default Dynamic: {source_record_Order_id}
|
|
51
51
|
* @hidden This field is not visible in the UI
|
|
52
52
|
*/
|
|
53
53
|
OrderId?: string | null;
|
|
@@ -39,7 +39,7 @@ export interface CreateDispatchAmcoWorkOrderProperties {
|
|
|
39
39
|
*
|
|
40
40
|
* Reference identifier for WorkOrder relationships. Used for data integrity.
|
|
41
41
|
* @type {LOOKUP}
|
|
42
|
-
* @default Dynamic: {
|
|
42
|
+
* @default Dynamic: {source_record_Order_id}
|
|
43
43
|
* @hidden This field is not visible in the UI
|
|
44
44
|
*/
|
|
45
45
|
OrderId?: string | null;
|
|
@@ -0,0 +1,186 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* CreateTransactionalEmail Action DTO
|
|
3
|
+
*
|
|
4
|
+
* Used to create a transactional email
|
|
5
|
+
*
|
|
6
|
+
* @module NotificationModule
|
|
7
|
+
* @entity Email
|
|
8
|
+
* @entityType TRANSACTIONAL
|
|
9
|
+
* @actionKey CreateTransactionalEmail
|
|
10
|
+
* @event CreateTransactionEmailEvent
|
|
11
|
+
*
|
|
12
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
13
|
+
*/
|
|
14
|
+
import { OdinRecordCreateDto, OdinRecordCreatedEvent } from '@d19n/odin-types/dist/core';
|
|
15
|
+
/**
|
|
16
|
+
* RabbitMQ message payload for CreateTransactionalEmail created events
|
|
17
|
+
*
|
|
18
|
+
* @event NotificationModule.Email.Create.CreateTransactionalEmail
|
|
19
|
+
*/
|
|
20
|
+
export interface CreateTransactionalEmailMessage extends OdinRecordCreatedEvent<CreateTransactionalEmailDto, CreateTransactionalEmailProperties> {
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Properties for CreateTransactionalEmail action
|
|
24
|
+
*
|
|
25
|
+
* @property Required fields: 2
|
|
26
|
+
* @property Optional fields: 15
|
|
27
|
+
*/
|
|
28
|
+
export interface CreateTransactionalEmailProperties {
|
|
29
|
+
/**
|
|
30
|
+
* Date
|
|
31
|
+
*
|
|
32
|
+
* Date field for Email records. Used by Communications team.
|
|
33
|
+
* @type {DATE_TIME}
|
|
34
|
+
* @required
|
|
35
|
+
*/
|
|
36
|
+
Date: string;
|
|
37
|
+
/**
|
|
38
|
+
* MessageId
|
|
39
|
+
*
|
|
40
|
+
* SMTP Message Id (Communications - Email)
|
|
41
|
+
* @type {TEXT}
|
|
42
|
+
* @required
|
|
43
|
+
*/
|
|
44
|
+
MessageId: string;
|
|
45
|
+
/**
|
|
46
|
+
* Case
|
|
47
|
+
*
|
|
48
|
+
* Data field for Email records. Used by Communications team.
|
|
49
|
+
* @type {LOOKUP}
|
|
50
|
+
*/
|
|
51
|
+
Case?: string | null;
|
|
52
|
+
/**
|
|
53
|
+
* SenderType
|
|
54
|
+
*
|
|
55
|
+
* Sender Type (Communications - Email)
|
|
56
|
+
* @type {ENUM}
|
|
57
|
+
*/
|
|
58
|
+
SenderType?: string | null;
|
|
59
|
+
/**
|
|
60
|
+
* Bcc
|
|
61
|
+
*
|
|
62
|
+
* Blind Carbon Copy (Communications - Email)
|
|
63
|
+
* @type {TEXT}
|
|
64
|
+
*/
|
|
65
|
+
Bcc?: string | null;
|
|
66
|
+
/**
|
|
67
|
+
* UpdatedAt
|
|
68
|
+
*
|
|
69
|
+
* When the email was updated (Communications - Email)
|
|
70
|
+
* @type {DATE_TIME}
|
|
71
|
+
*/
|
|
72
|
+
UpdatedAt?: string | null;
|
|
73
|
+
/**
|
|
74
|
+
* Files
|
|
75
|
+
*
|
|
76
|
+
* email attachments (Communications - Email)
|
|
77
|
+
* @type {FILE_MULTIPLE}
|
|
78
|
+
*/
|
|
79
|
+
Files?: undefined | null;
|
|
80
|
+
/**
|
|
81
|
+
* From
|
|
82
|
+
*
|
|
83
|
+
* Data field for Email records. Used by Communications team.
|
|
84
|
+
* @type {TEXT}
|
|
85
|
+
*/
|
|
86
|
+
From?: string | null;
|
|
87
|
+
/**
|
|
88
|
+
* Message
|
|
89
|
+
*
|
|
90
|
+
* Data field for Email records. Used by Communications team.
|
|
91
|
+
* @type {TEXT}
|
|
92
|
+
*/
|
|
93
|
+
Message?: string | null;
|
|
94
|
+
/**
|
|
95
|
+
* ParentMessageId
|
|
96
|
+
*
|
|
97
|
+
* Parent Message id (Communications - Email)
|
|
98
|
+
* @type {LOOKUP}
|
|
99
|
+
*/
|
|
100
|
+
ParentMessageId?: string | null;
|
|
101
|
+
/**
|
|
102
|
+
* CreatedAt
|
|
103
|
+
*
|
|
104
|
+
* When the email was created (Communications - Email)
|
|
105
|
+
* @type {DATE_TIME}
|
|
106
|
+
*/
|
|
107
|
+
CreatedAt?: string | null;
|
|
108
|
+
/**
|
|
109
|
+
* Envelope
|
|
110
|
+
*
|
|
111
|
+
* Data field for Email records. Used by Communications team.
|
|
112
|
+
* @type {JSON}
|
|
113
|
+
*/
|
|
114
|
+
Envelope?: string | null;
|
|
115
|
+
/**
|
|
116
|
+
* InReplyTo
|
|
117
|
+
*
|
|
118
|
+
* In Reply To (Communications - Email)
|
|
119
|
+
* @type {TEXT}
|
|
120
|
+
*/
|
|
121
|
+
InReplyTo?: string | null;
|
|
122
|
+
/**
|
|
123
|
+
* To
|
|
124
|
+
*
|
|
125
|
+
* Data field for Email records. Used by Communications team.
|
|
126
|
+
* @type {TEXT}
|
|
127
|
+
*/
|
|
128
|
+
To?: string | null;
|
|
129
|
+
/**
|
|
130
|
+
* Cc
|
|
131
|
+
*
|
|
132
|
+
* Carbon Copy (Communications - Email)
|
|
133
|
+
* @type {TEXT}
|
|
134
|
+
*/
|
|
135
|
+
Cc?: string | null;
|
|
136
|
+
/**
|
|
137
|
+
* FormattedMessage
|
|
138
|
+
*
|
|
139
|
+
* Formatted Message (Communications - Email)
|
|
140
|
+
* @type {HTML}
|
|
141
|
+
*/
|
|
142
|
+
FormattedMessage?: string | null;
|
|
143
|
+
/**
|
|
144
|
+
* Subject
|
|
145
|
+
*
|
|
146
|
+
* Data field for Email records. Used by Communications team.
|
|
147
|
+
* @type {TEXT}
|
|
148
|
+
*/
|
|
149
|
+
Subject?: string | null;
|
|
150
|
+
}
|
|
151
|
+
/**
|
|
152
|
+
* CreateTransactionalEmail
|
|
153
|
+
*
|
|
154
|
+
* Used to create a transactional email
|
|
155
|
+
*
|
|
156
|
+
* @actionType CREATE - Creates a new Email record
|
|
157
|
+
* @module NotificationModule
|
|
158
|
+
* @entity Email
|
|
159
|
+
* @entityType TRANSACTIONAL (TRANSACTIONAL)
|
|
160
|
+
* @event NotificationModule.Email.Create.CreateTransactionalEmail
|
|
161
|
+
* @permission schema.action.createtransactionalemail.trigger
|
|
162
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
163
|
+
*/
|
|
164
|
+
export declare class CreateTransactionalEmailDto extends OdinRecordCreateDto<CreateTransactionalEmailProperties> {
|
|
165
|
+
/** Used by SDK generators to identify action type */
|
|
166
|
+
static readonly ACTION_TYPE = "CREATE";
|
|
167
|
+
static readonly ACTION_KEY = "CreateTransactionalEmail";
|
|
168
|
+
static readonly MODULE_NAME = "NotificationModule";
|
|
169
|
+
static readonly ENTITIES: string[];
|
|
170
|
+
static readonly ENTITY_TYPE = "TRANSACTIONAL";
|
|
171
|
+
static readonly EVENT_NAME = "NotificationModule.Email.Create.CreateTransactionalEmail";
|
|
172
|
+
static readonly PERMISSION = "schema.action.createtransactionalemail.trigger";
|
|
173
|
+
/** Step metadata - entity this action targets */
|
|
174
|
+
static readonly STEP_ENTITY = "NotificationModule:Email";
|
|
175
|
+
static readonly STEP_SCHEMA_ID = "a3b4d6b7-0647-4202-90a6-036e3c87c5ae";
|
|
176
|
+
static readonly STEP_SCHEMA_ACTION_ID = "1e0cbbca-e05c-45d4-8422-5e34839de0ab";
|
|
177
|
+
static readonly STEP_SCHEMA_TYPE_ID = "e9e1ed12-a147-4163-aff0-b38e2c635d53";
|
|
178
|
+
static readonly STEP_TYPE = "TRANSACTIONAL";
|
|
179
|
+
static readonly AUTO_LINK_PARENT = true;
|
|
180
|
+
readonly actionName: string;
|
|
181
|
+
readonly schemaActionId: string;
|
|
182
|
+
readonly entity: string;
|
|
183
|
+
constructor(properties: CreateTransactionalEmailProperties, options?: {
|
|
184
|
+
journeyId?: string;
|
|
185
|
+
});
|
|
186
|
+
}
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* CreateTransactionalEmail Action DTO
|
|
4
|
+
*
|
|
5
|
+
* Used to create a transactional email
|
|
6
|
+
*
|
|
7
|
+
* @module NotificationModule
|
|
8
|
+
* @entity Email
|
|
9
|
+
* @entityType TRANSACTIONAL
|
|
10
|
+
* @actionKey CreateTransactionalEmail
|
|
11
|
+
* @event CreateTransactionEmailEvent
|
|
12
|
+
*
|
|
13
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.CreateTransactionalEmailDto = void 0;
|
|
17
|
+
const core_1 = require("@d19n/odin-types/dist/core");
|
|
18
|
+
/**
|
|
19
|
+
* CreateTransactionalEmail
|
|
20
|
+
*
|
|
21
|
+
* Used to create a transactional email
|
|
22
|
+
*
|
|
23
|
+
* @actionType CREATE - Creates a new Email record
|
|
24
|
+
* @module NotificationModule
|
|
25
|
+
* @entity Email
|
|
26
|
+
* @entityType TRANSACTIONAL (TRANSACTIONAL)
|
|
27
|
+
* @event NotificationModule.Email.Create.CreateTransactionalEmail
|
|
28
|
+
* @permission schema.action.createtransactionalemail.trigger
|
|
29
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
30
|
+
*/
|
|
31
|
+
class CreateTransactionalEmailDto extends core_1.OdinRecordCreateDto {
|
|
32
|
+
constructor(properties, options) {
|
|
33
|
+
super({
|
|
34
|
+
entity: 'NotificationModule:Email',
|
|
35
|
+
type: 'TRANSACTIONAL',
|
|
36
|
+
properties,
|
|
37
|
+
journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
|
|
38
|
+
});
|
|
39
|
+
this.actionName = 'CreateTransactionalEmail';
|
|
40
|
+
this.schemaActionId = '1e0cbbca-e05c-45d4-8422-5e34839de0ab';
|
|
41
|
+
this.entity = 'NotificationModule:Email';
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
exports.CreateTransactionalEmailDto = CreateTransactionalEmailDto;
|
|
45
|
+
/** Used by SDK generators to identify action type */
|
|
46
|
+
CreateTransactionalEmailDto.ACTION_TYPE = 'CREATE';
|
|
47
|
+
CreateTransactionalEmailDto.ACTION_KEY = 'CreateTransactionalEmail';
|
|
48
|
+
CreateTransactionalEmailDto.MODULE_NAME = 'NotificationModule';
|
|
49
|
+
CreateTransactionalEmailDto.ENTITIES = ['Email'];
|
|
50
|
+
CreateTransactionalEmailDto.ENTITY_TYPE = 'TRANSACTIONAL';
|
|
51
|
+
CreateTransactionalEmailDto.EVENT_NAME = 'NotificationModule.Email.Create.CreateTransactionalEmail';
|
|
52
|
+
CreateTransactionalEmailDto.PERMISSION = 'schema.action.createtransactionalemail.trigger';
|
|
53
|
+
/** Step metadata - entity this action targets */
|
|
54
|
+
CreateTransactionalEmailDto.STEP_ENTITY = 'NotificationModule:Email';
|
|
55
|
+
CreateTransactionalEmailDto.STEP_SCHEMA_ID = 'a3b4d6b7-0647-4202-90a6-036e3c87c5ae';
|
|
56
|
+
CreateTransactionalEmailDto.STEP_SCHEMA_ACTION_ID = '1e0cbbca-e05c-45d4-8422-5e34839de0ab';
|
|
57
|
+
CreateTransactionalEmailDto.STEP_SCHEMA_TYPE_ID = 'e9e1ed12-a147-4163-aff0-b38e2c635d53';
|
|
58
|
+
CreateTransactionalEmailDto.STEP_TYPE = 'TRANSACTIONAL';
|
|
59
|
+
CreateTransactionalEmailDto.AUTO_LINK_PARENT = true;
|
|
@@ -208,11 +208,10 @@ export declare enum CaseSla {
|
|
|
208
208
|
* - `TLOS_APP` - TLOS App
|
|
209
209
|
* - `TLOS_PORTAL` - TLOS Portal
|
|
210
210
|
* - `TRUSTPILOT_SERVICE_REVIEW` - Trustpilot review
|
|
211
|
-
* - `
|
|
212
|
-
* - `TWITTER_MENTION` - Twitter Mention
|
|
211
|
+
* - `TWITTER_X_MENTION` - Twitter/X Mention
|
|
213
212
|
* - `WEB_CHAT` - Web chat
|
|
214
213
|
* - `WEB_FORM_BUSINESS` - Web form - Business
|
|
215
|
-
* -
|
|
214
|
+
* - `WHATSAPP` - Whatsapp
|
|
216
215
|
*/
|
|
217
216
|
export declare enum CaseChannel {
|
|
218
217
|
CALL = "CALL",
|
|
@@ -226,8 +225,7 @@ export declare enum CaseChannel {
|
|
|
226
225
|
TLOS_APP = "TLOS_APP",
|
|
227
226
|
TLOS_PORTAL = "TLOS_PORTAL",
|
|
228
227
|
TRUSTPILOT_REVIEW = "TRUSTPILOT_SERVICE_REVIEW",
|
|
229
|
-
|
|
230
|
-
TWITTER_MENTION = "TWITTER_MENTION",
|
|
228
|
+
TWITTER_X_MENTION = "TWITTER_X_MENTION",
|
|
231
229
|
WEB_CHAT = "WEB_CHAT",
|
|
232
230
|
WEB_FORM_BUSINESS = "WEB_FORM_BUSINESS",
|
|
233
231
|
WHATSAPP = "WHATSAPP"
|
|
@@ -437,9 +435,9 @@ export declare enum CaseImpact {
|
|
|
437
435
|
* - `FACEBOOK` - Facebook
|
|
438
436
|
* - `TRUSTPILOT` - Trustpilot
|
|
439
437
|
* - `TWILIO` - Twilio
|
|
438
|
+
* - `TWITTER_X` - Twitter/X
|
|
440
439
|
* - `USERESPONSE` - Useresponse
|
|
441
440
|
* - `WEBSITE` - Website
|
|
442
|
-
* - `TWITTER` - X/Twitter
|
|
443
441
|
*/
|
|
444
442
|
export declare enum CaseSource {
|
|
445
443
|
AIRCALL = "AIRCALL",
|
|
@@ -449,9 +447,9 @@ export declare enum CaseSource {
|
|
|
449
447
|
FACEBOOK = "FACEBOOK",
|
|
450
448
|
TRUSTPILOT = "TRUSTPILOT",
|
|
451
449
|
TWILIO = "TWILIO",
|
|
450
|
+
TWITTER_X = "TWITTER_X",
|
|
452
451
|
USERESPONSE = "USERESPONSE",
|
|
453
|
-
WEBSITE = "WEBSITE"
|
|
454
|
-
X_TWITTER = "TWITTER"
|
|
452
|
+
WEBSITE = "WEBSITE"
|
|
455
453
|
}
|
|
456
454
|
/**
|
|
457
455
|
* Valid values for Case.Problem
|
package/dist/entities-v2/Case.js
CHANGED
|
@@ -202,11 +202,10 @@ var CaseSla;
|
|
|
202
202
|
* - `TLOS_APP` - TLOS App
|
|
203
203
|
* - `TLOS_PORTAL` - TLOS Portal
|
|
204
204
|
* - `TRUSTPILOT_SERVICE_REVIEW` - Trustpilot review
|
|
205
|
-
* - `
|
|
206
|
-
* - `TWITTER_MENTION` - Twitter Mention
|
|
205
|
+
* - `TWITTER_X_MENTION` - Twitter/X Mention
|
|
207
206
|
* - `WEB_CHAT` - Web chat
|
|
208
207
|
* - `WEB_FORM_BUSINESS` - Web form - Business
|
|
209
|
-
* -
|
|
208
|
+
* - `WHATSAPP` - Whatsapp
|
|
210
209
|
*/
|
|
211
210
|
var CaseChannel;
|
|
212
211
|
(function (CaseChannel) {
|
|
@@ -221,8 +220,7 @@ var CaseChannel;
|
|
|
221
220
|
CaseChannel["TLOS_APP"] = "TLOS_APP";
|
|
222
221
|
CaseChannel["TLOS_PORTAL"] = "TLOS_PORTAL";
|
|
223
222
|
CaseChannel["TRUSTPILOT_REVIEW"] = "TRUSTPILOT_SERVICE_REVIEW";
|
|
224
|
-
CaseChannel["
|
|
225
|
-
CaseChannel["TWITTER_MENTION"] = "TWITTER_MENTION";
|
|
223
|
+
CaseChannel["TWITTER_X_MENTION"] = "TWITTER_X_MENTION";
|
|
226
224
|
CaseChannel["WEB_CHAT"] = "WEB_CHAT";
|
|
227
225
|
CaseChannel["WEB_FORM_BUSINESS"] = "WEB_FORM_BUSINESS";
|
|
228
226
|
CaseChannel["WHATSAPP"] = "WHATSAPP";
|
|
@@ -439,9 +437,9 @@ var CaseImpact;
|
|
|
439
437
|
* - `FACEBOOK` - Facebook
|
|
440
438
|
* - `TRUSTPILOT` - Trustpilot
|
|
441
439
|
* - `TWILIO` - Twilio
|
|
440
|
+
* - `TWITTER_X` - Twitter/X
|
|
442
441
|
* - `USERESPONSE` - Useresponse
|
|
443
442
|
* - `WEBSITE` - Website
|
|
444
|
-
* - `TWITTER` - X/Twitter
|
|
445
443
|
*/
|
|
446
444
|
var CaseSource;
|
|
447
445
|
(function (CaseSource) {
|
|
@@ -452,9 +450,9 @@ var CaseSource;
|
|
|
452
450
|
CaseSource["FACEBOOK"] = "FACEBOOK";
|
|
453
451
|
CaseSource["TRUSTPILOT"] = "TRUSTPILOT";
|
|
454
452
|
CaseSource["TWILIO"] = "TWILIO";
|
|
453
|
+
CaseSource["TWITTER_X"] = "TWITTER_X";
|
|
455
454
|
CaseSource["USERESPONSE"] = "USERESPONSE";
|
|
456
455
|
CaseSource["WEBSITE"] = "WEBSITE";
|
|
457
|
-
CaseSource["X_TWITTER"] = "TWITTER";
|
|
458
456
|
})(CaseSource = exports.CaseSource || (exports.CaseSource = {}));
|
|
459
457
|
/**
|
|
460
458
|
* Valid values for Case.Problem
|
|
@@ -23,12 +23,12 @@ export declare enum ConfigEntityTypes {
|
|
|
23
23
|
* Use these constants instead of string literals for type safety
|
|
24
24
|
*/
|
|
25
25
|
export declare enum ConfigPropertyKeys {
|
|
26
|
-
/**
|
|
27
|
-
|
|
26
|
+
/** the name of the app this config relates to (Platform - Config) */
|
|
27
|
+
AppName = "AppName",
|
|
28
28
|
/** object of { key: value } mappings (Platform - Config) */
|
|
29
29
|
Mappings = "Mappings",
|
|
30
|
-
/**
|
|
31
|
-
|
|
30
|
+
/** Data field for Config records. Used by Platform team. */
|
|
31
|
+
Test = "Test"
|
|
32
32
|
}
|
|
33
33
|
/**
|
|
34
34
|
* Properties for Config records
|
|
@@ -36,21 +36,21 @@ export declare enum ConfigPropertyKeys {
|
|
|
36
36
|
* @see SchemaModule:Config
|
|
37
37
|
*/
|
|
38
38
|
export interface ConfigProperties {
|
|
39
|
-
/**
|
|
39
|
+
/** the name of the app this config relates to (Platform - Config)
|
|
40
40
|
*
|
|
41
41
|
* @type {TEXT}
|
|
42
42
|
*/
|
|
43
|
-
|
|
43
|
+
AppName: string;
|
|
44
44
|
/** object of { key: value } mappings (Platform - Config)
|
|
45
45
|
*
|
|
46
46
|
* @type {JSON}
|
|
47
47
|
*/
|
|
48
48
|
Mappings: string;
|
|
49
|
-
/**
|
|
49
|
+
/** Data field for Config records. Used by Platform team.
|
|
50
50
|
*
|
|
51
51
|
* @type {TEXT}
|
|
52
52
|
*/
|
|
53
|
-
|
|
53
|
+
Test: string;
|
|
54
54
|
}
|
|
55
55
|
/**
|
|
56
56
|
* Config entity from SchemaModule
|
|
@@ -28,12 +28,12 @@ var ConfigEntityTypes;
|
|
|
28
28
|
*/
|
|
29
29
|
var ConfigPropertyKeys;
|
|
30
30
|
(function (ConfigPropertyKeys) {
|
|
31
|
-
/** Data field for Config records. Used by Platform team. */
|
|
32
|
-
ConfigPropertyKeys["Test"] = "Test";
|
|
33
|
-
/** object of { key: value } mappings (Platform - Config) */
|
|
34
|
-
ConfigPropertyKeys["Mappings"] = "Mappings";
|
|
35
31
|
/** the name of the app this config relates to (Platform - Config) */
|
|
36
32
|
ConfigPropertyKeys["AppName"] = "AppName";
|
|
33
|
+
/** object of { key: value } mappings (Platform - Config) */
|
|
34
|
+
ConfigPropertyKeys["Mappings"] = "Mappings";
|
|
35
|
+
/** Data field for Config records. Used by Platform team. */
|
|
36
|
+
ConfigPropertyKeys["Test"] = "Test";
|
|
37
37
|
})(ConfigPropertyKeys = exports.ConfigPropertyKeys || (exports.ConfigPropertyKeys = {}));
|
|
38
38
|
/**
|
|
39
39
|
* Config entity from SchemaModule
|
|
@@ -32,8 +32,7 @@ export declare enum ConversationEntityTypes {
|
|
|
32
32
|
* - `INSTAGRAM_DM` - Instagram DM
|
|
33
33
|
* - `SMS`
|
|
34
34
|
* - `TRUSTPILOT_SERVICE_REVIEW` - Trustpilot Service Review
|
|
35
|
-
* - `
|
|
36
|
-
* - `TWITTER_MENTION` - Twitter Mention
|
|
35
|
+
* - `TWITTER_X_MENTION` - Twitter/X Mention
|
|
37
36
|
* - `WHATSAPP` - WhatsApp
|
|
38
37
|
*/
|
|
39
38
|
export declare enum ConversationChannel {
|
|
@@ -43,8 +42,7 @@ export declare enum ConversationChannel {
|
|
|
43
42
|
INSTAGRAM_DM = "INSTAGRAM_DM",
|
|
44
43
|
SMS = "SMS",
|
|
45
44
|
TRUSTPILOT_SERVICE_REVIEW = "TRUSTPILOT_SERVICE_REVIEW",
|
|
46
|
-
|
|
47
|
-
TWITTER_MENTION = "TWITTER_MENTION",
|
|
45
|
+
TWITTER_X_MENTION = "TWITTER_X_MENTION",
|
|
48
46
|
WHATS_APP = "WHATSAPP"
|
|
49
47
|
}
|
|
50
48
|
/**
|
|
@@ -74,14 +72,14 @@ export declare enum ConversationStatus {
|
|
|
74
72
|
* - `INSTAGRAM` - Instagram
|
|
75
73
|
* - `TRUSTPILOT` - Trustpilot
|
|
76
74
|
* - `TWILIO` - Twilio
|
|
77
|
-
* - `
|
|
75
|
+
* - `TWITTER_X` - Twitter/X
|
|
78
76
|
*/
|
|
79
77
|
export declare enum ConversationSource {
|
|
80
78
|
FACEBOOK = "FACEBOOK",
|
|
81
79
|
INSTAGRAM = "INSTAGRAM",
|
|
82
80
|
TRUSTPILOT = "TRUSTPILOT",
|
|
83
81
|
TWILIO = "TWILIO",
|
|
84
|
-
|
|
82
|
+
TWITTER_X = "TWITTER_X"
|
|
85
83
|
}
|
|
86
84
|
/**
|
|
87
85
|
* Property keys for Conversation
|
|
@@ -34,8 +34,7 @@ var ConversationEntityTypes;
|
|
|
34
34
|
* - `INSTAGRAM_DM` - Instagram DM
|
|
35
35
|
* - `SMS`
|
|
36
36
|
* - `TRUSTPILOT_SERVICE_REVIEW` - Trustpilot Service Review
|
|
37
|
-
* - `
|
|
38
|
-
* - `TWITTER_MENTION` - Twitter Mention
|
|
37
|
+
* - `TWITTER_X_MENTION` - Twitter/X Mention
|
|
39
38
|
* - `WHATSAPP` - WhatsApp
|
|
40
39
|
*/
|
|
41
40
|
var ConversationChannel;
|
|
@@ -46,8 +45,7 @@ var ConversationChannel;
|
|
|
46
45
|
ConversationChannel["INSTAGRAM_DM"] = "INSTAGRAM_DM";
|
|
47
46
|
ConversationChannel["SMS"] = "SMS";
|
|
48
47
|
ConversationChannel["TRUSTPILOT_SERVICE_REVIEW"] = "TRUSTPILOT_SERVICE_REVIEW";
|
|
49
|
-
ConversationChannel["
|
|
50
|
-
ConversationChannel["TWITTER_MENTION"] = "TWITTER_MENTION";
|
|
48
|
+
ConversationChannel["TWITTER_X_MENTION"] = "TWITTER_X_MENTION";
|
|
51
49
|
ConversationChannel["WHATS_APP"] = "WHATSAPP";
|
|
52
50
|
})(ConversationChannel = exports.ConversationChannel || (exports.ConversationChannel = {}));
|
|
53
51
|
/**
|
|
@@ -78,7 +76,7 @@ var ConversationStatus;
|
|
|
78
76
|
* - `INSTAGRAM` - Instagram
|
|
79
77
|
* - `TRUSTPILOT` - Trustpilot
|
|
80
78
|
* - `TWILIO` - Twilio
|
|
81
|
-
* - `
|
|
79
|
+
* - `TWITTER_X` - Twitter/X
|
|
82
80
|
*/
|
|
83
81
|
var ConversationSource;
|
|
84
82
|
(function (ConversationSource) {
|
|
@@ -86,7 +84,7 @@ var ConversationSource;
|
|
|
86
84
|
ConversationSource["INSTAGRAM"] = "INSTAGRAM";
|
|
87
85
|
ConversationSource["TRUSTPILOT"] = "TRUSTPILOT";
|
|
88
86
|
ConversationSource["TWILIO"] = "TWILIO";
|
|
89
|
-
ConversationSource["
|
|
87
|
+
ConversationSource["TWITTER_X"] = "TWITTER_X";
|
|
90
88
|
})(ConversationSource = exports.ConversationSource || (exports.ConversationSource = {}));
|
|
91
89
|
/**
|
|
92
90
|
* Property keys for Conversation
|
|
@@ -22,7 +22,9 @@ export declare enum EmailEntityTypes {
|
|
|
22
22
|
/** This is the default record type */
|
|
23
23
|
DEFAULT = "DEFAULT",
|
|
24
24
|
/** Support */
|
|
25
|
-
SUPPORT = "SUPPORT"
|
|
25
|
+
SUPPORT = "SUPPORT",
|
|
26
|
+
/** This type is used to create entities for transactional emails */
|
|
27
|
+
TRANSACTIONAL = "TRANSACTIONAL"
|
|
26
28
|
}
|
|
27
29
|
/**
|
|
28
30
|
* Valid values for Email.SenderType
|
|
@@ -267,6 +269,100 @@ export interface SupportEmailProperties {
|
|
|
267
269
|
*/
|
|
268
270
|
Case: string;
|
|
269
271
|
}
|
|
272
|
+
/**
|
|
273
|
+
* Properties for TRANSACTIONAL Email records
|
|
274
|
+
*
|
|
275
|
+
* @see NotificationModule:Email
|
|
276
|
+
*/
|
|
277
|
+
export interface TransactionalEmailProperties {
|
|
278
|
+
/** Data field for Email records. Used by Communications team.
|
|
279
|
+
*
|
|
280
|
+
* @type {TEXT}
|
|
281
|
+
*/
|
|
282
|
+
Subject: string;
|
|
283
|
+
/** Formatted Message (Communications - Email)
|
|
284
|
+
*
|
|
285
|
+
* @type {HTML}
|
|
286
|
+
*/
|
|
287
|
+
FormattedMessage: string;
|
|
288
|
+
/** Carbon Copy (Communications - Email)
|
|
289
|
+
*
|
|
290
|
+
* @type {TEXT}
|
|
291
|
+
*/
|
|
292
|
+
Cc: string;
|
|
293
|
+
/** Data field for Email records. Used by Communications team.
|
|
294
|
+
*
|
|
295
|
+
* @type {TEXT}
|
|
296
|
+
*/
|
|
297
|
+
To: string;
|
|
298
|
+
/** In Reply To (Communications - Email)
|
|
299
|
+
*
|
|
300
|
+
* @type {TEXT}
|
|
301
|
+
*/
|
|
302
|
+
InReplyTo: string;
|
|
303
|
+
/** Data field for Email records. Used by Communications team.
|
|
304
|
+
*
|
|
305
|
+
* @type {JSON}
|
|
306
|
+
*/
|
|
307
|
+
Envelope: string;
|
|
308
|
+
/** When the email was created (Communications - Email)
|
|
309
|
+
*
|
|
310
|
+
* @type {DATE_TIME}
|
|
311
|
+
*/
|
|
312
|
+
CreatedAt: string;
|
|
313
|
+
/** Parent Message id (Communications - Email)
|
|
314
|
+
*
|
|
315
|
+
* @type {LOOKUP}
|
|
316
|
+
*/
|
|
317
|
+
ParentMessageId: string;
|
|
318
|
+
/** Data field for Email records. Used by Communications team.
|
|
319
|
+
*
|
|
320
|
+
* @type {TEXT}
|
|
321
|
+
*/
|
|
322
|
+
Message: string;
|
|
323
|
+
/** SMTP Message Id (Communications - Email)
|
|
324
|
+
*
|
|
325
|
+
* @type {TEXT}
|
|
326
|
+
*/
|
|
327
|
+
MessageId: string;
|
|
328
|
+
/** Data field for Email records. Used by Communications team.
|
|
329
|
+
*
|
|
330
|
+
* @type {TEXT}
|
|
331
|
+
*/
|
|
332
|
+
From: string;
|
|
333
|
+
/** email attachments (Communications - Email)
|
|
334
|
+
*
|
|
335
|
+
* @type {FILE_MULTIPLE}
|
|
336
|
+
*/
|
|
337
|
+
Files: string;
|
|
338
|
+
/** When the email was updated (Communications - Email)
|
|
339
|
+
*
|
|
340
|
+
* @type {DATE_TIME}
|
|
341
|
+
*/
|
|
342
|
+
UpdatedAt: string;
|
|
343
|
+
/** Blind Carbon Copy (Communications - Email)
|
|
344
|
+
*
|
|
345
|
+
* @type {TEXT}
|
|
346
|
+
*/
|
|
347
|
+
Bcc: string;
|
|
348
|
+
/** Date field for Email records. Used by Communications team.
|
|
349
|
+
*
|
|
350
|
+
* @type {DATE_TIME}
|
|
351
|
+
*/
|
|
352
|
+
Date: string;
|
|
353
|
+
/** Sender Type (Communications - Email)
|
|
354
|
+
*
|
|
355
|
+
* @type {ENUM}
|
|
356
|
+
* @default CUSTOMER
|
|
357
|
+
* @enum {EmailSenderType}
|
|
358
|
+
*/
|
|
359
|
+
SenderType: EmailSenderType;
|
|
360
|
+
/** Data field for Email records. Used by Communications team.
|
|
361
|
+
*
|
|
362
|
+
* @type {LOOKUP}
|
|
363
|
+
*/
|
|
364
|
+
Case: string;
|
|
365
|
+
}
|
|
270
366
|
/**
|
|
271
367
|
* Email entity from NotificationModule
|
|
272
368
|
*
|
|
@@ -23,6 +23,8 @@ var EmailEntityTypes;
|
|
|
23
23
|
EmailEntityTypes["DEFAULT"] = "DEFAULT";
|
|
24
24
|
/** Support */
|
|
25
25
|
EmailEntityTypes["SUPPORT"] = "SUPPORT";
|
|
26
|
+
/** This type is used to create entities for transactional emails */
|
|
27
|
+
EmailEntityTypes["TRANSACTIONAL"] = "TRANSACTIONAL";
|
|
26
28
|
})(EmailEntityTypes = exports.EmailEntityTypes || (exports.EmailEntityTypes = {}));
|
|
27
29
|
/**
|
|
28
30
|
* Valid values for Email.SenderType
|
|
@@ -438,7 +438,9 @@ export declare enum OrderPropertyKeys {
|
|
|
438
438
|
/** PendingAmcoDispatch */
|
|
439
439
|
PendingAmcoDispatch = "PendingAmcoDispatch",
|
|
440
440
|
/** PendingAmcoCollection */
|
|
441
|
-
PendingAmcoCollection = "PendingAmcoCollection"
|
|
441
|
+
PendingAmcoCollection = "PendingAmcoCollection",
|
|
442
|
+
/** Affiliate code used when order was placed */
|
|
443
|
+
AffiliateCode = "AffiliateCode"
|
|
442
444
|
}
|
|
443
445
|
/**
|
|
444
446
|
* Properties for Order records
|
|
@@ -986,6 +988,11 @@ export interface OrderProperties {
|
|
|
986
988
|
* @type {BOOLEAN}
|
|
987
989
|
*/
|
|
988
990
|
PendingAmcoCollection: boolean;
|
|
991
|
+
/** Affiliate code used when order was placed
|
|
992
|
+
*
|
|
993
|
+
* @type {TEXT}
|
|
994
|
+
*/
|
|
995
|
+
AffiliateCode: string;
|
|
989
996
|
}
|
|
990
997
|
/**
|
|
991
998
|
* Order entity from OrderModule
|
|
@@ -423,6 +423,8 @@ var OrderPropertyKeys;
|
|
|
423
423
|
OrderPropertyKeys["PendingAmcoDispatch"] = "PendingAmcoDispatch";
|
|
424
424
|
/** PendingAmcoCollection */
|
|
425
425
|
OrderPropertyKeys["PendingAmcoCollection"] = "PendingAmcoCollection";
|
|
426
|
+
/** Affiliate code used when order was placed */
|
|
427
|
+
OrderPropertyKeys["AffiliateCode"] = "AffiliateCode";
|
|
426
428
|
})(OrderPropertyKeys = exports.OrderPropertyKeys || (exports.OrderPropertyKeys = {}));
|
|
427
429
|
/**
|
|
428
430
|
* Order entity from OrderModule
|
|
@@ -56,14 +56,14 @@ export declare enum RewardPropertyKeys {
|
|
|
56
56
|
ContactId = "ContactId",
|
|
57
57
|
/** Campaign this reward belongs to */
|
|
58
58
|
CampaignId = "CampaignId",
|
|
59
|
-
/** Affiliate code that generated this reward */
|
|
60
|
-
AffiliateCodeId = "AffiliateCodeId",
|
|
61
59
|
/** Reward amount value */
|
|
62
60
|
Amount = "Amount",
|
|
63
61
|
/** Currency of the rewarded amount */
|
|
64
62
|
Currency = "Currency",
|
|
65
63
|
/** PaymentMethodRefund reference */
|
|
66
|
-
PaymentMethodRefundId = "PaymentMethodRefundId"
|
|
64
|
+
PaymentMethodRefundId = "PaymentMethodRefundId",
|
|
65
|
+
/** Affiliate code that generated this reward */
|
|
66
|
+
AffiliateCodeId = "AffiliateCodeId"
|
|
67
67
|
}
|
|
68
68
|
/**
|
|
69
69
|
* Properties for Reward records
|
|
@@ -81,11 +81,6 @@ export interface RewardProperties {
|
|
|
81
81
|
* @type {LOOKUP}
|
|
82
82
|
*/
|
|
83
83
|
CampaignId: string;
|
|
84
|
-
/** Affiliate code that generated this reward
|
|
85
|
-
*
|
|
86
|
-
* @type {LOOKUP}
|
|
87
|
-
*/
|
|
88
|
-
AffiliateCodeId: string;
|
|
89
84
|
/** Reward amount value
|
|
90
85
|
*
|
|
91
86
|
* @type {NUMBER}
|
|
@@ -101,6 +96,11 @@ export interface RewardProperties {
|
|
|
101
96
|
* @type {LOOKUP}
|
|
102
97
|
*/
|
|
103
98
|
PaymentMethodRefundId: string;
|
|
99
|
+
/** Affiliate code that generated this reward
|
|
100
|
+
*
|
|
101
|
+
* @type {LOOKUP}
|
|
102
|
+
*/
|
|
103
|
+
AffiliateCodeId: string;
|
|
104
104
|
}
|
|
105
105
|
/**
|
|
106
106
|
* Properties for CASHBACK Reward records
|
|
@@ -118,11 +118,6 @@ export interface CashbackRewardProperties {
|
|
|
118
118
|
* @type {LOOKUP}
|
|
119
119
|
*/
|
|
120
120
|
CampaignId: string;
|
|
121
|
-
/** Affiliate code that generated this reward
|
|
122
|
-
*
|
|
123
|
-
* @type {LOOKUP}
|
|
124
|
-
*/
|
|
125
|
-
AffiliateCodeId: string;
|
|
126
121
|
/** Reward amount value
|
|
127
122
|
*
|
|
128
123
|
* @type {NUMBER}
|
|
@@ -138,6 +133,11 @@ export interface CashbackRewardProperties {
|
|
|
138
133
|
* @type {LOOKUP}
|
|
139
134
|
*/
|
|
140
135
|
PaymentMethodRefundId: string;
|
|
136
|
+
/** Affiliate code that generated this reward
|
|
137
|
+
*
|
|
138
|
+
* @type {LOOKUP}
|
|
139
|
+
*/
|
|
140
|
+
AffiliateCodeId: string;
|
|
141
141
|
}
|
|
142
142
|
/**
|
|
143
143
|
* Reward entity from CrmModule
|
|
@@ -59,14 +59,14 @@ var RewardPropertyKeys;
|
|
|
59
59
|
RewardPropertyKeys["ContactId"] = "ContactId";
|
|
60
60
|
/** Campaign this reward belongs to */
|
|
61
61
|
RewardPropertyKeys["CampaignId"] = "CampaignId";
|
|
62
|
-
/** Affiliate code that generated this reward */
|
|
63
|
-
RewardPropertyKeys["AffiliateCodeId"] = "AffiliateCodeId";
|
|
64
62
|
/** Reward amount value */
|
|
65
63
|
RewardPropertyKeys["Amount"] = "Amount";
|
|
66
64
|
/** Currency of the rewarded amount */
|
|
67
65
|
RewardPropertyKeys["Currency"] = "Currency";
|
|
68
66
|
/** PaymentMethodRefund reference */
|
|
69
67
|
RewardPropertyKeys["PaymentMethodRefundId"] = "PaymentMethodRefundId";
|
|
68
|
+
/** Affiliate code that generated this reward */
|
|
69
|
+
RewardPropertyKeys["AffiliateCodeId"] = "AffiliateCodeId";
|
|
70
70
|
})(RewardPropertyKeys = exports.RewardPropertyKeys || (exports.RewardPropertyKeys = {}));
|
|
71
71
|
/**
|
|
72
72
|
* Reward entity from CrmModule
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* await record.createEmail({ ... });
|
|
11
11
|
* ```
|
|
12
12
|
*
|
|
13
|
-
* Entity Types: DEFAULT, SUPPORT
|
|
13
|
+
* Entity Types: DEFAULT, SUPPORT, TRANSACTIONAL
|
|
14
14
|
*
|
|
15
15
|
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
16
16
|
*/
|
|
@@ -19,13 +19,14 @@ import { PipelineStageEntity } from '@d19n/odin-types/dist/core';
|
|
|
19
19
|
import { IDbRecordCreateUpdateRes } from '@d19n/odin-types/dist/core/interfaces/v1.db.interfaces';
|
|
20
20
|
import { IOdinProvider } from '@d19n/odin-sdk-generator/dist/odin-sdk-types';
|
|
21
21
|
import { RecordLinkManager } from '@d19n/odin-sdk-generator/dist/record-link-manager';
|
|
22
|
-
import { EmailProperties, SupportEmailProperties } from '../entities-v2/Email';
|
|
22
|
+
import { EmailProperties, SupportEmailProperties, TransactionalEmailProperties } from '../entities-v2/Email';
|
|
23
|
+
import { CreateTransactionalEmailProperties } from '../actions-v2/CreateTransactionalEmailDto';
|
|
23
24
|
import { UpdateSupportEmailProperties } from '../actions-v2/UpdateSupportEmailDto';
|
|
24
25
|
import { UserRecord } from './UserRecord';
|
|
25
26
|
import { CaseRecord } from './CaseRecord';
|
|
26
27
|
import { ContactRecord } from './ContactRecord';
|
|
27
28
|
/** Valid entity types for Email */
|
|
28
|
-
export declare type EmailType = 'DEFAULT' | 'SUPPORT';
|
|
29
|
+
export declare type EmailType = 'DEFAULT' | 'SUPPORT' | 'TRANSACTIONAL';
|
|
29
30
|
export declare class EmailRecord<TProps = EmailProperties> {
|
|
30
31
|
private _record;
|
|
31
32
|
private _provider;
|
|
@@ -89,6 +90,22 @@ export declare class EmailRecord<TProps = EmailProperties> {
|
|
|
89
90
|
* @remarks Support
|
|
90
91
|
*/
|
|
91
92
|
isSupport(): this is EmailRecord<SupportEmailProperties>;
|
|
93
|
+
/**
|
|
94
|
+
* Type guard: check if this record is of type TRANSACTIONAL
|
|
95
|
+
*
|
|
96
|
+
* When this returns true, TypeScript automatically narrows the type,
|
|
97
|
+
* giving you access to TRANSACTIONAL-specific properties.
|
|
98
|
+
*
|
|
99
|
+
* @example
|
|
100
|
+
* ```typescript
|
|
101
|
+
* if (record.isTransactional()) {
|
|
102
|
+
* // TypeScript knows record.properties is TransactionalEmailProperties
|
|
103
|
+
* console.log(record.properties.SomeTypeSpecificField);
|
|
104
|
+
* }
|
|
105
|
+
* ```
|
|
106
|
+
* @remarks This type is used to create entities for transactional emails
|
|
107
|
+
*/
|
|
108
|
+
isTransactional(): this is EmailRecord<TransactionalEmailProperties>;
|
|
92
109
|
/** Valid labels for User associations */
|
|
93
110
|
static readonly usersLabels: readonly ["Email_User"];
|
|
94
111
|
/**
|
|
@@ -182,6 +199,36 @@ export declare class EmailRecord<TProps = EmailProperties> {
|
|
|
182
199
|
unlink(target: OdinRecord<any> | {
|
|
183
200
|
id: string;
|
|
184
201
|
} | string): Promise<void>;
|
|
202
|
+
/**
|
|
203
|
+
* CreateTransactionalEmail
|
|
204
|
+
*
|
|
205
|
+
* Creates a new Email record with the specified properties.
|
|
206
|
+
* Can be chained with .link() to create associations.
|
|
207
|
+
*
|
|
208
|
+
* @remarks Record type: TRANSACTIONAL
|
|
209
|
+
*
|
|
210
|
+
* @param properties - The properties for the new record
|
|
211
|
+
* @param options - Optional settings
|
|
212
|
+
* @param options.journeyId - Associate with a journey
|
|
213
|
+
* @param options.stageKey - Set initial pipeline stage
|
|
214
|
+
* @returns The created record(s)
|
|
215
|
+
*
|
|
216
|
+
* @example
|
|
217
|
+
* ```typescript
|
|
218
|
+
* // Create with properties
|
|
219
|
+
* const record = odinClient.emails.new();
|
|
220
|
+
* await record.createTransactionalEmail({ ... });
|
|
221
|
+
*
|
|
222
|
+
* // Create with link to parent
|
|
223
|
+
* await odinClient.emails.new()
|
|
224
|
+
* .link({ id: parentId, entity: "Module:Entity" })
|
|
225
|
+
* .createTransactionalEmail({ ... });
|
|
226
|
+
* ```
|
|
227
|
+
*/
|
|
228
|
+
createTransactionalEmail(properties: CreateTransactionalEmailProperties, options?: {
|
|
229
|
+
journeyId?: string;
|
|
230
|
+
stageKey?: string;
|
|
231
|
+
}): Promise<IDbRecordCreateUpdateRes[]>;
|
|
185
232
|
/**
|
|
186
233
|
* Update Support Email
|
|
187
234
|
*
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
* await record.createEmail({ ... });
|
|
12
12
|
* ```
|
|
13
13
|
*
|
|
14
|
-
* Entity Types: DEFAULT, SUPPORT
|
|
14
|
+
* Entity Types: DEFAULT, SUPPORT, TRANSACTIONAL
|
|
15
15
|
*
|
|
16
16
|
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
17
17
|
*/
|
|
@@ -98,6 +98,22 @@ class EmailRecord {
|
|
|
98
98
|
* @remarks Support
|
|
99
99
|
*/
|
|
100
100
|
isSupport() { var _a; return ((_a = this._record) === null || _a === void 0 ? void 0 : _a.type) === 'SUPPORT'; }
|
|
101
|
+
/**
|
|
102
|
+
* Type guard: check if this record is of type TRANSACTIONAL
|
|
103
|
+
*
|
|
104
|
+
* When this returns true, TypeScript automatically narrows the type,
|
|
105
|
+
* giving you access to TRANSACTIONAL-specific properties.
|
|
106
|
+
*
|
|
107
|
+
* @example
|
|
108
|
+
* ```typescript
|
|
109
|
+
* if (record.isTransactional()) {
|
|
110
|
+
* // TypeScript knows record.properties is TransactionalEmailProperties
|
|
111
|
+
* console.log(record.properties.SomeTypeSpecificField);
|
|
112
|
+
* }
|
|
113
|
+
* ```
|
|
114
|
+
* @remarks This type is used to create entities for transactional emails
|
|
115
|
+
*/
|
|
116
|
+
isTransactional() { var _a; return ((_a = this._record) === null || _a === void 0 ? void 0 : _a.type) === 'TRANSACTIONAL'; }
|
|
101
117
|
/**
|
|
102
118
|
* Access linked User records
|
|
103
119
|
* @remarks Available labels: Email_User
|
|
@@ -254,6 +270,50 @@ class EmailRecord {
|
|
|
254
270
|
});
|
|
255
271
|
}
|
|
256
272
|
// ============================================
|
|
273
|
+
// CREATE ACTIONS (no existing record required)
|
|
274
|
+
// ============================================
|
|
275
|
+
/**
|
|
276
|
+
* CreateTransactionalEmail
|
|
277
|
+
*
|
|
278
|
+
* Creates a new Email record with the specified properties.
|
|
279
|
+
* Can be chained with .link() to create associations.
|
|
280
|
+
*
|
|
281
|
+
* @remarks Record type: TRANSACTIONAL
|
|
282
|
+
*
|
|
283
|
+
* @param properties - The properties for the new record
|
|
284
|
+
* @param options - Optional settings
|
|
285
|
+
* @param options.journeyId - Associate with a journey
|
|
286
|
+
* @param options.stageKey - Set initial pipeline stage
|
|
287
|
+
* @returns The created record(s)
|
|
288
|
+
*
|
|
289
|
+
* @example
|
|
290
|
+
* ```typescript
|
|
291
|
+
* // Create with properties
|
|
292
|
+
* const record = odinClient.emails.new();
|
|
293
|
+
* await record.createTransactionalEmail({ ... });
|
|
294
|
+
*
|
|
295
|
+
* // Create with link to parent
|
|
296
|
+
* await odinClient.emails.new()
|
|
297
|
+
* .link({ id: parentId, entity: "Module:Entity" })
|
|
298
|
+
* .createTransactionalEmail({ ... });
|
|
299
|
+
* ```
|
|
300
|
+
*/
|
|
301
|
+
createTransactionalEmail(properties, options) {
|
|
302
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
303
|
+
const result = yield this._provider._applyAction('NotificationModule', 'Email', {
|
|
304
|
+
entity: 'NotificationModule:Email',
|
|
305
|
+
type: 'TRANSACTIONAL',
|
|
306
|
+
actionName: 'CreateTransactionalEmail',
|
|
307
|
+
properties: properties || {},
|
|
308
|
+
associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined,
|
|
309
|
+
journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
|
|
310
|
+
stageKey: options === null || options === void 0 ? void 0 : options.stageKey,
|
|
311
|
+
});
|
|
312
|
+
this._pendingLinks = [];
|
|
313
|
+
return result;
|
|
314
|
+
});
|
|
315
|
+
}
|
|
316
|
+
// ============================================
|
|
257
317
|
// UPDATE ACTIONS (require existing record)
|
|
258
318
|
// ============================================
|
|
259
319
|
/**
|
|
@@ -83,6 +83,7 @@ export { VoiceConfigurationRecord, isVoiceConfigurationRecord } from './VoiceCon
|
|
|
83
83
|
export { SalesTerritoryRecord, isSalesTerritoryRecord } from './SalesTerritoryRecord';
|
|
84
84
|
export { TeamRecord, isTeamRecord } from './TeamRecord';
|
|
85
85
|
export { TimeSlotRecord, isTimeSlotRecord } from './TimeSlotRecord';
|
|
86
|
+
export { EmailRecord, isEmailRecord } from './EmailRecord';
|
|
86
87
|
export { WayleaveAuditRecord, isWayleaveAuditRecord } from './WayleaveAuditRecord';
|
|
87
88
|
export { WorkOrderStatusUpdateRecord, isWorkOrderStatusUpdateRecord } from './WorkOrderStatusUpdateRecord';
|
|
88
89
|
export { TwilioUserUpdateRecord, isTwilioUserUpdateRecord } from './TwilioUserUpdateRecord';
|
|
@@ -102,7 +103,6 @@ export { ScheduleSlotRecord, isScheduleSlotRecord } from './ScheduleSlotRecord';
|
|
|
102
103
|
export { CallLegRecord, isCallLegRecord } from './CallLegRecord';
|
|
103
104
|
export { CallRecord, isCallRecord } from './CallRecord';
|
|
104
105
|
export { ServiceRecord, isServiceRecord } from './ServiceRecord';
|
|
105
|
-
export { EmailRecord, isEmailRecord } from './EmailRecord';
|
|
106
106
|
export { UserRecord, isUserRecord } from './UserRecord';
|
|
107
107
|
export { VisitRecord, isVisitRecord } from './VisitRecord';
|
|
108
108
|
export { CustomerPhonePortingRecord, isCustomerPhonePortingRecord } from './CustomerPhonePortingRecord';
|
package/dist/records-v2/index.js
CHANGED
|
@@ -11,7 +11,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
11
11
|
exports.isOhInstallationAuditRecord = exports.OhInstallationAuditRecord = exports.isOhInProgressAuditRecord = exports.OhInProgressAuditRecord = exports.isOhAuditOfInstallationRecord = exports.OhAuditOfInstallationRecord = exports.isUgRetroAuditRecord = exports.UgRetroAuditRecord = exports.isUgInProgressAuditRecord = exports.UgInProgressAuditRecord = exports.isUgInstallationAuditRecord = exports.UgInstallationAuditRecord = exports.isUgAuditOfInstallationRecord = exports.UgAuditOfInstallationRecord = exports.isOntReplacementApprovalRecord = exports.OntReplacementApprovalRecord = exports.isAccountRecord = exports.AccountRecord = exports.isPermissionToFailRecord = exports.PermissionToFailRecord = exports.isTransactionRecord = exports.TransactionRecord = exports.isPaymentRecord = exports.PaymentRecord = exports.isPICRequestRecord = exports.PICRequestRecord = exports.isChangeReasonRecord = exports.ChangeReasonRecord = exports.isChurnRequestRecord = exports.ChurnRequestRecord = exports.isBillingRequestRecord = exports.BillingRequestRecord = exports.isBillingAdjustmentRecord = exports.BillingAdjustmentRecord = exports.isServiceAppointmentConfigRecord = exports.ServiceAppointmentConfigRecord = exports.isCrmDatasetRecord = exports.CrmDatasetRecord = exports.isNoteRecord = exports.NoteRecord = exports.isCaseRecord = exports.CaseRecord = exports.isContractBuyOutRecord = exports.ContractBuyOutRecord = exports.isAddressRecord = exports.AddressRecord = exports.isWorkOrderRecord = exports.WorkOrderRecord = exports.isOrderRecord = exports.OrderRecord = void 0;
|
|
12
12
|
exports.isFieldServiceProductRecord = exports.FieldServiceProductRecord = exports.isFieldServiceDispatchedProductRecord = exports.FieldServiceDispatchedProductRecord = exports.isEmailTemplateRecord = exports.EmailTemplateRecord = exports.isCustomerDeviceRouterRecord = exports.CustomerDeviceRouterRecord = exports.isCustomerDeviceOntRecord = exports.CustomerDeviceOntRecord = exports.isConfigRecord = exports.ConfigRecord = exports.isRewardRecord = exports.RewardRecord = exports.isContactRecord = exports.ContactRecord = exports.isMessageRecord = exports.MessageRecord = exports.isConversationRecord = exports.ConversationRecord = exports.isProductRecord = exports.ProductRecord = exports.isPgFileAllocationRecord = exports.PgFileAllocationRecord = exports.isAppointmentRecord = exports.AppointmentRecord = exports.isAffiliateCodeRecord = exports.AffiliateCodeRecord = exports.isActivityLogRecord = exports.ActivityLogRecord = exports.isServiceVisitAuditRecord = exports.ServiceVisitAuditRecord = exports.isYfFieldServiceVisitRecord = exports.YfFieldServiceVisitRecord = exports.isRemediationOutcomeFormRecord = exports.RemediationOutcomeFormRecord = exports.isOhExternalAuditRecord = exports.OhExternalAuditRecord = exports.isUgExternalAuditRecord = exports.UgExternalAuditRecord = exports.isPaymentMethodRefundRecord = exports.PaymentMethodRefundRecord = exports.isInternalInstallAuditRecord = exports.InternalInstallAuditRecord = exports.isSweeperMaintenanceAuditRecord = exports.SweeperMaintenanceAuditRecord = exports.isBlockageA55Record = exports.BlockageA55Record = exports.isOhRetroAuditRecord = exports.OhRetroAuditRecord = void 0;
|
|
13
13
|
exports.isSalesTerritoryRecord = exports.SalesTerritoryRecord = exports.isVoiceConfigurationRecord = exports.VoiceConfigurationRecord = exports.isOrderItemRecord = exports.OrderItemRecord = exports.isPushNotificationRecord = exports.PushNotificationRecord = exports.isPgWebhookRecord = exports.PgWebhookRecord = exports.isPgWebhookAttemptRecord = exports.PgWebhookAttemptRecord = exports.isPgAccountValidationRecord = exports.PgAccountValidationRecord = exports.isPgTransactionRecord = exports.PgTransactionRecord = exports.isPgSortCodeSubstitutionRecord = exports.PgSortCodeSubstitutionRecord = exports.isPgVocalinkRecord = exports.PgVocalinkRecord = exports.isPgDirectDebitFileRecord = exports.PgDirectDebitFileRecord = exports.isPgPaymentMethodRecord = exports.PgPaymentMethodRecord = exports.isPgLogRecord = exports.PgLogRecord = exports.isPgDisputeRecord = exports.PgDisputeRecord = exports.isPgContactRecord = exports.PgContactRecord = exports.isPaymentMethodRecord = exports.PaymentMethodRecord = exports.isReferralRecord = exports.ReferralRecord = exports.isOrderCheckRecord = exports.OrderCheckRecord = exports.isCampaignRecord = exports.CampaignRecord = exports.isOneTouchSwitchRecord = exports.OneTouchSwitchRecord = exports.isReturnsRecord = exports.ReturnsRecord = exports.isNetworkDeviceRecord = exports.NetworkDeviceRecord = exports.isLeadRecord = exports.LeadRecord = exports.isImpersonationTrackerRecord = exports.ImpersonationTrackerRecord = exports.isActivityRecord = exports.ActivityRecord = void 0;
|
|
14
|
-
exports.isCustomerPhonePortingRecord = exports.CustomerPhonePortingRecord = exports.isVisitRecord = exports.VisitRecord = exports.isUserRecord = exports.UserRecord = exports.
|
|
14
|
+
exports.isCustomerPhonePortingRecord = exports.CustomerPhonePortingRecord = exports.isVisitRecord = exports.VisitRecord = exports.isUserRecord = exports.UserRecord = exports.isServiceRecord = exports.ServiceRecord = exports.isCallRecord = exports.CallRecord = exports.isCallLegRecord = exports.CallLegRecord = exports.isScheduleSlotRecord = exports.ScheduleSlotRecord = exports.isPriceBookRecord = exports.PriceBookRecord = exports.isOverlayRealA55Record = exports.OverlayRealA55Record = exports.isOfferRecord = exports.OfferRecord = exports.isServiceAppointmentRecord = exports.ServiceAppointmentRecord = exports.isOutageRecord = exports.OutageRecord = exports.isSiteSpecificRiskAssessmentOutcomeFormRecord = exports.SiteSpecificRiskAssessmentOutcomeFormRecord = exports.isRemediationRequiredReasonRecord = exports.RemediationRequiredReasonRecord = exports.isKnowledgeArticleRecord = exports.KnowledgeArticleRecord = exports.isInvoiceRecord = exports.InvoiceRecord = exports.isDiscountRecord = exports.DiscountRecord = exports.isCustomerDeviceAtaRecord = exports.CustomerDeviceAtaRecord = exports.isCreditNoteRecord = exports.CreditNoteRecord = exports.isTwilioUserUpdateRecord = exports.TwilioUserUpdateRecord = exports.isWorkOrderStatusUpdateRecord = exports.WorkOrderStatusUpdateRecord = exports.isWayleaveAuditRecord = exports.WayleaveAuditRecord = exports.isEmailRecord = exports.EmailRecord = exports.isTimeSlotRecord = exports.TimeSlotRecord = exports.isTeamRecord = exports.TeamRecord = void 0;
|
|
15
15
|
var OrderRecord_1 = require("./OrderRecord");
|
|
16
16
|
Object.defineProperty(exports, "OrderRecord", { enumerable: true, get: function () { return OrderRecord_1.OrderRecord; } });
|
|
17
17
|
Object.defineProperty(exports, "isOrderRecord", { enumerable: true, get: function () { return OrderRecord_1.isOrderRecord; } });
|
|
@@ -243,6 +243,9 @@ Object.defineProperty(exports, "isTeamRecord", { enumerable: true, get: function
|
|
|
243
243
|
var TimeSlotRecord_1 = require("./TimeSlotRecord");
|
|
244
244
|
Object.defineProperty(exports, "TimeSlotRecord", { enumerable: true, get: function () { return TimeSlotRecord_1.TimeSlotRecord; } });
|
|
245
245
|
Object.defineProperty(exports, "isTimeSlotRecord", { enumerable: true, get: function () { return TimeSlotRecord_1.isTimeSlotRecord; } });
|
|
246
|
+
var EmailRecord_1 = require("./EmailRecord");
|
|
247
|
+
Object.defineProperty(exports, "EmailRecord", { enumerable: true, get: function () { return EmailRecord_1.EmailRecord; } });
|
|
248
|
+
Object.defineProperty(exports, "isEmailRecord", { enumerable: true, get: function () { return EmailRecord_1.isEmailRecord; } });
|
|
246
249
|
var WayleaveAuditRecord_1 = require("./WayleaveAuditRecord");
|
|
247
250
|
Object.defineProperty(exports, "WayleaveAuditRecord", { enumerable: true, get: function () { return WayleaveAuditRecord_1.WayleaveAuditRecord; } });
|
|
248
251
|
Object.defineProperty(exports, "isWayleaveAuditRecord", { enumerable: true, get: function () { return WayleaveAuditRecord_1.isWayleaveAuditRecord; } });
|
|
@@ -300,9 +303,6 @@ Object.defineProperty(exports, "isCallRecord", { enumerable: true, get: function
|
|
|
300
303
|
var ServiceRecord_1 = require("./ServiceRecord");
|
|
301
304
|
Object.defineProperty(exports, "ServiceRecord", { enumerable: true, get: function () { return ServiceRecord_1.ServiceRecord; } });
|
|
302
305
|
Object.defineProperty(exports, "isServiceRecord", { enumerable: true, get: function () { return ServiceRecord_1.isServiceRecord; } });
|
|
303
|
-
var EmailRecord_1 = require("./EmailRecord");
|
|
304
|
-
Object.defineProperty(exports, "EmailRecord", { enumerable: true, get: function () { return EmailRecord_1.EmailRecord; } });
|
|
305
|
-
Object.defineProperty(exports, "isEmailRecord", { enumerable: true, get: function () { return EmailRecord_1.isEmailRecord; } });
|
|
306
306
|
var UserRecord_1 = require("./UserRecord");
|
|
307
307
|
Object.defineProperty(exports, "UserRecord", { enumerable: true, get: function () { return UserRecord_1.UserRecord; } });
|
|
308
308
|
Object.defineProperty(exports, "isUserRecord", { enumerable: true, get: function () { return UserRecord_1.isUserRecord; } });
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@d19n/youfibre-odin-sdk",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.304",
|
|
4
4
|
"description": "",
|
|
5
5
|
"author": "@d19n",
|
|
6
6
|
"license": "UNLICENSED",
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
"typescript": "4.8.4"
|
|
12
12
|
},
|
|
13
13
|
"dependencies": {
|
|
14
|
-
"@d19n/odin-sdk-generator": "^3.0.
|
|
14
|
+
"@d19n/odin-sdk-generator": "^3.0.206",
|
|
15
15
|
"@d19n/odin-types": "^3.0.22",
|
|
16
16
|
"@d19n/youfibre-odin-sdk": "^1.0.219"
|
|
17
17
|
},
|