@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.
- package/README.md +72 -62
- package/dist/EntityRegistry.d.ts +2 -2
- package/dist/EntityRegistry.js +2 -2
- package/dist/OdinApiClient.d.ts +4 -4
- package/dist/OdinApiClient.js +6 -6
- package/dist/OdinDbClient.d.ts +4 -4
- package/dist/OdinDbClient.js +6 -6
- package/dist/accessors-v2/{YfFieldServiceVisitAccessor.d.ts → YfFieldVisitOutcomeFormAccessor.d.ts} +24 -24
- package/dist/accessors-v2/{YfFieldServiceVisitAccessor.js → YfFieldVisitOutcomeFormAccessor.js} +21 -21
- package/dist/accessors-v2/index.d.ts +1 -1
- package/dist/accessors-v2/index.js +3 -3
- package/dist/actions-v2/CompleteServiceWorkOrderFlowDto.d.ts +230 -594
- package/dist/actions-v2/CompleteServiceWorkOrderFlowDto.js +30 -30
- package/dist/actions-v2/CreateAmcoCollectionBookedEmailDto.d.ts +135 -0
- package/dist/actions-v2/CreateAmcoCollectionBookedEmailDto.js +59 -0
- package/dist/actions-v2/CreateAmcoCollectionChargeEmailDto.d.ts +135 -0
- package/dist/actions-v2/CreateAmcoCollectionChargeEmailDto.js +59 -0
- package/dist/actions-v2/CreateAmcoCollectionCompleteEmailDto.d.ts +135 -0
- package/dist/actions-v2/CreateAmcoCollectionCompleteEmailDto.js +59 -0
- package/dist/actions-v2/CreateAmcoCollectionReceivedEmailDto.d.ts +135 -0
- package/dist/actions-v2/CreateAmcoCollectionReceivedEmailDto.js +59 -0
- package/dist/actions-v2/CreateAmcoCollectionReminder10DayEmailDto.d.ts +135 -0
- package/dist/actions-v2/CreateAmcoCollectionReminder10DayEmailDto.js +59 -0
- package/dist/actions-v2/CreateAmcoCollectionReminder5DayEmailDto.d.ts +135 -0
- package/dist/actions-v2/CreateAmcoCollectionReminder5DayEmailDto.js +59 -0
- package/dist/actions-v2/CreateAmcoDispatchConfirmedEmailDto.d.ts +135 -0
- package/dist/actions-v2/CreateAmcoDispatchConfirmedEmailDto.js +59 -0
- package/dist/actions-v2/CreateAmcoDispatchDeliveredEmailDto.d.ts +135 -0
- package/dist/actions-v2/CreateAmcoDispatchDeliveredEmailDto.js +59 -0
- package/dist/actions-v2/CreateAmcoDispatchSentEmailDto.d.ts +135 -0
- package/dist/actions-v2/CreateAmcoDispatchSentEmailDto.js +59 -0
- package/dist/api-sdk-v2/AddressApi.d.ts +2 -0
- package/dist/api-sdk-v2/AddressApi.js +6 -0
- package/dist/api-sdk-v2/FileApi.d.ts +2 -0
- package/dist/api-sdk-v2/FileApi.js +6 -0
- package/dist/api-sdk-v2/ModifyServiceRequestApi.d.ts +2 -0
- package/dist/api-sdk-v2/ModifyServiceRequestApi.js +6 -0
- package/dist/api-sdk-v2/NoteApi.d.ts +2 -0
- package/dist/api-sdk-v2/NoteApi.js +6 -0
- package/dist/api-sdk-v2/RecontractApi.d.ts +2 -0
- package/dist/api-sdk-v2/RecontractApi.js +6 -0
- package/dist/api-sdk-v2/WorkOrderApi.d.ts +2 -0
- package/dist/api-sdk-v2/WorkOrderApi.js +6 -0
- package/dist/api-sdk-v2/YfFieldVisitOutcomeFormApi.d.ts +54 -0
- package/dist/api-sdk-v2/YfFieldVisitOutcomeFormApi.js +173 -0
- package/dist/db-accessors-v2/{YfFieldServiceVisitDbAccessor.d.ts → YfFieldVisitOutcomeFormDbAccessor.d.ts} +22 -22
- package/dist/db-accessors-v2/{YfFieldServiceVisitDbAccessor.js → YfFieldVisitOutcomeFormDbAccessor.js} +21 -21
- package/dist/db-accessors-v2/index.d.ts +1 -1
- package/dist/db-accessors-v2/index.js +3 -3
- package/dist/db-sdk-v2/AddressDb.d.ts +2 -0
- package/dist/db-sdk-v2/AddressDb.js +6 -0
- package/dist/db-sdk-v2/FileDb.d.ts +2 -0
- package/dist/db-sdk-v2/FileDb.js +6 -0
- package/dist/db-sdk-v2/ModifyServiceRequestDb.d.ts +2 -0
- package/dist/db-sdk-v2/ModifyServiceRequestDb.js +6 -0
- package/dist/db-sdk-v2/NoteDb.d.ts +2 -0
- package/dist/db-sdk-v2/NoteDb.js +6 -0
- package/dist/db-sdk-v2/RecontractDb.d.ts +2 -0
- package/dist/db-sdk-v2/RecontractDb.js +6 -0
- package/dist/db-sdk-v2/WorkOrderDb.d.ts +2 -0
- package/dist/db-sdk-v2/WorkOrderDb.js +6 -0
- package/dist/db-sdk-v2/YfFieldVisitOutcomeFormDb.d.ts +126 -0
- package/dist/db-sdk-v2/YfFieldVisitOutcomeFormDb.js +222 -0
- package/dist/entities-v2/Address.d.ts +3 -0
- package/dist/entities-v2/Contact.d.ts +8 -0
- package/dist/entities-v2/Contact.js +2 -0
- package/dist/entities-v2/File.d.ts +3 -0
- package/dist/entities-v2/ModifyServiceRequest.d.ts +3 -0
- package/dist/entities-v2/Note.d.ts +3 -0
- package/dist/entities-v2/Recontract.d.ts +31 -0
- package/dist/entities-v2/Recontract.js +23 -1
- package/dist/entities-v2/WorkOrder.d.ts +7 -0
- package/dist/entities-v2/WorkOrder.js +5 -1
- package/dist/entities-v2/YfFieldVisitOutcomeForm.d.ts +1223 -0
- package/dist/entities-v2/YfFieldVisitOutcomeForm.js +503 -0
- package/dist/records-v2/AddressRecord.d.ts +20 -20
- package/dist/records-v2/AddressRecord.js +33 -33
- package/dist/records-v2/EmailRecord.d.ts +261 -0
- package/dist/records-v2/EmailRecord.js +324 -0
- package/dist/records-v2/FileRecord.d.ts +20 -20
- package/dist/records-v2/FileRecord.js +33 -33
- package/dist/records-v2/ModifyServiceRequestRecord.d.ts +20 -0
- package/dist/records-v2/ModifyServiceRequestRecord.js +33 -0
- package/dist/records-v2/NoteRecord.d.ts +20 -20
- package/dist/records-v2/NoteRecord.js +33 -33
- package/dist/records-v2/RecontractRecord.d.ts +20 -0
- package/dist/records-v2/RecontractRecord.js +33 -0
- package/dist/records-v2/WorkOrderRecord.d.ts +24 -24
- package/dist/records-v2/WorkOrderRecord.js +38 -38
- package/dist/records-v2/{YfFieldServiceVisitRecord.d.ts → YfFieldVisitOutcomeFormRecord.d.ts} +76 -61
- package/dist/records-v2/{YfFieldServiceVisitRecord.js → YfFieldVisitOutcomeFormRecord.js} +112 -96
- package/dist/records-v2/index.d.ts +2 -2
- package/dist/records-v2/index.js +7 -7
- package/package.json +1 -1
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
14
14
|
*/
|
|
15
15
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
-
exports.CompleteServiceWorkOrderFlowDto = exports.CompleteServiceWorkOrderFlowSteps = exports.
|
|
16
|
+
exports.CompleteServiceWorkOrderFlowDto = exports.CompleteServiceWorkOrderFlowSteps = exports.YfFieldVisitOutcomeFormDto = exports.CompleteServiceWorkOrderDto = void 0;
|
|
17
17
|
const core_1 = require("@d19n/odin-types/dist/core");
|
|
18
18
|
/**
|
|
19
19
|
* CompleteServiceWorkOrder
|
|
@@ -60,47 +60,47 @@ CompleteServiceWorkOrderDto.STEP_SCHEMA_TYPE_ID = 'f7ca5acc-acaa-45b6-bc67-cff04
|
|
|
60
60
|
CompleteServiceWorkOrderDto.STEP_TYPE = 'SERVICE';
|
|
61
61
|
CompleteServiceWorkOrderDto.AUTO_LINK_PARENT = false;
|
|
62
62
|
/**
|
|
63
|
-
* YF Field
|
|
63
|
+
* YF Field Visit Outcome Form
|
|
64
64
|
*
|
|
65
|
-
* YF Field
|
|
65
|
+
* YF Field Visit Outcome Form
|
|
66
66
|
*
|
|
67
|
-
* @actionType CREATE - Creates a new
|
|
67
|
+
* @actionType CREATE - Creates a new YfFieldVisitOutcomeForm record
|
|
68
68
|
* @module FieldServiceModule
|
|
69
|
-
* @entity
|
|
70
|
-
* @entityType OUTCOME_FORM (
|
|
71
|
-
* @event k1.t-hEOJjsDb.FieldServiceModule.
|
|
72
|
-
* @permission schema.action.
|
|
69
|
+
* @entity YfFieldVisitOutcomeForm
|
|
70
|
+
* @entityType OUTCOME_FORM (Outcome Form)
|
|
71
|
+
* @event k1.t-hEOJjsDb.FieldServiceModule.YfFieldVisitOutcomeForm.Create.YfFieldVisitOutcomeForm
|
|
72
|
+
* @permission schema.action.yffieldvisitoutcomeform.trigger
|
|
73
73
|
* @benchmark This action is tracked for performance benchmarks
|
|
74
74
|
*/
|
|
75
|
-
class
|
|
75
|
+
class YfFieldVisitOutcomeFormDto extends core_1.OdinRecordCreateDto {
|
|
76
76
|
constructor(properties, options) {
|
|
77
77
|
super({
|
|
78
|
-
entity: 'FieldServiceModule:
|
|
78
|
+
entity: 'FieldServiceModule:YfFieldVisitOutcomeForm',
|
|
79
79
|
type: 'OUTCOME_FORM',
|
|
80
80
|
properties,
|
|
81
81
|
journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
|
|
82
82
|
});
|
|
83
|
-
this.actionName = '
|
|
84
|
-
this.schemaActionId = '
|
|
85
|
-
this.entity = 'FieldServiceModule:
|
|
83
|
+
this.actionName = 'YfFieldVisitOutcomeForm';
|
|
84
|
+
this.schemaActionId = '7a7c95a1-0fc9-4a83-a4bd-26302411735d';
|
|
85
|
+
this.entity = 'FieldServiceModule:YfFieldVisitOutcomeForm';
|
|
86
86
|
}
|
|
87
87
|
}
|
|
88
|
-
exports.
|
|
88
|
+
exports.YfFieldVisitOutcomeFormDto = YfFieldVisitOutcomeFormDto;
|
|
89
89
|
/** Used by SDK generators to identify action type */
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
90
|
+
YfFieldVisitOutcomeFormDto.ACTION_TYPE = 'CREATE';
|
|
91
|
+
YfFieldVisitOutcomeFormDto.ACTION_KEY = 'YfFieldVisitOutcomeForm';
|
|
92
|
+
YfFieldVisitOutcomeFormDto.MODULE_NAME = 'FieldServiceModule';
|
|
93
|
+
YfFieldVisitOutcomeFormDto.ENTITIES = ['YfFieldVisitOutcomeForm'];
|
|
94
|
+
YfFieldVisitOutcomeFormDto.ENTITY_TYPE = 'OUTCOME_FORM';
|
|
95
|
+
YfFieldVisitOutcomeFormDto.EVENT_NAME = 'k1.t-hEOJjsDb.FieldServiceModule.YfFieldVisitOutcomeForm.Create.YfFieldVisitOutcomeForm';
|
|
96
|
+
YfFieldVisitOutcomeFormDto.PERMISSION = 'schema.action.yffieldvisitoutcomeform.trigger';
|
|
97
97
|
/** Step metadata - entity this action targets */
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
98
|
+
YfFieldVisitOutcomeFormDto.STEP_ENTITY = 'FieldServiceModule:YfFieldVisitOutcomeForm';
|
|
99
|
+
YfFieldVisitOutcomeFormDto.STEP_SCHEMA_ID = 'cca6f70d-9b11-42b6-9439-c3672d871e14';
|
|
100
|
+
YfFieldVisitOutcomeFormDto.STEP_SCHEMA_ACTION_ID = '7a7c95a1-0fc9-4a83-a4bd-26302411735d';
|
|
101
|
+
YfFieldVisitOutcomeFormDto.STEP_SCHEMA_TYPE_ID = '334af74f-77ed-4196-9e9b-a4dc31b5c864';
|
|
102
|
+
YfFieldVisitOutcomeFormDto.STEP_TYPE = 'OUTCOME_FORM';
|
|
103
|
+
YfFieldVisitOutcomeFormDto.AUTO_LINK_PARENT = true;
|
|
104
104
|
/**
|
|
105
105
|
* Type-safe step keys for CompleteServiceWorkOrderFlow
|
|
106
106
|
*/
|
|
@@ -164,12 +164,12 @@ CompleteServiceWorkOrderFlowDto.stepDefinitions = [
|
|
|
164
164
|
},
|
|
165
165
|
{
|
|
166
166
|
stepKey: 'step_2',
|
|
167
|
-
dtoClass: '
|
|
168
|
-
entity: 'FieldServiceModule:
|
|
167
|
+
dtoClass: 'YfFieldVisitOutcomeFormDto',
|
|
168
|
+
entity: 'FieldServiceModule:YfFieldVisitOutcomeForm',
|
|
169
169
|
linksTo: null
|
|
170
170
|
}
|
|
171
171
|
];
|
|
172
172
|
/** Type-safe step key accessor */
|
|
173
173
|
CompleteServiceWorkOrderFlowDto.Steps = exports.CompleteServiceWorkOrderFlowSteps;
|
|
174
174
|
/** Step classes that can be used with this action */
|
|
175
|
-
CompleteServiceWorkOrderFlowDto.stepClasses = ['CompleteServiceWorkOrderDto', '
|
|
175
|
+
CompleteServiceWorkOrderFlowDto.stepClasses = ['CompleteServiceWorkOrderDto', 'YfFieldVisitOutcomeFormDto'];
|
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* CreateAmcoCollectionBookedEmail Action DTO
|
|
3
|
+
*
|
|
4
|
+
* 3PL-C1. Confirms an equipment collection has been booked, when the COLLECTION_AMCO work order reaches Received. Lists the items expected back and what each costs if it is not returned.
|
|
5
|
+
*
|
|
6
|
+
* @module NotificationModule
|
|
7
|
+
* @entity Email
|
|
8
|
+
* @entityType TRANSACTIONAL
|
|
9
|
+
* @actionKey CreateAmcoCollectionBookedEmail
|
|
10
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoCollectionBookedEmail
|
|
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 CreateAmcoCollectionBookedEmail created events
|
|
17
|
+
*
|
|
18
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoCollectionBookedEmail
|
|
19
|
+
*/
|
|
20
|
+
export interface CreateAmcoCollectionBookedEmailMessage extends OdinRecordCreatedEvent<CreateAmcoCollectionBookedEmailDto, CreateAmcoCollectionBookedEmailProperties> {
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Properties for CreateAmcoCollectionBookedEmail action
|
|
24
|
+
*
|
|
25
|
+
* @property Required fields: 0
|
|
26
|
+
* @property Optional fields: 10
|
|
27
|
+
*/
|
|
28
|
+
export interface CreateAmcoCollectionBookedEmailProperties {
|
|
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
|
+
* CreateAmcoCollectionBookedEmail
|
|
102
|
+
*
|
|
103
|
+
* 3PL-C1. Confirms an equipment collection has been booked, when the COLLECTION_AMCO work order reaches Received. Lists the items expected back and what each costs if it is not returned.
|
|
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.CreateAmcoCollectionBookedEmail
|
|
110
|
+
* @permission schema.action.createamcocollectionbookedemail.trigger
|
|
111
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
112
|
+
*/
|
|
113
|
+
export declare class CreateAmcoCollectionBookedEmailDto extends OdinRecordCreateDto<CreateAmcoCollectionBookedEmailProperties> {
|
|
114
|
+
/** Used by SDK generators to identify action type */
|
|
115
|
+
static readonly ACTION_TYPE = "CREATE";
|
|
116
|
+
static readonly ACTION_KEY = "CreateAmcoCollectionBookedEmail";
|
|
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.CreateAmcoCollectionBookedEmail";
|
|
121
|
+
static readonly PERMISSION = "schema.action.createamcocollectionbookedemail.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 = "deef2370-fcef-403f-8671-cd6f69e0a515";
|
|
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: CreateAmcoCollectionBookedEmailProperties, options?: {
|
|
133
|
+
journeyId?: string;
|
|
134
|
+
});
|
|
135
|
+
}
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* CreateAmcoCollectionBookedEmail Action DTO
|
|
4
|
+
*
|
|
5
|
+
* 3PL-C1. Confirms an equipment collection has been booked, when the COLLECTION_AMCO work order reaches Received. Lists the items expected back and what each costs if it is not returned.
|
|
6
|
+
*
|
|
7
|
+
* @module NotificationModule
|
|
8
|
+
* @entity Email
|
|
9
|
+
* @entityType TRANSACTIONAL
|
|
10
|
+
* @actionKey CreateAmcoCollectionBookedEmail
|
|
11
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoCollectionBookedEmail
|
|
12
|
+
*
|
|
13
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.CreateAmcoCollectionBookedEmailDto = void 0;
|
|
17
|
+
const core_1 = require("@d19n/odin-types/dist/core");
|
|
18
|
+
/**
|
|
19
|
+
* CreateAmcoCollectionBookedEmail
|
|
20
|
+
*
|
|
21
|
+
* 3PL-C1. Confirms an equipment collection has been booked, when the COLLECTION_AMCO work order reaches Received. Lists the items expected back and what each costs if it is not returned.
|
|
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.CreateAmcoCollectionBookedEmail
|
|
28
|
+
* @permission schema.action.createamcocollectionbookedemail.trigger
|
|
29
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
30
|
+
*/
|
|
31
|
+
class CreateAmcoCollectionBookedEmailDto 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 = 'CreateAmcoCollectionBookedEmail';
|
|
40
|
+
this.schemaActionId = 'deef2370-fcef-403f-8671-cd6f69e0a515';
|
|
41
|
+
this.entity = 'NotificationModule:Email';
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
exports.CreateAmcoCollectionBookedEmailDto = CreateAmcoCollectionBookedEmailDto;
|
|
45
|
+
/** Used by SDK generators to identify action type */
|
|
46
|
+
CreateAmcoCollectionBookedEmailDto.ACTION_TYPE = 'CREATE';
|
|
47
|
+
CreateAmcoCollectionBookedEmailDto.ACTION_KEY = 'CreateAmcoCollectionBookedEmail';
|
|
48
|
+
CreateAmcoCollectionBookedEmailDto.MODULE_NAME = 'NotificationModule';
|
|
49
|
+
CreateAmcoCollectionBookedEmailDto.ENTITIES = ['Email'];
|
|
50
|
+
CreateAmcoCollectionBookedEmailDto.ENTITY_TYPE = 'TRANSACTIONAL';
|
|
51
|
+
CreateAmcoCollectionBookedEmailDto.EVENT_NAME = 'k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoCollectionBookedEmail';
|
|
52
|
+
CreateAmcoCollectionBookedEmailDto.PERMISSION = 'schema.action.createamcocollectionbookedemail.trigger';
|
|
53
|
+
/** Step metadata - entity this action targets */
|
|
54
|
+
CreateAmcoCollectionBookedEmailDto.STEP_ENTITY = 'NotificationModule:Email';
|
|
55
|
+
CreateAmcoCollectionBookedEmailDto.STEP_SCHEMA_ID = 'cb37958c-d72f-44aa-975a-a8fae42b1b72';
|
|
56
|
+
CreateAmcoCollectionBookedEmailDto.STEP_SCHEMA_ACTION_ID = 'deef2370-fcef-403f-8671-cd6f69e0a515';
|
|
57
|
+
CreateAmcoCollectionBookedEmailDto.STEP_SCHEMA_TYPE_ID = '14042940-a388-44c7-87fe-3a4105d92e94';
|
|
58
|
+
CreateAmcoCollectionBookedEmailDto.STEP_TYPE = 'TRANSACTIONAL';
|
|
59
|
+
CreateAmcoCollectionBookedEmailDto.AUTO_LINK_PARENT = true;
|
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* CreateAmcoCollectionChargeEmail Action DTO
|
|
3
|
+
*
|
|
4
|
+
* 3PL-C7. Notifies the customer that unreturned equipment is being charged for, when the COLLECTION_AMCO work order reaches Non Returned. Carries the per-item non-return charge.
|
|
5
|
+
*
|
|
6
|
+
* @module NotificationModule
|
|
7
|
+
* @entity Email
|
|
8
|
+
* @entityType TRANSACTIONAL
|
|
9
|
+
* @actionKey CreateAmcoCollectionChargeEmail
|
|
10
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoCollectionChargeEmail
|
|
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 CreateAmcoCollectionChargeEmail created events
|
|
17
|
+
*
|
|
18
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoCollectionChargeEmail
|
|
19
|
+
*/
|
|
20
|
+
export interface CreateAmcoCollectionChargeEmailMessage extends OdinRecordCreatedEvent<CreateAmcoCollectionChargeEmailDto, CreateAmcoCollectionChargeEmailProperties> {
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Properties for CreateAmcoCollectionChargeEmail action
|
|
24
|
+
*
|
|
25
|
+
* @property Required fields: 0
|
|
26
|
+
* @property Optional fields: 10
|
|
27
|
+
*/
|
|
28
|
+
export interface CreateAmcoCollectionChargeEmailProperties {
|
|
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
|
+
* CreateAmcoCollectionChargeEmail
|
|
102
|
+
*
|
|
103
|
+
* 3PL-C7. Notifies the customer that unreturned equipment is being charged for, when the COLLECTION_AMCO work order reaches Non Returned. Carries the per-item non-return charge.
|
|
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.CreateAmcoCollectionChargeEmail
|
|
110
|
+
* @permission schema.action.createamcocollectionchargeemail.trigger
|
|
111
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
112
|
+
*/
|
|
113
|
+
export declare class CreateAmcoCollectionChargeEmailDto extends OdinRecordCreateDto<CreateAmcoCollectionChargeEmailProperties> {
|
|
114
|
+
/** Used by SDK generators to identify action type */
|
|
115
|
+
static readonly ACTION_TYPE = "CREATE";
|
|
116
|
+
static readonly ACTION_KEY = "CreateAmcoCollectionChargeEmail";
|
|
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.CreateAmcoCollectionChargeEmail";
|
|
121
|
+
static readonly PERMISSION = "schema.action.createamcocollectionchargeemail.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 = "b54efe0a-536e-49e8-8c16-d2aa5fbb9c5b";
|
|
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: CreateAmcoCollectionChargeEmailProperties, options?: {
|
|
133
|
+
journeyId?: string;
|
|
134
|
+
});
|
|
135
|
+
}
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* CreateAmcoCollectionChargeEmail Action DTO
|
|
4
|
+
*
|
|
5
|
+
* 3PL-C7. Notifies the customer that unreturned equipment is being charged for, when the COLLECTION_AMCO work order reaches Non Returned. Carries the per-item non-return charge.
|
|
6
|
+
*
|
|
7
|
+
* @module NotificationModule
|
|
8
|
+
* @entity Email
|
|
9
|
+
* @entityType TRANSACTIONAL
|
|
10
|
+
* @actionKey CreateAmcoCollectionChargeEmail
|
|
11
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoCollectionChargeEmail
|
|
12
|
+
*
|
|
13
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.CreateAmcoCollectionChargeEmailDto = void 0;
|
|
17
|
+
const core_1 = require("@d19n/odin-types/dist/core");
|
|
18
|
+
/**
|
|
19
|
+
* CreateAmcoCollectionChargeEmail
|
|
20
|
+
*
|
|
21
|
+
* 3PL-C7. Notifies the customer that unreturned equipment is being charged for, when the COLLECTION_AMCO work order reaches Non Returned. Carries the per-item non-return charge.
|
|
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.CreateAmcoCollectionChargeEmail
|
|
28
|
+
* @permission schema.action.createamcocollectionchargeemail.trigger
|
|
29
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
30
|
+
*/
|
|
31
|
+
class CreateAmcoCollectionChargeEmailDto 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 = 'CreateAmcoCollectionChargeEmail';
|
|
40
|
+
this.schemaActionId = 'b54efe0a-536e-49e8-8c16-d2aa5fbb9c5b';
|
|
41
|
+
this.entity = 'NotificationModule:Email';
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
exports.CreateAmcoCollectionChargeEmailDto = CreateAmcoCollectionChargeEmailDto;
|
|
45
|
+
/** Used by SDK generators to identify action type */
|
|
46
|
+
CreateAmcoCollectionChargeEmailDto.ACTION_TYPE = 'CREATE';
|
|
47
|
+
CreateAmcoCollectionChargeEmailDto.ACTION_KEY = 'CreateAmcoCollectionChargeEmail';
|
|
48
|
+
CreateAmcoCollectionChargeEmailDto.MODULE_NAME = 'NotificationModule';
|
|
49
|
+
CreateAmcoCollectionChargeEmailDto.ENTITIES = ['Email'];
|
|
50
|
+
CreateAmcoCollectionChargeEmailDto.ENTITY_TYPE = 'TRANSACTIONAL';
|
|
51
|
+
CreateAmcoCollectionChargeEmailDto.EVENT_NAME = 'k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoCollectionChargeEmail';
|
|
52
|
+
CreateAmcoCollectionChargeEmailDto.PERMISSION = 'schema.action.createamcocollectionchargeemail.trigger';
|
|
53
|
+
/** Step metadata - entity this action targets */
|
|
54
|
+
CreateAmcoCollectionChargeEmailDto.STEP_ENTITY = 'NotificationModule:Email';
|
|
55
|
+
CreateAmcoCollectionChargeEmailDto.STEP_SCHEMA_ID = 'cb37958c-d72f-44aa-975a-a8fae42b1b72';
|
|
56
|
+
CreateAmcoCollectionChargeEmailDto.STEP_SCHEMA_ACTION_ID = 'b54efe0a-536e-49e8-8c16-d2aa5fbb9c5b';
|
|
57
|
+
CreateAmcoCollectionChargeEmailDto.STEP_SCHEMA_TYPE_ID = '14042940-a388-44c7-87fe-3a4105d92e94';
|
|
58
|
+
CreateAmcoCollectionChargeEmailDto.STEP_TYPE = 'TRANSACTIONAL';
|
|
59
|
+
CreateAmcoCollectionChargeEmailDto.AUTO_LINK_PARENT = true;
|
|
@@ -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
|
+
}
|