@d19n/youfibre-odin-sdk 2.0.297 → 2.0.299

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
@@ -369,7 +369,7 @@ This SDK includes **181** entities across **12** modules.
369
369
 
370
370
  ## Actions
371
371
 
372
- This SDK includes **867** actions.
372
+ This SDK includes **868** actions.
373
373
 
374
374
  ### Action Types
375
375
 
@@ -1401,6 +1401,7 @@ This SDK includes **867** actions.
1401
1401
  | `CreatePreContractOrderSummary` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreatePreContractOrderSummary |
1402
1402
  | `CreateRecontractOrderConfirmation` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateRecontractOrderConfirmation |
1403
1403
  | `CreateRecontractReminderEmail` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateRecontractReminderEmail |
1404
+ | `CreateRegisterInterestEmail` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateRegisterInterestEmail |
1404
1405
  | `CreateServiceAppointmentConfirmation` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateServiceAppointmentConfirmation |
1405
1406
  | `CreateServiceAppointmentRescheduled` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateServiceAppointmentRescheduled |
1406
1407
  | `CreateServiceDeactivatedMandate` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateServiceDeactivatedMandate |
@@ -0,0 +1,135 @@
1
+ /**
2
+ * CreateRegisterInterestEmail Action DTO
3
+ *
4
+ * Send email for register interest confirmation
5
+ *
6
+ * @module NotificationModule
7
+ * @entity Email
8
+ * @entityType TRANSACTIONAL
9
+ * @actionKey CreateRegisterInterestEmail
10
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateRegisterInterestEmail
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 CreateRegisterInterestEmail created events
17
+ *
18
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateRegisterInterestEmail
19
+ */
20
+ export interface CreateRegisterInterestEmailMessage extends OdinRecordCreatedEvent<CreateRegisterInterestEmailDto, CreateRegisterInterestEmailProperties> {
21
+ }
22
+ /**
23
+ * Properties for CreateRegisterInterestEmail action
24
+ *
25
+ * @property Required fields: 0
26
+ * @property Optional fields: 10
27
+ */
28
+ export interface CreateRegisterInterestEmailProperties {
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
+ * Email Sender
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
+ * CreateRegisterInterestEmail
102
+ *
103
+ * Send email for register interest confirmation
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.CreateRegisterInterestEmail
110
+ * @permission schema.action.createregisterinterestemail.trigger
111
+ * @benchmark This action is tracked for performance benchmarks
112
+ */
113
+ export declare class CreateRegisterInterestEmailDto extends OdinRecordCreateDto<CreateRegisterInterestEmailProperties> {
114
+ /** Used by SDK generators to identify action type */
115
+ static readonly ACTION_TYPE = "CREATE";
116
+ static readonly ACTION_KEY = "CreateRegisterInterestEmail";
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.CreateRegisterInterestEmail";
121
+ static readonly PERMISSION = "schema.action.createregisterinterestemail.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 = "0666fd12-e734-43e1-b928-87594c9f450b";
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: CreateRegisterInterestEmailProperties, options?: {
133
+ journeyId?: string;
134
+ });
135
+ }
@@ -0,0 +1,59 @@
1
+ "use strict";
2
+ /**
3
+ * CreateRegisterInterestEmail Action DTO
4
+ *
5
+ * Send email for register interest confirmation
6
+ *
7
+ * @module NotificationModule
8
+ * @entity Email
9
+ * @entityType TRANSACTIONAL
10
+ * @actionKey CreateRegisterInterestEmail
11
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateRegisterInterestEmail
12
+ *
13
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.CreateRegisterInterestEmailDto = void 0;
17
+ const core_1 = require("@d19n/odin-types/dist/core");
18
+ /**
19
+ * CreateRegisterInterestEmail
20
+ *
21
+ * Send email for register interest confirmation
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.CreateRegisterInterestEmail
28
+ * @permission schema.action.createregisterinterestemail.trigger
29
+ * @benchmark This action is tracked for performance benchmarks
30
+ */
31
+ class CreateRegisterInterestEmailDto 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 = 'CreateRegisterInterestEmail';
40
+ this.schemaActionId = '0666fd12-e734-43e1-b928-87594c9f450b';
41
+ this.entity = 'NotificationModule:Email';
42
+ }
43
+ }
44
+ exports.CreateRegisterInterestEmailDto = CreateRegisterInterestEmailDto;
45
+ /** Used by SDK generators to identify action type */
46
+ CreateRegisterInterestEmailDto.ACTION_TYPE = 'CREATE';
47
+ CreateRegisterInterestEmailDto.ACTION_KEY = 'CreateRegisterInterestEmail';
48
+ CreateRegisterInterestEmailDto.MODULE_NAME = 'NotificationModule';
49
+ CreateRegisterInterestEmailDto.ENTITIES = ['Email'];
50
+ CreateRegisterInterestEmailDto.ENTITY_TYPE = 'TRANSACTIONAL';
51
+ CreateRegisterInterestEmailDto.EVENT_NAME = 'k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateRegisterInterestEmail';
52
+ CreateRegisterInterestEmailDto.PERMISSION = 'schema.action.createregisterinterestemail.trigger';
53
+ /** Step metadata - entity this action targets */
54
+ CreateRegisterInterestEmailDto.STEP_ENTITY = 'NotificationModule:Email';
55
+ CreateRegisterInterestEmailDto.STEP_SCHEMA_ID = 'cb37958c-d72f-44aa-975a-a8fae42b1b72';
56
+ CreateRegisterInterestEmailDto.STEP_SCHEMA_ACTION_ID = '0666fd12-e734-43e1-b928-87594c9f450b';
57
+ CreateRegisterInterestEmailDto.STEP_SCHEMA_TYPE_ID = '14042940-a388-44c7-87fe-3a4105d92e94';
58
+ CreateRegisterInterestEmailDto.STEP_TYPE = 'TRANSACTIONAL';
59
+ CreateRegisterInterestEmailDto.AUTO_LINK_PARENT = true;
@@ -67,6 +67,7 @@ import { CreatePortalSignupProperties } from '../actions-v2/CreatePortalSignupDt
67
67
  import { CreatePreContractOrderSummaryProperties } from '../actions-v2/CreatePreContractOrderSummaryDto';
