@d19n/youfibre-odin-sdk 2.0.332 → 2.0.334

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 CHANGED
@@ -375,7 +375,7 @@ This SDK includes **187** entities across **12** modules.
375
375
 
376
376
  ## Actions
377
377
 
378
- This SDK includes **885** actions.
378
+ This SDK includes **886** actions.
379
379
 
380
380
  ### Action Types
381
381
 
@@ -1395,6 +1395,7 @@ This SDK includes **885** actions.
1395
1395
  | `CreateAmcoCollectionReminder5DayEmail` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoCollectionReminder5DayEmail |
1396
1396
  | `CreateAmcoDispatchConfirmedEmail` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoDispatchConfirmedEmail |
1397
1397
  | `CreateAmcoDispatchDeliveredEmail` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoDispatchDeliveredEmail |
1398
+ | `CreateAmcoDispatchFailedDeliveryEmail` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoDispatchFailedDeliveryEmail |
1398
1399
  | `CreateAmcoDispatchSentEmail` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoDispatchSentEmail |
1399
1400
  | `CreateCashbackRewardRefereeFailedEmail` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateCashbackRewardRefereeFailedEmail |
1400
1401
  | `CreateCashbackRewardRefereePendingEmail` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateCashbackRewardRefereePendingEmail |
