@d19n/youfibre-odin-sdk 2.0.8 → 2.0.10-beta.0
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 -2
- package/dist/actions-v2/SendOrderReferralRefereePendingEmailDto.d.ts +128 -0
- package/dist/actions-v2/SendOrderReferralRefereePendingEmailDto.js +59 -0
- package/dist/api-sdk-v2/EmailApi.d.ts +2 -0
- package/dist/api-sdk-v2/EmailApi.js +6 -0
- package/dist/api-sdk-v2/ReferralApi.d.ts +2 -0
- package/dist/api-sdk-v2/ReferralApi.js +6 -0
- package/dist/db-sdk-v2/EmailDb.d.ts +2 -0
- package/dist/db-sdk-v2/EmailDb.js +6 -0
- package/dist/db-sdk-v2/ReferralDb.d.ts +2 -0
- package/dist/db-sdk-v2/ReferralDb.js +6 -0
- package/dist/entities-v2/Email.d.ts +170 -0
- package/dist/entities-v2/Email.js +11 -1
- package/dist/entities-v2/Product.d.ts +42 -0
- package/dist/entities-v2/Product.js +2 -0
- package/dist/entities-v2/Referral.d.ts +7 -0
- package/dist/entities-v2/Referral.js +5 -1
- package/dist/entities-v2/Visit.d.ts +163 -163
- package/dist/entities-v2/Visit.js +110 -110
- package/dist/records-v2/EmailRecord.d.ts +68 -3
- package/dist/records-v2/EmailRecord.js +86 -1
- package/dist/records-v2/ReferralRecord.d.ts +20 -0
- package/dist/records-v2/ReferralRecord.js +33 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -269,7 +269,7 @@ This SDK includes **164** entities across **12** modules.
|
|
|
269
269
|
| **Conversation** | Conversation Entity Definition | DEFAULT |
|
|
270
270
|
| **ConversationFeedback** | ConversationFeedback Entity Definition | DEFAULT |
|
|
271
271
|
| **CustomerDeviceConfiguration** | CustomerDeviceConfiguration Entity Definition | DEFAULT |
|
|
272
|
-
| **Email** | Email Entity Definition | SUPPORT, TRANSACTIONAL |
|
|
272
|
+
| **Email** | Email Entity Definition | REFERRAL, SUPPORT, TRANSACTIONAL |
|
|
273
273
|
| **EmailSender** | EmailSender Entity Definition | DEFAULT |
|
|
274
274
|
| **EmailTemplate** | EmailTemplate Entity Definition | DEFAULT |
|
|
275
275
|
| **Message** | Message Entity Definition | EVENT |
|
|
@@ -352,7 +352,7 @@ This SDK includes **164** entities across **12** modules.
|
|
|
352
352
|
|
|
353
353
|
## Actions
|
|
354
354
|
|
|
355
|
-
This SDK includes **
|
|
355
|
+
This SDK includes **560** actions.
|
|
356
356
|
|
|
357
357
|
### Action Types
|
|
358
358
|
|
|
@@ -1618,6 +1618,7 @@ This SDK includes **559** actions.
|
|
|
1618
1618
|
| Action | Type | Event |
|
|
1619
1619
|
|--------|------|-------|
|
|
1620
1620
|
| `CreateTransactionalEmail` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateTransactionalEmail |
|
|
1621
|
+
| `SendOrderReferralRefereePendingEmail` | CREATE | k1.t-t-hEOJjsDb.NotificationModule.Email.Create.SendOrderReferralRefereePendingEmail |
|
|
1621
1622
|
| `SendTlosNinjaCaseEmail` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.SendTlosNinjaCaseEmail |
|
|
1622
1623
|
| `UpdateEmail` | UPDATE | k1.t-hEOJjsDb.NotificationModule.Email.Update.UpdateEmail |
|
|
1623
1624
|
| `UpdateSupportEmail` | UPDATE | k1.t-hEOJjsDb.NotificationModule.Email.Update.UpdateSupportEmail |
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* SendOrderReferralRefereePendingEmail Action DTO
|
|
3
|
+
*
|
|
4
|
+
* Order Referral Referee Pending
|
|
5
|
+
*
|
|
6
|
+
* @module NotificationModule
|
|
7
|
+
* @entity Email
|
|
8
|
+
* @entityType REFERRAL
|
|
9
|
+
* @actionKey SendOrderReferralRefereePendingEmail
|
|
10
|
+
* @event k1.t-t-hEOJjsDb.NotificationModule.Email.Create.SendOrderReferralRefereePendingEmail
|
|
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 SendOrderReferralRefereePendingEmail created events
|
|
17
|
+
*
|
|
18
|
+
* @event k1.t-t-hEOJjsDb.NotificationModule.Email.Create.SendOrderReferralRefereePendingEmail
|
|
19
|
+
*/
|
|
20
|
+
export interface SendOrderReferralRefereePendingEmailMessage extends OdinRecordCreatedEvent<SendOrderReferralRefereePendingEmailDto, SendOrderReferralRefereePendingEmailProperties> {
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Properties for SendOrderReferralRefereePendingEmail action
|
|
24
|
+
*
|
|
25
|
+
* @property Required fields: 0
|
|
26
|
+
* @property Optional fields: 9
|
|
27
|
+
*/
|
|
28
|
+
export interface SendOrderReferralRefereePendingEmailProperties {
|
|
29
|
+
/**
|
|
30
|
+
* TemplateLabel
|
|
31
|
+
*
|
|
32
|
+
* The template label from email templates engine
|
|
33
|
+
* @type {TEXT}
|
|
34
|
+
*/
|
|
35
|
+
TemplateLabel?: string | null;
|
|
36
|
+
/**
|
|
37
|
+
* DynamicData
|
|
38
|
+
*
|
|
39
|
+
* Data will pass to emailing service (variables)
|
|
40
|
+
* @type {JSON}
|
|
41
|
+
*/
|
|
42
|
+
DynamicData?: string | null;
|
|
43
|
+
/**
|
|
44
|
+
* ContactId
|
|
45
|
+
*
|
|
46
|
+
* The related Contact to send the email
|
|
47
|
+
* @type {LOOKUP}
|
|
48
|
+
*/
|
|
49
|
+
ContactId?: string | null;
|
|
50
|
+
/**
|
|
51
|
+
* To
|
|
52
|
+
*
|
|
53
|
+
* Data field for Email records. Used by Communications team.
|
|
54
|
+
* @type {TEXT}
|
|
55
|
+
*/
|
|
56
|
+
To?: string | null;
|
|
57
|
+
/**
|
|
58
|
+
* Subject
|
|
59
|
+
*
|
|
60
|
+
* Data field for Email records. Used by Communications team.
|
|
61
|
+
* @type {TEXT}
|
|
62
|
+
*/
|
|
63
|
+
Subject?: string | null;
|
|
64
|
+
/**
|
|
65
|
+
* MessageId
|
|
66
|
+
*
|
|
67
|
+
* SMTP Message Id (Communications - Email)
|
|
68
|
+
* @type {TEXT}
|
|
69
|
+
*/
|
|
70
|
+
MessageId?: string | null;
|
|
71
|
+
/**
|
|
72
|
+
* Email Sender
|
|
73
|
+
*
|
|
74
|
+
* The Email Sender related entity
|
|
75
|
+
* @type {LOOKUP}
|
|
76
|
+
*/
|
|
77
|
+
EmailSenderId?: string | null;
|
|
78
|
+
/**
|
|
79
|
+
* Date
|
|
80
|
+
*
|
|
81
|
+
* Date field for Email records. Used by Communications team.
|
|
82
|
+
* @type {DATE_TIME}
|
|
83
|
+
*/
|
|
84
|
+
Date?: string | null;
|
|
85
|
+
/**
|
|
86
|
+
* Referral Id
|
|
87
|
+
*
|
|
88
|
+
* Reference to referral
|
|
89
|
+
* @type {LOOKUP}
|
|
90
|
+
*/
|
|
91
|
+
ReferralId?: string | null;
|
|
92
|
+
}
|
|
93
|
+
/**
|
|
94
|
+
* SendOrderReferralRefereePendingEmail
|
|
95
|
+
*
|
|
96
|
+
* Order Referral Referee Pending
|
|
97
|
+
*
|
|
98
|
+
* @actionType CREATE - Creates a new Email record
|
|
99
|
+
* @module NotificationModule
|
|
100
|
+
* @entity Email
|
|
101
|
+
* @entityType REFERRAL (REFERRAL)
|
|
102
|
+
* @event k1.t-t-hEOJjsDb.NotificationModule.Email.Create.SendOrderReferralRefereePendingEmail
|
|
103
|
+
* @permission schema.action.sendorderreferralrefereependingemail.trigger
|
|
104
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
105
|
+
*/
|
|
106
|
+
export declare class SendOrderReferralRefereePendingEmailDto extends OdinRecordCreateDto<SendOrderReferralRefereePendingEmailProperties> {
|
|
107
|
+
/** Used by SDK generators to identify action type */
|
|
108
|
+
static readonly ACTION_TYPE = "CREATE";
|
|
109
|
+
static readonly ACTION_KEY = "SendOrderReferralRefereePendingEmail";
|
|
110
|
+
static readonly MODULE_NAME = "NotificationModule";
|
|
111
|
+
static readonly ENTITIES: string[];
|
|
112
|
+
static readonly ENTITY_TYPE = "REFERRAL";
|
|
113
|
+
static readonly EVENT_NAME = "k1.t-t-hEOJjsDb.NotificationModule.Email.Create.SendOrderReferralRefereePendingEmail";
|
|
114
|
+
static readonly PERMISSION = "schema.action.sendorderreferralrefereependingemail.trigger";
|
|
115
|
+
/** Step metadata - entity this action targets */
|
|
116
|
+
static readonly STEP_ENTITY = "NotificationModule:Email";
|
|
117
|
+
static readonly STEP_SCHEMA_ID = "a3b4d6b7-0647-4202-90a6-036e3c87c5ae";
|
|
118
|
+
static readonly STEP_SCHEMA_ACTION_ID = "a103026a-b665-4927-9eea-c1a222f1a4dd";
|
|
119
|
+
static readonly STEP_SCHEMA_TYPE_ID = "d9d0bf79-8d32-4f71-a6d7-3ce74dd5ba16";
|
|
120
|
+
static readonly STEP_TYPE = "REFERRAL";
|
|
121
|
+
static readonly AUTO_LINK_PARENT = true;
|
|
122
|
+
readonly actionName: string;
|
|
123
|
+
readonly schemaActionId: string;
|
|
124
|
+
readonly entity: string;
|
|
125
|
+
constructor(properties: SendOrderReferralRefereePendingEmailProperties, options?: {
|
|
126
|
+
journeyId?: string;
|
|
127
|
+
});
|
|
128
|
+
}
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* SendOrderReferralRefereePendingEmail Action DTO
|
|
4
|
+
*
|
|
5
|
+
* Order Referral Referee Pending
|
|
6
|
+
*
|
|
7
|
+
* @module NotificationModule
|
|
8
|
+
* @entity Email
|
|
9
|
+
* @entityType REFERRAL
|
|
10
|
+
* @actionKey SendOrderReferralRefereePendingEmail
|
|
11
|
+
* @event k1.t-t-hEOJjsDb.NotificationModule.Email.Create.SendOrderReferralRefereePendingEmail
|
|
12
|
+
*
|
|
13
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.SendOrderReferralRefereePendingEmailDto = void 0;
|
|
17
|
+
const core_1 = require("@d19n/odin-types/dist/core");
|
|
18
|
+
/**
|
|
19
|
+
* SendOrderReferralRefereePendingEmail
|
|
20
|
+
*
|
|
21
|
+
* Order Referral Referee Pending
|
|
22
|
+
*
|
|
23
|
+
* @actionType CREATE - Creates a new Email record
|
|
24
|
+
* @module NotificationModule
|
|
25
|
+
* @entity Email
|
|
26
|
+
* @entityType REFERRAL (REFERRAL)
|
|
27
|
+
* @event k1.t-t-hEOJjsDb.NotificationModule.Email.Create.SendOrderReferralRefereePendingEmail
|
|
28
|
+
* @permission schema.action.sendorderreferralrefereependingemail.trigger
|
|
29
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
30
|
+
*/
|
|
31
|
+
class SendOrderReferralRefereePendingEmailDto extends core_1.OdinRecordCreateDto {
|
|
32
|
+
constructor(properties, options) {
|
|
33
|
+
super({
|
|
34
|
+
entity: 'NotificationModule:Email',
|
|
35
|
+
type: 'REFERRAL',
|
|
36
|
+
properties,
|
|
37
|
+
journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
|
|
38
|
+
});
|
|
39
|
+
this.actionName = 'SendOrderReferralRefereePendingEmail';
|
|
40
|
+
this.schemaActionId = 'a103026a-b665-4927-9eea-c1a222f1a4dd';
|
|
41
|
+
this.entity = 'NotificationModule:Email';
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
exports.SendOrderReferralRefereePendingEmailDto = SendOrderReferralRefereePendingEmailDto;
|
|
45
|
+
/** Used by SDK generators to identify action type */
|
|
46
|
+
SendOrderReferralRefereePendingEmailDto.ACTION_TYPE = 'CREATE';
|
|
47
|
+
SendOrderReferralRefereePendingEmailDto.ACTION_KEY = 'SendOrderReferralRefereePendingEmail';
|
|
48
|
+
SendOrderReferralRefereePendingEmailDto.MODULE_NAME = 'NotificationModule';
|
|
49
|
+
SendOrderReferralRefereePendingEmailDto.ENTITIES = ['Email'];
|
|
50
|
+
SendOrderReferralRefereePendingEmailDto.ENTITY_TYPE = 'REFERRAL';
|
|
51
|
+
SendOrderReferralRefereePendingEmailDto.EVENT_NAME = 'k1.t-t-hEOJjsDb.NotificationModule.Email.Create.SendOrderReferralRefereePendingEmail';
|
|
52
|
+
SendOrderReferralRefereePendingEmailDto.PERMISSION = 'schema.action.sendorderreferralrefereependingemail.trigger';
|
|
53
|
+
/** Step metadata - entity this action targets */
|
|
54
|
+
SendOrderReferralRefereePendingEmailDto.STEP_ENTITY = 'NotificationModule:Email';
|
|
55
|
+
SendOrderReferralRefereePendingEmailDto.STEP_SCHEMA_ID = 'a3b4d6b7-0647-4202-90a6-036e3c87c5ae';
|
|
56
|
+
SendOrderReferralRefereePendingEmailDto.STEP_SCHEMA_ACTION_ID = 'a103026a-b665-4927-9eea-c1a222f1a4dd';
|
|
57
|
+
SendOrderReferralRefereePendingEmailDto.STEP_SCHEMA_TYPE_ID = 'd9d0bf79-8d32-4f71-a6d7-3ce74dd5ba16';
|
|
58
|
+
SendOrderReferralRefereePendingEmailDto.STEP_TYPE = 'REFERRAL';
|
|
59
|
+
SendOrderReferralRefereePendingEmailDto.AUTO_LINK_PARENT = true;
|
|
@@ -24,6 +24,7 @@ export declare class EmailApi extends ApiProvider {
|
|
|
24
24
|
private _contact?;
|
|
25
25
|
private _emailsender?;
|
|
26
26
|
private _workorder?;
|
|
27
|
+
private _referral?;
|
|
27
28
|
constructor(authParams?: OauthParams, authToken?: string);
|
|
28
29
|
get user(): ApiRecordLinkManager;
|
|
29
30
|
get email(): ApiRecordLinkManager;
|
|
@@ -32,6 +33,7 @@ export declare class EmailApi extends ApiProvider {
|
|
|
32
33
|
get contact(): ApiRecordLinkManager;
|
|
33
34
|
get emailsender(): ApiRecordLinkManager;
|
|
34
35
|
get workorder(): ApiRecordLinkManager;
|
|
36
|
+
get referral(): ApiRecordLinkManager;
|
|
35
37
|
setRecord(sourceRecord: any): void;
|
|
36
38
|
schema(): Promise<import("@d19n/odin-types/dist/core").OdinSchema>;
|
|
37
39
|
search(params: Partial<OdinSearchV2>): Promise<import("@d19n/odin-sdk-generator/dist/odin-sdk-types").OdinSearchResponse<import("@d19n/odin-types/dist/core").OdinRecord<EmailProperties>>>;
|
|
@@ -75,6 +75,12 @@ class EmailApi extends api_provider_1.ApiProvider {
|
|
|
75
75
|
}
|
|
76
76
|
return this._workorder;
|
|
77
77
|
}
|
|
78
|
+
get referral() {
|
|
79
|
+
if (!this._referral) {
|
|
80
|
+
this._referral = new api_record_link_manager_1.ApiRecordLinkManager(this.authParams, 'NotificationModule:Email', 'CrmModule:Referral', 'Referral__Email');
|
|
81
|
+
}
|
|
82
|
+
return this._referral;
|
|
83
|
+
}
|
|
78
84
|
// ============================================
|
|
79
85
|
// STANDARD METHODS (Unchanged API)
|
|
80
86
|
// ============================================
|
|
@@ -23,6 +23,7 @@ export declare class ReferralApi extends ApiProvider {
|
|
|
23
23
|
private _campaign?;
|
|
24
24
|
private _order?;
|
|
25
25
|
private _reward?;
|
|
26
|
+
private _email?;
|
|
26
27
|
constructor(authParams?: OauthParams, authToken?: string);
|
|
27
28
|
get referrerreferrals(): ApiRecordLinkManager;
|
|
28
29
|
get refereereferrals(): ApiRecordLinkManager;
|
|
@@ -30,6 +31,7 @@ export declare class ReferralApi extends ApiProvider {
|
|
|
30
31
|
get campaign(): ApiRecordLinkManager;
|
|
31
32
|
get order(): ApiRecordLinkManager;
|
|
32
33
|
get reward(): ApiRecordLinkManager;
|
|
34
|
+
get email(): ApiRecordLinkManager;
|
|
33
35
|
setRecord(sourceRecord: any): void;
|
|
34
36
|
schema(): Promise<import("@d19n/odin-types/dist/core").OdinSchema>;
|
|
35
37
|
search(params: Partial<OdinSearchV2>): Promise<import("@d19n/odin-sdk-generator/dist/odin-sdk-types").OdinSearchResponse<import("@d19n/odin-types/dist/core").OdinRecord<ReferralProperties>>>;
|
|
@@ -69,6 +69,12 @@ class ReferralApi extends api_provider_1.ApiProvider {
|
|
|
69
69
|
}
|
|
70
70
|
return this._reward;
|
|
71
71
|
}
|
|
72
|
+
get email() {
|
|
73
|
+
if (!this._email) {
|
|
74
|
+
this._email = new api_record_link_manager_1.ApiRecordLinkManager(this.authParams, 'CrmModule:Referral', 'NotificationModule:Email', 'Referral__Email');
|
|
75
|
+
}
|
|
76
|
+
return this._email;
|
|
77
|
+
}
|
|
72
78
|
// ============================================
|
|
73
79
|
// STANDARD METHODS (Unchanged API)
|
|
74
80
|
// ============================================
|
|
@@ -28,6 +28,7 @@ export declare class EmailDb extends DbProvider {
|
|
|
28
28
|
private _contact?;
|
|
29
29
|
private _emailsender?;
|
|
30
30
|
private _workorder?;
|
|
31
|
+
private _referral?;
|
|
31
32
|
constructor(principal: any, dbService: any, defaultOptions?: DbProviderOptions);
|
|
32
33
|
get user(): DbRecordLinkManager;
|
|
33
34
|
get email(): DbRecordLinkManager;
|
|
@@ -36,6 +37,7 @@ export declare class EmailDb extends DbProvider {
|
|
|
36
37
|
get contact(): DbRecordLinkManager;
|
|
37
38
|
get emailsender(): DbRecordLinkManager;
|
|
38
39
|
get workorder(): DbRecordLinkManager;
|
|
40
|
+
get referral(): DbRecordLinkManager;
|
|
39
41
|
setRecord(sourceRecord: any): void;
|
|
40
42
|
/**
|
|
41
43
|
* Search records with manual pagination control
|
|
@@ -80,6 +80,12 @@ class EmailDb extends db_provider_1.DbProvider {
|
|
|
80
80
|
}
|
|
81
81
|
return this._workorder;
|
|
82
82
|
}
|
|
83
|
+
get referral() {
|
|
84
|
+
if (!this._referral) {
|
|
85
|
+
this._referral = new db_record_link_manager_1.DbRecordLinkManager(this.principal, this.dbService, 'NotificationModule:Email', 'CrmModule:Referral', 'Referral__Email');
|
|
86
|
+
}
|
|
87
|
+
return this._referral;
|
|
88
|
+
}
|
|
83
89
|
// ============================================
|
|
84
90
|
// STANDARD METHODS
|
|
85
91
|
// ============================================
|
|
@@ -27,6 +27,7 @@ export declare class ReferralDb extends DbProvider {
|
|
|
27
27
|
private _campaign?;
|
|
28
28
|
private _order?;
|
|
29
29
|
private _reward?;
|
|
30
|
+
private _email?;
|
|
30
31
|
constructor(principal: any, dbService: any, defaultOptions?: DbProviderOptions);
|
|
31
32
|
get referrerreferrals(): DbRecordLinkManager;
|
|
32
33
|
get refereereferrals(): DbRecordLinkManager;
|
|
@@ -34,6 +35,7 @@ export declare class ReferralDb extends DbProvider {
|
|
|
34
35
|
get campaign(): DbRecordLinkManager;
|
|
35
36
|
get order(): DbRecordLinkManager;
|
|
36
37
|
get reward(): DbRecordLinkManager;
|
|
38
|
+
get email(): DbRecordLinkManager;
|
|
37
39
|
setRecord(sourceRecord: any): void;
|
|
38
40
|
/**
|
|
39
41
|
* Search records with manual pagination control
|
|
@@ -74,6 +74,12 @@ class ReferralDb extends db_provider_1.DbProvider {
|
|
|
74
74
|
}
|
|
75
75
|
return this._reward;
|
|
76
76
|
}
|
|
77
|
+
get email() {
|
|
78
|
+
if (!this._email) {
|
|
79
|
+
this._email = new db_record_link_manager_1.DbRecordLinkManager(this.principal, this.dbService, 'CrmModule:Referral', 'NotificationModule:Email', 'Referral__Email');
|
|
80
|
+
}
|
|
81
|
+
return this._email;
|
|
82
|
+
}
|
|
77
83
|
// ============================================
|
|
78
84
|
// STANDARD METHODS
|
|
79
85
|
// ============================================
|
|
@@ -17,12 +17,15 @@ import { CaseProperties } from './Case';
|
|
|
17
17
|
import { ContactProperties } from './Contact';
|
|
18
18
|
import { EmailSenderProperties } from './EmailSender';
|
|
19
19
|
import { WorkOrderProperties } from './WorkOrder';
|
|
20
|
+
import { ReferralProperties } from './Referral';
|
|
20
21
|
/**
|
|
21
22
|
* Available types for Email records
|
|
22
23
|
*/
|
|
23
24
|
export declare enum EmailEntityTypes {
|
|
24
25
|
/** This is the default record type */
|
|
25
26
|
DEFAULT = "DEFAULT",
|
|
27
|
+
/** Sending emails in the referral system */
|
|
28
|
+
REFERRAL = "REFERRAL",
|
|
26
29
|
/** Support */
|
|
27
30
|
SUPPORT = "SUPPORT",
|
|
28
31
|
/** This type is used to create entities for transactional emails */
|
|
@@ -114,6 +117,8 @@ export declare enum EmailPropertyKeys {
|
|
|
114
117
|
Bcc = "Bcc",
|
|
115
118
|
/** Date field for Email records. Used by Communications team. */
|
|
116
119
|
Date = "Date",
|
|
120
|
+
/** Reference to referral */
|
|
121
|
+
ReferralId = "ReferralId",
|
|
117
122
|
/** Sender Type (Communications - Email) */
|
|
118
123
|
SenderType = "SenderType",
|
|
119
124
|
/** Data field for Email records. Used by Communications team. */
|
|
@@ -219,6 +224,153 @@ export interface EmailProperties {
|
|
|
219
224
|
* @type {DATE_TIME}
|
|
220
225
|
*/
|
|
221
226
|
Date: string;
|
|
227
|
+
/** Reference to referral
|
|
228
|
+
*
|
|
229
|
+
* @type {LOOKUP}
|
|
230
|
+
*/
|
|
231
|
+
ReferralId: string;
|
|
232
|
+
/** Sender Type (Communications - Email)
|
|
233
|
+
*
|
|
234
|
+
* @type {ENUM}
|
|
235
|
+
* @default CUSTOMER
|
|
236
|
+
* @enum {EmailSenderType}
|
|
237
|
+
*/
|
|
238
|
+
SenderType: EmailSenderType;
|
|
239
|
+
/** Data field for Email records. Used by Communications team.
|
|
240
|
+
*
|
|
241
|
+
* @type {LOOKUP}
|
|
242
|
+
*/
|
|
243
|
+
Case: string;
|
|
244
|
+
/** Status of the email in the process
|
|
245
|
+
*
|
|
246
|
+
* @type {ENUM}
|
|
247
|
+
* @default CREATED
|
|
248
|
+
* @enum {EmailStatus}
|
|
249
|
+
*/
|
|
250
|
+
Status: EmailStatus;
|
|
251
|
+
/** Data will pass to emailing service (variables)
|
|
252
|
+
*
|
|
253
|
+
* @type {JSON}
|
|
254
|
+
*/
|
|
255
|
+
DynamicData: string;
|
|
256
|
+
/** The template label from email templates engine
|
|
257
|
+
*
|
|
258
|
+
* @type {TEXT}
|
|
259
|
+
*/
|
|
260
|
+
TemplateLabel: string;
|
|
261
|
+
/** The related Contact to send the email
|
|
262
|
+
*
|
|
263
|
+
* @type {LOOKUP}
|
|
264
|
+
*/
|
|
265
|
+
ContactId: string;
|
|
266
|
+
/** The provider we use to send email (eg. Sendgrid)
|
|
267
|
+
*
|
|
268
|
+
* @type {ENUM}
|
|
269
|
+
* @enum {EmailEmailingService}
|
|
270
|
+
*/
|
|
271
|
+
EmailingService: EmailEmailingService;
|
|
272
|
+
/** The Email Sender related entity
|
|
273
|
+
*
|
|
274
|
+
* @type {LOOKUP}
|
|
275
|
+
*/
|
|
276
|
+
EmailSenderId: string;
|
|
277
|
+
/** WorkOrder
|
|
278
|
+
*
|
|
279
|
+
* @type {LOOKUP}
|
|
280
|
+
*/
|
|
281
|
+
WorkOrder: string;
|
|
282
|
+
}
|
|
283
|
+
/**
|
|
284
|
+
* Properties for REFERRAL Email records
|
|
285
|
+
*
|
|
286
|
+
* @see NotificationModule:Email
|
|
287
|
+
*/
|
|
288
|
+
export interface ReferralEmailProperties {
|
|
289
|
+
/** Used for title
|
|
290
|
+
*
|
|
291
|
+
* @type {TEXT}
|
|
292
|
+
*/
|
|
293
|
+
Title: string;
|
|
294
|
+
/** Data field for Email records. Used by Communications team.
|
|
295
|
+
*
|
|
296
|
+
* @type {TEXT}
|
|
297
|
+
*/
|
|
298
|
+
Subject: string;
|
|
299
|
+
/** Formatted Message (Communications - Email)
|
|
300
|
+
*
|
|
301
|
+
* @type {HTML}
|
|
302
|
+
*/
|
|
303
|
+
FormattedMessage: string;
|
|
304
|
+
/** Carbon Copy (Communications - Email)
|
|
305
|
+
*
|
|
306
|
+
* @type {TEXT}
|
|
307
|
+
*/
|
|
308
|
+
Cc: string;
|
|
309
|
+
/** Data field for Email records. Used by Communications team.
|
|
310
|
+
*
|
|
311
|
+
* @type {TEXT}
|
|
312
|
+
*/
|
|
313
|
+
To: string;
|
|
314
|
+
/** In Reply To (Communications - Email)
|
|
315
|
+
*
|
|
316
|
+
* @type {TEXT}
|
|
317
|
+
*/
|
|
318
|
+
InReplyTo: string;
|
|
319
|
+
/** Data field for Email records. Used by Communications team.
|
|
320
|
+
*
|
|
321
|
+
* @type {JSON}
|
|
322
|
+
*/
|
|
323
|
+
Envelope: string;
|
|
324
|
+
/** When the email was created (Communications - Email)
|
|
325
|
+
*
|
|
326
|
+
* @type {DATE_TIME}
|
|
327
|
+
*/
|
|
328
|
+
CreatedAt: string;
|
|
329
|
+
/** Parent Message id (Communications - Email)
|
|
330
|
+
*
|
|
331
|
+
* @type {LOOKUP}
|
|
332
|
+
*/
|
|
333
|
+
ParentMessageId: string;
|
|
334
|
+
/** Data field for Email records. Used by Communications team.
|
|
335
|
+
*
|
|
336
|
+
* @type {TEXT}
|
|
337
|
+
*/
|
|
338
|
+
Message: string;
|
|
339
|
+
/** Data field for Email records. Used by Communications team.
|
|
340
|
+
*
|
|
341
|
+
* @type {TEXT}
|
|
342
|
+
*/
|
|
343
|
+
From: string;
|
|
344
|
+
/** email attachments (Communications - Email)
|
|
345
|
+
*
|
|
346
|
+
* @type {FILE_MULTIPLE}
|
|
347
|
+
*/
|
|
348
|
+
Files: string;
|
|
349
|
+
/** SMTP Message Id (Communications - Email)
|
|
350
|
+
*
|
|
351
|
+
* @type {TEXT}
|
|
352
|
+
*/
|
|
353
|
+
MessageId: string;
|
|
354
|
+
/** When the email was updated (Communications - Email)
|
|
355
|
+
*
|
|
356
|
+
* @type {DATE_TIME}
|
|
357
|
+
*/
|
|
358
|
+
UpdatedAt: string;
|
|
359
|
+
/** Blind Carbon Copy (Communications - Email)
|
|
360
|
+
*
|
|
361
|
+
* @type {TEXT}
|
|
362
|
+
*/
|
|
363
|
+
Bcc: string;
|
|
364
|
+
/** Date field for Email records. Used by Communications team.
|
|
365
|
+
*
|
|
366
|
+
* @type {DATE_TIME}
|
|
367
|
+
*/
|
|
368
|
+
Date: string;
|
|
369
|
+
/** Reference to referral
|
|
370
|
+
*
|
|
371
|
+
* @type {LOOKUP}
|
|
372
|
+
*/
|
|
373
|
+
ReferralId: string;
|
|
222
374
|
/** Sender Type (Communications - Email)
|
|
223
375
|
*
|
|
224
376
|
* @type {ENUM}
|
|
@@ -356,6 +508,11 @@ export interface SupportEmailProperties {
|
|
|
356
508
|
* @type {DATE_TIME}
|
|
357
509
|
*/
|
|
358
510
|
Date: string;
|
|
511
|
+
/** Reference to referral
|
|
512
|
+
*
|
|
513
|
+
* @type {LOOKUP}
|
|
514
|
+
*/
|
|
515
|
+
ReferralId: string;
|
|
359
516
|
/** Sender Type (Communications - Email)
|
|
360
517
|
*
|
|
361
518
|
* @type {ENUM}
|
|
@@ -493,6 +650,11 @@ export interface TransactionalEmailProperties {
|
|
|
493
650
|
* @type {DATE_TIME}
|
|
494
651
|
*/
|
|
495
652
|
Date: string;
|
|
653
|
+
/** Reference to referral
|
|
654
|
+
*
|
|
655
|
+
* @type {LOOKUP}
|
|
656
|
+
*/
|
|
657
|
+
ReferralId: string;
|
|
496
658
|
/** Sender Type (Communications - Email)
|
|
497
659
|
*
|
|
498
660
|
* @type {ENUM}
|
|
@@ -573,6 +735,8 @@ export declare class Email extends OdinRecord<EmailProperties> {
|
|
|
573
735
|
EmailSender: OdinLink<LinkedOdinRecord<EmailSenderProperties>>;
|
|
574
736
|
/** Linked WorkOrder records (WorkOrder__Email) */
|
|
575
737
|
WorkOrder: OdinLink<LinkedOdinRecord<WorkOrderProperties>>;
|
|
738
|
+
/** Linked Referral records (Referral__Email) */
|
|
739
|
+
Referral: OdinLink<LinkedOdinRecord<ReferralProperties>>;
|
|
576
740
|
}
|
|
577
741
|
/**
|
|
578
742
|
* RabbitMQ routing keys for Email events
|
|
@@ -590,6 +754,12 @@ export declare const ROUTING_KEY_EMAIL_DEFAULT_CREATED = "NotificationModule.Ema
|
|
|
590
754
|
export declare const ROUTING_KEY_EMAIL_DEFAULT_UPDATED = "NotificationModule.Email.DEFAULT.SubDbRecordUpdated";
|
|
591
755
|
/** This is the default record type deleted */
|
|
592
756
|
export declare const ROUTING_KEY_EMAIL_DEFAULT_DELETED = "NotificationModule.Email.DEFAULT.SubDbRecordDeleted";
|
|
757
|
+
/** Sending emails in the referral system created */
|
|
758
|
+
export declare const ROUTING_KEY_EMAIL_REFERRAL_CREATED = "NotificationModule.Email.REFERRAL.SubDbRecordCreated";
|
|
759
|
+
/** Sending emails in the referral system updated */
|
|
760
|
+
export declare const ROUTING_KEY_EMAIL_REFERRAL_UPDATED = "NotificationModule.Email.REFERRAL.SubDbRecordUpdated";
|
|
761
|
+
/** Sending emails in the referral system deleted */
|
|
762
|
+
export declare const ROUTING_KEY_EMAIL_REFERRAL_DELETED = "NotificationModule.Email.REFERRAL.SubDbRecordDeleted";
|
|
593
763
|
/** Support created */
|
|
594
764
|
export declare const ROUTING_KEY_EMAIL_SUPPORT_CREATED = "NotificationModule.Email.SUPPORT.SubDbRecordCreated";
|
|
595
765
|
/** Support updated */
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
* Generated from Odin schema definition
|
|
13
13
|
*/
|
|
14
14
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
|
-
exports.ROUTING_KEY_LINK_EMAI_EMAIL_SENDER_DELETED = exports.ROUTING_KEY_LINK_EMAI_EMAIL_SENDER_CREATED = exports.ROUTING_KEY_LINK_EMAIL_CONTACT_DELETED = exports.ROUTING_KEY_LINK_EMAIL_CONTACT_CREATED = exports.ROUTING_KEY_LINK_ATTACHMENTS_DELETED = exports.ROUTING_KEY_LINK_ATTACHMENTS_CREATED = exports.ROUTING_KEY_LINK_EMAIL_EMAIL_DELETED = exports.ROUTING_KEY_LINK_EMAIL_EMAIL_CREATED = exports.ROUTING_KEY_LINK_EMAIL_USER_DELETED = exports.ROUTING_KEY_LINK_EMAIL_USER_CREATED = exports.ROUTING_KEY_EMAIL_TRANSACTIONAL_DELETED = exports.ROUTING_KEY_EMAIL_TRANSACTIONAL_UPDATED = exports.ROUTING_KEY_EMAIL_TRANSACTIONAL_CREATED = exports.ROUTING_KEY_EMAIL_SUPPORT_DELETED = exports.ROUTING_KEY_EMAIL_SUPPORT_UPDATED = exports.ROUTING_KEY_EMAIL_SUPPORT_CREATED = exports.ROUTING_KEY_EMAIL_DEFAULT_DELETED = exports.ROUTING_KEY_EMAIL_DEFAULT_UPDATED = exports.ROUTING_KEY_EMAIL_DEFAULT_CREATED = exports.ROUTING_KEY_EMAIL_DELETED = exports.ROUTING_KEY_EMAIL_UPDATED = exports.ROUTING_KEY_EMAIL_CREATED = exports.Email = exports.EmailPropertyKeys = exports.EmailEmailingService = exports.EmailStatus = exports.EmailSenderType = exports.EmailEntityTypes = void 0;
|
|
15
|
+
exports.ROUTING_KEY_LINK_EMAI_EMAIL_SENDER_DELETED = exports.ROUTING_KEY_LINK_EMAI_EMAIL_SENDER_CREATED = exports.ROUTING_KEY_LINK_EMAIL_CONTACT_DELETED = exports.ROUTING_KEY_LINK_EMAIL_CONTACT_CREATED = exports.ROUTING_KEY_LINK_ATTACHMENTS_DELETED = exports.ROUTING_KEY_LINK_ATTACHMENTS_CREATED = exports.ROUTING_KEY_LINK_EMAIL_EMAIL_DELETED = exports.ROUTING_KEY_LINK_EMAIL_EMAIL_CREATED = exports.ROUTING_KEY_LINK_EMAIL_USER_DELETED = exports.ROUTING_KEY_LINK_EMAIL_USER_CREATED = exports.ROUTING_KEY_EMAIL_TRANSACTIONAL_DELETED = exports.ROUTING_KEY_EMAIL_TRANSACTIONAL_UPDATED = exports.ROUTING_KEY_EMAIL_TRANSACTIONAL_CREATED = exports.ROUTING_KEY_EMAIL_SUPPORT_DELETED = exports.ROUTING_KEY_EMAIL_SUPPORT_UPDATED = exports.ROUTING_KEY_EMAIL_SUPPORT_CREATED = exports.ROUTING_KEY_EMAIL_REFERRAL_DELETED = exports.ROUTING_KEY_EMAIL_REFERRAL_UPDATED = exports.ROUTING_KEY_EMAIL_REFERRAL_CREATED = exports.ROUTING_KEY_EMAIL_DEFAULT_DELETED = exports.ROUTING_KEY_EMAIL_DEFAULT_UPDATED = exports.ROUTING_KEY_EMAIL_DEFAULT_CREATED = exports.ROUTING_KEY_EMAIL_DELETED = exports.ROUTING_KEY_EMAIL_UPDATED = exports.ROUTING_KEY_EMAIL_CREATED = exports.Email = exports.EmailPropertyKeys = exports.EmailEmailingService = exports.EmailStatus = exports.EmailSenderType = exports.EmailEntityTypes = void 0;
|
|
16
16
|
const core_1 = require("@d19n/odin-types/dist/core");
|
|
17
17
|
/**
|
|
18
18
|
* Available types for Email records
|
|
@@ -21,6 +21,8 @@ var EmailEntityTypes;
|
|
|
21
21
|
(function (EmailEntityTypes) {
|
|
22
22
|
/** This is the default record type */
|
|
23
23
|
EmailEntityTypes["DEFAULT"] = "DEFAULT";
|
|
24
|
+
/** Sending emails in the referral system */
|
|
25
|
+
EmailEntityTypes["REFERRAL"] = "REFERRAL";
|
|
24
26
|
/** Support */
|
|
25
27
|
EmailEntityTypes["SUPPORT"] = "SUPPORT";
|
|
26
28
|
/** This type is used to create entities for transactional emails */
|
|
@@ -116,6 +118,8 @@ var EmailPropertyKeys;
|
|
|
116
118
|
EmailPropertyKeys["Bcc"] = "Bcc";
|
|
117
119
|
/** Date field for Email records. Used by Communications team. */
|
|
118
120
|
EmailPropertyKeys["Date"] = "Date";
|
|
121
|
+
/** Reference to referral */
|
|
122
|
+
EmailPropertyKeys["ReferralId"] = "ReferralId";
|
|
119
123
|
/** Sender Type (Communications - Email) */
|
|
120
124
|
EmailPropertyKeys["SenderType"] = "SenderType";
|
|
121
125
|
/** Data field for Email records. Used by Communications team. */
|
|
@@ -167,6 +171,12 @@ exports.ROUTING_KEY_EMAIL_DEFAULT_CREATED = 'NotificationModule.Email.DEFAULT.Su
|
|
|
167
171
|
exports.ROUTING_KEY_EMAIL_DEFAULT_UPDATED = 'NotificationModule.Email.DEFAULT.SubDbRecordUpdated';
|
|
168
172
|
/** This is the default record type deleted */
|
|
169
173
|
exports.ROUTING_KEY_EMAIL_DEFAULT_DELETED = 'NotificationModule.Email.DEFAULT.SubDbRecordDeleted';
|
|
174
|
+
/** Sending emails in the referral system created */
|
|
175
|
+
exports.ROUTING_KEY_EMAIL_REFERRAL_CREATED = 'NotificationModule.Email.REFERRAL.SubDbRecordCreated';
|
|
176
|
+
/** Sending emails in the referral system updated */
|
|
177
|
+
exports.ROUTING_KEY_EMAIL_REFERRAL_UPDATED = 'NotificationModule.Email.REFERRAL.SubDbRecordUpdated';
|
|
178
|
+
/** Sending emails in the referral system deleted */
|
|
179
|
+
exports.ROUTING_KEY_EMAIL_REFERRAL_DELETED = 'NotificationModule.Email.REFERRAL.SubDbRecordDeleted';
|
|
170
180
|
/** Support created */
|
|
171
181
|
exports.ROUTING_KEY_EMAIL_SUPPORT_CREATED = 'NotificationModule.Email.SUPPORT.SubDbRecordCreated';
|
|
172
182
|
/** Support updated */
|