@d19n/youfibre-odin-sdk 2.0.10-beta.4 → 2.0.10-beta.5

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
@@ -352,7 +352,7 @@ This SDK includes **164** entities across **12** modules.
352
352
 
353
353
  ## Actions
354
354
 
355
- This SDK includes **574** actions.
355
+ This SDK includes **575** actions.
356
356
 
357
357
  ### Action Types
358
358
 
@@ -1139,6 +1139,7 @@ This SDK includes **574** actions.
1139
1139
  | `CreateOrderReferralRefereeQualifiedEmail` | CREATE | k1.t-t-hEOJjsDb.NotificationModule.Email.Create.CreateOrderReferralRefereeQualifiedEmail |
1140
1140
  | `CreateOrderReferralReferrerCancelledEmail` | CREATE | k1.t-t-hEOJjsDb.NotificationModule.Email.Create.CreateOrderReferralReferrerCancelledEmail |
1141
1141
  | `CreateOrderReferralReferrerNotQualifiedEmail` | CREATE | k1.t-t-hEOJjsDb.NotificationModule.Email.Create.CreateOrderReferralReferrerNotQualifiedEmail |
1142
+ | `CreateOrderReferralReferrerPendingEmail` | CREATE | k1.t-t-hEOJjsDb.NotificationModule.Email.Create.CreateOrderReferralReferrerPendingEmail |
1142
1143
  | `CreateOrderReferralReferrerQualifiedEmail` | CREATE | k1.t-t-hEOJjsDb.NotificationModule.Email.Create.CreateOrderReferralReferrerQualifiedEmail |
1143
1144
  | `CreateTransactionalEmail` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateTransactionalEmail |
1144
1145
  | `SendOrderReferralRefereePendingEmail` | CREATE | k1.t-t-hEOJjsDb.NotificationModule.Email.Create.SendOrderReferralRefereePendingEmail |
