@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,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;
@@ -0,0 +1,135 @@
1
+ /**
2
+ * CreateAmcoDispatchDeliveredEmail Action DTO
3
+ *
4
+ * 3PL-D4. Confirms the equipment was delivered, when the DISPATCH_AMCO work order reaches Complete.
5
+ *
6
+ * @module NotificationModule
7
+ * @entity Email
8
+ * @entityType TRANSACTIONAL
9
+ * @actionKey CreateAmcoDispatchDeliveredEmail
10
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoDispatchDeliveredEmail
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 CreateAmcoDispatchDeliveredEmail created events
17
+ *
18
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoDispatchDeliveredEmail
19
+ */
20
+ export interface CreateAmcoDispatchDeliveredEmailMessage extends OdinRecordCreatedEvent<CreateAmcoDispatchDeliveredEmailDto, CreateAmcoDispatchDeliveredEmailProperties> {
21
+ }
22
+ /**
23
+ * Properties for CreateAmcoDispatchDeliveredEmail action
24
+ *
25
+ * @property Required fields: 0
26
+ * @property Optional fields: 10
27
+ */
28
+ export interface CreateAmcoDispatchDeliveredEmailProperties {
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
+ * CreateAmcoDispatchDeliveredEmail
102
+ *
103
+ * 3PL-D4. Confirms the equipment was delivered, when the DISPATCH_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.CreateAmcoDispatchDeliveredEmail
110
+ * @permission schema.action.createamcodispatchdeliveredemail.trigger
111
+ * @benchmark This action is tracked for performance benchmarks
112
+ */
113
+ export declare class CreateAmcoDispatchDeliveredEmailDto extends OdinRecordCreateDto<CreateAmcoDispatchDeliveredEmailProperties> {
114
+ /** Used by SDK generators to identify action type */
115
+ static readonly ACTION_TYPE = "CREATE";
116
+ static readonly ACTION_KEY = "CreateAmcoDispatchDeliveredEmail";
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.CreateAmcoDispatchDeliveredEmail";
121
+ static readonly PERMISSION = "schema.action.createamcodispatchdeliveredemail.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 = "86e5c903-6a7d-4118-930d-1773f8766f2b";
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: CreateAmcoDispatchDeliveredEmailProperties, options?: {
133
+ journeyId?: string;
134
+ });
135
+ }
@@ -0,0 +1,59 @@
1
+ "use strict";
2
+ /**
3
+ * CreateAmcoDispatchDeliveredEmail Action DTO
4
+ *
5
+ * 3PL-D4. Confirms the equipment was delivered, when the DISPATCH_AMCO work order reaches Complete.
6
+ *
7
+ * @module NotificationModule
8
+ * @entity Email
9
+ * @entityType TRANSACTIONAL
10
+ * @actionKey CreateAmcoDispatchDeliveredEmail
11
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoDispatchDeliveredEmail
12
+ *
13
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.CreateAmcoDispatchDeliveredEmailDto = void 0;
17
+ const core_1 = require("@d19n/odin-types/dist/core");
18
+ /**
19
+ * CreateAmcoDispatchDeliveredEmail
20
+ *
21
+ * 3PL-D4. Confirms the equipment was delivered, when the DISPATCH_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.CreateAmcoDispatchDeliveredEmail
28
+ * @permission schema.action.createamcodispatchdeliveredemail.trigger
29
+ * @benchmark This action is tracked for performance benchmarks
30
+ */
31
+ class CreateAmcoDispatchDeliveredEmailDto 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 = 'CreateAmcoDispatchDeliveredEmail';
40
+ this.schemaActionId = '86e5c903-6a7d-4118-930d-1773f8766f2b';
41
+ this.entity = 'NotificationModule:Email';
42
+ }
43
+ }
44
+ exports.CreateAmcoDispatchDeliveredEmailDto = CreateAmcoDispatchDeliveredEmailDto;
45
+ /** Used by SDK generators to identify action type */
46
+ CreateAmcoDispatchDeliveredEmailDto.ACTION_TYPE = 'CREATE';
47
+ CreateAmcoDispatchDeliveredEmailDto.ACTION_KEY = 'CreateAmcoDispatchDeliveredEmail';
48
+ CreateAmcoDispatchDeliveredEmailDto.MODULE_NAME = 'NotificationModule';
49
+ CreateAmcoDispatchDeliveredEmailDto.ENTITIES = ['Email'];
50
+ CreateAmcoDispatchDeliveredEmailDto.ENTITY_TYPE = 'TRANSACTIONAL';
51
+ CreateAmcoDispatchDeliveredEmailDto.EVENT_NAME = 'k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoDispatchDeliveredEmail';
52
+ CreateAmcoDispatchDeliveredEmailDto.PERMISSION = 'schema.action.createamcodispatchdeliveredemail.trigger';
53
+ /** Step metadata - entity this action targets */
54
+ CreateAmcoDispatchDeliveredEmailDto.STEP_ENTITY = 'NotificationModule:Email';
55
+ CreateAmcoDispatchDeliveredEmailDto.STEP_SCHEMA_ID = 'cb37958c-d72f-44aa-975a-a8fae42b1b72';
56
+ CreateAmcoDispatchDeliveredEmailDto.STEP_SCHEMA_ACTION_ID = '86e5c903-6a7d-4118-930d-1773f8766f2b';
57
+ CreateAmcoDispatchDeliveredEmailDto.STEP_SCHEMA_TYPE_ID = '14042940-a388-44c7-87fe-3a4105d92e94';
58
+ CreateAmcoDispatchDeliveredEmailDto.STEP_TYPE = 'TRANSACTIONAL';
59
+ CreateAmcoDispatchDeliveredEmailDto.AUTO_LINK_PARENT = true;
@@ -0,0 +1,135 @@
1
+ /**
2
+ * CreateAmcoDispatchSentEmail Action DTO
3
+ *
4
+ * 3PL-D2. Tells the customer their equipment is on its way, when the DISPATCH_AMCO work order reaches En Route.
5
+ *
6
+ * @module NotificationModule
7
+ * @entity Email
8
+ * @entityType TRANSACTIONAL
9
+ * @actionKey CreateAmcoDispatchSentEmail
10
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoDispatchSentEmail
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 CreateAmcoDispatchSentEmail created events
17
+ *
18
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoDispatchSentEmail
19
+ */
20
+ export interface CreateAmcoDispatchSentEmailMessage extends OdinRecordCreatedEvent<CreateAmcoDispatchSentEmailDto, CreateAmcoDispatchSentEmailProperties> {
21
+ }
22
+ /**
23
+ * Properties for CreateAmcoDispatchSentEmail action
24
+ *
25
+ * @property Required fields: 0
26
+ * @property Optional fields: 10
27
+ */
28
+ export interface CreateAmcoDispatchSentEmailProperties {
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
+ * CreateAmcoDispatchSentEmail
102
+ *
103
+ * 3PL-D2. Tells the customer their equipment is on its way, when the DISPATCH_AMCO work order reaches En Route.
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.CreateAmcoDispatchSentEmail
110
+ * @permission schema.action.createamcodispatchsentemail.trigger
111
+ * @benchmark This action is tracked for performance benchmarks
112
+ */
113
+ export declare class CreateAmcoDispatchSentEmailDto extends OdinRecordCreateDto<CreateAmcoDispatchSentEmailProperties> {
114
+ /** Used by SDK generators to identify action type */
115
+ static readonly ACTION_TYPE = "CREATE";
116
+ static readonly ACTION_KEY = "CreateAmcoDispatchSentEmail";
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.CreateAmcoDispatchSentEmail";
121
+ static readonly PERMISSION = "schema.action.createamcodispatchsentemail.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 = "434a1378-bc4a-489e-bfcc-7cf9668d1538";
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: CreateAmcoDispatchSentEmailProperties, options?: {
133
+ journeyId?: string;
134
+ });
135
+ }
@@ -0,0 +1,59 @@
1
+ "use strict";
2
+ /**
3
+ * CreateAmcoDispatchSentEmail Action DTO
4
+ *
5
+ * 3PL-D2. Tells the customer their equipment is on its way, when the DISPATCH_AMCO work order reaches En Route.
6
+ *
7
+ * @module NotificationModule
8
+ * @entity Email
9
+ * @entityType TRANSACTIONAL
10
+ * @actionKey CreateAmcoDispatchSentEmail
11
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoDispatchSentEmail
12
+ *
13
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.CreateAmcoDispatchSentEmailDto = void 0;
17
+ const core_1 = require("@d19n/odin-types/dist/core");
18
+ /**
19
+ * CreateAmcoDispatchSentEmail
20
+ *
21
+ * 3PL-D2. Tells the customer their equipment is on its way, when the DISPATCH_AMCO work order reaches En Route.
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.CreateAmcoDispatchSentEmail
28
+ * @permission schema.action.createamcodispatchsentemail.trigger
29
+ * @benchmark This action is tracked for performance benchmarks
30
+ */
31
+ class CreateAmcoDispatchSentEmailDto 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 = 'CreateAmcoDispatchSentEmail';
40
+ this.schemaActionId = '434a1378-bc4a-489e-bfcc-7cf9668d1538';
41
+ this.entity = 'NotificationModule:Email';
42
+ }
43
+ }
44
+ exports.CreateAmcoDispatchSentEmailDto = CreateAmcoDispatchSentEmailDto;
45
+ /** Used by SDK generators to identify action type */
46
+ CreateAmcoDispatchSentEmailDto.ACTION_TYPE = 'CREATE';
47
+ CreateAmcoDispatchSentEmailDto.ACTION_KEY = 'CreateAmcoDispatchSentEmail';
48
+ CreateAmcoDispatchSentEmailDto.MODULE_NAME = 'NotificationModule';
49
+ CreateAmcoDispatchSentEmailDto.ENTITIES = ['Email'];
50
+ CreateAmcoDispatchSentEmailDto.ENTITY_TYPE = 'TRANSACTIONAL';
51
+ CreateAmcoDispatchSentEmailDto.EVENT_NAME = 'k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoDispatchSentEmail';
52
+ CreateAmcoDispatchSentEmailDto.PERMISSION = 'schema.action.createamcodispatchsentemail.trigger';
53
+ /** Step metadata - entity this action targets */
54
+ CreateAmcoDispatchSentEmailDto.STEP_ENTITY = 'NotificationModule:Email';
55
+ CreateAmcoDispatchSentEmailDto.STEP_SCHEMA_ID = 'cb37958c-d72f-44aa-975a-a8fae42b1b72';
56
+ CreateAmcoDispatchSentEmailDto.STEP_SCHEMA_ACTION_ID = '434a1378-bc4a-489e-bfcc-7cf9668d1538';
57
+ CreateAmcoDispatchSentEmailDto.STEP_SCHEMA_TYPE_ID = '14042940-a388-44c7-87fe-3a4105d92e94';
58
+ CreateAmcoDispatchSentEmailDto.STEP_TYPE = 'TRANSACTIONAL';
59
+ CreateAmcoDispatchSentEmailDto.AUTO_LINK_PARENT = true;
@@ -40,6 +40,7 @@ export declare class AddressApi extends ApiProvider {
40
40
  private _yffieldservicevisit?;
41
41
  private _churnrequest?;
42
42
  private _dataissue?;
43
+ private _yffieldvisitoutcomeform?;
43
44
  constructor(authParams?: OauthParams, authToken?: string);
44
45
  get file(): ApiRecordLinkManager;
45
46
  get note(): ApiRecordLinkManager;
@@ -64,6 +65,7 @@ export declare class AddressApi extends ApiProvider {
64
65
  get yffieldservicevisit(): ApiRecordLinkManager;
65
66
  get churnrequest(): ApiRecordLinkManager;
66
67
  get dataissue(): ApiRecordLinkManager;
68
+ get yffieldvisitoutcomeform(): ApiRecordLinkManager;
67
69
  setRecord(sourceRecord: any): void;
68
70
  schema(): Promise<import("@d19n/odin-types/dist/core").OdinSchema>;
69
71
  search(params: Partial<OdinSearchV2>): Promise<import("@d19n/odin-sdk-generator/dist/odin-sdk-types").OdinSearchResponse<import("@d19n/odin-types/dist/core").OdinRecord<AddressProperties>>>;
@@ -171,6 +171,12 @@ class AddressApi extends api_provider_1.ApiProvider {
171
171
  }
172
172
  return this._dataissue;
173
173
  }
174
+ get yffieldvisitoutcomeform() {
175
+ if (!this._yffieldvisitoutcomeform) {
176
+ this._yffieldvisitoutcomeform = new api_record_link_manager_1.ApiRecordLinkManager(this.authParams, 'CrmModule:Address', 'FieldServiceModule:YfFieldVisitOutcomeForm', 'YfFieldVisitOutcomeForm__Address');
177
+ }
178
+ return this._yffieldvisitoutcomeform;
179
+ }
174
180
  // ============================================
175
181
  // STANDARD METHODS (Unchanged API)
176
182
  // ============================================
@@ -80,6 +80,7 @@ export declare class FileApi extends ApiProvider {
80
80
  private _uginprogressaudit?;
81
81
  private _pgdirectdebitfile?;
82
82
  private _yfwifisurvey?;
83
+ private _yffieldvisitoutcomeform?;
83
84
  constructor(authParams?: OauthParams, authToken?: string);
84
85
  get servicevisitaudit(): ApiRecordLinkManager;
85
86
  get blockagea55(): ApiRecordLinkManager;
@@ -144,6 +145,7 @@ export declare class FileApi extends ApiProvider {
144
145
  get uginprogressaudit(): ApiRecordLinkManager;
145
146
  get pgdirectdebitfile(): ApiRecordLinkManager;
146
147
  get yfwifisurvey(): ApiRecordLinkManager;
148
+ get yffieldvisitoutcomeform(): ApiRecordLinkManager;
147
149
  setRecord(sourceRecord: any): void;
148
150
  schema(): Promise<import("@d19n/odin-types/dist/core").OdinSchema>;
149
151
  search(params: Partial<OdinSearchV2>): Promise<import("@d19n/odin-sdk-generator/dist/odin-sdk-types").OdinSearchResponse<import("@d19n/odin-types/dist/core").OdinRecord<FileProperties>>>;
@@ -411,6 +411,12 @@ class FileApi extends api_provider_1.ApiProvider {
411
411
  }
412
412
  return this._yfwifisurvey;
413
413
  }
414
+ get yffieldvisitoutcomeform() {
415
+ if (!this._yffieldvisitoutcomeform) {
416
+ this._yffieldvisitoutcomeform = new api_record_link_manager_1.ApiRecordLinkManager(this.authParams, 'SchemaModule:File', 'FieldServiceModule:YfFieldVisitOutcomeForm', 'YfFieldVisitOutcomeForm__File');
417
+ }
418
+ return this._yffieldvisitoutcomeform;
419
+ }
414
420
  // ============================================
415
421
  // STANDARD METHODS (Unchanged API)
416
422
  // ============================================
@@ -19,9 +19,11 @@ export declare class ModifyServiceRequestApi extends ApiProvider {
19
19
  private sourceRecord;
20
20
  private _orderkci?;
21
21
  private _order?;
22
+ private _recontract?;
22
23
  constructor(authParams?: OauthParams, authToken?: string);
23
24
  get orderkci(): ApiRecordLinkManager;
24
25
  get order(): ApiRecordLinkManager;
26
+ get recontract(): ApiRecordLinkManager;
25
27
  setRecord(sourceRecord: any): void;
26
28
  schema(): Promise<import("@d19n/odin-types/dist/core").OdinSchema>;
27
29
  search(params: Partial<OdinSearchV2>): Promise<import("@d19n/odin-sdk-generator/dist/odin-sdk-types").OdinSearchResponse<import("@d19n/odin-types/dist/core").OdinRecord<ModifyServiceRequestProperties>>>;
@@ -45,6 +45,12 @@ class ModifyServiceRequestApi extends api_provider_1.ApiProvider {
45
45
  }
46
46
  return this._order;
47
47
  }
48
+ get recontract() {
49
+ if (!this._recontract) {
50
+ this._recontract = new api_record_link_manager_1.ApiRecordLinkManager(this.authParams, 'ServiceModule:ModifyServiceRequest', 'OrderModule:Recontract', 'Recontract__ModifyServiceRequest');
51
+ }
52
+ return this._recontract;
53
+ }
48
54
  // ============================================
49
55
  // STANDARD METHODS (Unchanged API)
50
56
  // ============================================