68
68
  import { CreateRecontractOrderConfirmationProperties } from '../actions-v2/CreateRecontractOrderConfirmationDto';
69
69
  import { CreateRecontractReminderEmailProperties } from '../actions-v2/CreateRecontractReminderEmailDto';
70
+ import { CreateRegisterInterestEmailProperties } from '../actions-v2/CreateRegisterInterestEmailDto';
70
71
  import { CreateServiceAppointmentConfirmationProperties } from '../actions-v2/CreateServiceAppointmentConfirmationDto';
71
72
  import { CreateServiceAppointmentRescheduledProperties } from '../actions-v2/CreateServiceAppointmentRescheduledDto';
72
73
  import { CreateServiceDeactivatedMandateProperties } from '../actions-v2/CreateServiceDeactivatedMandateDto';
@@ -1571,6 +1572,34 @@ export declare class EmailRecord<TProps = EmailProperties> {
1571
1572
  journeyId?: string;
1572
1573
  stageKey?: string;
1573
1574
  }): ActionBuilder;
1575
+ /**
1576
+ * CreateRegisterInterestEmail
1577
+ *
1578
+ * Creates a new Email record with the specified properties.
1579
+ * Returns an ActionBuilder - call .execute() to create or .dryRun() for debugging.
1580
+ *
1581
+ * @remarks Record type: TRANSACTIONAL
1582
+ *
1583
+ * @param properties - The properties for the new record
1584
+ * @param options - Optional settings
1585
+ * @param options.journeyId - Associate with a journey
1586
+ * @param options.stageKey - Set initial pipeline stage
1587
+ * @returns ActionBuilder - call .execute() to create or .dryRun() for payload
1588
+ *
1589
+ * @example
1590
+ * ```typescript
1591
+ * // Create with properties
1592
+ * const record = odinClient.emails.new();
1593
+ * await record.createRegisterInterestEmail({ ... }).execute();
1594
+ *
1595
+ * // Dry run (for debugging)
1596
+ * const payload = record.createRegisterInterestEmail({ ... }).dryRun();
1597
+ * ```
1598
+ */
1599
+ createRegisterInterestEmail(properties?: CreateRegisterInterestEmailProperties, options?: {
1600
+ journeyId?: string;
1601
+ stageKey?: string;
1602
+ }): ActionBuilder;
1574
1603
  /**
1575
1604
  * CreateServiceAppointmentConfirmation
1576
1605
  *
@@ -1972,6 +1972,42 @@ class EmailRecord {
1972
1972
  };
1973
1973
  return new ActionBuilder(this._provider, 'NotificationModule', 'Email', payload, () => { this._pendingLinks = []; });
1974
1974
  }
1975
+ /**
1976
+ * CreateRegisterInterestEmail
1977
+ *
1978
+ * Creates a new Email record with the specified properties.
1979
+ * Returns an ActionBuilder - call .execute() to create or .dryRun() for debugging.
1980
+ *
1981
+ * @remarks Record type: TRANSACTIONAL
1982
+ *
1983
+ * @param properties - The properties for the new record
1984
+ * @param options - Optional settings
1985
+ * @param options.journeyId - Associate with a journey
1986
+ * @param options.stageKey - Set initial pipeline stage
1987
+ * @returns ActionBuilder - call .execute() to create or .dryRun() for payload
1988
+ *
1989
+ * @example
1990
+ * ```typescript
1991
+ * // Create with properties
1992
+ * const record = odinClient.emails.new();
1993
+ * await record.createRegisterInterestEmail({ ... }).execute();
1994
+ *
1995
+ * // Dry run (for debugging)
1996
+ * const payload = record.createRegisterInterestEmail({ ... }).dryRun();
1997
+ * ```
1998
+ */
1999
+ createRegisterInterestEmail(properties, options) {
2000
+ const payload = {
2001
+ entity: 'NotificationModule:Email',
2002
+ type: 'TRANSACTIONAL',
2003
+ actionName: 'CreateRegisterInterestEmail',
2004
+ properties: properties || {},
2005
+ associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined,
2006
+ journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
2007
+ stageKey: options === null || options === void 0 ? void 0 : options.stageKey,
2008
+ };
2009
+ return new ActionBuilder(this._provider, 'NotificationModule', 'Email', payload, () => { this._pendingLinks = []; });
2010
+ }
1975
2011
  /**
1976
2012
  * CreateServiceAppointmentConfirmation
1977
2013
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@d19n/youfibre-odin-sdk",
3
- "version": "2.0.297",
3
+ "version": "2.0.299",
4
4
  "description": "",
5
5
  "author": "@d19n",
6
6
  "license": "UNLICENSED",