@@ -0,0 +1,142 @@
1
+ /**
2
+ * CreateAmcoDispatchFailedDeliveryEmail Action DTO
3
+ *
4
+ * 3PL-D5. Tells the customer their equipment could not be delivered and is on its way back to us, when the DISPATCH_AMCO work order reaches Failed Delivery. Names the items that were being sent.
5
+ *
6
+ * @module NotificationModule
7
+ * @entity Email
8
+ * @entityType TRANSACTIONAL
9
+ * @actionKey CreateAmcoDispatchFailedDeliveryEmail
10
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoDispatchFailedDeliveryEmail
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 CreateAmcoDispatchFailedDeliveryEmail created events
17
+ *
18
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoDispatchFailedDeliveryEmail
19
+ */
20
+ export interface CreateAmcoDispatchFailedDeliveryEmailMessage extends OdinRecordCreatedEvent<CreateAmcoDispatchFailedDeliveryEmailDto, CreateAmcoDispatchFailedDeliveryEmailProperties> {
21
+ }
22
+ /**
23
+ * Properties for CreateAmcoDispatchFailedDeliveryEmail action
24
+ *
25
+ * @property Required fields: 0
26
+ * @property Optional fields: 11
27
+ */
28
+ export interface CreateAmcoDispatchFailedDeliveryEmailProperties {
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
+ * Work Order
101
+ *
102
+ * WorkOrder
103
+ * @type {LOOKUP}
104
+ */
105
+ WorkOrder?: string | null;
106
+ }
107
+ /**
108
+ * CreateAmcoDispatchFailedDeliveryEmail
109
+ *
110
+ * 3PL-D5. Tells the customer their equipment could not be delivered and is on its way back to us, when the DISPATCH_AMCO work order reaches Failed Delivery. Names the items that were being sent.
111
+ *
112
+ * @actionType CREATE - Creates a new Email record
113
+ * @module NotificationModule
114
+ * @entity Email
115
+ * @entityType TRANSACTIONAL (TRANSACTIONAL)
116
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoDispatchFailedDeliveryEmail
117
+ * @permission schema.action.createamcodispatchfaileddeliveryemail.trigger
118
+ * @benchmark This action is tracked for performance benchmarks
119
+ */
120
+ export declare class CreateAmcoDispatchFailedDeliveryEmailDto extends OdinRecordCreateDto<CreateAmcoDispatchFailedDeliveryEmailProperties> {
121
+ /** Used by SDK generators to identify action type */
122
+ static readonly ACTION_TYPE = "CREATE";
123
+ static readonly ACTION_KEY = "CreateAmcoDispatchFailedDeliveryEmail";
124
+ static readonly MODULE_NAME = "NotificationModule";
125
+ static readonly ENTITIES: string[];
126
+ static readonly ENTITY_TYPE = "TRANSACTIONAL";
127
+ static readonly EVENT_NAME = "k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoDispatchFailedDeliveryEmail";
128
+ static readonly PERMISSION = "schema.action.createamcodispatchfaileddeliveryemail.trigger";
129
+ /** Step metadata - entity this action targets */
130
+ static readonly STEP_ENTITY = "NotificationModule:Email";
131
+ static readonly STEP_SCHEMA_ID = "cb37958c-d72f-44aa-975a-a8fae42b1b72";
132
+ static readonly STEP_SCHEMA_ACTION_ID = "6b9dc5c2-39b6-46da-865b-616f9c99758f";
133
+ static readonly STEP_SCHEMA_TYPE_ID = "14042940-a388-44c7-87fe-3a4105d92e94";
134
+ static readonly STEP_TYPE = "TRANSACTIONAL";
135
+ static readonly AUTO_LINK_PARENT = true;
136
+ readonly actionName: string;
137
+ readonly schemaActionId: string;
138
+ readonly entity: string;
139
+ constructor(properties: CreateAmcoDispatchFailedDeliveryEmailProperties, options?: {
140
+ journeyId?: string;
141
+ });
142
+ }
@@ -0,0 +1,59 @@
1
+ "use strict";
2
+ /**
3
+ * CreateAmcoDispatchFailedDeliveryEmail Action DTO
4
+ *
5
+ * 3PL-D5. Tells the customer their equipment could not be delivered and is on its way back to us, when the DISPATCH_AMCO work order reaches Failed Delivery. Names the items that were being sent.
6
+ *
7
+ * @module NotificationModule
8
+ * @entity Email
9
+ * @entityType TRANSACTIONAL
10
+ * @actionKey CreateAmcoDispatchFailedDeliveryEmail
11
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoDispatchFailedDeliveryEmail
12
+ *
13
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.CreateAmcoDispatchFailedDeliveryEmailDto = void 0;
17
+ const core_1 = require("@d19n/odin-types/dist/core");
18
+ /**
19
+ * CreateAmcoDispatchFailedDeliveryEmail
20
+ *
21
+ * 3PL-D5. Tells the customer their equipment could not be delivered and is on its way back to us, when the DISPATCH_AMCO work order reaches Failed Delivery. Names the items that were 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.CreateAmcoDispatchFailedDeliveryEmail
28
+ * @permission schema.action.createamcodispatchfaileddeliveryemail.trigger
29
+ * @benchmark This action is tracked for performance benchmarks
30
+ */
31
+ class CreateAmcoDispatchFailedDeliveryEmailDto 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 = 'CreateAmcoDispatchFailedDeliveryEmail';
40
+ this.schemaActionId = '6b9dc5c2-39b6-46da-865b-616f9c99758f';
41
+ this.entity = 'NotificationModule:Email';
42
+ }
43
+ }
44
+ exports.CreateAmcoDispatchFailedDeliveryEmailDto = CreateAmcoDispatchFailedDeliveryEmailDto;
45
+ /** Used by SDK generators to identify action type */
46
+ CreateAmcoDispatchFailedDeliveryEmailDto.ACTION_TYPE = 'CREATE';
47
+ CreateAmcoDispatchFailedDeliveryEmailDto.ACTION_KEY = 'CreateAmcoDispatchFailedDeliveryEmail';
48
+ CreateAmcoDispatchFailedDeliveryEmailDto.MODULE_NAME = 'NotificationModule';
49
+ CreateAmcoDispatchFailedDeliveryEmailDto.ENTITIES = ['Email'];
50
+ CreateAmcoDispatchFailedDeliveryEmailDto.ENTITY_TYPE = 'TRANSACTIONAL';
51
+ CreateAmcoDispatchFailedDeliveryEmailDto.EVENT_NAME = 'k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateAmcoDispatchFailedDeliveryEmail';
52
+ CreateAmcoDispatchFailedDeliveryEmailDto.PERMISSION = 'schema.action.createamcodispatchfaileddeliveryemail.trigger';
53
+ /** Step metadata - entity this action targets */
54
+ CreateAmcoDispatchFailedDeliveryEmailDto.STEP_ENTITY = 'NotificationModule:Email';
55
+ CreateAmcoDispatchFailedDeliveryEmailDto.STEP_SCHEMA_ID = 'cb37958c-d72f-44aa-975a-a8fae42b1b72';
56
+ CreateAmcoDispatchFailedDeliveryEmailDto.STEP_SCHEMA_ACTION_ID = '6b9dc5c2-39b6-46da-865b-616f9c99758f';
57
+ CreateAmcoDispatchFailedDeliveryEmailDto.STEP_SCHEMA_TYPE_ID = '14042940-a388-44c7-87fe-3a4105d92e94';
58
+ CreateAmcoDispatchFailedDeliveryEmailDto.STEP_TYPE = 'TRANSACTIONAL';
59
+ CreateAmcoDispatchFailedDeliveryEmailDto.AUTO_LINK_PARENT = true;
@@ -31,6 +31,7 @@ import { CreateAmcoCollectionReminder10DayEmailProperties } from '../actions-v2/
31
31
  import { CreateAmcoCollectionReminder5DayEmailProperties } from '../actions-v2/CreateAmcoCollectionReminder5DayEmailDto';