@@ -0,0 +1,128 @@
1
+ /**
2
+ * CreateOrderReferralReferrerPendingEmail Action DTO
3
+ *
4
+ * referral reaches pending validation stage
5
+ *
6
+ * @module NotificationModule
7
+ * @entity Email
8
+ * @entityType REFERRAL
9
+ * @actionKey CreateOrderReferralReferrerPendingEmail
10
+ * @event k1.t-t-hEOJjsDb.NotificationModule.Email.Create.CreateOrderReferralReferrerPendingEmail
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 CreateOrderReferralReferrerPendingEmail created events
17
+ *
18
+ * @event k1.t-t-hEOJjsDb.NotificationModule.Email.Create.CreateOrderReferralReferrerPendingEmail
19
+ */
20
+ export interface CreateOrderReferralReferrerPendingEmailMessage extends OdinRecordCreatedEvent<CreateOrderReferralReferrerPendingEmailDto, CreateOrderReferralReferrerPendingEmailProperties> {
21
+ }
22
+ /**
23
+ * Properties for CreateOrderReferralReferrerPendingEmail action
24
+ *
25
+ * @property Required fields: 0
26
+ * @property Optional fields: 9
27
+ */
28
+ export interface CreateOrderReferralReferrerPendingEmailProperties {
29
+ /**
30
+ * ContactId
31
+ *
32
+ * The related Contact to send the email
33
+ * @type {LOOKUP}
34
+ */
35
+ ContactId?: string | null;
36
+ /**
37
+ * Date
38
+ *
39
+ * Date field for Email records. Used by Communications team.
40
+ * @type {DATE_TIME}
41
+ */
42
+ Date?: string | null;
43
+ /**
44
+ * DynamicData
45
+ *
46
+ * Data will pass to emailing service (variables)
47
+ * @type {JSON}
48
+ */
49
+ DynamicData?: string | null;
50
+ /**
51
+ * MessageId
52
+ *
53
+ * SMTP Message Id (Communications - Email)
54
+ * @type {TEXT}
55
+ */
56
+ MessageId?: string | null;
57
+ /**
58
+ * Referral Id
59
+ *
60
+ * Reference to referral
61
+ * @type {LOOKUP}
62
+ */
63
+ ReferralId?: string | null;
64
+ /**
65
+ * Subject
66
+ *
67
+ * Data field for Email records. Used by Communications team.
68
+ * @type {TEXT}
69
+ */
70
+ Subject?: string | null;
71
+ /**
72
+ * TemplateLabel
73
+ *
74
+ * The template label from email templates engine
75
+ * @type {TEXT}
76
+ */
77
+ TemplateLabel?: string | null;
78
+ /**
79
+ * To
80
+ *
81
+ * Data field for Email records. Used by Communications team.
82
+ * @type {TEXT}
83
+ */
84
+ To?: string | null;
85
+ /**
86
+ * Email Sender
87
+ *
88
+ * The Email Sender related entity
89
+ * @type {LOOKUP}
90
+ */
91
+ EmailSenderId?: string | null;
92
+ }
93
+ /**
94
+ * CreateOrderReferralReferrerPendingEmail
95
+ *
96
+ * referral reaches pending validation stage
97
+ *
98
+ * @actionType CREATE - Creates a new Email record
99
+ * @module NotificationModule
100
+ * @entity Email
101
+ * @entityType REFERRAL (REFERRAL)
102
+ * @event k1.t-t-hEOJjsDb.NotificationModule.Email.Create.CreateOrderReferralReferrerPendingEmail
103
+ * @permission schema.action.createorderreferralreferrerpendingemail.trigger
104
+ * @benchmark This action is tracked for performance benchmarks
105
+ */
106
+ export declare class CreateOrderReferralReferrerPendingEmailDto extends OdinRecordCreateDto<CreateOrderReferralReferrerPendingEmailProperties> {
107
+ /** Used by SDK generators to identify action type */
108
+ static readonly ACTION_TYPE = "CREATE";
109
+ static readonly ACTION_KEY = "CreateOrderReferralReferrerPendingEmail";
110
+ static readonly MODULE_NAME = "NotificationModule";
111
+ static readonly ENTITIES: string[];
112
+ static readonly ENTITY_TYPE = "REFERRAL";
113
+ static readonly EVENT_NAME = "k1.t-t-hEOJjsDb.NotificationModule.Email.Create.CreateOrderReferralReferrerPendingEmail";
114
+ static readonly PERMISSION = "schema.action.createorderreferralreferrerpendingemail.trigger";
115
+ /** Step metadata - entity this action targets */
116
+ static readonly STEP_ENTITY = "NotificationModule:Email";
117
+ static readonly STEP_SCHEMA_ID = "a3b4d6b7-0647-4202-90a6-036e3c87c5ae";
118
+ static readonly STEP_SCHEMA_ACTION_ID = "51b00a55-73b4-4e35-9ab3-4ce985f710ef";
119
+ static readonly STEP_SCHEMA_TYPE_ID = "d9d0bf79-8d32-4f71-a6d7-3ce74dd5ba16";
120
+ static readonly STEP_TYPE = "REFERRAL";
121
+ static readonly AUTO_LINK_PARENT = true;
122
+ readonly actionName: string;
123
+ readonly schemaActionId: string;
124
+ readonly entity: string;
125
+ constructor(properties: CreateOrderReferralReferrerPendingEmailProperties, options?: {
126
+ journeyId?: string;
127
+ });
128
+ }
@@ -0,0 +1,59 @@
1
+ "use strict";
2
+ /**
3
+ * CreateOrderReferralReferrerPendingEmail Action DTO
4
+ *
5
+ * referral reaches pending validation stage
6
+ *
7
+ * @module NotificationModule
8
+ * @entity Email
9
+ * @entityType REFERRAL
10
+ * @actionKey CreateOrderReferralReferrerPendingEmail
11
+ * @event k1.t-t-hEOJjsDb.NotificationModule.Email.Create.CreateOrderReferralReferrerPendingEmail
12
+ *
13
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.CreateOrderReferralReferrerPendingEmailDto = void 0;
17
+ const core_1 = require("@d19n/odin-types/dist/core");
18
+ /**
19
+ * CreateOrderReferralReferrerPendingEmail
20
+ *
21
+ * referral reaches pending validation stage
22
+ *
23
+ * @actionType CREATE - Creates a new Email record
24
+ * @module NotificationModule
25
+ * @entity Email
26
+ * @entityType REFERRAL (REFERRAL)
27
+ * @event k1.t-t-hEOJjsDb.NotificationModule.Email.Create.CreateOrderReferralReferrerPendingEmail
28
+ * @permission schema.action.createorderreferralreferrerpendingemail.trigger
29
+ * @benchmark This action is tracked for performance benchmarks
30
+ */
31
+ class CreateOrderReferralReferrerPendingEmailDto extends core_1.OdinRecordCreateDto {
32
+ constructor(properties, options) {
33
+ super({
34
+ entity: 'NotificationModule:Email',
35
+ type: 'REFERRAL',
36
+ properties,
37
+ journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
38
+ });
39
+ this.actionName = 'CreateOrderReferralReferrerPendingEmail';
40
+ this.schemaActionId = '51b00a55-73b4-4e35-9ab3-4ce985f710ef';
41
+ this.entity = 'NotificationModule:Email';
42
+ }
43
+ }
44
+ exports.CreateOrderReferralReferrerPendingEmailDto = CreateOrderReferralReferrerPendingEmailDto;
45
+ /** Used by SDK generators to identify action type */
46
+ CreateOrderReferralReferrerPendingEmailDto.ACTION_TYPE = 'CREATE';
47
+ CreateOrderReferralReferrerPendingEmailDto.ACTION_KEY = 'CreateOrderReferralReferrerPendingEmail';
48
+ CreateOrderReferralReferrerPendingEmailDto.MODULE_NAME = 'NotificationModule';
49
+ CreateOrderReferralReferrerPendingEmailDto.ENTITIES = ['Email'];
50
+ CreateOrderReferralReferrerPendingEmailDto.ENTITY_TYPE = 'REFERRAL';
51
+ CreateOrderReferralReferrerPendingEmailDto.EVENT_NAME = 'k1.t-t-hEOJjsDb.NotificationModule.Email.Create.CreateOrderReferralReferrerPendingEmail';
52
+ CreateOrderReferralReferrerPendingEmailDto.PERMISSION = 'schema.action.createorderreferralreferrerpendingemail.trigger';
53
+ /** Step metadata - entity this action targets */
54
+ CreateOrderReferralReferrerPendingEmailDto.STEP_ENTITY = 'NotificationModule:Email';
55
+ CreateOrderReferralReferrerPendingEmailDto.STEP_SCHEMA_ID = 'a3b4d6b7-0647-4202-90a6-036e3c87c5ae';
56
+ CreateOrderReferralReferrerPendingEmailDto.STEP_SCHEMA_ACTION_ID = '51b00a55-73b4-4e35-9ab3-4ce985f710ef';
57
+ CreateOrderReferralReferrerPendingEmailDto.STEP_SCHEMA_TYPE_ID = 'd9d0bf79-8d32-4f71-a6d7-3ce74dd5ba16';
58
+ CreateOrderReferralReferrerPendingEmailDto.STEP_TYPE = 'REFERRAL';
59
+ CreateOrderReferralReferrerPendingEmailDto.AUTO_LINK_PARENT = true;
@@ -35,6 +35,7 @@ import { CreateOrderReferralRefereePendingEmailProperties } from '../actions-v2/
35
35
  import { CreateOrderReferralRefereeQualifiedEmailProperties } from '../actions-v2/CreateOrderReferralRefereeQualifiedEmailDto';
