@d19n/youfibre-odin-sdk 2.0.10-beta.0 → 2.0.10-beta.2
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 **
|
|
355
|
+
This SDK includes **561** actions.
|
|
356
356
|
|
|
357
357
|
### Action Types
|
|
358
358
|
|
|
@@ -1618,6 +1618,7 @@ This SDK includes **560** actions.
|
|
|
1618
1618
|
| Action | Type | Event |
|
|
1619
1619
|
|--------|------|-------|
|
|
1620
1620
|
| `CreateTransactionalEmail` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateTransactionalEmail |
|
|
1621
|
+
| `SendOrderReferralRefereeNotQualified` | CREATE | k1.t-t-hEOJjsDb.NotificationModule.Email.Create.SendOrderReferralRefereeNotQualified |
|
|
1621
1622
|
| `SendOrderReferralRefereePendingEmail` | CREATE | k1.t-t-hEOJjsDb.NotificationModule.Email.Create.SendOrderReferralRefereePendingEmail |
|
|
1622
1623
|
| `SendTlosNinjaCaseEmail` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.SendTlosNinjaCaseEmail |
|
|
1623
1624
|
| `UpdateEmail` | UPDATE | k1.t-hEOJjsDb.NotificationModule.Email.Update.UpdateEmail |
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* SendOrderReferralRefereeNotQualified Action DTO
|
|
3
|
+
*
|
|
4
|
+
* Order Referral Referee Not Qualified
|
|
5
|
+
*
|
|
6
|
+
* @module NotificationModule
|
|
7
|
+
* @entity Email
|
|
8
|
+
* @entityType REFERRAL
|
|
9
|
+
* @actionKey SendOrderReferralRefereeNotQualified
|
|
10
|
+
* @event k1.t-t-hEOJjsDb.NotificationModule.Email.Create.SendOrderReferralRefereeNotQualified
|
|
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 SendOrderReferralRefereeNotQualified created events
|
|
17
|
+
*
|
|
18
|
+
* @event k1.t-t-hEOJjsDb.NotificationModule.Email.Create.SendOrderReferralRefereeNotQualified
|
|
19
|
+
*/
|
|
20
|
+
export interface SendOrderReferralRefereeNotQualifiedMessage extends OdinRecordCreatedEvent<SendOrderReferralRefereeNotQualifiedDto, SendOrderReferralRefereeNotQualifiedProperties> {
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Properties for SendOrderReferralRefereeNotQualified action
|
|
24
|
+
*
|
|
25
|
+
* @property Required fields: 0
|
|
26
|
+
* @property Optional fields: 9
|
|
27
|
+
*/
|
|
28
|
+
export interface SendOrderReferralRefereeNotQualifiedProperties {
|
|
29
|
+
/**
|
|
30
|
+
* DynamicData
|
|
31
|
+
*
|
|
32
|
+
* Data will pass to emailing service (variables)
|
|
33
|
+
* @type {JSON}
|
|
34
|
+
*/
|
|
35
|
+
DynamicData?: string | null;
|
|
36
|
+
/**
|
|
37
|
+
* Referral Id
|
|
38
|
+
*
|
|
39
|
+
* Reference to referral
|
|
40
|
+
* @type {LOOKUP}
|
|
41
|
+
*/
|
|
42
|
+
ReferralId?: string | null;
|
|
43
|
+
/**
|
|
44
|
+
* MessageId
|
|
45
|
+
*
|
|
46
|
+
* SMTP Message Id (Communications - Email)
|
|
47
|
+
* @type {TEXT}
|
|
48
|
+
*/
|
|
49
|
+
MessageId?: string | null;
|
|
50
|
+
/**
|
|
51
|
+
* ContactId
|
|
52
|
+
*
|
|
53
|
+
* The related Contact to send the email
|
|
54
|
+
* @type {LOOKUP}
|
|
55
|
+
*/
|
|
56
|
+
ContactId?: string | null;
|
|
57
|
+
/**
|
|
58
|
+
* Date
|
|
59
|
+
*
|
|
60
|
+
* Date field for Email records. Used by Communications team.
|
|
61
|
+
* @type {DATE_TIME}
|
|
62
|
+
*/
|
|
63
|
+
Date?: string | null;
|
|
64
|
+
/**
|
|
65
|
+
* TemplateLabel
|
|
66
|
+
*
|
|
67
|
+
* The template label from email templates engine
|
|
68
|
+
* @type {TEXT}
|
|
69
|
+
*/
|
|
70
|
+
TemplateLabel?: string | null;
|
|
71
|
+
/**
|
|
72
|
+
* To
|
|
73
|
+
*
|
|
74
|
+
* Data field for Email records. Used by Communications team.
|
|
75
|
+
* @type {TEXT}
|
|
76
|
+
*/
|
|
77
|
+
To?: string | null;
|
|
78
|
+
/**
|
|
79
|
+
* Subject
|
|
80
|
+
*
|
|
81
|
+
* Data field for Email records. Used by Communications team.
|
|
82
|
+
* @type {TEXT}
|
|
83
|
+
*/
|
|
84
|
+
Subject?: string | null;
|
|
85
|
+
/**
|
|
86
|
+
* Email Sender
|
|
87
|
+
*
|
|
88
|
+
* The Email Sender related entity
|
|
89
|
+
* @type {LOOKUP}
|
|
90
|
+
*/
|
|
91
|
+
EmailSenderId?: string | null;
|
|
92
|
+
}
|
|
93
|
+
/**
|
|
94
|
+
* SendOrderReferralRefereeNotQualified
|
|
95
|
+
*
|
|
96
|
+
* Order Referral Referee Not Qualified
|
|
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.SendOrderReferralRefereeNotQualified
|
|
103
|
+
* @permission schema.action.sendorderreferralrefereenotqualified.trigger
|
|
104
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
105
|
+
*/
|
|
106
|
+
export declare class SendOrderReferralRefereeNotQualifiedDto extends OdinRecordCreateDto<SendOrderReferralRefereeNotQualifiedProperties> {
|
|
107
|
+
/** Used by SDK generators to identify action type */
|
|
108
|
+
static readonly ACTION_TYPE = "CREATE";
|
|
109
|
+
static readonly ACTION_KEY = "SendOrderReferralRefereeNotQualified";
|
|
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.SendOrderReferralRefereeNotQualified";
|
|
114
|
+
static readonly PERMISSION = "schema.action.sendorderreferralrefereenotqualified.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 = "f1348e17-d8c9-40b5-ae07-c9d60c026fcd";
|
|
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: SendOrderReferralRefereeNotQualifiedProperties, options?: {
|
|
126
|
+
journeyId?: string;
|
|
127
|
+
});
|
|
128
|
+
}
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* SendOrderReferralRefereeNotQualified Action DTO
|
|
4
|
+
*
|
|
5
|
+
* Order Referral Referee Not Qualified
|
|
6
|
+
*
|
|
7
|
+
* @module NotificationModule
|
|
8
|
+
* @entity Email
|
|
9
|
+
* @entityType REFERRAL
|
|
10
|
+
* @actionKey SendOrderReferralRefereeNotQualified
|
|
11
|
+
* @event k1.t-t-hEOJjsDb.NotificationModule.Email.Create.SendOrderReferralRefereeNotQualified
|
|
12
|
+
*
|
|
13
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.SendOrderReferralRefereeNotQualifiedDto = void 0;
|
|
17
|
+
const core_1 = require("@d19n/odin-types/dist/core");
|
|
18
|
+
/**
|
|
19
|
+
* SendOrderReferralRefereeNotQualified
|
|
20
|
+
*
|
|
21
|
+
* Order Referral Referee Not Qualified
|
|
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.SendOrderReferralRefereeNotQualified
|
|
28
|
+
* @permission schema.action.sendorderreferralrefereenotqualified.trigger
|
|
29
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
30
|
+
*/
|
|
31
|
+
class SendOrderReferralRefereeNotQualifiedDto 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 = 'SendOrderReferralRefereeNotQualified';
|
|
40
|
+
this.schemaActionId = 'f1348e17-d8c9-40b5-ae07-c9d60c026fcd';
|
|
41
|
+
this.entity = 'NotificationModule:Email';
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
exports.SendOrderReferralRefereeNotQualifiedDto = SendOrderReferralRefereeNotQualifiedDto;
|
|
45
|
+
/** Used by SDK generators to identify action type */
|
|
46
|
+
SendOrderReferralRefereeNotQualifiedDto.ACTION_TYPE = 'CREATE';
|
|
47
|
+
SendOrderReferralRefereeNotQualifiedDto.ACTION_KEY = 'SendOrderReferralRefereeNotQualified';
|
|
48
|
+
SendOrderReferralRefereeNotQualifiedDto.MODULE_NAME = 'NotificationModule';
|
|
49
|
+
SendOrderReferralRefereeNotQualifiedDto.ENTITIES = ['Email'];
|
|
50
|
+
SendOrderReferralRefereeNotQualifiedDto.ENTITY_TYPE = 'REFERRAL';
|
|
51
|
+
SendOrderReferralRefereeNotQualifiedDto.EVENT_NAME = 'k1.t-t-hEOJjsDb.NotificationModule.Email.Create.SendOrderReferralRefereeNotQualified';
|
|
52
|
+
SendOrderReferralRefereeNotQualifiedDto.PERMISSION = 'schema.action.sendorderreferralrefereenotqualified.trigger';
|
|
53
|
+
/** Step metadata - entity this action targets */
|
|
54
|
+
SendOrderReferralRefereeNotQualifiedDto.STEP_ENTITY = 'NotificationModule:Email';
|
|
55
|
+
SendOrderReferralRefereeNotQualifiedDto.STEP_SCHEMA_ID = 'a3b4d6b7-0647-4202-90a6-036e3c87c5ae';
|
|
56
|
+
SendOrderReferralRefereeNotQualifiedDto.STEP_SCHEMA_ACTION_ID = 'f1348e17-d8c9-40b5-ae07-c9d60c026fcd';
|
|
57
|
+
SendOrderReferralRefereeNotQualifiedDto.STEP_SCHEMA_TYPE_ID = 'd9d0bf79-8d32-4f71-a6d7-3ce74dd5ba16';
|
|
58
|
+
SendOrderReferralRefereeNotQualifiedDto.STEP_TYPE = 'REFERRAL';
|
|
59
|
+
SendOrderReferralRefereeNotQualifiedDto.AUTO_LINK_PARENT = true;
|
|
@@ -24,6 +24,7 @@ import { IOdinProvider } from '@d19n/odin-sdk-generator/dist/odin-sdk-types';
|
|
|
24
24
|
import { RecordLinkManager } from '@d19n/odin-sdk-generator/dist/record-link-manager';
|
|
25
25
|
import { EmailProperties, ReferralEmailProperties, SupportEmailProperties, TransactionalEmailProperties } from '../entities-v2/Email';
|
|
26
26
|
import { CreateTransactionalEmailProperties } from '../actions-v2/CreateTransactionalEmailDto';
|
|
27
|
+
import { SendOrderReferralRefereeNotQualifiedProperties } from '../actions-v2/SendOrderReferralRefereeNotQualifiedDto';
|
|
27
28
|
import { SendOrderReferralRefereePendingEmailProperties } from '../actions-v2/SendOrderReferralRefereePendingEmailDto';
|
|
28
29
|
import { SendTlosNinjaCaseEmailProperties } from '../actions-v2/SendTlosNinjaCaseEmailDto';
|
|
29
30
|
import { UpdateEmailProperties } from '../actions-v2/UpdateEmailDto';
|
|
@@ -390,6 +391,34 @@ export declare class EmailRecord<TProps = EmailProperties> {
|
|
|
390
391
|
journeyId?: string;
|
|
391
392
|
stageKey?: string;
|
|
392
393
|
}): ActionBuilder;
|
|
394
|
+
/**
|
|
395
|
+
* SendOrderReferralRefereeNotQualified
|
|
396
|
+
*
|
|
397
|
+
* Creates a new Email record with the specified properties.
|
|
398
|
+
* Returns an ActionBuilder - call .execute() to create or .dryRun() for debugging.
|
|
399
|
+
*
|
|
400
|
+
* @remarks Record type: REFERRAL
|
|
401
|
+
*
|
|
402
|
+
* @param properties - The properties for the new record
|
|
403
|
+
* @param options - Optional settings
|
|
404
|
+
* @param options.journeyId - Associate with a journey
|
|
405
|
+
* @param options.stageKey - Set initial pipeline stage
|
|
406
|
+
* @returns ActionBuilder - call .execute() to create or .dryRun() for payload
|
|
407
|
+
*
|
|
408
|
+
* @example
|
|
409
|
+
* ```typescript
|
|
410
|
+
* // Create with properties
|
|
411
|
+
* const record = odinClient.emails.new();
|
|
412
|
+
* await record.sendOrderReferralRefereeNotQualified({ ... }).execute();
|
|
413
|
+
*
|
|
414
|
+
* // Dry run (for debugging)
|
|
415
|
+
* const payload = record.sendOrderReferralRefereeNotQualified({ ... }).dryRun();
|
|
416
|
+
* ```
|
|
417
|
+
*/
|
|
418
|
+
sendOrderReferralRefereeNotQualified(properties?: SendOrderReferralRefereeNotQualifiedProperties, options?: {
|
|
419
|
+
journeyId?: string;
|
|
420
|
+
stageKey?: string;
|
|
421
|
+
}): ActionBuilder;
|
|
393
422
|
/**
|
|
394
423
|
* SendOrderReferralRefereePendingEmail
|
|
395
424
|
*
|
|
@@ -530,6 +530,42 @@ class EmailRecord {
|
|
|
530
530
|
};
|
|
531
531
|
return new ActionBuilder(this._provider, 'NotificationModule', 'Email', payload, () => { this._pendingLinks = []; });
|
|
532
532
|
}
|
|
533
|
+
/**
|
|
534
|
+
* SendOrderReferralRefereeNotQualified
|
|
535
|
+
*
|
|
536
|
+
* Creates a new Email record with the specified properties.
|
|
537
|
+
* Returns an ActionBuilder - call .execute() to create or .dryRun() for debugging.
|
|
538
|
+
*
|
|
539
|
+
* @remarks Record type: REFERRAL
|
|
540
|
+
*
|
|
541
|
+
* @param properties - The properties for the new record
|
|
542
|
+
* @param options - Optional settings
|
|
543
|
+
* @param options.journeyId - Associate with a journey
|
|
544
|
+
* @param options.stageKey - Set initial pipeline stage
|
|
545
|
+
* @returns ActionBuilder - call .execute() to create or .dryRun() for payload
|
|
546
|
+
*
|
|
547
|
+
* @example
|
|
548
|
+
* ```typescript
|
|
549
|
+
* // Create with properties
|
|
550
|
+
* const record = odinClient.emails.new();
|
|
551
|
+
* await record.sendOrderReferralRefereeNotQualified({ ... }).execute();
|
|
552
|
+
*
|
|
553
|
+
* // Dry run (for debugging)
|
|
554
|
+
* const payload = record.sendOrderReferralRefereeNotQualified({ ... }).dryRun();
|
|
555
|
+
* ```
|
|
556
|
+
*/
|
|
557
|
+
sendOrderReferralRefereeNotQualified(properties, options) {
|
|
558
|
+
const payload = {
|
|
559
|
+
entity: 'NotificationModule:Email',
|
|
560
|
+
type: 'REFERRAL',
|
|
561
|
+
actionName: 'SendOrderReferralRefereeNotQualified',
|
|
562
|
+
properties: properties || {},
|
|
563
|
+
associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined,
|
|
564
|
+
journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
|
|
565
|
+
stageKey: options === null || options === void 0 ? void 0 : options.stageKey,
|
|
566
|
+
};
|
|
567
|
+
return new ActionBuilder(this._provider, 'NotificationModule', 'Email', payload, () => { this._pendingLinks = []; });
|
|
568
|
+
}
|
|
533
569
|
/**
|
|
534
570
|
* SendOrderReferralRefereePendingEmail
|
|
535
571
|
*
|