@d19n/youfibre-odin-sdk 2.0.273 → 2.0.276
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 +20 -1
- package/dist/EntityRegistry.d.ts +4 -0
- package/dist/EntityRegistry.js +4 -0
- package/dist/OdinApiClient.d.ts +8 -0
- package/dist/OdinApiClient.js +16 -0
- package/dist/OdinDbClient.d.ts +8 -0
- package/dist/OdinDbClient.js +16 -0
- package/dist/accessors-v2/NotificationTemplateAccessor.d.ts +111 -0
- package/dist/accessors-v2/NotificationTemplateAccessor.js +190 -0
- package/dist/accessors-v2/SmsTemplateAccessor.d.ts +111 -0
- package/dist/accessors-v2/SmsTemplateAccessor.js +190 -0
- package/dist/accessors-v2/index.d.ts +2 -0
- package/dist/accessors-v2/index.js +6 -2
- package/dist/actions-v2/CreateAppointmentDto.d.ts +5 -5
- package/dist/actions-v2/CreateCollectionAmcoWorkOrderDto.d.ts +8 -1
- package/dist/actions-v2/CreateCollectionAmcoWorkOrderFromOrderDto.d.ts +8 -1
- package/dist/actions-v2/CreateInboundSupportEmailDto.d.ts +170 -0
- package/dist/actions-v2/CreateInboundSupportEmailDto.js +56 -0
- package/dist/actions-v2/CreateOutageEmailDto.d.ts +142 -0
- package/dist/actions-v2/CreateOutageEmailDto.js +56 -0
- package/dist/actions-v2/CreateOutboundSupportEmailDto.d.ts +149 -0
- package/dist/actions-v2/CreateOutboundSupportEmailDto.js +56 -0
- package/dist/actions-v2/RecordSmsAppointmentConfirmationDto.d.ts +86 -0
- package/dist/actions-v2/RecordSmsAppointmentConfirmationDto.js +56 -0
- package/dist/actions-v2/RecordSmsSurveyRatingDto.d.ts +86 -0
- package/dist/actions-v2/RecordSmsSurveyRatingDto.js +56 -0
- package/dist/actions-v2/ReturnCaseToAgentOnCustomerReplyDto.d.ts +86 -0
- package/dist/actions-v2/ReturnCaseToAgentOnCustomerReplyDto.js +56 -0
- package/dist/actions-v2/UpdateNotificationTemplateDto.d.ts +93 -0
- package/dist/actions-v2/UpdateNotificationTemplateDto.js +56 -0
- package/dist/actions-v2/UpdateSmsDeliveryStatusDto.d.ts +73 -0
- package/dist/actions-v2/UpdateSmsDeliveryStatusDto.js +56 -0
- package/dist/actions-v2/UpdateSmsTemplateDto.d.ts +79 -0
- package/dist/actions-v2/UpdateSmsTemplateDto.js +56 -0
- package/dist/db-accessors-v2/NotificationTemplateDbAccessor.d.ts +149 -0
- package/dist/db-accessors-v2/NotificationTemplateDbAccessor.js +227 -0
- package/dist/db-accessors-v2/SmsTemplateDbAccessor.d.ts +149 -0
- package/dist/db-accessors-v2/SmsTemplateDbAccessor.js +227 -0
- package/dist/db-accessors-v2/index.d.ts +2 -0
- package/dist/db-accessors-v2/index.js +6 -2
- package/dist/entities-v2/Case.d.ts +67 -94
- package/dist/entities-v2/Case.js +67 -94
- package/dist/entities-v2/File.d.ts +6 -0
- package/dist/entities-v2/File.js +5 -1
- package/dist/records-v2/CaseRecord.d.ts +28 -0
- package/dist/records-v2/CaseRecord.js +37 -0
- package/dist/records-v2/EmailRecord.d.ts +84 -0
- package/dist/records-v2/EmailRecord.js +111 -0
- package/dist/records-v2/NotificationTemplateRecord.d.ts +183 -0
- package/dist/records-v2/NotificationTemplateRecord.js +244 -0
- package/dist/records-v2/SmsMessageRecord.d.ts +83 -0
- package/dist/records-v2/SmsMessageRecord.js +106 -0
- package/dist/records-v2/SmsTemplateRecord.d.ts +183 -0
- package/dist/records-v2/SmsTemplateRecord.js +244 -0
- package/dist/records-v2/index.d.ts +2 -0
- package/dist/records-v2/index.js +7 -1
- package/dist/wholesale-provider/index.d.ts +1 -1
- package/dist/wholesale-provider/interface.d.ts +54 -0
- package/dist/wholesale-provider/providers/netomnia-provider.d.ts +8 -1
- package/dist/wholesale-provider/providers/netomnia-provider.js +3 -0
- package/dist/wholesale-provider/test/netomnia-provider.spec.js +31 -0
- package/package.json +1 -1
|
@@ -0,0 +1,142 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* CreateOutageEmail Action DTO
|
|
3
|
+
*
|
|
4
|
+
* Records the master outage notification email against the parent OUTAGE case. This is the fan-out template record, not a delivered message — To is deliberately null because recipients are resolved per sub-case by the RMQ fan-out that follows. Distinct from CreateOutboundSupportEmail, which is one agent reply to one customer on a support case.
|
|
5
|
+
*
|
|
6
|
+
* @module NotificationModule
|
|
7
|
+
* @entity Email
|
|
8
|
+
* @actionKey CreateOutageEmail
|
|
9
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Email.Update.CreateOutageEmail
|
|
10
|
+
*
|
|
11
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
12
|
+
*/
|
|
13
|
+
import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
|
|
14
|
+
/**
|
|
15
|
+
* RabbitMQ message payload for CreateOutageEmail updated events
|
|
16
|
+
*
|
|
17
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Email.Update.CreateOutageEmail
|
|
18
|
+
*/
|
|
19
|
+
export interface CreateOutageEmailMessage extends OdinRecordUpdatedEvent<CreateOutageEmailDto, CreateOutageEmailProperties> {
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Properties for CreateOutageEmail action
|
|
23
|
+
*
|
|
24
|
+
* @property Required fields: 0
|
|
25
|
+
* @property Optional fields: 11
|
|
26
|
+
*/
|
|
27
|
+
export interface CreateOutageEmailProperties {
|
|
28
|
+
/**
|
|
29
|
+
* Message ID
|
|
30
|
+
*
|
|
31
|
+
* SMTP Message Id (Communications - Email)
|
|
32
|
+
* @type {TEXT}
|
|
33
|
+
*/
|
|
34
|
+
MessageId?: string | null;
|
|
35
|
+
/**
|
|
36
|
+
* Outage case
|
|
37
|
+
*
|
|
38
|
+
* Data field for Email records. Used by Communications team.
|
|
39
|
+
* @type {LOOKUP}
|
|
40
|
+
*/
|
|
41
|
+
Case?: string | null;
|
|
42
|
+
/**
|
|
43
|
+
* Date
|
|
44
|
+
*
|
|
45
|
+
* Date field for Email records. Used by Communications team.
|
|
46
|
+
* @type {DATE_TIME}
|
|
47
|
+
*/
|
|
48
|
+
Date?: string | null;
|
|
49
|
+
/**
|
|
50
|
+
* From
|
|
51
|
+
*
|
|
52
|
+
* Data field for Email records. Used by Communications team.
|
|
53
|
+
* @type {TEXT}
|
|
54
|
+
*/
|
|
55
|
+
From?: string | null;
|
|
56
|
+
/**
|
|
57
|
+
* To (null for the master record)
|
|
58
|
+
*
|
|
59
|
+
* Data field for Email records. Used by Communications team.
|
|
60
|
+
* @type {TEXT}
|
|
61
|
+
*/
|
|
62
|
+
To?: string | null;
|
|
63
|
+
/**
|
|
64
|
+
* Cc
|
|
65
|
+
*
|
|
66
|
+
* Carbon Copy (Communications - Email)
|
|
67
|
+
* @type {TEXT}
|
|
68
|
+
*/
|
|
69
|
+
Cc?: string | null;
|
|
70
|
+
/**
|
|
71
|
+
* Bcc
|
|
72
|
+
*
|
|
73
|
+
* Blind Carbon Copy (Communications - Email)
|
|
74
|
+
* @type {TEXT}
|
|
75
|
+
*/
|
|
76
|
+
Bcc?: string | null;
|
|
77
|
+
/**
|
|
78
|
+
* Subject
|
|
79
|
+
*
|
|
80
|
+
* Data field for Email records. Used by Communications team.
|
|
81
|
+
* @type {TEXT}
|
|
82
|
+
*/
|
|
83
|
+
Subject?: string | null;
|
|
84
|
+
/**
|
|
85
|
+
* Body
|
|
86
|
+
*
|
|
87
|
+
* Data field for Email records. Used by Communications team.
|
|
88
|
+
* @type {TEXT}
|
|
89
|
+
*/
|
|
90
|
+
Message?: string | null;
|
|
91
|
+
/**
|
|
92
|
+
* Sender type
|
|
93
|
+
*
|
|
94
|
+
* Sender Type (Communications - Email)
|
|
95
|
+
* @type {ENUM}
|
|
96
|
+
*/
|
|
97
|
+
SenderType?: string | null;
|
|
98
|
+
/**
|
|
99
|
+
* Attachment file ids
|
|
100
|
+
*
|
|
101
|
+
* email attachments (Communications - Email)
|
|
102
|
+
* @type {FILE_MULTIPLE}
|
|
103
|
+
*/
|
|
104
|
+
Files?: string | null;
|
|
105
|
+
}
|
|
106
|
+
/**
|
|
107
|
+
* CreateOutageEmail
|
|
108
|
+
*
|
|
109
|
+
* Records the master outage notification email against the parent OUTAGE case. This is the fan-out template record, not a delivered message — To is deliberately null because recipients are resolved per sub-case by the RMQ fan-out that follows. Distinct from CreateOutboundSupportEmail, which is one agent reply to one customer on a support case.
|
|
110
|
+
*
|
|
111
|
+
* @actionType UPDATE - Updates an existing Email record
|
|
112
|
+
* @module NotificationModule
|
|
113
|
+
* @entity Email
|
|
114
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Email.Update.CreateOutageEmail
|
|
115
|
+
* @permission schema.action.createoutageemail.trigger
|
|
116
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
117
|
+
*/
|
|
118
|
+
export declare class CreateOutageEmailDto extends OdinRecordUpdateDto<CreateOutageEmailProperties> {
|
|
119
|
+
/** Used by SDK generators to identify action type */
|
|
120
|
+
static readonly ACTION_TYPE = "UPDATE";
|
|
121
|
+
static readonly ACTION_KEY = "CreateOutageEmail";
|
|
122
|
+
static readonly MODULE_NAME = "NotificationModule";
|
|
123
|
+
static readonly ENTITIES: string[];
|
|
124
|
+
static readonly EVENT_NAME = "k1.t-hEOJjsDb.NotificationModule.Email.Update.CreateOutageEmail";
|
|
125
|
+
static readonly PERMISSION = "schema.action.createoutageemail.trigger";
|
|
126
|
+
/** Step metadata - entity this action targets */
|
|
127
|
+
static readonly STEP_ENTITY = "NotificationModule:Email";
|
|
128
|
+
static readonly STEP_SCHEMA_ID = "cb37958c-d72f-44aa-975a-a8fae42b1b72";
|
|
129
|
+
static readonly STEP_SCHEMA_ACTION_ID = "50dcd610-2588-49df-97e1-eb988034173f";
|
|
130
|
+
static readonly AUTO_LINK_PARENT = false;
|
|
131
|
+
readonly actionName: string;
|
|
132
|
+
readonly schemaActionId: string;
|
|
133
|
+
readonly entity: string;
|
|
134
|
+
constructor(record: OdinRecord<any> | {
|
|
135
|
+
id: string;
|
|
136
|
+
entity: string;
|
|
137
|
+
type?: string;
|
|
138
|
+
}, properties: CreateOutageEmailProperties, options?: {
|
|
139
|
+
journeyId?: string;
|
|
140
|
+
stageKey?: string;
|
|
141
|
+
});
|
|
142
|
+
}
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* CreateOutageEmail Action DTO
|
|
4
|
+
*
|
|
5
|
+
* Records the master outage notification email against the parent OUTAGE case. This is the fan-out template record, not a delivered message — To is deliberately null because recipients are resolved per sub-case by the RMQ fan-out that follows. Distinct from CreateOutboundSupportEmail, which is one agent reply to one customer on a support case.
|
|
6
|
+
*
|
|
7
|
+
* @module NotificationModule
|
|
8
|
+
* @entity Email
|
|
9
|
+
* @actionKey CreateOutageEmail
|
|
10
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Email.Update.CreateOutageEmail
|
|
11
|
+
*
|
|
12
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
13
|
+
*/
|
|
14
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
|
+
exports.CreateOutageEmailDto = void 0;
|
|
16
|
+
const core_1 = require("@d19n/odin-types/dist/core");
|
|
17
|
+
/**
|
|
18
|
+
* CreateOutageEmail
|
|
19
|
+
*
|
|
20
|
+
* Records the master outage notification email against the parent OUTAGE case. This is the fan-out template record, not a delivered message — To is deliberately null because recipients are resolved per sub-case by the RMQ fan-out that follows. Distinct from CreateOutboundSupportEmail, which is one agent reply to one customer on a support case.
|
|
21
|
+
*
|
|
22
|
+
* @actionType UPDATE - Updates an existing Email record
|
|
23
|
+
* @module NotificationModule
|
|
24
|
+
* @entity Email
|
|
25
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Email.Update.CreateOutageEmail
|
|
26
|
+
* @permission schema.action.createoutageemail.trigger
|
|
27
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
28
|
+
*/
|
|
29
|
+
class CreateOutageEmailDto extends core_1.OdinRecordUpdateDto {
|
|
30
|
+
constructor(record, properties, options) {
|
|
31
|
+
super({
|
|
32
|
+
id: record.id,
|
|
33
|
+
entity: record.entity,
|
|
34
|
+
type: record.type,
|
|
35
|
+
properties,
|
|
36
|
+
journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
|
|
37
|
+
stageKey: options === null || options === void 0 ? void 0 : options.stageKey,
|
|
38
|
+
});
|
|
39
|
+
this.actionName = 'CreateOutageEmail';
|
|
40
|
+
this.schemaActionId = '50dcd610-2588-49df-97e1-eb988034173f';
|
|
41
|
+
this.entity = 'NotificationModule:Email';
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
exports.CreateOutageEmailDto = CreateOutageEmailDto;
|
|
45
|
+
/** Used by SDK generators to identify action type */
|
|
46
|
+
CreateOutageEmailDto.ACTION_TYPE = 'UPDATE';
|
|
47
|
+
CreateOutageEmailDto.ACTION_KEY = 'CreateOutageEmail';
|
|
48
|
+
CreateOutageEmailDto.MODULE_NAME = 'NotificationModule';
|
|
49
|
+
CreateOutageEmailDto.ENTITIES = ['Email'];
|
|
50
|
+
CreateOutageEmailDto.EVENT_NAME = 'k1.t-hEOJjsDb.NotificationModule.Email.Update.CreateOutageEmail';
|
|
51
|
+
CreateOutageEmailDto.PERMISSION = 'schema.action.createoutageemail.trigger';
|
|
52
|
+
/** Step metadata - entity this action targets */
|
|
53
|
+
CreateOutageEmailDto.STEP_ENTITY = 'NotificationModule:Email';
|
|
54
|
+
CreateOutageEmailDto.STEP_SCHEMA_ID = 'cb37958c-d72f-44aa-975a-a8fae42b1b72';
|
|
55
|
+
CreateOutageEmailDto.STEP_SCHEMA_ACTION_ID = '50dcd610-2588-49df-97e1-eb988034173f';
|
|
56
|
+
CreateOutageEmailDto.AUTO_LINK_PARENT = false;
|
|
@@ -0,0 +1,149 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* CreateOutboundSupportEmail Action DTO
|
|
3
|
+
*
|
|
4
|
+
* Stages an agent's outbound support email as an Email record before SendGrid is called, so the record id can be threaded into the send headers and the reply correlated back. MessageId is a uuidV4 placeholder that the send handler overwrites with the real SendGrid x-message-id; a UUIDv4 still present after 5 minutes is the stuck-send signature. Distinct from CreateInboundSupportEmail, which records an already-received customer message with its real Message-ID.
|
|
5
|
+
*
|
|
6
|
+
* @module NotificationModule
|
|
7
|
+
* @entity Email
|
|
8
|
+
* @actionKey CreateOutboundSupportEmail
|
|
9
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Email.Update.CreateOutboundSupportEmail
|
|
10
|
+
*
|
|
11
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
12
|
+
*/
|
|
13
|
+
import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
|
|
14
|
+
/**
|
|
15
|
+
* RabbitMQ message payload for CreateOutboundSupportEmail updated events
|
|
16
|
+
*
|
|
17
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Email.Update.CreateOutboundSupportEmail
|
|
18
|
+
*/
|
|
19
|
+
export interface CreateOutboundSupportEmailMessage extends OdinRecordUpdatedEvent<CreateOutboundSupportEmailDto, CreateOutboundSupportEmailProperties> {
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Properties for CreateOutboundSupportEmail action
|
|
23
|
+
*
|
|
24
|
+
* @property Required fields: 0
|
|
25
|
+
* @property Optional fields: 12
|
|
26
|
+
*/
|
|
27
|
+
export interface CreateOutboundSupportEmailProperties {
|
|
28
|
+
/**
|
|
29
|
+
* Message ID (placeholder)
|
|
30
|
+
*
|
|
31
|
+
* SMTP Message Id (Communications - Email)
|
|
32
|
+
* @type {TEXT}
|
|
33
|
+
*/
|
|
34
|
+
MessageId?: string | null;
|
|
35
|
+
/**
|
|
36
|
+
* Parent message ID
|
|
37
|
+
*
|
|
38
|
+
* Parent Message id (Communications - Email)
|
|
39
|
+
* @type {LOOKUP}
|
|
40
|
+
*/
|
|
41
|
+
ParentMessageId?: string | null;
|
|
42
|
+
/**
|
|
43
|
+
* Date sent
|
|
44
|
+
*
|
|
45
|
+
* Date field for Email records. Used by Communications team.
|
|
46
|
+
* @type {DATE_TIME}
|
|
47
|
+
*/
|
|
48
|
+
Date?: string | null;
|
|
49
|
+
/**
|
|
50
|
+
* From
|
|
51
|
+
*
|
|
52
|
+
* Data field for Email records. Used by Communications team.
|
|
53
|
+
* @type {TEXT}
|
|
54
|
+
*/
|
|
55
|
+
From?: string | null;
|
|
56
|
+
/**
|
|
57
|
+
* To
|
|
58
|
+
*
|
|
59
|
+
* Data field for Email records. Used by Communications team.
|
|
60
|
+
* @type {TEXT}
|
|
61
|
+
*/
|
|
62
|
+
To?: string | null;
|
|
63
|
+
/**
|
|
64
|
+
* Cc
|
|
65
|
+
*
|
|
66
|
+
* Carbon Copy (Communications - Email)
|
|
67
|
+
* @type {TEXT}
|
|
68
|
+
*/
|
|
69
|
+
Cc?: string | null;
|
|
70
|
+
/**
|
|
71
|
+
* Bcc
|
|
72
|
+
*
|
|
73
|
+
* Blind Carbon Copy (Communications - Email)
|
|
74
|
+
* @type {TEXT}
|
|
75
|
+
*/
|
|
76
|
+
Bcc?: string | null;
|
|
77
|
+
/**
|
|
78
|
+
* Subject
|
|
79
|
+
*
|
|
80
|
+
* Data field for Email records. Used by Communications team.
|
|
81
|
+
* @type {TEXT}
|
|
82
|
+
*/
|
|
83
|
+
Subject?: string | null;
|
|
84
|
+
/**
|
|
85
|
+
* Plain-text body
|
|
86
|
+
*
|
|
87
|
+
* Data field for Email records. Used by Communications team.
|
|
88
|
+
* @type {TEXT}
|
|
89
|
+
*/
|
|
90
|
+
Message?: string | null;
|
|
91
|
+
/**
|
|
92
|
+
* Sender type
|
|
93
|
+
*
|
|
94
|
+
* Sender Type (Communications - Email)
|
|
95
|
+
* @type {ENUM}
|
|
96
|
+
*/
|
|
97
|
+
SenderType?: string | null;
|
|
98
|
+
/**
|
|
99
|
+
* Case
|
|
100
|
+
*
|
|
101
|
+
* Data field for Email records. Used by Communications team.
|
|
102
|
+
* @type {LOOKUP}
|
|
103
|
+
*/
|
|
104
|
+
Case?: string | null;
|
|
105
|
+
/**
|
|
106
|
+
* Attachment file ids
|
|
107
|
+
*
|
|
108
|
+
* email attachments (Communications - Email)
|
|
109
|
+
* @type {FILE_MULTIPLE}
|
|
110
|
+
*/
|
|
111
|
+
Files?: string | null;
|
|
112
|
+
}
|
|
113
|
+
/**
|
|
114
|
+
* CreateOutboundSupportEmail
|
|
115
|
+
*
|
|
116
|
+
* Stages an agent's outbound support email as an Email record before SendGrid is called, so the record id can be threaded into the send headers and the reply correlated back. MessageId is a uuidV4 placeholder that the send handler overwrites with the real SendGrid x-message-id; a UUIDv4 still present after 5 minutes is the stuck-send signature. Distinct from CreateInboundSupportEmail, which records an already-received customer message with its real Message-ID.
|
|
117
|
+
*
|
|
118
|
+
* @actionType UPDATE - Updates an existing Email record
|
|
119
|
+
* @module NotificationModule
|
|
120
|
+
* @entity Email
|
|
121
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Email.Update.CreateOutboundSupportEmail
|
|
122
|
+
* @permission schema.action.createoutboundsupportemail.trigger
|
|
123
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
124
|
+
*/
|
|
125
|
+
export declare class CreateOutboundSupportEmailDto extends OdinRecordUpdateDto<CreateOutboundSupportEmailProperties> {
|
|
126
|
+
/** Used by SDK generators to identify action type */
|
|
127
|
+
static readonly ACTION_TYPE = "UPDATE";
|
|
128
|
+
static readonly ACTION_KEY = "CreateOutboundSupportEmail";
|
|
129
|
+
static readonly MODULE_NAME = "NotificationModule";
|
|
130
|
+
static readonly ENTITIES: string[];
|
|
131
|
+
static readonly EVENT_NAME = "k1.t-hEOJjsDb.NotificationModule.Email.Update.CreateOutboundSupportEmail";
|
|
132
|
+
static readonly PERMISSION = "schema.action.createoutboundsupportemail.trigger";
|
|
133
|
+
/** Step metadata - entity this action targets */
|
|
134
|
+
static readonly STEP_ENTITY = "NotificationModule:Email";
|
|
135
|
+
static readonly STEP_SCHEMA_ID = "cb37958c-d72f-44aa-975a-a8fae42b1b72";
|
|
136
|
+
static readonly STEP_SCHEMA_ACTION_ID = "f425d771-edb0-4069-82a9-4cc601f7c375";
|
|
137
|
+
static readonly AUTO_LINK_PARENT = false;
|
|
138
|
+
readonly actionName: string;
|
|
139
|
+
readonly schemaActionId: string;
|
|
140
|
+
readonly entity: string;
|
|
141
|
+
constructor(record: OdinRecord<any> | {
|
|
142
|
+
id: string;
|
|
143
|
+
entity: string;
|
|
144
|
+
type?: string;
|
|
145
|
+
}, properties: CreateOutboundSupportEmailProperties, options?: {
|
|
146
|
+
journeyId?: string;
|
|
147
|
+
stageKey?: string;
|
|
148
|
+
});
|
|
149
|
+
}
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* CreateOutboundSupportEmail Action DTO
|
|
4
|
+
*
|
|
5
|
+
* Stages an agent's outbound support email as an Email record before SendGrid is called, so the record id can be threaded into the send headers and the reply correlated back. MessageId is a uuidV4 placeholder that the send handler overwrites with the real SendGrid x-message-id; a UUIDv4 still present after 5 minutes is the stuck-send signature. Distinct from CreateInboundSupportEmail, which records an already-received customer message with its real Message-ID.
|
|
6
|
+
*
|
|
7
|
+
* @module NotificationModule
|
|
8
|
+
* @entity Email
|
|
9
|
+
* @actionKey CreateOutboundSupportEmail
|
|
10
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Email.Update.CreateOutboundSupportEmail
|
|
11
|
+
*
|
|
12
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
13
|
+
*/
|
|
14
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
|
+
exports.CreateOutboundSupportEmailDto = void 0;
|
|
16
|
+
const core_1 = require("@d19n/odin-types/dist/core");
|
|
17
|
+
/**
|
|
18
|
+
* CreateOutboundSupportEmail
|
|
19
|
+
*
|
|
20
|
+
* Stages an agent's outbound support email as an Email record before SendGrid is called, so the record id can be threaded into the send headers and the reply correlated back. MessageId is a uuidV4 placeholder that the send handler overwrites with the real SendGrid x-message-id; a UUIDv4 still present after 5 minutes is the stuck-send signature. Distinct from CreateInboundSupportEmail, which records an already-received customer message with its real Message-ID.
|
|
21
|
+
*
|
|
22
|
+
* @actionType UPDATE - Updates an existing Email record
|
|
23
|
+
* @module NotificationModule
|
|
24
|
+
* @entity Email
|
|
25
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Email.Update.CreateOutboundSupportEmail
|
|
26
|
+
* @permission schema.action.createoutboundsupportemail.trigger
|
|
27
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
28
|
+
*/
|
|
29
|
+
class CreateOutboundSupportEmailDto extends core_1.OdinRecordUpdateDto {
|
|
30
|
+
constructor(record, properties, options) {
|
|
31
|
+
super({
|
|
32
|
+
id: record.id,
|
|
33
|
+
entity: record.entity,
|
|
34
|
+
type: record.type,
|
|
35
|
+
properties,
|
|
36
|
+
journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
|
|
37
|
+
stageKey: options === null || options === void 0 ? void 0 : options.stageKey,
|
|
38
|
+
});
|
|
39
|
+
this.actionName = 'CreateOutboundSupportEmail';
|
|
40
|
+
this.schemaActionId = 'f425d771-edb0-4069-82a9-4cc601f7c375';
|
|
41
|
+
this.entity = 'NotificationModule:Email';
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
exports.CreateOutboundSupportEmailDto = CreateOutboundSupportEmailDto;
|
|
45
|
+
/** Used by SDK generators to identify action type */
|
|
46
|
+
CreateOutboundSupportEmailDto.ACTION_TYPE = 'UPDATE';
|
|
47
|
+
CreateOutboundSupportEmailDto.ACTION_KEY = 'CreateOutboundSupportEmail';
|
|
48
|
+
CreateOutboundSupportEmailDto.MODULE_NAME = 'NotificationModule';
|
|
49
|
+
CreateOutboundSupportEmailDto.ENTITIES = ['Email'];
|
|
50
|
+
CreateOutboundSupportEmailDto.EVENT_NAME = 'k1.t-hEOJjsDb.NotificationModule.Email.Update.CreateOutboundSupportEmail';
|
|
51
|
+
CreateOutboundSupportEmailDto.PERMISSION = 'schema.action.createoutboundsupportemail.trigger';
|
|
52
|
+
/** Step metadata - entity this action targets */
|
|
53
|
+
CreateOutboundSupportEmailDto.STEP_ENTITY = 'NotificationModule:Email';
|
|
54
|
+
CreateOutboundSupportEmailDto.STEP_SCHEMA_ID = 'cb37958c-d72f-44aa-975a-a8fae42b1b72';
|
|
55
|
+
CreateOutboundSupportEmailDto.STEP_SCHEMA_ACTION_ID = 'f425d771-edb0-4069-82a9-4cc601f7c375';
|
|
56
|
+
CreateOutboundSupportEmailDto.AUTO_LINK_PARENT = false;
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* RecordSmsAppointmentConfirmation Action DTO
|
|
3
|
+
*
|
|
4
|
+
* Records a customer's SMS reply to an appointment-confirmation message, storing the reply body and the CONFIRMED/REJECTED/PENDING outcome parsed from its keywords. Distinct from UpdateSmsDeliveryStatus, which is Twilio's carrier delivery callback — this is a human decision that determines whether the engineer visit goes ahead.
|
|
5
|
+
*
|
|
6
|
+
* @module NotificationModule
|
|
7
|
+
* @entity SmsMessage
|
|
8
|
+
* @actionKey RecordSmsAppointmentConfirmation
|
|
9
|
+
* @event k1.t-hEOJjsDb.NotificationModule.SmsMessage.Update.RecordSmsAppointmentConfirmation
|
|
10
|
+
*
|
|
11
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
12
|
+
*/
|
|
13
|
+
import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
|
|
14
|
+
/**
|
|
15
|
+
* RabbitMQ message payload for RecordSmsAppointmentConfirmation updated events
|
|
16
|
+
*
|
|
17
|
+
* @event k1.t-hEOJjsDb.NotificationModule.SmsMessage.Update.RecordSmsAppointmentConfirmation
|
|
18
|
+
*/
|
|
19
|
+
export interface RecordSmsAppointmentConfirmationMessage extends OdinRecordUpdatedEvent<RecordSmsAppointmentConfirmationDto, RecordSmsAppointmentConfirmationProperties> {
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Properties for RecordSmsAppointmentConfirmation action
|
|
23
|
+
*
|
|
24
|
+
* @property Required fields: 0
|
|
25
|
+
* @property Optional fields: 3
|
|
26
|
+
*/
|
|
27
|
+
export interface RecordSmsAppointmentConfirmationProperties {
|
|
28
|
+
/**
|
|
29
|
+
* SMS status
|
|
30
|
+
*
|
|
31
|
+
* The status of the message (Communications - SmsMessage)
|
|
32
|
+
* @type {TEXT}
|
|
33
|
+
*/
|
|
34
|
+
SmsStatus?: string | null;
|
|
35
|
+
/**
|
|
36
|
+
* Confirmation outcome
|
|
37
|
+
*
|
|
38
|
+
* based on users reply to the sms message (YES, NO .. ) (Communications - SmsMessage)
|
|
39
|
+
* @type {TEXT}
|
|
40
|
+
*/
|
|
41
|
+
ConfirmationStatus?: string | null;
|
|
42
|
+
/**
|
|
43
|
+
* Reply body
|
|
44
|
+
*
|
|
45
|
+
* the message body (Communications - SmsMessage)
|
|
46
|
+
* @type {TEXT_LONG}
|
|
47
|
+
*/
|
|
48
|
+
Body?: string | null;
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* RecordSmsAppointmentConfirmation
|
|
52
|
+
*
|
|
53
|
+
* Records a customer's SMS reply to an appointment-confirmation message, storing the reply body and the CONFIRMED/REJECTED/PENDING outcome parsed from its keywords. Distinct from UpdateSmsDeliveryStatus, which is Twilio's carrier delivery callback — this is a human decision that determines whether the engineer visit goes ahead.
|
|
54
|
+
*
|
|
55
|
+
* @actionType UPDATE - Updates an existing SmsMessage record
|
|
56
|
+
* @module NotificationModule
|
|
57
|
+
* @entity SmsMessage
|
|
58
|
+
* @event k1.t-hEOJjsDb.NotificationModule.SmsMessage.Update.RecordSmsAppointmentConfirmation
|
|
59
|
+
* @permission schema.action.recordsmsappointmentconfirmation.trigger
|
|
60
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
61
|
+
*/
|
|
62
|
+
export declare class RecordSmsAppointmentConfirmationDto extends OdinRecordUpdateDto<RecordSmsAppointmentConfirmationProperties> {
|
|
63
|
+
/** Used by SDK generators to identify action type */
|
|
64
|
+
static readonly ACTION_TYPE = "UPDATE";
|
|
65
|
+
static readonly ACTION_KEY = "RecordSmsAppointmentConfirmation";
|
|
66
|
+
static readonly MODULE_NAME = "NotificationModule";
|
|
67
|
+
static readonly ENTITIES: string[];
|
|
68
|
+
static readonly EVENT_NAME = "k1.t-hEOJjsDb.NotificationModule.SmsMessage.Update.RecordSmsAppointmentConfirmation";
|
|
69
|
+
static readonly PERMISSION = "schema.action.recordsmsappointmentconfirmation.trigger";
|
|
70
|
+
/** Step metadata - entity this action targets */
|
|
71
|
+
static readonly STEP_ENTITY = "NotificationModule:SmsMessage";
|
|
72
|
+
static readonly STEP_SCHEMA_ID = "de8aa864-5a08-45c7-b3d6-00f1e8cfa276";
|
|
73
|
+
static readonly STEP_SCHEMA_ACTION_ID = "ffcd18f4-8a33-4bf3-b32f-7fb73c609182";
|
|
74
|
+
static readonly AUTO_LINK_PARENT = false;
|
|
75
|
+
readonly actionName: string;
|
|
76
|
+
readonly schemaActionId: string;
|
|
77
|
+
readonly entity: string;
|
|
78
|
+
constructor(record: OdinRecord<any> | {
|
|
79
|
+
id: string;
|
|
80
|
+
entity: string;
|
|
81
|
+
type?: string;
|
|
82
|
+
}, properties: RecordSmsAppointmentConfirmationProperties, options?: {
|
|
83
|
+
journeyId?: string;
|
|
84
|
+
stageKey?: string;
|
|
85
|
+
});
|
|
86
|
+
}
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* RecordSmsAppointmentConfirmation Action DTO
|
|
4
|
+
*
|
|
5
|
+
* Records a customer's SMS reply to an appointment-confirmation message, storing the reply body and the CONFIRMED/REJECTED/PENDING outcome parsed from its keywords. Distinct from UpdateSmsDeliveryStatus, which is Twilio's carrier delivery callback — this is a human decision that determines whether the engineer visit goes ahead.
|
|
6
|
+
*
|
|
7
|
+
* @module NotificationModule
|
|
8
|
+
* @entity SmsMessage
|
|
9
|
+
* @actionKey RecordSmsAppointmentConfirmation
|
|
10
|
+
* @event k1.t-hEOJjsDb.NotificationModule.SmsMessage.Update.RecordSmsAppointmentConfirmation
|
|
11
|
+
*
|
|
12
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
13
|
+
*/
|
|
14
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
|
+
exports.RecordSmsAppointmentConfirmationDto = void 0;
|
|
16
|
+
const core_1 = require("@d19n/odin-types/dist/core");
|
|
17
|
+
/**
|
|
18
|
+
* RecordSmsAppointmentConfirmation
|
|
19
|
+
*
|
|
20
|
+
* Records a customer's SMS reply to an appointment-confirmation message, storing the reply body and the CONFIRMED/REJECTED/PENDING outcome parsed from its keywords. Distinct from UpdateSmsDeliveryStatus, which is Twilio's carrier delivery callback — this is a human decision that determines whether the engineer visit goes ahead.
|
|
21
|
+
*
|
|
22
|
+
* @actionType UPDATE - Updates an existing SmsMessage record
|
|
23
|
+
* @module NotificationModule
|
|
24
|
+
* @entity SmsMessage
|
|
25
|
+
* @event k1.t-hEOJjsDb.NotificationModule.SmsMessage.Update.RecordSmsAppointmentConfirmation
|
|
26
|
+
* @permission schema.action.recordsmsappointmentconfirmation.trigger
|
|
27
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
28
|
+
*/
|
|
29
|
+
class RecordSmsAppointmentConfirmationDto extends core_1.OdinRecordUpdateDto {
|
|
30
|
+
constructor(record, properties, options) {
|
|
31
|
+
super({
|
|
32
|
+
id: record.id,
|
|
33
|
+
entity: record.entity,
|
|
34
|
+
type: record.type,
|
|
35
|
+
properties,
|
|
36
|
+
journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
|
|
37
|
+
stageKey: options === null || options === void 0 ? void 0 : options.stageKey,
|
|
38
|
+
});
|
|
39
|
+
this.actionName = 'RecordSmsAppointmentConfirmation';
|
|
40
|
+
this.schemaActionId = 'ffcd18f4-8a33-4bf3-b32f-7fb73c609182';
|
|
41
|
+
this.entity = 'NotificationModule:SmsMessage';
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
exports.RecordSmsAppointmentConfirmationDto = RecordSmsAppointmentConfirmationDto;
|
|
45
|
+
/** Used by SDK generators to identify action type */
|
|
46
|
+
RecordSmsAppointmentConfirmationDto.ACTION_TYPE = 'UPDATE';
|
|
47
|
+
RecordSmsAppointmentConfirmationDto.ACTION_KEY = 'RecordSmsAppointmentConfirmation';
|
|
48
|
+
RecordSmsAppointmentConfirmationDto.MODULE_NAME = 'NotificationModule';
|
|
49
|
+
RecordSmsAppointmentConfirmationDto.ENTITIES = ['SmsMessage'];
|
|
50
|
+
RecordSmsAppointmentConfirmationDto.EVENT_NAME = 'k1.t-hEOJjsDb.NotificationModule.SmsMessage.Update.RecordSmsAppointmentConfirmation';
|
|
51
|
+
RecordSmsAppointmentConfirmationDto.PERMISSION = 'schema.action.recordsmsappointmentconfirmation.trigger';
|
|
52
|
+
/** Step metadata - entity this action targets */
|
|
53
|
+
RecordSmsAppointmentConfirmationDto.STEP_ENTITY = 'NotificationModule:SmsMessage';
|
|
54
|
+
RecordSmsAppointmentConfirmationDto.STEP_SCHEMA_ID = 'de8aa864-5a08-45c7-b3d6-00f1e8cfa276';
|
|
55
|
+
RecordSmsAppointmentConfirmationDto.STEP_SCHEMA_ACTION_ID = 'ffcd18f4-8a33-4bf3-b32f-7fb73c609182';
|
|
56
|
+
RecordSmsAppointmentConfirmationDto.AUTO_LINK_PARENT = false;
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* RecordSmsSurveyRating Action DTO
|
|
3
|
+
*
|
|
4
|
+
* Records a customer's SMS reply to a CSAT survey, storing the reply body and the rating derived from it. Feeds satisfaction reporting. Distinct from RecordSmsAppointmentConfirmation (which decides whether a visit goes ahead) and from UpdateSmsDeliveryStatus (which is a carrier callback, not a customer reply).
|
|
5
|
+
*
|
|
6
|
+
* @module NotificationModule
|
|
7
|
+
* @entity SmsMessage
|
|
8
|
+
* @actionKey RecordSmsSurveyRating
|
|
9
|
+
* @event k1.t-hEOJjsDb.NotificationModule.SmsMessage.Update.RecordSmsSurveyRating
|
|
10
|
+
*
|
|
11
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
12
|
+
*/
|
|
13
|
+
import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
|
|
14
|
+
/**
|
|
15
|
+
* RabbitMQ message payload for RecordSmsSurveyRating updated events
|
|
16
|
+
*
|
|
17
|
+
* @event k1.t-hEOJjsDb.NotificationModule.SmsMessage.Update.RecordSmsSurveyRating
|
|
18
|
+
*/
|
|
19
|
+
export interface RecordSmsSurveyRatingMessage extends OdinRecordUpdatedEvent<RecordSmsSurveyRatingDto, RecordSmsSurveyRatingProperties> {
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Properties for RecordSmsSurveyRating action
|
|
23
|
+
*
|
|
24
|
+
* @property Required fields: 0
|
|
25
|
+
* @property Optional fields: 3
|
|
26
|
+
*/
|
|
27
|
+
export interface RecordSmsSurveyRatingProperties {
|
|
28
|
+
/**
|
|
29
|
+
* SMS status
|
|
30
|
+
*
|
|
31
|
+
* The status of the message (Communications - SmsMessage)
|
|
32
|
+
* @type {TEXT}
|
|
33
|
+
*/
|
|
34
|
+
SmsStatus?: string | null;
|
|
35
|
+
/**
|
|
36
|
+
* Reply body
|
|
37
|
+
*
|
|
38
|
+
* the message body (Communications - SmsMessage)
|
|
39
|
+
* @type {TEXT_LONG}
|
|
40
|
+
*/
|
|
41
|
+
Body?: string | null;
|
|
42
|
+
/**
|
|
43
|
+
* Feedback rating
|
|
44
|
+
*
|
|
45
|
+
* Feedback rating is used for survey messages (Communications - SmsMessage)
|
|
46
|
+
* @type {TEXT}
|
|
47
|
+
*/
|
|
48
|
+
FeedbackRating?: string | null;
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* RecordSmsSurveyRating
|
|
52
|
+
*
|
|
53
|
+
* Records a customer's SMS reply to a CSAT survey, storing the reply body and the rating derived from it. Feeds satisfaction reporting. Distinct from RecordSmsAppointmentConfirmation (which decides whether a visit goes ahead) and from UpdateSmsDeliveryStatus (which is a carrier callback, not a customer reply).
|
|
54
|
+
*
|
|
55
|
+
* @actionType UPDATE - Updates an existing SmsMessage record
|
|
56
|
+
* @module NotificationModule
|
|
57
|
+
* @entity SmsMessage
|
|
58
|
+
* @event k1.t-hEOJjsDb.NotificationModule.SmsMessage.Update.RecordSmsSurveyRating
|
|
59
|
+
* @permission schema.action.recordsmssurveyrating.trigger
|
|
60
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
61
|
+
*/
|
|
62
|
+
export declare class RecordSmsSurveyRatingDto extends OdinRecordUpdateDto<RecordSmsSurveyRatingProperties> {
|
|
63
|
+
/** Used by SDK generators to identify action type */
|
|
64
|
+
static readonly ACTION_TYPE = "UPDATE";
|
|
65
|
+
static readonly ACTION_KEY = "RecordSmsSurveyRating";
|
|
66
|
+
static readonly MODULE_NAME = "NotificationModule";
|
|
67
|
+
static readonly ENTITIES: string[];
|
|
68
|
+
static readonly EVENT_NAME = "k1.t-hEOJjsDb.NotificationModule.SmsMessage.Update.RecordSmsSurveyRating";
|
|
69
|
+
static readonly PERMISSION = "schema.action.recordsmssurveyrating.trigger";
|
|
70
|
+
/** Step metadata - entity this action targets */
|
|
71
|
+
static readonly STEP_ENTITY = "NotificationModule:SmsMessage";
|
|
72
|
+
static readonly STEP_SCHEMA_ID = "de8aa864-5a08-45c7-b3d6-00f1e8cfa276";
|
|
73
|
+
static readonly STEP_SCHEMA_ACTION_ID = "ee92c419-2434-470d-a83c-fac4c5047267";
|
|
74
|
+
static readonly AUTO_LINK_PARENT = false;
|
|
75
|
+
readonly actionName: string;
|
|
76
|
+
readonly schemaActionId: string;
|
|
77
|
+
readonly entity: string;
|
|
78
|
+
constructor(record: OdinRecord<any> | {
|
|
79
|
+
id: string;
|
|
80
|
+
entity: string;
|
|
81
|
+
type?: string;
|
|
82
|
+
}, properties: RecordSmsSurveyRatingProperties, options?: {
|
|
83
|
+
journeyId?: string;
|
|
84
|
+
stageKey?: string;
|
|
85
|
+
});
|
|
86
|
+
}
|