@d19n/youfibre-odin-sdk 2.0.293 → 2.0.295

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 (94) hide show
  1. package/README.md +72 -62
  2. package/dist/EntityRegistry.d.ts +2 -2
  3. package/dist/EntityRegistry.js +2 -2
  4. package/dist/OdinApiClient.d.ts +4 -4
  5. package/dist/OdinApiClient.js +6 -6
  6. package/dist/OdinDbClient.d.ts +4 -4
  7. package/dist/OdinDbClient.js +6 -6
  8. package/dist/accessors-v2/{YfFieldServiceVisitAccessor.d.ts → YfFieldVisitOutcomeFormAccessor.d.ts} +24 -24
  9. package/dist/accessors-v2/{YfFieldServiceVisitAccessor.js → YfFieldVisitOutcomeFormAccessor.js} +21 -21
  10. package/dist/accessors-v2/index.d.ts +1 -1
  11. package/dist/accessors-v2/index.js +3 -3
  12. package/dist/actions-v2/CompleteServiceWorkOrderFlowDto.d.ts +230 -594
  13. package/dist/actions-v2/CompleteServiceWorkOrderFlowDto.js +30 -30
  14. package/dist/actions-v2/CreateAmcoCollectionBookedEmailDto.d.ts +135 -0
  15. package/dist/actions-v2/CreateAmcoCollectionBookedEmailDto.js +59 -0
  16. package/dist/actions-v2/CreateAmcoCollectionChargeEmailDto.d.ts +135 -0
  17. package/dist/actions-v2/CreateAmcoCollectionChargeEmailDto.js +59 -0
  18. package/dist/actions-v2/CreateAmcoCollectionCompleteEmailDto.d.ts +135 -0
  19. package/dist/actions-v2/CreateAmcoCollectionCompleteEmailDto.js +59 -0
  20. package/dist/actions-v2/CreateAmcoCollectionReceivedEmailDto.d.ts +135 -0
  21. package/dist/actions-v2/CreateAmcoCollectionReceivedEmailDto.js +59 -0
  22. package/dist/actions-v2/CreateAmcoCollectionReminder10DayEmailDto.d.ts +135 -0
  23. package/dist/actions-v2/CreateAmcoCollectionReminder10DayEmailDto.js +59 -0
  24. package/dist/actions-v2/CreateAmcoCollectionReminder5DayEmailDto.d.ts +135 -0
  25. package/dist/actions-v2/CreateAmcoCollectionReminder5DayEmailDto.js +59 -0
  26. package/dist/actions-v2/CreateAmcoDispatchConfirmedEmailDto.d.ts +135 -0
  27. package/dist/actions-v2/CreateAmcoDispatchConfirmedEmailDto.js +59 -0
  28. package/dist/actions-v2/CreateAmcoDispatchDeliveredEmailDto.d.ts +135 -0
  29. package/dist/actions-v2/CreateAmcoDispatchDeliveredEmailDto.js +59 -0
  30. package/dist/actions-v2/CreateAmcoDispatchSentEmailDto.d.ts +135 -0
  31. package/dist/actions-v2/CreateAmcoDispatchSentEmailDto.js +59 -0
  32. package/dist/api-sdk-v2/AddressApi.d.ts +2 -0
  33. package/dist/api-sdk-v2/AddressApi.js +6 -0
  34. package/dist/api-sdk-v2/FileApi.d.ts +2 -0
  35. package/dist/api-sdk-v2/FileApi.js +6 -0
  36. package/dist/api-sdk-v2/ModifyServiceRequestApi.d.ts +2 -0
  37. package/dist/api-sdk-v2/ModifyServiceRequestApi.js +6 -0
  38. package/dist/api-sdk-v2/NoteApi.d.ts +2 -0
  39. package/dist/api-sdk-v2/NoteApi.js +6 -0
  40. package/dist/api-sdk-v2/RecontractApi.d.ts +2 -0
  41. package/dist/api-sdk-v2/RecontractApi.js +6 -0
  42. package/dist/api-sdk-v2/WorkOrderApi.d.ts +2 -0
  43. package/dist/api-sdk-v2/WorkOrderApi.js +6 -0
  44. package/dist/api-sdk-v2/YfFieldVisitOutcomeFormApi.d.ts +54 -0
  45. package/dist/api-sdk-v2/YfFieldVisitOutcomeFormApi.js +173 -0
  46. package/dist/db-accessors-v2/{YfFieldServiceVisitDbAccessor.d.ts → YfFieldVisitOutcomeFormDbAccessor.d.ts} +22 -22
  47. package/dist/db-accessors-v2/{YfFieldServiceVisitDbAccessor.js → YfFieldVisitOutcomeFormDbAccessor.js} +21 -21
  48. package/dist/db-accessors-v2/index.d.ts +1 -1
  49. package/dist/db-accessors-v2/index.js +3 -3
  50. package/dist/db-sdk-v2/AddressDb.d.ts +2 -0
  51. package/dist/db-sdk-v2/AddressDb.js +6 -0
  52. package/dist/db-sdk-v2/FileDb.d.ts +2 -0
  53. package/dist/db-sdk-v2/FileDb.js +6 -0
  54. package/dist/db-sdk-v2/ModifyServiceRequestDb.d.ts +2 -0
  55. package/dist/db-sdk-v2/ModifyServiceRequestDb.js +6 -0
  56. package/dist/db-sdk-v2/NoteDb.d.ts +2 -0
  57. package/dist/db-sdk-v2/NoteDb.js +6 -0
  58. package/dist/db-sdk-v2/RecontractDb.d.ts +2 -0
  59. package/dist/db-sdk-v2/RecontractDb.js +6 -0
  60. package/dist/db-sdk-v2/WorkOrderDb.d.ts +2 -0
  61. package/dist/db-sdk-v2/WorkOrderDb.js +6 -0
  62. package/dist/db-sdk-v2/YfFieldVisitOutcomeFormDb.d.ts +126 -0
  63. package/dist/db-sdk-v2/YfFieldVisitOutcomeFormDb.js +222 -0
  64. package/dist/entities-v2/Address.d.ts +3 -0
  65. package/dist/entities-v2/Contact.d.ts +8 -0
  66. package/dist/entities-v2/Contact.js +2 -0
  67. package/dist/entities-v2/File.d.ts +3 -0
  68. package/dist/entities-v2/ModifyServiceRequest.d.ts +3 -0
  69. package/dist/entities-v2/Note.d.ts +3 -0
  70. package/dist/entities-v2/Recontract.d.ts +31 -0
  71. package/dist/entities-v2/Recontract.js +23 -1
  72. package/dist/entities-v2/WorkOrder.d.ts +7 -0
  73. package/dist/entities-v2/WorkOrder.js +5 -1
  74. package/dist/entities-v2/YfFieldVisitOutcomeForm.d.ts +1223 -0
  75. package/dist/entities-v2/YfFieldVisitOutcomeForm.js +503 -0
  76. package/dist/records-v2/AddressRecord.d.ts +20 -20
  77. package/dist/records-v2/AddressRecord.js +33 -33
  78. package/dist/records-v2/EmailRecord.d.ts +261 -0
  79. package/dist/records-v2/EmailRecord.js +324 -0
  80. package/dist/records-v2/FileRecord.d.ts +20 -20
  81. package/dist/records-v2/FileRecord.js +33 -33
  82. package/dist/records-v2/ModifyServiceRequestRecord.d.ts +20 -0
  83. package/dist/records-v2/ModifyServiceRequestRecord.js +33 -0
  84. package/dist/records-v2/NoteRecord.d.ts +20 -20
  85. package/dist/records-v2/NoteRecord.js +33 -33
  86. package/dist/records-v2/RecontractRecord.d.ts +20 -0
  87. package/dist/records-v2/RecontractRecord.js +33 -0
  88. package/dist/records-v2/WorkOrderRecord.d.ts +24 -24
  89. package/dist/records-v2/WorkOrderRecord.js +38 -38
  90. package/dist/records-v2/{YfFieldServiceVisitRecord.d.ts → YfFieldVisitOutcomeFormRecord.d.ts} +76 -61
  91. package/dist/records-v2/{YfFieldServiceVisitRecord.js → YfFieldVisitOutcomeFormRecord.js} +112 -96
  92. package/dist/records-v2/index.d.ts +2 -2
  93. package/dist/records-v2/index.js +7 -7
  94. package/package.json +1 -1