36
36
  import { CreateOrderReferralReferrerCancelledEmailProperties } from '../actions-v2/CreateOrderReferralReferrerCancelledEmailDto';
37
37
  import { CreateOrderReferralReferrerNotQualifiedEmailProperties } from '../actions-v2/CreateOrderReferralReferrerNotQualifiedEmailDto';
38
+ import { CreateOrderReferralReferrerPendingEmailProperties } from '../actions-v2/CreateOrderReferralReferrerPendingEmailDto';
38
39
  import { CreateOrderReferralReferrerQualifiedEmailProperties } from '../actions-v2/CreateOrderReferralReferrerQualifiedEmailDto';
39
40
  import { CreateTransactionalEmailProperties } from '../actions-v2/CreateTransactionalEmailDto';
40
41
  import { SendOrderReferralRefereePendingEmailProperties } from '../actions-v2/SendOrderReferralRefereePendingEmailDto';
@@ -711,6 +712,34 @@ export declare class EmailRecord<TProps = EmailProperties> {
711
712
  journeyId?: string;
712
713
  stageKey?: string;
713
714
  }): ActionBuilder;
715
+ /**
716
+ * CreateOrderReferralReferrerPendingEmail
717
+ *
718
+ * Creates a new Email record with the specified properties.
719
+ * Returns an ActionBuilder - call .execute() to create or .dryRun() for debugging.
720
+ *
721
+ * @remarks Record type: REFERRAL
722
+ *
723
+ * @param properties - The properties for the new record
724
+ * @param options - Optional settings
725
+ * @param options.journeyId - Associate with a journey
726
+ * @param options.stageKey - Set initial pipeline stage
727
+ * @returns ActionBuilder - call .execute() to create or .dryRun() for payload
728
+ *
729
+ * @example
730
+ * ```typescript
731
+ * // Create with properties
732
+ * const record = odinClient.emails.new();
733
+ * await record.createOrderReferralReferrerPendingEmail({ ... }).execute();
734
+ *
735
+ * // Dry run (for debugging)
736
+ * const payload = record.createOrderReferralReferrerPendingEmail({ ... }).dryRun();
737
+ * ```
738
+ */
739
+ createOrderReferralReferrerPendingEmail(properties?: CreateOrderReferralReferrerPendingEmailProperties, options?: {
740
+ journeyId?: string;
741
+ stageKey?: string;
742
+ }): ActionBuilder;
714
743
  /**
715
744
  * CreateOrderReferralReferrerQualifiedEmail
716
745
  *
@@ -926,6 +926,42 @@ class EmailRecord {
926
926
  };
927
927
  return new ActionBuilder(this._provider, 'NotificationModule', 'Email', payload, () => { this._pendingLinks = []; });
928
928
  }
929
+ /**
930
+ * CreateOrderReferralReferrerPendingEmail
931
+ *
932
+ * Creates a new Email record with the specified properties.
933
+ * Returns an ActionBuilder - call .execute() to create or .dryRun() for debugging.
934
+ *
935
+ * @remarks Record type: REFERRAL
936
+ *
937
+ * @param properties - The properties for the new record
938
+ * @param options - Optional settings
939
+ * @param options.journeyId - Associate with a journey
940
+ * @param options.stageKey - Set initial pipeline stage
941
+ * @returns ActionBuilder - call .execute() to create or .dryRun() for payload
942
+ *
943
+ * @example
944
+ * ```typescript
945
+ * // Create with properties
946
+ * const record = odinClient.emails.new();
947
+ * await record.createOrderReferralReferrerPendingEmail({ ... }).execute();
948
+ *
949
+ * // Dry run (for debugging)
950
+ * const payload = record.createOrderReferralReferrerPendingEmail({ ... }).dryRun();
951
+ * ```
952
+ */
953
+ createOrderReferralReferrerPendingEmail(properties, options) {
954
+ const payload = {
955
+ entity: 'NotificationModule:Email',
956
+ type: 'REFERRAL',
957
+ actionName: 'CreateOrderReferralReferrerPendingEmail',
958
+ properties: properties || {},
959
+ associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined,
960
+ journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
961
+ stageKey: options === null || options === void 0 ? void 0 : options.stageKey,
962
+ };
963
+ return new ActionBuilder(this._provider, 'NotificationModule', 'Email', payload, () => { this._pendingLinks = []; });
964
+ }
929
965
  /**
930
966
  * CreateOrderReferralReferrerQualifiedEmail
931
967
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@d19n/youfibre-odin-sdk",
3
- "version": "2.0.10-beta.4",
3
+ "version": "2.0.10-beta.5",
4
4
  "description": "",
5
5
  "author": "@d19n",
6
6
  "license": "UNLICENSED",