@d19n/youfibre-odin-sdk 2.0.293 → 2.0.294

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.
Files changed (37) hide show
  1. package/README.md +68 -61
  2. package/dist/actions-v2/CreateAmcoCollectionBookedEmailDto.d.ts +135 -0
  3. package/dist/actions-v2/CreateAmcoCollectionBookedEmailDto.js +59 -0
  4. package/dist/actions-v2/CreateAmcoCollectionChargeEmailDto.d.ts +135 -0
  5. package/dist/actions-v2/CreateAmcoCollectionChargeEmailDto.js +59 -0
  6. package/dist/actions-v2/CreateAmcoCollectionCompleteEmailDto.d.ts +135 -0
  7. package/dist/actions-v2/CreateAmcoCollectionCompleteEmailDto.js +59 -0
  8. package/dist/actions-v2/CreateAmcoCollectionReceivedEmailDto.d.ts +135 -0
  9. package/dist/actions-v2/CreateAmcoCollectionReceivedEmailDto.js +59 -0
  10. package/dist/actions-v2/CreateAmcoDispatchConfirmedEmailDto.d.ts +135 -0
  11. package/dist/actions-v2/CreateAmcoDispatchConfirmedEmailDto.js +59 -0
  12. package/dist/actions-v2/CreateAmcoDispatchDeliveredEmailDto.d.ts +135 -0
  13. package/dist/actions-v2/CreateAmcoDispatchDeliveredEmailDto.js +59 -0
  14. package/dist/actions-v2/CreateAmcoDispatchSentEmailDto.d.ts +135 -0
  15. package/dist/actions-v2/CreateAmcoDispatchSentEmailDto.js +59 -0
  16. package/dist/api-sdk-v2/ModifyServiceRequestApi.d.ts +2 -0
  17. package/dist/api-sdk-v2/ModifyServiceRequestApi.js +6 -0
  18. package/dist/api-sdk-v2/RecontractApi.d.ts +2 -0
  19. package/dist/api-sdk-v2/RecontractApi.js +6 -0
  20. package/dist/db-sdk-v2/ModifyServiceRequestDb.d.ts +2 -0
  21. package/dist/db-sdk-v2/ModifyServiceRequestDb.js +6 -0
  22. package/dist/db-sdk-v2/RecontractDb.d.ts +2 -0
  23. package/dist/db-sdk-v2/RecontractDb.js +6 -0
  24. package/dist/entities-v2/Contact.d.ts +8 -0
  25. package/dist/entities-v2/Contact.js +2 -0
  26. package/dist/entities-v2/ModifyServiceRequest.d.ts +3 -0
  27. package/dist/entities-v2/Recontract.d.ts +31 -0
  28. package/dist/entities-v2/Recontract.js +23 -1
  29. package/dist/records-v2/EmailRecord.d.ts +203 -0
  30. package/dist/records-v2/EmailRecord.js +252 -0
  31. package/dist/records-v2/ModifyServiceRequestRecord.d.ts +20 -0
  32. package/dist/records-v2/ModifyServiceRequestRecord.js +33 -0
  33. package/dist/records-v2/RecontractRecord.d.ts +20 -0
  34. package/dist/records-v2/RecontractRecord.js +33 -0
  35. package/dist/records-v2/index.d.ts +1 -1
  36. package/dist/records-v2/index.js +4 -4
  37. package/package.json +1 -1