@@ -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
+ * CreateAmcoCollectionReminder10DayEmail Action DTO
3
+ *
4
+ * 3PL-C3. Reminds the customer their equipment return is 10 days overdue. Sent by the scheduled sweep in youfibre-api-connect, not by a stage change.
5
+ *
6
+ * @module NotificationModule
7
+ * @entity Email
8
+ * @entityType TRANSACTIONAL
9
+ * @actionKey CreateAmcoCollectionReminder10DayEmail
10
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoCollectionReminder10DayEmail
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 CreateAmcoCollectionReminder10DayEmail created events
17
+ *
18
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoCollectionReminder10DayEmail
19
+ */
20
+ export interface CreateAmcoCollectionReminder10DayEmailMessage extends OdinRecordCreatedEvent<CreateAmcoCollectionReminder10DayEmailDto, CreateAmcoCollectionReminder10DayEmailProperties> {
21
+ }
22
+ /**
23
+ * Properties for CreateAmcoCollectionReminder10DayEmail action
24
+ *
25
+ * @property Required fields: 0
26
+ * @property Optional fields: 10
27
+ */
28
+ export interface CreateAmcoCollectionReminder10DayEmailProperties {
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
+ * CreateAmcoCollectionReminder10DayEmail
102
+ *
103
+ * 3PL-C3. Reminds the customer their equipment return is 10 days overdue. Sent by the scheduled sweep in youfibre-api-connect, not by a stage change.
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.CreateAmcoCollectionReminder10DayEmail
110
+ * @permission schema.action.createamcocollectionreminder10dayemail.trigger
111
+ * @benchmark This action is tracked for performance benchmarks
112
+ */
113
+ export declare class CreateAmcoCollectionReminder10DayEmailDto extends OdinRecordCreateDto<CreateAmcoCollectionReminder10DayEmailProperties> {
114
+ /** Used by SDK generators to identify action type */
115
+ static readonly ACTION_TYPE = "CREATE";
116
+ static readonly ACTION_KEY = "CreateAmcoCollectionReminder10DayEmail";
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.CreateAmcoCollectionReminder10DayEmail";
121
+ static readonly PERMISSION = "schema.action.createamcocollectionreminder10dayemail.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 = "ba134596-0140-41f7-bc9e-8d3b2a369743";
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: CreateAmcoCollectionReminder10DayEmailProperties, options?: {
133
+ journeyId?: string;
134
+ });
135
+ }
@@ -0,0 +1,59 @@
1
+ "use strict";
2
+ /**
3
+ * CreateAmcoCollectionReminder10DayEmail Action DTO
4
+ *
5
+ * 3PL-C3. Reminds the customer their equipment return is 10 days overdue. Sent by the scheduled sweep in youfibre-api-connect, not by a stage change.
6
+ *
7
+ * @module NotificationModule
8
+ * @entity Email
9
+ * @entityType TRANSACTIONAL
10
+ * @actionKey CreateAmcoCollectionReminder10DayEmail
11
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoCollectionReminder10DayEmail
12
+ *
13
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.CreateAmcoCollectionReminder10DayEmailDto = void 0;
17
+ const core_1 = require("@d19n/odin-types/dist/core");
18
+ /**
19
+ * CreateAmcoCollectionReminder10DayEmail
20
+ *
21
+ * 3PL-C3. Reminds the customer their equipment return is 10 days overdue. Sent by the scheduled sweep in youfibre-api-connect, not by a stage change.
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.CreateAmcoCollectionReminder10DayEmail
28
+ * @permission schema.action.createamcocollectionreminder10dayemail.trigger
29
+ * @benchmark This action is tracked for performance benchmarks
30
+ */
31
+ class CreateAmcoCollectionReminder10DayEmailDto 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 = 'CreateAmcoCollectionReminder10DayEmail';
40
+ this.schemaActionId = 'ba134596-0140-41f7-bc9e-8d3b2a369743';
41
+ this.entity = 'NotificationModule:Email';
42
+ }
43
+ }
44
+ exports.CreateAmcoCollectionReminder10DayEmailDto = CreateAmcoCollectionReminder10DayEmailDto;
45
+ /** Used by SDK generators to identify action type */
46
+ CreateAmcoCollectionReminder10DayEmailDto.ACTION_TYPE = 'CREATE';
47
+ CreateAmcoCollectionReminder10DayEmailDto.ACTION_KEY = 'CreateAmcoCollectionReminder10DayEmail';
48
+ CreateAmcoCollectionReminder10DayEmailDto.MODULE_NAME = 'NotificationModule';
49
+ CreateAmcoCollectionReminder10DayEmailDto.ENTITIES = ['Email'];
50
+ CreateAmcoCollectionReminder10DayEmailDto.ENTITY_TYPE = 'TRANSACTIONAL';
51
+ CreateAmcoCollectionReminder10DayEmailDto.EVENT_NAME = 'k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoCollectionReminder10DayEmail';
52
+ CreateAmcoCollectionReminder10DayEmailDto.PERMISSION = 'schema.action.createamcocollectionreminder10dayemail.trigger';
53
+ /** Step metadata - entity this action targets */
54
+ CreateAmcoCollectionReminder10DayEmailDto.STEP_ENTITY = 'NotificationModule:Email';
55
+ CreateAmcoCollectionReminder10DayEmailDto.STEP_SCHEMA_ID = 'cb37958c-d72f-44aa-975a-a8fae42b1b72';
56
+ CreateAmcoCollectionReminder10DayEmailDto.STEP_SCHEMA_ACTION_ID = 'ba134596-0140-41f7-bc9e-8d3b2a369743';
57
+ CreateAmcoCollectionReminder10DayEmailDto.STEP_SCHEMA_TYPE_ID = '14042940-a388-44c7-87fe-3a4105d92e94';
58
+ CreateAmcoCollectionReminder10DayEmailDto.STEP_TYPE = 'TRANSACTIONAL';
59
+ CreateAmcoCollectionReminder10DayEmailDto.AUTO_LINK_PARENT = true;
@@ -0,0 +1,135 @@
1
+ /**
2
+ * CreateAmcoCollectionReminder5DayEmail Action DTO
3
+ *
4
+ * 3PL-C2. Reminds the customer their equipment return is 5 days overdue. Sent by the scheduled sweep in youfibre-api-connect, not by a stage change — the trigger is a date offset, not a transition.
5
+ *
6
+ * @module NotificationModule
7
+ * @entity Email
8
+ * @entityType TRANSACTIONAL
9
+ * @actionKey CreateAmcoCollectionReminder5DayEmail
10
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoCollectionReminder5DayEmail
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 CreateAmcoCollectionReminder5DayEmail created events
17
+ *
18
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoCollectionReminder5DayEmail
19
+ */
20
+ export interface CreateAmcoCollectionReminder5DayEmailMessage extends OdinRecordCreatedEvent<CreateAmcoCollectionReminder5DayEmailDto, CreateAmcoCollectionReminder5DayEmailProperties> {
21
+ }
22
+ /**
23
+ * Properties for CreateAmcoCollectionReminder5DayEmail action
24
+ *
25
+ * @property Required fields: 0
26
+ * @property Optional fields: 10
27
+ */
28
+ export interface CreateAmcoCollectionReminder5DayEmailProperties {
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
+ * CreateAmcoCollectionReminder5DayEmail
102
+ *
103
+ * 3PL-C2. Reminds the customer their equipment return is 5 days overdue. Sent by the scheduled sweep in youfibre-api-connect, not by a stage change — the trigger is a date offset, not a transition.
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.CreateAmcoCollectionReminder5DayEmail
110
+ * @permission schema.action.createamcocollectionreminder5dayemail.trigger
111
+ * @benchmark This action is tracked for performance benchmarks
112
+ */
113
+ export declare class CreateAmcoCollectionReminder5DayEmailDto extends OdinRecordCreateDto<CreateAmcoCollectionReminder5DayEmailProperties> {
114
+ /** Used by SDK generators to identify action type */
115
+ static readonly ACTION_TYPE = "CREATE";
116
+ static readonly ACTION_KEY = "CreateAmcoCollectionReminder5DayEmail";
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.CreateAmcoCollectionReminder5DayEmail";
121
+ static readonly PERMISSION = "schema.action.createamcocollectionreminder5dayemail.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 = "22970592-ab48-4fe6-9978-65501025deb7";
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: CreateAmcoCollectionReminder5DayEmailProperties, options?: {
133
+ journeyId?: string;
134
+ });
135
+ }
@@ -0,0 +1,59 @@
1
+ "use strict";
2
+ /**
3
+ * CreateAmcoCollectionReminder5DayEmail Action DTO
4
+ *
5
+ * 3PL-C2. Reminds the customer their equipment return is 5 days overdue. Sent by the scheduled sweep in youfibre-api-connect, not by a stage change — the trigger is a date offset, not a transition.
6
+ *
7
+ * @module NotificationModule
8
+ * @entity Email
9
+ * @entityType TRANSACTIONAL
10
+ * @actionKey CreateAmcoCollectionReminder5DayEmail
11
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoCollectionReminder5DayEmail
12
+ *
13
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.CreateAmcoCollectionReminder5DayEmailDto = void 0;
17
+ const core_1 = require("@d19n/odin-types/dist/core");
18
+ /**
19
+ * CreateAmcoCollectionReminder5DayEmail
20
+ *
21
+ * 3PL-C2. Reminds the customer their equipment return is 5 days overdue. Sent by the scheduled sweep in youfibre-api-connect, not by a stage change — the trigger is a date offset, not a transition.
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.CreateAmcoCollectionReminder5DayEmail
28
+ * @permission schema.action.createamcocollectionreminder5dayemail.trigger
29
+ * @benchmark This action is tracked for performance benchmarks
30
+ */
31
+ class CreateAmcoCollectionReminder5DayEmailDto 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 = 'CreateAmcoCollectionReminder5DayEmail';
40
+ this.schemaActionId = '22970592-ab48-4fe6-9978-65501025deb7';
41
+ this.entity = 'NotificationModule:Email';
42
+ }
43
+ }
44
+ exports.CreateAmcoCollectionReminder5DayEmailDto = CreateAmcoCollectionReminder5DayEmailDto;
45
+ /** Used by SDK generators to identify action type */
46
+ CreateAmcoCollectionReminder5DayEmailDto.ACTION_TYPE = 'CREATE';
47
+ CreateAmcoCollectionReminder5DayEmailDto.ACTION_KEY = 'CreateAmcoCollectionReminder5DayEmail';
48
+ CreateAmcoCollectionReminder5DayEmailDto.MODULE_NAME = 'NotificationModule';
49
+ CreateAmcoCollectionReminder5DayEmailDto.ENTITIES = ['Email'];
50
+ CreateAmcoCollectionReminder5DayEmailDto.ENTITY_TYPE = 'TRANSACTIONAL';
51
+ CreateAmcoCollectionReminder5DayEmailDto.EVENT_NAME = 'k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoCollectionReminder5DayEmail';
52
+ CreateAmcoCollectionReminder5DayEmailDto.PERMISSION = 'schema.action.createamcocollectionreminder5dayemail.trigger';
53
+ /** Step metadata - entity this action targets */
54
+ CreateAmcoCollectionReminder5DayEmailDto.STEP_ENTITY = 'NotificationModule:Email';
55
+ CreateAmcoCollectionReminder5DayEmailDto.STEP_SCHEMA_ID = 'cb37958c-d72f-44aa-975a-a8fae42b1b72';
56
+ CreateAmcoCollectionReminder5DayEmailDto.STEP_SCHEMA_ACTION_ID = '22970592-ab48-4fe6-9978-65501025deb7';
57
+ CreateAmcoCollectionReminder5DayEmailDto.STEP_SCHEMA_TYPE_ID = '14042940-a388-44c7-87fe-3a4105d92e94';
58
+ CreateAmcoCollectionReminder5DayEmailDto.STEP_TYPE = 'TRANSACTIONAL';
59
+ CreateAmcoCollectionReminder5DayEmailDto.AUTO_LINK_PARENT = true;