@d19n/youfibre-odin-sdk 2.0.331 → 2.0.333

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,135 @@
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: 10
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
+ /**
101
+ * CreateAmcoDispatchFailedDeliveryEmail
102
+ *
103
+ * 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.
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.CreateAmcoDispatchFailedDeliveryEmail
110
+ * @permission schema.action.createamcodispatchfaileddeliveryemail.trigger
111
+ * @benchmark This action is tracked for performance benchmarks
112
+ */
113
+ export declare class CreateAmcoDispatchFailedDeliveryEmailDto extends OdinRecordCreateDto<CreateAmcoDispatchFailedDeliveryEmailProperties> {
114
+ /** Used by SDK generators to identify action type */
115
+ static readonly ACTION_TYPE = "CREATE";
116
+ static readonly ACTION_KEY = "CreateAmcoDispatchFailedDeliveryEmail";
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.CreateAmcoDispatchFailedDeliveryEmail";
121
+ static readonly PERMISSION = "schema.action.createamcodispatchfaileddeliveryemail.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 = "6b9dc5c2-39b6-46da-865b-616f9c99758f";
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: CreateAmcoDispatchFailedDeliveryEmailProperties, options?: {
133
+ journeyId?: string;
134
+ });
135
+ }
@@ -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;
@@ -899,7 +899,6 @@ export declare enum CaseEnquiryCategory {
899
899
  * Why the customer contacted us, specific. 119-value business taxonomy (Categories.xlsx, 2026-09-11); every label is globally unique, so this value alone determines EnquiryCategory. Each category carries an "- other" catch-all so "nothing specific fits" has a defined answer. Parentage lives in the form action's enumOptionFilter (CASES-1861), not on the column.
900
900
  *
901
901
  * @remarks Available options:
902
- * - `NOTICE_30_DAY_FORMAL_TERMINATION` - 30-day notice / formal termination
903
902
  * - `ACCESS_PROPERTY_LOGISTICS_VISIT` - Access & property logistics for the visit
904
903
  * - `ACCESS_WIRING_PROPERTY_COMPLICATIONS` - Access, wiring & property complications
905
904
  * - `ACCOUNT_PORTAL_APP_OTHER` - Account portal and app - other
@@ -914,6 +913,7 @@ export declare enum CaseEnquiryCategory {
914
913
  * - `BILLING_PAYMENTS_OTHER` - Billing & payments - other
915
914
  * - `BOOK_REQUEST_ENGINEER_VISIT` - Book / request an engineer visit
916
915
  * - `BOOK_SCHEDULE_INITIAL_INSTALLATION` - Book / schedule initial installation
916
+ * - `BUYOUT_AMOUNT_ELIGIBILITY_DISPUTE` - Buyout amount or eligibility dispute
917
917
  * - ... and 104 more
918
918
  */
919
919
  export declare enum CaseEnquirySubCategory {
@@ -966,6 +966,7 @@ export declare enum CaseEnquirySubCategory {
966
966
  ETA_WHERE_IS_MY_ENGINEER_ON_THE_DAY = "ENGINEER_ETA_ON_DAY",
967
967
  EXPLICIT_CANCELLATION_REQUEST = "EXPLICIT_CANCELLATION_REQUEST",
968
968
  FORMAL_COMPLAINT_OTHER = "FORMAL_COMPLAINT_OTHER",
969
+ FORMAL_TERMINATION_30_DAY_NOTICE = "NOTICE_30_DAY_FORMAL_TERMINATION",
969
970
  GDPR_OTHER = "GDPR_OTHER",
970
971
  HARDWARE_QUESTIONS_TIED_TO_RENEWAL_OR_UPGRADE = "RENEWAL_HARDWARE_QUESTION",
971
972
  HOMES_MOVES_OTHER = "HOME_MOVES_OTHER",
@@ -914,7 +914,6 @@ var CaseEnquiryCategory;
914
914
  * Why the customer contacted us, specific. 119-value business taxonomy (Categories.xlsx, 2026-09-11); every label is globally unique, so this value alone determines EnquiryCategory. Each category carries an "- other" catch-all so "nothing specific fits" has a defined answer. Parentage lives in the form action's enumOptionFilter (CASES-1861), not on the column.
915
915
  *
916
916
  * @remarks Available options:
917
- * - `NOTICE_30_DAY_FORMAL_TERMINATION` - 30-day notice / formal termination
918
917
  * - `ACCESS_PROPERTY_LOGISTICS_VISIT` - Access & property logistics for the visit
919
918
  * - `ACCESS_WIRING_PROPERTY_COMPLICATIONS` - Access, wiring & property complications
920
919
  * - `ACCOUNT_PORTAL_APP_OTHER` - Account portal and app - other
@@ -929,6 +928,7 @@ var CaseEnquiryCategory;
929
928
  * - `BILLING_PAYMENTS_OTHER` - Billing & payments - other
930
929
  * - `BOOK_REQUEST_ENGINEER_VISIT` - Book / request an engineer visit
931
930
  * - `BOOK_SCHEDULE_INITIAL_INSTALLATION` - Book / schedule initial installation
931
+ * - `BUYOUT_AMOUNT_ELIGIBILITY_DISPUTE` - Buyout amount or eligibility dispute
932
932
  * - ... and 104 more
933
933
  */
934
934
  var CaseEnquirySubCategory;
@@ -982,6 +982,7 @@ var CaseEnquirySubCategory;
982
982
  CaseEnquirySubCategory["ETA_WHERE_IS_MY_ENGINEER_ON_THE_DAY"] = "ENGINEER_ETA_ON_DAY";
983
983
  CaseEnquirySubCategory["EXPLICIT_CANCELLATION_REQUEST"] = "EXPLICIT_CANCELLATION_REQUEST";
984
984
  CaseEnquirySubCategory["FORMAL_COMPLAINT_OTHER"] = "FORMAL_COMPLAINT_OTHER";
985
+ CaseEnquirySubCategory["FORMAL_TERMINATION_30_DAY_NOTICE"] = "NOTICE_30_DAY_FORMAL_TERMINATION";
985
986
  CaseEnquirySubCategory["GDPR_OTHER"] = "GDPR_OTHER";
986
987
  CaseEnquirySubCategory["HARDWARE_QUESTIONS_TIED_TO_RENEWAL_OR_UPGRADE"] = "RENEWAL_HARDWARE_QUESTION";
987
988
  CaseEnquirySubCategory["HOMES_MOVES_OTHER"] = "HOME_MOVES_OTHER";
@@ -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.331",
3
+ "version": "2.0.333",
4
4
  "description": "",
5
5
  "author": "@d19n",
6
6
  "license": "UNLICENSED",