@@ -0,0 +1,135 @@
1
+ /**
2
+ * CreateAmcoCollectionCompleteEmail Action DTO
3
+ *
4
+ * 3PL-C6. Confirms the return is complete and nothing further is owed, when the COLLECTION_AMCO work order reaches Complete.
5
+ *
6
+ * @module NotificationModule
7
+ * @entity Email
8
+ * @entityType TRANSACTIONAL
9
+ * @actionKey CreateAmcoCollectionCompleteEmail
10
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoCollectionCompleteEmail
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 CreateAmcoCollectionCompleteEmail created events
17
+ *
18
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoCollectionCompleteEmail
19
+ */
20
+ export interface CreateAmcoCollectionCompleteEmailMessage extends OdinRecordCreatedEvent<CreateAmcoCollectionCompleteEmailDto, CreateAmcoCollectionCompleteEmailProperties> {
21
+ }
22
+ /**
23
+ * Properties for CreateAmcoCollectionCompleteEmail action
24
+ *
25
+ * @property Required fields: 0
26
+ * @property Optional fields: 10
27
+ */
28
+ export interface CreateAmcoCollectionCompleteEmailProperties {
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
+ * Title
80
+ *
81
+ * Used for title
82
+ * @type {TEXT}
83
+ */
84
+ Title?: string | null;
85
+ /**
86
+ * Subject
87
+ *
88
+ * Data field for Email records. Used by Communications team.
89
+ * @type {TEXT}
90
+ */
91
+ Subject?: string | null;
92
+ /**
93
+ * To
94
+ *
95
+ * Data field for Email records. Used by Communications team.
96
+ * @type {TEXT}
97
+ */
98
+ To?: string | null;
99
+ }
100
+ /**
101
+ * CreateAmcoCollectionCompleteEmail
102
+ *
103
+ * 3PL-C6. Confirms the return is complete and nothing further is owed, when the COLLECTION_AMCO work order reaches Complete.
104
+ *
105
+ * @actionType CREATE - Creates a new Email record
106
+ * @module NotificationModule
107
+ * @entity Email
108
+ * @entityType TRANSACTIONAL (TRANSACTIONAL)
109
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoCollectionCompleteEmail
110
+ * @permission schema.action.createamcocollectioncompleteemail.trigger
111
+ * @benchmark This action is tracked for performance benchmarks
112
+ */
113
+ export declare class CreateAmcoCollectionCompleteEmailDto extends OdinRecordCreateDto<CreateAmcoCollectionCompleteEmailProperties> {
114
+ /** Used by SDK generators to identify action type */
115
+ static readonly ACTION_TYPE = "CREATE";
116
+ static readonly ACTION_KEY = "CreateAmcoCollectionCompleteEmail";
117
+ static readonly MODULE_NAME = "NotificationModule";
118
+ static readonly ENTITIES: string[];
119
+ static readonly ENTITY_TYPE = "TRANSACTIONAL";
120
+ static readonly EVENT_NAME = "k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoCollectionCompleteEmail";
121
+ static readonly PERMISSION = "schema.action.createamcocollectioncompleteemail.trigger";
122
+ /** Step metadata - entity this action targets */
123
+ static readonly STEP_ENTITY = "NotificationModule:Email";
124
+ static readonly STEP_SCHEMA_ID = "cb37958c-d72f-44aa-975a-a8fae42b1b72";
125
+ static readonly STEP_SCHEMA_ACTION_ID = "bd610d43-8088-4ed1-a854-06c6721b631a";
126
+ static readonly STEP_SCHEMA_TYPE_ID = "14042940-a388-44c7-87fe-3a4105d92e94";
127
+ static readonly STEP_TYPE = "TRANSACTIONAL";
128
+ static readonly AUTO_LINK_PARENT = true;
129
+ readonly actionName: string;
130
+ readonly schemaActionId: string;
131
+ readonly entity: string;
132
+ constructor(properties: CreateAmcoCollectionCompleteEmailProperties, options?: {
133
+ journeyId?: string;
134
+ });
135
+ }
@@ -0,0 +1,59 @@
1
+ "use strict";
2
+ /**
3
+ * CreateAmcoCollectionCompleteEmail Action DTO
4
+ *
5
+ * 3PL-C6. Confirms the return is complete and nothing further is owed, when the COLLECTION_AMCO work order reaches Complete.
6
+ *
7
+ * @module NotificationModule
8
+ * @entity Email
9
+ * @entityType TRANSACTIONAL
10
+ * @actionKey CreateAmcoCollectionCompleteEmail
11
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoCollectionCompleteEmail
12
+ *
13
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.CreateAmcoCollectionCompleteEmailDto = void 0;
17
+ const core_1 = require("@d19n/odin-types/dist/core");
18
+ /**
19
+ * CreateAmcoCollectionCompleteEmail
20
+ *
21
+ * 3PL-C6. Confirms the return is complete and nothing further is owed, when the COLLECTION_AMCO work order reaches Complete.
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.CreateAmcoCollectionCompleteEmail
28
+ * @permission schema.action.createamcocollectioncompleteemail.trigger
29
+ * @benchmark This action is tracked for performance benchmarks
30
+ */
31
+ class CreateAmcoCollectionCompleteEmailDto 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 = 'CreateAmcoCollectionCompleteEmail';
40
+ this.schemaActionId = 'bd610d43-8088-4ed1-a854-06c6721b631a';
41
+ this.entity = 'NotificationModule:Email';
42
+ }
43
+ }
44
+ exports.CreateAmcoCollectionCompleteEmailDto = CreateAmcoCollectionCompleteEmailDto;
45
+ /** Used by SDK generators to identify action type */
46
+ CreateAmcoCollectionCompleteEmailDto.ACTION_TYPE = 'CREATE';
47
+ CreateAmcoCollectionCompleteEmailDto.ACTION_KEY = 'CreateAmcoCollectionCompleteEmail';
48
+ CreateAmcoCollectionCompleteEmailDto.MODULE_NAME = 'NotificationModule';
49
+ CreateAmcoCollectionCompleteEmailDto.ENTITIES = ['Email'];
50
+ CreateAmcoCollectionCompleteEmailDto.ENTITY_TYPE = 'TRANSACTIONAL';
51
+ CreateAmcoCollectionCompleteEmailDto.EVENT_NAME = 'k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoCollectionCompleteEmail';
52
+ CreateAmcoCollectionCompleteEmailDto.PERMISSION = 'schema.action.createamcocollectioncompleteemail.trigger';
53
+ /** Step metadata - entity this action targets */
54
+ CreateAmcoCollectionCompleteEmailDto.STEP_ENTITY = 'NotificationModule:Email';
55
+ CreateAmcoCollectionCompleteEmailDto.STEP_SCHEMA_ID = 'cb37958c-d72f-44aa-975a-a8fae42b1b72';
56
+ CreateAmcoCollectionCompleteEmailDto.STEP_SCHEMA_ACTION_ID = 'bd610d43-8088-4ed1-a854-06c6721b631a';
57
+ CreateAmcoCollectionCompleteEmailDto.STEP_SCHEMA_TYPE_ID = '14042940-a388-44c7-87fe-3a4105d92e94';
58
+ CreateAmcoCollectionCompleteEmailDto.STEP_TYPE = 'TRANSACTIONAL';
59
+ CreateAmcoCollectionCompleteEmailDto.AUTO_LINK_PARENT = true;
@@ -0,0 +1,135 @@
1
+ /**
2
+ * CreateAmcoCollectionReceivedEmail Action DTO
3
+ *
4
+ * 3PL-C5. Confirms the returned equipment has arrived with the 3PL and is awaiting inspection, when the COLLECTION_AMCO work order reaches Pending Inspection.
5
+ *
6
+ * @module NotificationModule
7
+ * @entity Email
8
+ * @entityType TRANSACTIONAL
9
+ * @actionKey CreateAmcoCollectionReceivedEmail
10
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoCollectionReceivedEmail
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 CreateAmcoCollectionReceivedEmail created events
17
+ *
18
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoCollectionReceivedEmail
19
+ */
20
+ export interface CreateAmcoCollectionReceivedEmailMessage extends OdinRecordCreatedEvent<CreateAmcoCollectionReceivedEmailDto, CreateAmcoCollectionReceivedEmailProperties> {
21
+ }
22
+ /**
23
+ * Properties for CreateAmcoCollectionReceivedEmail action
24
+ *
25
+ * @property Required fields: 0
26
+ * @property Optional fields: 10
27
+ */
28
+ export interface CreateAmcoCollectionReceivedEmailProperties {
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
+ * Title
80
+ *
81
+ * Used for title
82
+ * @type {TEXT}
83
+ */
84
+ Title?: string | null;
85
+ /**
86
+ * Subject
87
+ *
88
+ * Data field for Email records. Used by Communications team.
89
+ * @type {TEXT}
90
+ */
91
+ Subject?: string | null;
92
+ /**
93
+ * To
94
+ *
95
+ * Data field for Email records. Used by Communications team.
96
+ * @type {TEXT}
97
+ */
98
+ To?: string | null;
99
+ }
100
+ /**
101
+ * CreateAmcoCollectionReceivedEmail
102
+ *
103
+ * 3PL-C5. Confirms the returned equipment has arrived with the 3PL and is awaiting inspection, when the COLLECTION_AMCO work order reaches Pending Inspection.
104
+ *
105
+ * @actionType CREATE - Creates a new Email record
106
+ * @module NotificationModule
107
+ * @entity Email
108
+ * @entityType TRANSACTIONAL (TRANSACTIONAL)
109
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoCollectionReceivedEmail
110
+ * @permission schema.action.createamcocollectionreceivedemail.trigger
111
+ * @benchmark This action is tracked for performance benchmarks
112
+ */
113
+ export declare class CreateAmcoCollectionReceivedEmailDto extends OdinRecordCreateDto<CreateAmcoCollectionReceivedEmailProperties> {
114
+ /** Used by SDK generators to identify action type */
115
+ static readonly ACTION_TYPE = "CREATE";
116
+ static readonly ACTION_KEY = "CreateAmcoCollectionReceivedEmail";
117
+ static readonly MODULE_NAME = "NotificationModule";
118
+ static readonly ENTITIES: string[];
119
+ static readonly ENTITY_TYPE = "TRANSACTIONAL";
120
+ static readonly EVENT_NAME = "k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoCollectionReceivedEmail";
121
+ static readonly PERMISSION = "schema.action.createamcocollectionreceivedemail.trigger";
122
+ /** Step metadata - entity this action targets */
123
+ static readonly STEP_ENTITY = "NotificationModule:Email";
124
+ static readonly STEP_SCHEMA_ID = "cb37958c-d72f-44aa-975a-a8fae42b1b72";
125
+ static readonly STEP_SCHEMA_ACTION_ID = "ad7b7119-fb96-4946-86b1-ef4af9d3f341";
126
+ static readonly STEP_SCHEMA_TYPE_ID = "14042940-a388-44c7-87fe-3a4105d92e94";
127
+ static readonly STEP_TYPE = "TRANSACTIONAL";
128
+ static readonly AUTO_LINK_PARENT = true;
129
+ readonly actionName: string;
130
+ readonly schemaActionId: string;
131
+ readonly entity: string;
132
+ constructor(properties: CreateAmcoCollectionReceivedEmailProperties, options?: {
133
+ journeyId?: string;
134
+ });
135
+ }
@@ -0,0 +1,59 @@
1
+ "use strict";
2
+ /**
3
+ * CreateAmcoCollectionReceivedEmail Action DTO
4
+ *
5
+ * 3PL-C5. Confirms the returned equipment has arrived with the 3PL and is awaiting inspection, when the COLLECTION_AMCO work order reaches Pending Inspection.
6
+ *
7
+ * @module NotificationModule
8
+ * @entity Email
9
+ * @entityType TRANSACTIONAL
10
+ * @actionKey CreateAmcoCollectionReceivedEmail
11
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoCollectionReceivedEmail
12
+ *
13
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.CreateAmcoCollectionReceivedEmailDto = void 0;
17
+ const core_1 = require("@d19n/odin-types/dist/core");
18
+ /**
19
+ * CreateAmcoCollectionReceivedEmail
20
+ *
21
+ * 3PL-C5. Confirms the returned equipment has arrived with the 3PL and is awaiting inspection, when the COLLECTION_AMCO work order reaches Pending Inspection.
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.CreateAmcoCollectionReceivedEmail
28
+ * @permission schema.action.createamcocollectionreceivedemail.trigger
29
+ * @benchmark This action is tracked for performance benchmarks
30
+ */
31
+ class CreateAmcoCollectionReceivedEmailDto 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 = 'CreateAmcoCollectionReceivedEmail';
40
+ this.schemaActionId = 'ad7b7119-fb96-4946-86b1-ef4af9d3f341';
41
+ this.entity = 'NotificationModule:Email';
42
+ }
43
+ }
44
+ exports.CreateAmcoCollectionReceivedEmailDto = CreateAmcoCollectionReceivedEmailDto;
45
+ /** Used by SDK generators to identify action type */
46
+ CreateAmcoCollectionReceivedEmailDto.ACTION_TYPE = 'CREATE';
47
+ CreateAmcoCollectionReceivedEmailDto.ACTION_KEY = 'CreateAmcoCollectionReceivedEmail';
48
+ CreateAmcoCollectionReceivedEmailDto.MODULE_NAME = 'NotificationModule';
49
+ CreateAmcoCollectionReceivedEmailDto.ENTITIES = ['Email'];
50
+ CreateAmcoCollectionReceivedEmailDto.ENTITY_TYPE = 'TRANSACTIONAL';
51
+ CreateAmcoCollectionReceivedEmailDto.EVENT_NAME = 'k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoCollectionReceivedEmail';
52
+ CreateAmcoCollectionReceivedEmailDto.PERMISSION = 'schema.action.createamcocollectionreceivedemail.trigger';
53
+ /** Step metadata - entity this action targets */
54
+ CreateAmcoCollectionReceivedEmailDto.STEP_ENTITY = 'NotificationModule:Email';
55
+ CreateAmcoCollectionReceivedEmailDto.STEP_SCHEMA_ID = 'cb37958c-d72f-44aa-975a-a8fae42b1b72';
56
+ CreateAmcoCollectionReceivedEmailDto.STEP_SCHEMA_ACTION_ID = 'ad7b7119-fb96-4946-86b1-ef4af9d3f341';
57
+ CreateAmcoCollectionReceivedEmailDto.STEP_SCHEMA_TYPE_ID = '14042940-a388-44c7-87fe-3a4105d92e94';
58
+ CreateAmcoCollectionReceivedEmailDto.STEP_TYPE = 'TRANSACTIONAL';
59
+ CreateAmcoCollectionReceivedEmailDto.AUTO_LINK_PARENT = true;
@@ -0,0 +1,135 @@
1
+ /**
2
+ * CreateAmcoDispatchConfirmedEmail Action DTO
3
+ *
4
+ * 3PL-D1. Confirms an equipment dispatch has been requested, when the DISPATCH_AMCO work order reaches Received. Lists the items being sent.
5
+ *
6
+ * @module NotificationModule
7
+ * @entity Email
8
+ * @entityType TRANSACTIONAL
9
+ * @actionKey CreateAmcoDispatchConfirmedEmail
10
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoDispatchConfirmedEmail
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 CreateAmcoDispatchConfirmedEmail created events
17
+ *
18
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoDispatchConfirmedEmail
19
+ */
20
+ export interface CreateAmcoDispatchConfirmedEmailMessage extends OdinRecordCreatedEvent<CreateAmcoDispatchConfirmedEmailDto, CreateAmcoDispatchConfirmedEmailProperties> {
21
+ }
22
+ /**
23
+ * Properties for CreateAmcoDispatchConfirmedEmail action
24
+ *
25
+ * @property Required fields: 0
26
+ * @property Optional fields: 10
27
+ */
28
+ export interface CreateAmcoDispatchConfirmedEmailProperties {
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
+ * Title
80
+ *
81
+ * Used for title
82
+ * @type {TEXT}
83
+ */
84
+ Title?: string | null;
85
+ /**
86
+ * Subject
87
+ *
88
+ * Data field for Email records. Used by Communications team.
89
+ * @type {TEXT}
90
+ */
91
+ Subject?: string | null;
92
+ /**
93
+ * To
94
+ *
95
+ * Data field for Email records. Used by Communications team.
96
+ * @type {TEXT}
97
+ */
98
+ To?: string | null;
99
+ }
100
+ /**
101
+ * CreateAmcoDispatchConfirmedEmail
102
+ *
103
+ * 3PL-D1. Confirms an equipment dispatch has been requested, when the DISPATCH_AMCO work order reaches Received. Lists the items being sent.
104
+ *
105
+ * @actionType CREATE - Creates a new Email record
106
+ * @module NotificationModule
107
+ * @entity Email
108
+ * @entityType TRANSACTIONAL (TRANSACTIONAL)
109
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoDispatchConfirmedEmail
110
+ * @permission schema.action.createamcodispatchconfirmedemail.trigger
111
+ * @benchmark This action is tracked for performance benchmarks
112
+ */
113
+ export declare class CreateAmcoDispatchConfirmedEmailDto extends OdinRecordCreateDto<CreateAmcoDispatchConfirmedEmailProperties> {
114
+ /** Used by SDK generators to identify action type */
115
+ static readonly ACTION_TYPE = "CREATE";
116
+ static readonly ACTION_KEY = "CreateAmcoDispatchConfirmedEmail";
117
+ static readonly MODULE_NAME = "NotificationModule";
118
+ static readonly ENTITIES: string[];
119
+ static readonly ENTITY_TYPE = "TRANSACTIONAL";
120
+ static readonly EVENT_NAME = "k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoDispatchConfirmedEmail";
121
+ static readonly PERMISSION = "schema.action.createamcodispatchconfirmedemail.trigger";
122
+ /** Step metadata - entity this action targets */
123
+ static readonly STEP_ENTITY = "NotificationModule:Email";
124
+ static readonly STEP_SCHEMA_ID = "cb37958c-d72f-44aa-975a-a8fae42b1b72";
125
+ static readonly STEP_SCHEMA_ACTION_ID = "04e488c2-42c7-4ac6-b481-786e3764a40e";
126
+ static readonly STEP_SCHEMA_TYPE_ID = "14042940-a388-44c7-87fe-3a4105d92e94";
127
+ static readonly STEP_TYPE = "TRANSACTIONAL";
128
+ static readonly AUTO_LINK_PARENT = true;
129
+ readonly actionName: string;
130
+ readonly schemaActionId: string;
131
+ readonly entity: string;
132
+ constructor(properties: CreateAmcoDispatchConfirmedEmailProperties, options?: {
133
+ journeyId?: string;
134
+ });
135
+ }
@@ -0,0 +1,59 @@
1
+ "use strict";
2
+ /**
3
+ * CreateAmcoDispatchConfirmedEmail Action DTO
4
+ *
5
+ * 3PL-D1. Confirms an equipment dispatch has been requested, when the DISPATCH_AMCO work order reaches Received. Lists the items being sent.
6
+ *
7
+ * @module NotificationModule
8
+ * @entity Email
9
+ * @entityType TRANSACTIONAL
10
+ * @actionKey CreateAmcoDispatchConfirmedEmail
11
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoDispatchConfirmedEmail
12
+ *
13
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.CreateAmcoDispatchConfirmedEmailDto = void 0;
17
+ const core_1 = require("@d19n/odin-types/dist/core");
18
+ /**
19
+ * CreateAmcoDispatchConfirmedEmail
20
+ *
21
+ * 3PL-D1. Confirms an equipment dispatch has been requested, when the DISPATCH_AMCO work order reaches Received. Lists the items being sent.
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.CreateAmcoDispatchConfirmedEmail
28
+ * @permission schema.action.createamcodispatchconfirmedemail.trigger
29
+ * @benchmark This action is tracked for performance benchmarks
30
+ */
31
+ class CreateAmcoDispatchConfirmedEmailDto 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 = 'CreateAmcoDispatchConfirmedEmail';
40
+ this.schemaActionId = '04e488c2-42c7-4ac6-b481-786e3764a40e';
41
+ this.entity = 'NotificationModule:Email';
42
+ }
43
+ }
44
+ exports.CreateAmcoDispatchConfirmedEmailDto = CreateAmcoDispatchConfirmedEmailDto;
45
+ /** Used by SDK generators to identify action type */
46
+ CreateAmcoDispatchConfirmedEmailDto.ACTION_TYPE = 'CREATE';
47
+ CreateAmcoDispatchConfirmedEmailDto.ACTION_KEY = 'CreateAmcoDispatchConfirmedEmail';
48
+ CreateAmcoDispatchConfirmedEmailDto.MODULE_NAME = 'NotificationModule';
49
+ CreateAmcoDispatchConfirmedEmailDto.ENTITIES = ['Email'];
50
+ CreateAmcoDispatchConfirmedEmailDto.ENTITY_TYPE = 'TRANSACTIONAL';
51
+ CreateAmcoDispatchConfirmedEmailDto.EVENT_NAME = 'k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoDispatchConfirmedEmail';
52
+ CreateAmcoDispatchConfirmedEmailDto.PERMISSION = 'schema.action.createamcodispatchconfirmedemail.trigger';
53
+ /** Step metadata - entity this action targets */
54
+ CreateAmcoDispatchConfirmedEmailDto.STEP_ENTITY = 'NotificationModule:Email';
55
+ CreateAmcoDispatchConfirmedEmailDto.STEP_SCHEMA_ID = 'cb37958c-d72f-44aa-975a-a8fae42b1b72';
56
+ CreateAmcoDispatchConfirmedEmailDto.STEP_SCHEMA_ACTION_ID = '04e488c2-42c7-4ac6-b481-786e3764a40e';
57
+ CreateAmcoDispatchConfirmedEmailDto.STEP_SCHEMA_TYPE_ID = '14042940-a388-44c7-87fe-3a4105d92e94';
58
+ CreateAmcoDispatchConfirmedEmailDto.STEP_TYPE = 'TRANSACTIONAL';
59
+ CreateAmcoDispatchConfirmedEmailDto.AUTO_LINK_PARENT = true;