@d19n/youfibre-odin-sdk 2.0.76 → 2.0.78
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 +10 -1
- package/dist/EntityRegistry.d.ts +2 -0
- package/dist/EntityRegistry.js +2 -0
- package/dist/OdinApiClient.d.ts +4 -0
- package/dist/OdinApiClient.js +8 -0
- package/dist/OdinDbClient.d.ts +4 -0
- package/dist/OdinDbClient.js +8 -0
- package/dist/accessors-v2/RegionAccessor.d.ts +111 -0
- package/dist/accessors-v2/RegionAccessor.js +190 -0
- package/dist/accessors-v2/index.d.ts +1 -0
- package/dist/accessors-v2/index.js +4 -2
- package/dist/actions-v2/CaseCreateNoteDto.d.ts +7 -0
- package/dist/actions-v2/CreateActivityLogEntryDto.d.ts +8 -0
- package/dist/actions-v2/CreateAppointmentDto.d.ts +8 -0
- package/dist/actions-v2/CreateBillingRequestTransactionDto.d.ts +9 -0
- package/dist/actions-v2/CreateBundleProductActionDto.d.ts +8 -0
- package/dist/actions-v2/CreateInstallDto.d.ts +9 -10
- package/dist/actions-v2/CreateInternetProductActionDto.d.ts +8 -0
- package/dist/actions-v2/CreateLaborProductActionDto.d.ts +8 -0
- package/dist/actions-v2/CreateLandlineProductActionDto.d.ts +8 -0
- package/dist/actions-v2/CreateLeadDto.d.ts +8 -0
- package/dist/actions-v2/CreateLeadFromAddressDto.d.ts +8 -0
- package/dist/actions-v2/CreateMeshProductActionDto.d.ts +8 -0
- package/dist/actions-v2/CreateMessageDto.d.ts +8 -0
- package/dist/actions-v2/CreateMobileProductActionDto.d.ts +8 -0
- package/dist/actions-v2/CreateOtpTransactionDto.d.ts +9 -0
- package/dist/actions-v2/CreatePgContactDto.d.ts +1 -1
- package/dist/actions-v2/CreateRegionDto.d.ts +65 -0
- package/dist/actions-v2/CreateRegionDto.js +52 -0
- package/dist/actions-v2/CreateTelevisionProductActionDto.d.ts +8 -0
- package/dist/actions-v2/CreateTransactionalEmailDto.d.ts +14 -0
- package/dist/actions-v2/NewAppointmentDto.d.ts +8 -0
- package/dist/actions-v2/SendDirectDebitCreatedEmailDto.d.ts +114 -0
- package/dist/actions-v2/SendDirectDebitCreatedEmailDto.js +59 -0
- package/dist/actions-v2/SendDirectDebitSetupConfirmationEmailDto.d.ts +114 -0
- package/dist/actions-v2/SendDirectDebitSetupConfirmationEmailDto.js +59 -0
- package/dist/actions-v2/SendRefundTransactionEmailDto.d.ts +109 -0
- package/dist/actions-v2/SendRefundTransactionEmailDto.js +54 -0
- package/dist/actions-v2/SendTlosNinjaCaseEmailDto.d.ts +7 -0
- package/dist/actions-v2/TransactionCreateDto.d.ts +8 -0
- package/dist/actions-v2/UpdateBundleProductActionDto.d.ts +8 -0
- package/dist/actions-v2/UpdateEmailDto.d.ts +14 -0
- package/dist/actions-v2/UpdateInternetProductActionDto.d.ts +8 -0
- package/dist/actions-v2/UpdateLaborProductActionDto.d.ts +8 -0
- package/dist/actions-v2/UpdateLandlineProductActionDto.d.ts +8 -0
- package/dist/actions-v2/UpdateLeadDto.d.ts +8 -0
- package/dist/actions-v2/UpdateMeshProductActionDto.d.ts +8 -0
- package/dist/actions-v2/UpdateMobileProductActionDto.d.ts +8 -0
- package/dist/actions-v2/UpdatePgContactDto.d.ts +1 -1
- package/dist/actions-v2/UpdateServiceDto.d.ts +8 -0
- package/dist/actions-v2/UpdateSupportEmailDto.d.ts +7 -0
- package/dist/actions-v2/UpdateTelevisionProductActionDto.d.ts +8 -0
- package/dist/api-sdk-v2/TeamApi.d.ts +2 -2
- package/dist/api-sdk-v2/TeamApi.js +6 -6
- package/dist/api-sdk-v2/UserApi.d.ts +4 -4
- package/dist/api-sdk-v2/UserApi.js +12 -12
- package/dist/db-accessors-v2/RegionDbAccessor.d.ts +149 -0
- package/dist/db-accessors-v2/RegionDbAccessor.js +227 -0
- package/dist/db-accessors-v2/index.d.ts +1 -0
- package/dist/db-accessors-v2/index.js +4 -2
- package/dist/db-sdk-v2/TeamDb.d.ts +2 -2
- package/dist/db-sdk-v2/TeamDb.js +6 -6
- package/dist/db-sdk-v2/UserDb.d.ts +4 -4
- package/dist/db-sdk-v2/UserDb.js +12 -12
- package/dist/entities-v2/Account.d.ts +60 -1
- package/dist/entities-v2/Account.js +20 -2
- package/dist/entities-v2/ActivityLog.d.ts +26 -1
- package/dist/entities-v2/ActivityLog.js +21 -1
- package/dist/entities-v2/Address.d.ts +23 -1
- package/dist/entities-v2/Address.js +17 -1
- package/dist/entities-v2/Appointment.d.ts +22 -1
- package/dist/entities-v2/Appointment.js +17 -1
- package/dist/entities-v2/Call.d.ts +15 -1
- package/dist/entities-v2/Call.js +4 -0
- package/dist/entities-v2/ConsumptionSchedule.d.ts +23 -1
- package/dist/entities-v2/ConsumptionSchedule.js +17 -1
- package/dist/entities-v2/Email.d.ts +45 -1
- package/dist/entities-v2/Email.js +4 -0
- package/dist/entities-v2/InvoiceItem.d.ts +26 -1
- package/dist/entities-v2/InvoiceItem.js +19 -1
- package/dist/entities-v2/KnowledgeArticle.d.ts +3 -1
- package/dist/entities-v2/KnowledgeArticle.js +2 -0
- package/dist/entities-v2/Lead.d.ts +31 -1
- package/dist/entities-v2/Lead.js +21 -1
- package/dist/entities-v2/Message.d.ts +23 -1
- package/dist/entities-v2/Message.js +2 -0
- package/dist/entities-v2/Milestone.d.ts +15 -1
- package/dist/entities-v2/Milestone.js +11 -1
- package/dist/entities-v2/Note.d.ts +8 -1
- package/dist/entities-v2/Note.js +2 -0
- package/dist/entities-v2/PaymentMethod.d.ts +43 -1
- package/dist/entities-v2/PaymentMethod.js +31 -1
- package/dist/entities-v2/PgContact.d.ts +8 -8
- package/dist/entities-v2/PgContact.js +2 -2
- package/dist/entities-v2/Product.d.ts +118 -1
- package/dist/entities-v2/Product.js +24 -2
- package/dist/entities-v2/ProductComponent.d.ts +27 -1
- package/dist/entities-v2/ProductComponent.js +21 -1
- package/dist/entities-v2/Program.d.ts +15 -1
- package/dist/entities-v2/Program.js +11 -1
- package/dist/entities-v2/Project.d.ts +15 -1
- package/dist/entities-v2/Project.js +11 -1
- package/dist/entities-v2/Restriction.d.ts +23 -1
- package/dist/entities-v2/Restriction.js +17 -1
- package/dist/entities-v2/Service.d.ts +22 -1
- package/dist/entities-v2/Service.js +17 -1
- package/dist/entities-v2/ServiceAppointment.d.ts +8 -1
- package/dist/entities-v2/ServiceAppointment.js +2 -0
- package/dist/entities-v2/ServiceVisitAudit.d.ts +13 -13
- package/dist/entities-v2/ServiceVisitAudit.js +2 -2
- package/dist/entities-v2/SmsMessage.d.ts +18 -1
- package/dist/entities-v2/SmsMessage.js +2 -0
- package/dist/entities-v2/Subtask.d.ts +15 -1
- package/dist/entities-v2/Subtask.js +11 -1
- package/dist/entities-v2/Task.d.ts +15 -1
- package/dist/entities-v2/Task.js +11 -1
- package/dist/entities-v2/Team.d.ts +3 -3
- package/dist/entities-v2/Transaction.d.ts +27 -1
- package/dist/entities-v2/Transaction.js +21 -1
- package/dist/entities-v2/User.d.ts +6 -6
- package/dist/entities-v2/Vendor.d.ts +22 -1
- package/dist/entities-v2/Vendor.js +17 -1
- package/dist/entities-v2/WorkOrder.d.ts +99 -1
- package/dist/entities-v2/WorkOrder.js +2 -0
- package/dist/entities-v2/YfStockCount.d.ts +9 -1
- package/dist/entities-v2/YfStockCount.js +8 -0
- package/dist/records-v2/EmailRecord.d.ts +87 -0
- package/dist/records-v2/EmailRecord.js +108 -0
- package/dist/records-v2/ExchangeRecord.d.ts +20 -0
- package/dist/records-v2/ExchangeRecord.js +33 -0
- package/dist/records-v2/RegionRecord.d.ts +205 -0
- package/dist/records-v2/RegionRecord.js +292 -0
- package/dist/records-v2/ServiceAppointmentConfigRecord.d.ts +20 -0
- package/dist/records-v2/ServiceAppointmentConfigRecord.js +33 -0
- package/dist/records-v2/TeamRecord.d.ts +20 -20
- package/dist/records-v2/TeamRecord.js +33 -33
- package/dist/records-v2/UserRecord.d.ts +40 -40
- package/dist/records-v2/UserRecord.js +66 -66
- package/dist/records-v2/index.d.ts +1 -0
- package/dist/records-v2/index.js +5 -2
- package/package.json +2 -2
|
@@ -34,6 +34,14 @@ export interface CreateLandlineProductActionProperties {
|
|
|
34
34
|
* @required
|
|
35
35
|
*/
|
|
36
36
|
Category: string;
|
|
37
|
+
/**
|
|
38
|
+
* Type
|
|
39
|
+
*
|
|
40
|
+
* type of product (Product Management - Product)
|
|
41
|
+
* @type {ENUM}
|
|
42
|
+
* @required
|
|
43
|
+
*/
|
|
44
|
+
Type: string;
|
|
37
45
|
/**
|
|
38
46
|
* CustomerType
|
|
39
47
|
*
|
|
@@ -34,6 +34,14 @@ export interface CreateMeshProductActionProperties {
|
|
|
34
34
|
* @required
|
|
35
35
|
*/
|
|
36
36
|
Category: string;
|
|
37
|
+
/**
|
|
38
|
+
* Type
|
|
39
|
+
*
|
|
40
|
+
* type of product (Product Management - Product)
|
|
41
|
+
* @type {ENUM}
|
|
42
|
+
* @required
|
|
43
|
+
*/
|
|
44
|
+
Type: string;
|
|
37
45
|
/**
|
|
38
46
|
* CustomerType
|
|
39
47
|
*
|
|
@@ -26,6 +26,14 @@ export interface CreateMobileProductActionMessage extends OdinRecordCreatedEvent
|
|
|
26
26
|
* @property Optional fields: 25
|
|
27
27
|
*/
|
|
28
28
|
export interface CreateMobileProductActionProperties {
|
|
29
|
+
/**
|
|
30
|
+
* Type
|
|
31
|
+
*
|
|
32
|
+
* type of product (Product Management - Product)
|
|
33
|
+
* @type {ENUM}
|
|
34
|
+
* @required
|
|
35
|
+
*/
|
|
36
|
+
Type: string;
|
|
29
37
|
/**
|
|
30
38
|
* CustomerType
|
|
31
39
|
*
|
|
@@ -51,6 +51,15 @@ export interface CreateOtpTransactionProperties {
|
|
|
51
51
|
* @default GBP
|
|
52
52
|
*/
|
|
53
53
|
CurrencyCode: string;
|
|
54
|
+
/**
|
|
55
|
+
* Type
|
|
56
|
+
*
|
|
57
|
+
* type of transaction (Finance - Transaction)
|
|
58
|
+
* @type {ENUM}
|
|
59
|
+
* @required
|
|
60
|
+
* @default OTP
|
|
61
|
+
*/
|
|
62
|
+
Type: string;
|
|
54
63
|
/**
|
|
55
64
|
* External Reference
|
|
56
65
|
*
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* CreateRegion Action DTO
|
|
3
|
+
*
|
|
4
|
+
* CreateRegion
|
|
5
|
+
*
|
|
6
|
+
* @module ProjectModule
|
|
7
|
+
* @entity Region
|
|
8
|
+
* @actionKey CreateRegion
|
|
9
|
+
* @event k1.t-hEOJjsDb.ProjectModule.Region.Create.CreateRegion
|
|
10
|
+
*
|
|
11
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
12
|
+
*/
|
|
13
|
+
import { OdinRecordCreateDto, OdinRecordCreatedEvent } from '@d19n/odin-types/dist/core';
|
|
14
|
+
/**
|
|
15
|
+
* RabbitMQ message payload for CreateRegion created events
|
|
16
|
+
*
|
|
17
|
+
* @event k1.t-hEOJjsDb.ProjectModule.Region.Create.CreateRegion
|
|
18
|
+
*/
|
|
19
|
+
export interface CreateRegionMessage extends OdinRecordCreatedEvent<CreateRegionDto, CreateRegionProperties> {
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Properties for CreateRegion action
|
|
23
|
+
*
|
|
24
|
+
* @property Required fields: 0
|
|
25
|
+
* @property Optional fields: 1
|
|
26
|
+
*/
|
|
27
|
+
export interface CreateRegionProperties {
|
|
28
|
+
/**
|
|
29
|
+
* name
|
|
30
|
+
*
|
|
31
|
+
* name of the region
|
|
32
|
+
* @type {TEXT}
|
|
33
|
+
*/
|
|
34
|
+
Name?: string | null;
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* CreateRegion
|
|
38
|
+
*
|
|
39
|
+
* @actionType CREATE - Creates a new Region record
|
|
40
|
+
* @module ProjectModule
|
|
41
|
+
* @entity Region
|
|
42
|
+
* @event k1.t-hEOJjsDb.ProjectModule.Region.Create.CreateRegion
|
|
43
|
+
* @permission schema.action.createregion.trigger
|
|
44
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
45
|
+
*/
|
|
46
|
+
export declare class CreateRegionDto extends OdinRecordCreateDto<CreateRegionProperties> {
|
|
47
|
+
/** Used by SDK generators to identify action type */
|
|
48
|
+
static readonly ACTION_TYPE = "CREATE";
|
|
49
|
+
static readonly ACTION_KEY = "CreateRegion";
|
|
50
|
+
static readonly MODULE_NAME = "ProjectModule";
|
|
51
|
+
static readonly ENTITIES: string[];
|
|
52
|
+
static readonly EVENT_NAME = "k1.t-hEOJjsDb.ProjectModule.Region.Create.CreateRegion";
|
|
53
|
+
static readonly PERMISSION = "schema.action.createregion.trigger";
|
|
54
|
+
/** Step metadata - entity this action targets */
|
|
55
|
+
static readonly STEP_ENTITY = "ProjectModule:Region";
|
|
56
|
+
static readonly STEP_SCHEMA_ID = "5cb5809a-a3a9-4753-879c-85d6cc6043c3";
|
|
57
|
+
static readonly STEP_SCHEMA_ACTION_ID = "4a28aa89-4083-4d04-a630-1c243365643d";
|
|
58
|
+
static readonly AUTO_LINK_PARENT = true;
|
|
59
|
+
readonly actionName: string;
|
|
60
|
+
readonly schemaActionId: string;
|
|
61
|
+
readonly entity: string;
|
|
62
|
+
constructor(properties: CreateRegionProperties, options?: {
|
|
63
|
+
journeyId?: string;
|
|
64
|
+
});
|
|
65
|
+
}
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* CreateRegion Action DTO
|
|
4
|
+
*
|
|
5
|
+
* CreateRegion
|
|
6
|
+
*
|
|
7
|
+
* @module ProjectModule
|
|
8
|
+
* @entity Region
|
|
9
|
+
* @actionKey CreateRegion
|
|
10
|
+
* @event k1.t-hEOJjsDb.ProjectModule.Region.Create.CreateRegion
|
|
11
|
+
*
|
|
12
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
13
|
+
*/
|
|
14
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
|
+
exports.CreateRegionDto = void 0;
|
|
16
|
+
const core_1 = require("@d19n/odin-types/dist/core");
|
|
17
|
+
/**
|
|
18
|
+
* CreateRegion
|
|
19
|
+
*
|
|
20
|
+
* @actionType CREATE - Creates a new Region record
|
|
21
|
+
* @module ProjectModule
|
|
22
|
+
* @entity Region
|
|
23
|
+
* @event k1.t-hEOJjsDb.ProjectModule.Region.Create.CreateRegion
|
|
24
|
+
* @permission schema.action.createregion.trigger
|
|
25
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
26
|
+
*/
|
|
27
|
+
class CreateRegionDto extends core_1.OdinRecordCreateDto {
|
|
28
|
+
constructor(properties, options) {
|
|
29
|
+
super({
|
|
30
|
+
entity: 'ProjectModule:Region',
|
|
31
|
+
type: undefined,
|
|
32
|
+
properties,
|
|
33
|
+
journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
|
|
34
|
+
});
|
|
35
|
+
this.actionName = 'CreateRegion';
|
|
36
|
+
this.schemaActionId = '4a28aa89-4083-4d04-a630-1c243365643d';
|
|
37
|
+
this.entity = 'ProjectModule:Region';
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
exports.CreateRegionDto = CreateRegionDto;
|
|
41
|
+
/** Used by SDK generators to identify action type */
|
|
42
|
+
CreateRegionDto.ACTION_TYPE = 'CREATE';
|
|
43
|
+
CreateRegionDto.ACTION_KEY = 'CreateRegion';
|
|
44
|
+
CreateRegionDto.MODULE_NAME = 'ProjectModule';
|
|
45
|
+
CreateRegionDto.ENTITIES = ['Region'];
|
|
46
|
+
CreateRegionDto.EVENT_NAME = 'k1.t-hEOJjsDb.ProjectModule.Region.Create.CreateRegion';
|
|
47
|
+
CreateRegionDto.PERMISSION = 'schema.action.createregion.trigger';
|
|
48
|
+
/** Step metadata - entity this action targets */
|
|
49
|
+
CreateRegionDto.STEP_ENTITY = 'ProjectModule:Region';
|
|
50
|
+
CreateRegionDto.STEP_SCHEMA_ID = '5cb5809a-a3a9-4753-879c-85d6cc6043c3';
|
|
51
|
+
CreateRegionDto.STEP_SCHEMA_ACTION_ID = '4a28aa89-4083-4d04-a630-1c243365643d';
|
|
52
|
+
CreateRegionDto.AUTO_LINK_PARENT = true;
|
|
@@ -34,6 +34,14 @@ export interface CreateTelevisionProductActionProperties {
|
|
|
34
34
|
* @required
|
|
35
35
|
*/
|
|
36
36
|
Category: string;
|
|
37
|
+
/**
|
|
38
|
+
* Type
|
|
39
|
+
*
|
|
40
|
+
* type of product (Product Management - Product)
|
|
41
|
+
* @type {ENUM}
|
|
42
|
+
* @required
|
|
43
|
+
*/
|
|
44
|
+
Type: string;
|
|
37
45
|
/**
|
|
38
46
|
* CustomerType
|
|
39
47
|
*
|
|
@@ -97,6 +97,13 @@ export interface CreateTransactionalEmailProperties {
|
|
|
97
97
|
* @type {TEXT}
|
|
98
98
|
*/
|
|
99
99
|
Message?: string | null;
|
|
100
|
+
/**
|
|
101
|
+
* From
|
|
102
|
+
*
|
|
103
|
+
* Data field for Email records. Used by Communications team.
|
|
104
|
+
* @type {TEXT}
|
|
105
|
+
*/
|
|
106
|
+
From?: string | null;
|
|
100
107
|
/**
|
|
101
108
|
* Files
|
|
102
109
|
*
|
|
@@ -132,6 +139,13 @@ export interface CreateTransactionalEmailProperties {
|
|
|
132
139
|
* @type {ENUM}
|
|
133
140
|
*/
|
|
134
141
|
SenderType?: string | null;
|
|
142
|
+
/**
|
|
143
|
+
* Case
|
|
144
|
+
*
|
|
145
|
+
* Data field for Email records. Used by Communications team.
|
|
146
|
+
* @type {LOOKUP}
|
|
147
|
+
*/
|
|
148
|
+
Case?: string | null;
|
|
135
149
|
/**
|
|
136
150
|
* Status
|
|
137
151
|
*
|
|
@@ -33,6 +33,14 @@ export interface NewAppointmentProperties {
|
|
|
33
33
|
* @required
|
|
34
34
|
*/
|
|
35
35
|
ExPolygonId: number;
|
|
36
|
+
/**
|
|
37
|
+
* Type
|
|
38
|
+
*
|
|
39
|
+
* the type of appointment (Field Operations - ServiceAppointment)
|
|
40
|
+
* @type {TEXT}
|
|
41
|
+
* @required
|
|
42
|
+
*/
|
|
43
|
+
Type: string;
|
|
36
44
|
/**
|
|
37
45
|
* ScheduleId
|
|
38
46
|
*
|
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* SendDirectDebitCreatedEmail Action DTO
|
|
3
|
+
*
|
|
4
|
+
* Send email when PG Payment Method is Created
|
|
5
|
+
*
|
|
6
|
+
* @module NotificationModule
|
|
7
|
+
* @entity Email
|
|
8
|
+
* @entityType TRANSACTIONAL
|
|
9
|
+
* @actionKey SendDirectDebitCreatedEmail
|
|
10
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Email.Create.SendDirectDebitCreatedEmail
|
|
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 SendDirectDebitCreatedEmail created events
|
|
17
|
+
*
|
|
18
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Email.Create.SendDirectDebitCreatedEmail
|
|
19
|
+
*/
|
|
20
|
+
export interface SendDirectDebitCreatedEmailMessage extends OdinRecordCreatedEvent<SendDirectDebitCreatedEmailDto, SendDirectDebitCreatedEmailProperties> {
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Properties for SendDirectDebitCreatedEmail action
|
|
24
|
+
*
|
|
25
|
+
* @property Required fields: 0
|
|
26
|
+
* @property Optional fields: 7
|
|
27
|
+
*/
|
|
28
|
+
export interface SendDirectDebitCreatedEmailProperties {
|
|
29
|
+
/**
|
|
30
|
+
* Date
|
|
31
|
+
*
|
|
32
|
+
* Date field for Email records. Used by Communications team.
|
|
33
|
+
* @type {DATE_TIME}
|
|
34
|
+
*/
|
|
35
|
+
Date?: string | null;
|
|
36
|
+
/**
|
|
37
|
+
* EmailingService
|
|
38
|
+
*
|
|
39
|
+
* The provider we use to send email (eg. Sendgrid)
|
|
40
|
+
* @type {ENUM}
|
|
41
|
+
*/
|
|
42
|
+
EmailingService?: string | null;
|
|
43
|
+
/**
|
|
44
|
+
* ContactId
|
|
45
|
+
*
|
|
46
|
+
* The related Contact to send the email
|
|
47
|
+
* @type {LOOKUP}
|
|
48
|
+
*/
|
|
49
|
+
ContactId?: string | null;
|
|
50
|
+
/**
|
|
51
|
+
* TemplateLabel
|
|
52
|
+
*
|
|
53
|
+
* The template label from email templates engine
|
|
54
|
+
* @type {TEXT}
|
|
55
|
+
*/
|
|
56
|
+
TemplateLabel?: string | null;
|
|
57
|
+
/**
|
|
58
|
+
* MessageId
|
|
59
|
+
*
|
|
60
|
+
* SMTP Message Id (Communications - Email)
|
|
61
|
+
* @type {TEXT}
|
|
62
|
+
*/
|
|
63
|
+
MessageId?: string | null;
|
|
64
|
+
/**
|
|
65
|
+
* EmailSenderId
|
|
66
|
+
*
|
|
67
|
+
* The Email Sender related entity
|
|
68
|
+
* @type {LOOKUP}
|
|
69
|
+
*/
|
|
70
|
+
EmailSenderId?: string | null;
|
|
71
|
+
/**
|
|
72
|
+
* DynamicData
|
|
73
|
+
*
|
|
74
|
+
* Data will pass to emailing service (variables)
|
|
75
|
+
* @type {JSON}
|
|
76
|
+
*/
|
|
77
|
+
DynamicData?: string | null;
|
|
78
|
+
}
|
|
79
|
+
/**
|
|
80
|
+
* SendDirectDebitCreatedEmail
|
|
81
|
+
*
|
|
82
|
+
* Send email when PG Payment Method is Created
|
|
83
|
+
*
|
|
84
|
+
* @actionType CREATE - Creates a new Email record
|
|
85
|
+
* @module NotificationModule
|
|
86
|
+
* @entity Email
|
|
87
|
+
* @entityType TRANSACTIONAL (TRANSACTIONAL)
|
|
88
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Email.Create.SendDirectDebitCreatedEmail
|
|
89
|
+
* @permission schema.action.senddirectdebitcreatedemail.trigger
|
|
90
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
91
|
+
*/
|
|
92
|
+
export declare class SendDirectDebitCreatedEmailDto extends OdinRecordCreateDto<SendDirectDebitCreatedEmailProperties> {
|
|
93
|
+
/** Used by SDK generators to identify action type */
|
|
94
|
+
static readonly ACTION_TYPE = "CREATE";
|
|
95
|
+
static readonly ACTION_KEY = "SendDirectDebitCreatedEmail";
|
|
96
|
+
static readonly MODULE_NAME = "NotificationModule";
|
|
97
|
+
static readonly ENTITIES: string[];
|
|
98
|
+
static readonly ENTITY_TYPE = "TRANSACTIONAL";
|
|
99
|
+
static readonly EVENT_NAME = "k1.t-hEOJjsDb.NotificationModule.Email.Create.SendDirectDebitCreatedEmail";
|
|
100
|
+
static readonly PERMISSION = "schema.action.senddirectdebitcreatedemail.trigger";
|
|
101
|
+
/** Step metadata - entity this action targets */
|
|
102
|
+
static readonly STEP_ENTITY = "NotificationModule:Email";
|
|
103
|
+
static readonly STEP_SCHEMA_ID = "cb37958c-d72f-44aa-975a-a8fae42b1b72";
|
|
104
|
+
static readonly STEP_SCHEMA_ACTION_ID = "435b867a-891d-4a17-8af0-8b78755ccff6";
|
|
105
|
+
static readonly STEP_SCHEMA_TYPE_ID = "14042940-a388-44c7-87fe-3a4105d92e94";
|
|
106
|
+
static readonly STEP_TYPE = "TRANSACTIONAL";
|
|
107
|
+
static readonly AUTO_LINK_PARENT = true;
|
|
108
|
+
readonly actionName: string;
|
|
109
|
+
readonly schemaActionId: string;
|
|
110
|
+
readonly entity: string;
|
|
111
|
+
constructor(properties: SendDirectDebitCreatedEmailProperties, options?: {
|
|
112
|
+
journeyId?: string;
|
|
113
|
+
});
|
|
114
|
+
}
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* SendDirectDebitCreatedEmail Action DTO
|
|
4
|
+
*
|
|
5
|
+
* Send email when PG Payment Method is Created
|
|
6
|
+
*
|
|
7
|
+
* @module NotificationModule
|
|
8
|
+
* @entity Email
|
|
9
|
+
* @entityType TRANSACTIONAL
|
|
10
|
+
* @actionKey SendDirectDebitCreatedEmail
|
|
11
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Email.Create.SendDirectDebitCreatedEmail
|
|
12
|
+
*
|
|
13
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.SendDirectDebitCreatedEmailDto = void 0;
|
|
17
|
+
const core_1 = require("@d19n/odin-types/dist/core");
|
|
18
|
+
/**
|
|
19
|
+
* SendDirectDebitCreatedEmail
|
|
20
|
+
*
|
|
21
|
+
* Send email when PG Payment Method is Created
|
|
22
|
+
*
|
|
23
|
+
* @actionType CREATE - Creates a new Email record
|
|
24
|
+
* @module NotificationModule
|
|
25
|
+
* @entity Email
|
|
26
|
+
* @entityType TRANSACTIONAL (TRANSACTIONAL)
|
|
27
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Email.Create.SendDirectDebitCreatedEmail
|
|
28
|
+
* @permission schema.action.senddirectdebitcreatedemail.trigger
|
|
29
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
30
|
+
*/
|
|
31
|
+
class SendDirectDebitCreatedEmailDto 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 = 'SendDirectDebitCreatedEmail';
|
|
40
|
+
this.schemaActionId = '435b867a-891d-4a17-8af0-8b78755ccff6';
|
|
41
|
+
this.entity = 'NotificationModule:Email';
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
exports.SendDirectDebitCreatedEmailDto = SendDirectDebitCreatedEmailDto;
|
|
45
|
+
/** Used by SDK generators to identify action type */
|
|
46
|
+
SendDirectDebitCreatedEmailDto.ACTION_TYPE = 'CREATE';
|
|
47
|
+
SendDirectDebitCreatedEmailDto.ACTION_KEY = 'SendDirectDebitCreatedEmail';
|
|
48
|
+
SendDirectDebitCreatedEmailDto.MODULE_NAME = 'NotificationModule';
|
|
49
|
+
SendDirectDebitCreatedEmailDto.ENTITIES = ['Email'];
|
|
50
|
+
SendDirectDebitCreatedEmailDto.ENTITY_TYPE = 'TRANSACTIONAL';
|
|
51
|
+
SendDirectDebitCreatedEmailDto.EVENT_NAME = 'k1.t-hEOJjsDb.NotificationModule.Email.Create.SendDirectDebitCreatedEmail';
|
|
52
|
+
SendDirectDebitCreatedEmailDto.PERMISSION = 'schema.action.senddirectdebitcreatedemail.trigger';
|
|
53
|
+
/** Step metadata - entity this action targets */
|
|
54
|
+
SendDirectDebitCreatedEmailDto.STEP_ENTITY = 'NotificationModule:Email';
|
|
55
|
+
SendDirectDebitCreatedEmailDto.STEP_SCHEMA_ID = 'cb37958c-d72f-44aa-975a-a8fae42b1b72';
|
|
56
|
+
SendDirectDebitCreatedEmailDto.STEP_SCHEMA_ACTION_ID = '435b867a-891d-4a17-8af0-8b78755ccff6';
|
|
57
|
+
SendDirectDebitCreatedEmailDto.STEP_SCHEMA_TYPE_ID = '14042940-a388-44c7-87fe-3a4105d92e94';
|
|
58
|
+
SendDirectDebitCreatedEmailDto.STEP_TYPE = 'TRANSACTIONAL';
|
|
59
|
+
SendDirectDebitCreatedEmailDto.AUTO_LINK_PARENT = true;
|
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* SendDirectDebitSetupConfirmationEmail Action DTO
|
|
3
|
+
*
|
|
4
|
+
* trigger email to send dd setup confirmation
|
|
5
|
+
*
|
|
6
|
+
* @module NotificationModule
|
|
7
|
+
* @entity Email
|
|
8
|
+
* @entityType TRANSACTIONAL
|
|
9
|
+
* @actionKey SendDirectDebitSetupConfirmationEmail
|
|
10
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Email.Create.SendDirectDebitSetupConfirmationEmail
|
|
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 SendDirectDebitSetupConfirmationEmail created events
|
|
17
|
+
*
|
|
18
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Email.Create.SendDirectDebitSetupConfirmationEmail
|
|
19
|
+
*/
|
|
20
|
+
export interface SendDirectDebitSetupConfirmationEmailMessage extends OdinRecordCreatedEvent<SendDirectDebitSetupConfirmationEmailDto, SendDirectDebitSetupConfirmationEmailProperties> {
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Properties for SendDirectDebitSetupConfirmationEmail action
|
|
24
|
+
*
|
|
25
|
+
* @property Required fields: 0
|
|
26
|
+
* @property Optional fields: 7
|
|
27
|
+
*/
|
|
28
|
+
export interface SendDirectDebitSetupConfirmationEmailProperties {
|
|
29
|
+
/**
|
|
30
|
+
* Date
|
|
31
|
+
*
|
|
32
|
+
* Date field for Email records. Used by Communications team.
|
|
33
|
+
* @type {DATE_TIME}
|
|
34
|
+
*/
|
|
35
|
+
Date?: string | null;
|
|
36
|
+
/**
|
|
37
|
+
* EmailingService
|
|
38
|
+
*
|
|
39
|
+
* The provider we use to send email (eg. Sendgrid)
|
|
40
|
+
* @type {ENUM}
|
|
41
|
+
*/
|
|
42
|
+
EmailingService?: string | null;
|
|
43
|
+
/**
|
|
44
|
+
* ContactId
|
|
45
|
+
*
|
|
46
|
+
* The related Contact to send the email
|
|
47
|
+
* @type {LOOKUP}
|
|
48
|
+
*/
|
|
49
|
+
ContactId?: string | null;
|
|
50
|
+
/**
|
|
51
|
+
* TemplateLabel
|
|
52
|
+
*
|
|
53
|
+
* The template label from email templates engine
|
|
54
|
+
* @type {TEXT}
|
|
55
|
+
*/
|
|
56
|
+
TemplateLabel?: string | null;
|
|
57
|
+
/**
|
|
58
|
+
* MessageId
|
|
59
|
+
*
|
|
60
|
+
* SMTP Message Id (Communications - Email)
|
|
61
|
+
* @type {TEXT}
|
|
62
|
+
*/
|
|
63
|
+
MessageId?: string | null;
|
|
64
|
+
/**
|
|
65
|
+
* EmailSenderId
|
|
66
|
+
*
|
|
67
|
+
* The Email Sender related entity
|
|
68
|
+
* @type {LOOKUP}
|
|
69
|
+
*/
|
|
70
|
+
EmailSenderId?: string | null;
|
|
71
|
+
/**
|
|
72
|
+
* DynamicData
|
|
73
|
+
*
|
|
74
|
+
* Data will pass to emailing service (variables)
|
|
75
|
+
* @type {JSON}
|
|
76
|
+
*/
|
|
77
|
+
DynamicData?: string | null;
|
|
78
|
+
}
|
|
79
|
+
/**
|
|
80
|
+
* SendDirectDebitSetupConfirmationEmail
|
|
81
|
+
*
|
|
82
|
+
* trigger email to send dd setup confirmation
|
|
83
|
+
*
|
|
84
|
+
* @actionType CREATE - Creates a new Email record
|
|
85
|
+
* @module NotificationModule
|
|
86
|
+
* @entity Email
|
|
87
|
+
* @entityType TRANSACTIONAL (TRANSACTIONAL)
|
|
88
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Email.Create.SendDirectDebitSetupConfirmationEmail
|
|
89
|
+
* @permission schema.action.senddirectdebitsetupconfirmationemail.trigger
|
|
90
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
91
|
+
*/
|
|
92
|
+
export declare class SendDirectDebitSetupConfirmationEmailDto extends OdinRecordCreateDto<SendDirectDebitSetupConfirmationEmailProperties> {
|
|
93
|
+
/** Used by SDK generators to identify action type */
|
|
94
|
+
static readonly ACTION_TYPE = "CREATE";
|
|
95
|
+
static readonly ACTION_KEY = "SendDirectDebitSetupConfirmationEmail";
|
|
96
|
+
static readonly MODULE_NAME = "NotificationModule";
|
|
97
|
+
static readonly ENTITIES: string[];
|
|
98
|
+
static readonly ENTITY_TYPE = "TRANSACTIONAL";
|
|
99
|
+
static readonly EVENT_NAME = "k1.t-hEOJjsDb.NotificationModule.Email.Create.SendDirectDebitSetupConfirmationEmail";
|
|
100
|
+
static readonly PERMISSION = "schema.action.senddirectdebitsetupconfirmationemail.trigger";
|
|
101
|
+
/** Step metadata - entity this action targets */
|
|
102
|
+
static readonly STEP_ENTITY = "NotificationModule:Email";
|
|
103
|
+
static readonly STEP_SCHEMA_ID = "cb37958c-d72f-44aa-975a-a8fae42b1b72";
|
|
104
|
+
static readonly STEP_SCHEMA_ACTION_ID = "34a1eaea-75a7-423c-ad92-8ab476e31f2f";
|
|
105
|
+
static readonly STEP_SCHEMA_TYPE_ID = "14042940-a388-44c7-87fe-3a4105d92e94";
|
|
106
|
+
static readonly STEP_TYPE = "TRANSACTIONAL";
|
|
107
|
+
static readonly AUTO_LINK_PARENT = true;
|
|
108
|
+
readonly actionName: string;
|
|
109
|
+
readonly schemaActionId: string;
|
|
110
|
+
readonly entity: string;
|
|
111
|
+
constructor(properties: SendDirectDebitSetupConfirmationEmailProperties, options?: {
|
|
112
|
+
journeyId?: string;
|
|
113
|
+
});
|
|
114
|
+
}
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* SendDirectDebitSetupConfirmationEmail Action DTO
|
|
4
|
+
*
|
|
5
|
+
* trigger email to send dd setup confirmation
|
|
6
|
+
*
|
|
7
|
+
* @module NotificationModule
|
|
8
|
+
* @entity Email
|
|
9
|
+
* @entityType TRANSACTIONAL
|
|
10
|
+
* @actionKey SendDirectDebitSetupConfirmationEmail
|
|
11
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Email.Create.SendDirectDebitSetupConfirmationEmail
|
|
12
|
+
*
|
|
13
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.SendDirectDebitSetupConfirmationEmailDto = void 0;
|
|
17
|
+
const core_1 = require("@d19n/odin-types/dist/core");
|
|
18
|
+
/**
|
|
19
|
+
* SendDirectDebitSetupConfirmationEmail
|
|
20
|
+
*
|
|
21
|
+
* trigger email to send dd setup confirmation
|
|
22
|
+
*
|
|
23
|
+
* @actionType CREATE - Creates a new Email record
|
|
24
|
+
* @module NotificationModule
|
|
25
|
+
* @entity Email
|
|
26
|
+
* @entityType TRANSACTIONAL (TRANSACTIONAL)
|
|
27
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Email.Create.SendDirectDebitSetupConfirmationEmail
|
|
28
|
+
* @permission schema.action.senddirectdebitsetupconfirmationemail.trigger
|
|
29
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
30
|
+
*/
|
|
31
|
+
class SendDirectDebitSetupConfirmationEmailDto 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 = 'SendDirectDebitSetupConfirmationEmail';
|
|
40
|
+
this.schemaActionId = '34a1eaea-75a7-423c-ad92-8ab476e31f2f';
|
|
41
|
+
this.entity = 'NotificationModule:Email';
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
exports.SendDirectDebitSetupConfirmationEmailDto = SendDirectDebitSetupConfirmationEmailDto;
|
|
45
|
+
/** Used by SDK generators to identify action type */
|
|
46
|
+
SendDirectDebitSetupConfirmationEmailDto.ACTION_TYPE = 'CREATE';
|
|
47
|
+
SendDirectDebitSetupConfirmationEmailDto.ACTION_KEY = 'SendDirectDebitSetupConfirmationEmail';
|
|
48
|
+
SendDirectDebitSetupConfirmationEmailDto.MODULE_NAME = 'NotificationModule';
|
|
49
|
+
SendDirectDebitSetupConfirmationEmailDto.ENTITIES = ['Email'];
|
|
50
|
+
SendDirectDebitSetupConfirmationEmailDto.ENTITY_TYPE = 'TRANSACTIONAL';
|
|
51
|
+
SendDirectDebitSetupConfirmationEmailDto.EVENT_NAME = 'k1.t-hEOJjsDb.NotificationModule.Email.Create.SendDirectDebitSetupConfirmationEmail';
|
|
52
|
+
SendDirectDebitSetupConfirmationEmailDto.PERMISSION = 'schema.action.senddirectdebitsetupconfirmationemail.trigger';
|
|
53
|
+
/** Step metadata - entity this action targets */
|
|
54
|
+
SendDirectDebitSetupConfirmationEmailDto.STEP_ENTITY = 'NotificationModule:Email';
|
|
55
|
+
SendDirectDebitSetupConfirmationEmailDto.STEP_SCHEMA_ID = 'cb37958c-d72f-44aa-975a-a8fae42b1b72';
|
|
56
|
+
SendDirectDebitSetupConfirmationEmailDto.STEP_SCHEMA_ACTION_ID = '34a1eaea-75a7-423c-ad92-8ab476e31f2f';
|
|
57
|
+
SendDirectDebitSetupConfirmationEmailDto.STEP_SCHEMA_TYPE_ID = '14042940-a388-44c7-87fe-3a4105d92e94';
|
|
58
|
+
SendDirectDebitSetupConfirmationEmailDto.STEP_TYPE = 'TRANSACTIONAL';
|
|
59
|
+
SendDirectDebitSetupConfirmationEmailDto.AUTO_LINK_PARENT = true;
|