32
32
  import { CreateAmcoDispatchConfirmedEmailProperties } from '../actions-v2/CreateAmcoDispatchConfirmedEmailDto';
33
33
  import { CreateAmcoDispatchDeliveredEmailProperties } from '../actions-v2/CreateAmcoDispatchDeliveredEmailDto';
34
+ import { CreateAmcoDispatchFailedDeliveryEmailProperties } from '../actions-v2/CreateAmcoDispatchFailedDeliveryEmailDto';
34
35
  import { CreateAmcoDispatchSentEmailProperties } from '../actions-v2/CreateAmcoDispatchSentEmailDto';
35
36
  import { CreateCashbackRewardRefereeFailedEmailProperties } from '../actions-v2/CreateCashbackRewardRefereeFailedEmailDto';
36
37
  import { CreateCashbackRewardRefereePendingEmailProperties } from '../actions-v2/CreateCashbackRewardRefereePendingEmailDto';
@@ -670,6 +671,34 @@ export declare class EmailRecord<TProps = EmailProperties> {
670
671
  journeyId?: string;
671
672
  stageKey?: string;
672
673
  }): ActionBuilder;
674
+ /**
675
+ * CreateAmcoDispatchFailedDeliveryEmail
676
+ *
677
+ * Creates a new Email record with the specified properties.
678
+ * Returns an ActionBuilder - call .execute() to create or .dryRun() for debugging.
679
+ *
680
+ * @remarks Record type: TRANSACTIONAL
681
+ *
682
+ * @param properties - The properties for the new record
683
+ * @param options - Optional settings
684
+ * @param options.journeyId - Associate with a journey
685
+ * @param options.stageKey - Set initial pipeline stage
686
+ * @returns ActionBuilder - call .execute() to create or .dryRun() for payload
687
+ *
688
+ * @example
689
+ * ```typescript
690
+ * // Create with properties
691
+ * const record = odinClient.emails.new();
692
+ * await record.createAmcoDispatchFailedDeliveryEmail({ ... }).execute();
693
+ *
694
+ * // Dry run (for debugging)
695
+ * const payload = record.createAmcoDispatchFailedDeliveryEmail({ ... }).dryRun();
696
+ * ```
697
+ */
698
+ createAmcoDispatchFailedDeliveryEmail(properties?: CreateAmcoDispatchFailedDeliveryEmailProperties, options?: {
699
+ journeyId?: string;
700
+ stageKey?: string;
701
+ }): ActionBuilder;
673
702
  /**
674
703
  * CreateAmcoDispatchSentEmail
675
704
  *
@@ -815,6 +815,42 @@ class EmailRecord {
815
815
  };
816
816
  return new ActionBuilder(this._provider, 'NotificationModule', 'Email', payload, () => { this._pendingLinks = []; });
817
817
  }
818
+ /**
819
+ * CreateAmcoDispatchFailedDeliveryEmail
820
+ *
821
+ * Creates a new Email record with the specified properties.
822
+ * Returns an ActionBuilder - call .execute() to create or .dryRun() for debugging.
823
+ *
824
+ * @remarks Record type: TRANSACTIONAL
825
+ *
826
+ * @param properties - The properties for the new record
827
+ * @param options - Optional settings
828
+ * @param options.journeyId - Associate with a journey
829
+ * @param options.stageKey - Set initial pipeline stage
830
+ * @returns ActionBuilder - call .execute() to create or .dryRun() for payload
831
+ *
832
+ * @example
833
+ * ```typescript
834
+ * // Create with properties
835
+ * const record = odinClient.emails.new();
836
+ * await record.createAmcoDispatchFailedDeliveryEmail({ ... }).execute();
837
+ *
838
+ * // Dry run (for debugging)
839
+ * const payload = record.createAmcoDispatchFailedDeliveryEmail({ ... }).dryRun();
840
+ * ```
841
+ */
842
+ createAmcoDispatchFailedDeliveryEmail(properties, options) {
843
+ const payload = {
844
+ entity: 'NotificationModule:Email',
845
+ type: 'TRANSACTIONAL',
846
+ actionName: 'CreateAmcoDispatchFailedDeliveryEmail',
847
+ properties: properties || {},
848
+ associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined,
849
+ journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
850
+ stageKey: options === null || options === void 0 ? void 0 : options.stageKey,
851
+ };
852
+ return new ActionBuilder(this._provider, 'NotificationModule', 'Email', payload, () => { this._pendingLinks = []; });
853
+ }
818
854
  /**
819
855
  * CreateAmcoDispatchSentEmail
820
856
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@d19n/youfibre-odin-sdk",
3
- "version": "2.0.332",
3
+ "version": "2.0.334",
4
4
  "description": "",
5
5
  "author": "@d19n",
6
6
  "license": "UNLICENSED",