@d19n/youfibre-odin-sdk 2.0.324 → 2.0.326
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 +4 -2
- package/dist/actions-v2/CreateOtsGainingSwitchCancelledDto.d.ts +135 -0
- package/dist/actions-v2/CreateOtsGainingSwitchCancelledDto.js +59 -0
- package/dist/actions-v2/CreateRollingContractSummaryDto.d.ts +135 -0
- package/dist/actions-v2/CreateRollingContractSummaryDto.js +59 -0
- package/dist/actions-v2/MovePgPaymentMethodToCancellationRequestedDto.d.ts +17 -17
- package/dist/actions-v2/MovePgPaymentMethodToCancellationRequestedDto.js +14 -15
- package/dist/entities-v2/ModifyServiceRequest.d.ts +41 -1
- package/dist/entities-v2/ModifyServiceRequest.js +29 -1
- package/dist/entities-v2/YfWifiSurvey.d.ts +25 -1
- package/dist/entities-v2/YfWifiSurvey.js +6 -0
- package/dist/records-v2/EmailRecord.d.ts +58 -0
- package/dist/records-v2/EmailRecord.js +72 -0
- package/package.json +1 -1
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 **
|
|
378
|
+
This SDK includes **885** actions.
|
|
379
379
|
|
|
380
380
|
### Action Types
|
|
381
381
|
|
|
@@ -1419,6 +1419,7 @@ This SDK includes **883** actions.
|
|
|
1419
1419
|
| `CreateOrderReferralReferrerPendingEmail` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateOrderReferralReferrerPendingEmail |
|
|
1420
1420
|
| `CreateOrderReferralReferrerQualifiedEmail` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateOrderReferralReferrerQualifiedEmail |
|
|
1421
1421
|
| `CreateOtsGainingCancellationIssue` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateOtsGainingCancellationIssue |
|
|
1422
|
+
| `CreateOtsGainingSwitchCancelled` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateOtsGainingSwitchCancelled |
|
|
1422
1423
|
| `CreateOtsGainingSwitchComplete` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateOtsGainingSwitchComplete |
|
|
1423
1424
|
| `CreateOtsLosingSwitchConfirmation` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateOtsLosingSwitchConfirmation |
|
|
1424
1425
|
| `CreateOtsLosingSwitchImpact` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateOtsLosingSwitchImpact |
|
|
@@ -1432,6 +1433,7 @@ This SDK includes **883** actions.
|
|
|
1432
1433
|
| `CreateRecontractOrderConfirmation` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateRecontractOrderConfirmation |
|
|
1433
1434
|
| `CreateRecontractReminderEmail` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateRecontractReminderEmail |
|
|
1434
1435
|
| `CreateRegisterInterestEmail` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateRegisterInterestEmail |
|
|
1436
|
+
| `CreateRollingContractSummary` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateRollingContractSummary |
|
|
1435
1437
|
| `CreateServiceAppointmentConfirmation` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateServiceAppointmentConfirmation |
|
|
1436
1438
|
| `CreateServiceAppointmentRescheduled` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateServiceAppointmentRescheduled |
|
|
1437
1439
|
| `CreateServiceDeactivatedMandate` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateServiceDeactivatedMandate |
|
|
@@ -1879,7 +1881,7 @@ This SDK includes **883** actions.
|
|
|
1879
1881
|
| `MovePgPaymentMethodToActive` | STAGE_TRANSITION | k1.t-hEOJjsDb.BillingModule.PgPaymentMethod.Transition.MovePgPaymentMethodToActive |
|
|
1880
1882
|
| `MovePgPaymentMethodToAllocated` | STAGE_TRANSITION | k1.t-hEOJjsDb.BillingModule.PgPaymentMethod.Transition.MovePgPaymentMethodToAllocated |
|
|
1881
1883
|
| `MovePgPaymentMethodToCancellationPending` | STAGE_TRANSITION | k1.t-hEOJjsDb.BillingModule.PgPaymentMethod.Transition.MovePgPaymentMethodToCancellationPending |
|
|
1882
|
-
| `MovePgPaymentMethodToCancellationRequested` | STAGE_TRANSITION | k1.t-hEOJjsDb.BillingModule.PgPaymentMethod.
|
|
1884
|
+
| `MovePgPaymentMethodToCancellationRequested` | STAGE_TRANSITION | k1.t-hEOJjsDb.BillingModule.PgPaymentMethod.Transition.MovePgPaymentMethodToCancellationRequested |
|
|
1883
1885
|
| `MovePgPaymentMethodToCancelled` | STAGE_TRANSITION | k1.t-hEOJjsDb.BillingModule.PgPaymentMethod.Transition.MovePgPaymentMethodToCancelled |
|
|
1884
1886
|
| `MovePgPaymentMethodToCreated` | STAGE_TRANSITION | k1.t-hEOJjsDb.BillingModule.PgPaymentMethod.Transition.MovePgPaymentMethodToCreated |
|
|
1885
1887
|
| `MovePgPaymentMethodToFileRejected` | STAGE_TRANSITION | k1.t-hEOJjsDb.BillingModule.PgPaymentMethod.Transition.MovePgPaymentMethodToFileRejected |
|
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* CreateOtsGainingSwitchCancelled Action DTO
|
|
3
|
+
*
|
|
4
|
+
* OTS gaining — switch cancellation confirmation to the customer
|
|
5
|
+
*
|
|
6
|
+
* @module NotificationModule
|
|
7
|
+
* @entity Email
|
|
8
|
+
* @entityType TRANSACTIONAL
|
|
9
|
+
* @actionKey CreateOtsGainingSwitchCancelled
|
|
10
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateOtsGainingSwitchCancelled
|
|
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 CreateOtsGainingSwitchCancelled created events
|
|
17
|
+
*
|
|
18
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateOtsGainingSwitchCancelled
|
|
19
|
+
*/
|
|
20
|
+
export interface CreateOtsGainingSwitchCancelledMessage extends OdinRecordCreatedEvent<CreateOtsGainingSwitchCancelledDto, CreateOtsGainingSwitchCancelledProperties> {
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Properties for CreateOtsGainingSwitchCancelled action
|
|
24
|
+
*
|
|
25
|
+
* @property Required fields: 0
|
|
26
|
+
* @property Optional fields: 10
|
|
27
|
+
*/
|
|
28
|
+
export interface CreateOtsGainingSwitchCancelledProperties {
|
|
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
|
+
* CreateOtsGainingSwitchCancelled
|
|
102
|
+
*
|
|
103
|
+
* OTS gaining — switch cancellation confirmation to the customer
|
|
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.CreateOtsGainingSwitchCancelled
|
|
110
|
+
* @permission schema.action.createotsgainingswitchcancelled.trigger
|
|
111
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
112
|
+
*/
|
|
113
|
+
export declare class CreateOtsGainingSwitchCancelledDto extends OdinRecordCreateDto<CreateOtsGainingSwitchCancelledProperties> {
|
|
114
|
+
/** Used by SDK generators to identify action type */
|
|
115
|
+
static readonly ACTION_TYPE = "CREATE";
|
|
116
|
+
static readonly ACTION_KEY = "CreateOtsGainingSwitchCancelled";
|
|
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.CreateOtsGainingSwitchCancelled";
|
|
121
|
+
static readonly PERMISSION = "schema.action.createotsgainingswitchcancelled.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 = "cc7563a1-c2c5-4702-9d1c-40197ba15ee7";
|
|
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: CreateOtsGainingSwitchCancelledProperties, options?: {
|
|
133
|
+
journeyId?: string;
|
|
134
|
+
});
|
|
135
|
+
}
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* CreateOtsGainingSwitchCancelled Action DTO
|
|
4
|
+
*
|
|
5
|
+
* OTS gaining — switch cancellation confirmation to the customer
|
|
6
|
+
*
|
|
7
|
+
* @module NotificationModule
|
|
8
|
+
* @entity Email
|
|
9
|
+
* @entityType TRANSACTIONAL
|
|
10
|
+
* @actionKey CreateOtsGainingSwitchCancelled
|
|
11
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateOtsGainingSwitchCancelled
|
|
12
|
+
*
|
|
13
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.CreateOtsGainingSwitchCancelledDto = void 0;
|
|
17
|
+
const core_1 = require("@d19n/odin-types/dist/core");
|
|
18
|
+
/**
|
|
19
|
+
* CreateOtsGainingSwitchCancelled
|
|
20
|
+
*
|
|
21
|
+
* OTS gaining — switch cancellation confirmation to the customer
|
|
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.CreateOtsGainingSwitchCancelled
|
|
28
|
+
* @permission schema.action.createotsgainingswitchcancelled.trigger
|
|
29
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
30
|
+
*/
|
|
31
|
+
class CreateOtsGainingSwitchCancelledDto 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 = 'CreateOtsGainingSwitchCancelled';
|
|
40
|
+
this.schemaActionId = 'cc7563a1-c2c5-4702-9d1c-40197ba15ee7';
|
|
41
|
+
this.entity = 'NotificationModule:Email';
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
exports.CreateOtsGainingSwitchCancelledDto = CreateOtsGainingSwitchCancelledDto;
|
|
45
|
+
/** Used by SDK generators to identify action type */
|
|
46
|
+
CreateOtsGainingSwitchCancelledDto.ACTION_TYPE = 'CREATE';
|
|
47
|
+
CreateOtsGainingSwitchCancelledDto.ACTION_KEY = 'CreateOtsGainingSwitchCancelled';
|
|
48
|
+
CreateOtsGainingSwitchCancelledDto.MODULE_NAME = 'NotificationModule';
|
|
49
|
+
CreateOtsGainingSwitchCancelledDto.ENTITIES = ['Email'];
|
|
50
|
+
CreateOtsGainingSwitchCancelledDto.ENTITY_TYPE = 'TRANSACTIONAL';
|
|
51
|
+
CreateOtsGainingSwitchCancelledDto.EVENT_NAME = 'k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateOtsGainingSwitchCancelled';
|
|
52
|
+
CreateOtsGainingSwitchCancelledDto.PERMISSION = 'schema.action.createotsgainingswitchcancelled.trigger';
|
|
53
|
+
/** Step metadata - entity this action targets */
|
|
54
|
+
CreateOtsGainingSwitchCancelledDto.STEP_ENTITY = 'NotificationModule:Email';
|
|
55
|
+
CreateOtsGainingSwitchCancelledDto.STEP_SCHEMA_ID = 'cb37958c-d72f-44aa-975a-a8fae42b1b72';
|
|
56
|
+
CreateOtsGainingSwitchCancelledDto.STEP_SCHEMA_ACTION_ID = 'cc7563a1-c2c5-4702-9d1c-40197ba15ee7';
|
|
57
|
+
CreateOtsGainingSwitchCancelledDto.STEP_SCHEMA_TYPE_ID = '14042940-a388-44c7-87fe-3a4105d92e94';
|
|
58
|
+
CreateOtsGainingSwitchCancelledDto.STEP_TYPE = 'TRANSACTIONAL';
|
|
59
|
+
CreateOtsGainingSwitchCancelledDto.AUTO_LINK_PARENT = true;
|
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* CreateRollingContractSummary Action DTO
|
|
3
|
+
*
|
|
4
|
+
* OT-1870. Send the monthly rolling contract summary on the day a fixed term ends.
|
|
5
|
+
*
|
|
6
|
+
* @module NotificationModule
|
|
7
|
+
* @entity Email
|
|
8
|
+
* @entityType TRANSACTIONAL
|
|
9
|
+
* @actionKey CreateRollingContractSummary
|
|
10
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateRollingContractSummary
|
|
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 CreateRollingContractSummary created events
|
|
17
|
+
*
|
|
18
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateRollingContractSummary
|
|
19
|
+
*/
|
|
20
|
+
export interface CreateRollingContractSummaryMessage extends OdinRecordCreatedEvent<CreateRollingContractSummaryDto, CreateRollingContractSummaryProperties> {
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Properties for CreateRollingContractSummary action
|
|
24
|
+
*
|
|
25
|
+
* @property Required fields: 0
|
|
26
|
+
* @property Optional fields: 10
|
|
27
|
+
*/
|
|
28
|
+
export interface CreateRollingContractSummaryProperties {
|
|
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
|
+
* CreateRollingContractSummary
|
|
102
|
+
*
|
|
103
|
+
* OT-1870. Send the monthly rolling contract summary on the day a fixed term ends.
|
|
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.CreateRollingContractSummary
|
|
110
|
+
* @permission schema.action.createrollingcontractsummary.trigger
|
|
111
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
112
|
+
*/
|
|
113
|
+
export declare class CreateRollingContractSummaryDto extends OdinRecordCreateDto<CreateRollingContractSummaryProperties> {
|
|
114
|
+
/** Used by SDK generators to identify action type */
|
|
115
|
+
static readonly ACTION_TYPE = "CREATE";
|
|
116
|
+
static readonly ACTION_KEY = "CreateRollingContractSummary";
|
|
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.CreateRollingContractSummary";
|
|
121
|
+
static readonly PERMISSION = "schema.action.createrollingcontractsummary.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 = "b3dd4243-df50-4187-a7f9-5a2f5e4e49c8";
|
|
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: CreateRollingContractSummaryProperties, options?: {
|
|
133
|
+
journeyId?: string;
|
|
134
|
+
});
|
|
135
|
+
}
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* CreateRollingContractSummary Action DTO
|
|
4
|
+
*
|
|
5
|
+
* OT-1870. Send the monthly rolling contract summary on the day a fixed term ends.
|
|
6
|
+
*
|
|
7
|
+
* @module NotificationModule
|
|
8
|
+
* @entity Email
|
|
9
|
+
* @entityType TRANSACTIONAL
|
|
10
|
+
* @actionKey CreateRollingContractSummary
|
|
11
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateRollingContractSummary
|
|
12
|
+
*
|
|
13
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.CreateRollingContractSummaryDto = void 0;
|
|
17
|
+
const core_1 = require("@d19n/odin-types/dist/core");
|
|
18
|
+
/**
|
|
19
|
+
* CreateRollingContractSummary
|
|
20
|
+
*
|
|
21
|
+
* OT-1870. Send the monthly rolling contract summary on the day a fixed term ends.
|
|
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.CreateRollingContractSummary
|
|
28
|
+
* @permission schema.action.createrollingcontractsummary.trigger
|
|
29
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
30
|
+
*/
|
|
31
|
+
class CreateRollingContractSummaryDto 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 = 'CreateRollingContractSummary';
|
|
40
|
+
this.schemaActionId = 'b3dd4243-df50-4187-a7f9-5a2f5e4e49c8';
|
|
41
|
+
this.entity = 'NotificationModule:Email';
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
exports.CreateRollingContractSummaryDto = CreateRollingContractSummaryDto;
|
|
45
|
+
/** Used by SDK generators to identify action type */
|
|
46
|
+
CreateRollingContractSummaryDto.ACTION_TYPE = 'CREATE';
|
|
47
|
+
CreateRollingContractSummaryDto.ACTION_KEY = 'CreateRollingContractSummary';
|
|
48
|
+
CreateRollingContractSummaryDto.MODULE_NAME = 'NotificationModule';
|
|
49
|
+
CreateRollingContractSummaryDto.ENTITIES = ['Email'];
|
|
50
|
+
CreateRollingContractSummaryDto.ENTITY_TYPE = 'TRANSACTIONAL';
|
|
51
|
+
CreateRollingContractSummaryDto.EVENT_NAME = 'k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateRollingContractSummary';
|
|
52
|
+
CreateRollingContractSummaryDto.PERMISSION = 'schema.action.createrollingcontractsummary.trigger';
|
|
53
|
+
/** Step metadata - entity this action targets */
|
|
54
|
+
CreateRollingContractSummaryDto.STEP_ENTITY = 'NotificationModule:Email';
|
|
55
|
+
CreateRollingContractSummaryDto.STEP_SCHEMA_ID = 'cb37958c-d72f-44aa-975a-a8fae42b1b72';
|
|
56
|
+
CreateRollingContractSummaryDto.STEP_SCHEMA_ACTION_ID = 'b3dd4243-df50-4187-a7f9-5a2f5e4e49c8';
|
|
57
|
+
CreateRollingContractSummaryDto.STEP_SCHEMA_TYPE_ID = '14042940-a388-44c7-87fe-3a4105d92e94';
|
|
58
|
+
CreateRollingContractSummaryDto.STEP_TYPE = 'TRANSACTIONAL';
|
|
59
|
+
CreateRollingContractSummaryDto.AUTO_LINK_PARENT = true;
|
|
@@ -7,17 +7,17 @@
|
|
|
7
7
|
* @entity PgPaymentMethod
|
|
8
8
|
* @entityType DEFAULT
|
|
9
9
|
* @actionKey MovePgPaymentMethodToCancellationRequested
|
|
10
|
-
* @event k1.t-hEOJjsDb.BillingModule.PgPaymentMethod.
|
|
10
|
+
* @event k1.t-hEOJjsDb.BillingModule.PgPaymentMethod.Transition.MovePgPaymentMethodToCancellationRequested
|
|
11
11
|
*
|
|
12
12
|
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
13
13
|
*/
|
|
14
14
|
import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
|
|
15
15
|
/**
|
|
16
|
-
* RabbitMQ message payload for MovePgPaymentMethodToCancellationRequested
|
|
16
|
+
* RabbitMQ message payload for MovePgPaymentMethodToCancellationRequested step flow events
|
|
17
17
|
*
|
|
18
|
-
* @event k1.t-hEOJjsDb.BillingModule.PgPaymentMethod.
|
|
18
|
+
* @event k1.t-hEOJjsDb.BillingModule.PgPaymentMethod.Transition.MovePgPaymentMethodToCancellationRequested
|
|
19
19
|
*/
|
|
20
|
-
export interface MovePgPaymentMethodToCancellationRequestedMessage extends OdinRecordUpdatedEvent<MovePgPaymentMethodToCancellationRequestedDto,
|
|
20
|
+
export interface MovePgPaymentMethodToCancellationRequestedMessage extends OdinRecordUpdatedEvent<MovePgPaymentMethodToCancellationRequestedDto, {}> {
|
|
21
21
|
}
|
|
22
22
|
/**
|
|
23
23
|
* Properties for MovePgPaymentMethodToCancellationRequested action
|
|
@@ -30,41 +30,41 @@ export interface MovePgPaymentMethodToCancellationRequestedProperties {
|
|
|
30
30
|
*
|
|
31
31
|
* Move PG Payment Method To Cancellation Requested
|
|
32
32
|
*
|
|
33
|
-
* @actionType
|
|
33
|
+
* @actionType STAGE_TRANSITION - Transitions record to new pipeline stage
|
|
34
34
|
* @module BillingModule
|
|
35
35
|
* @entity PgPaymentMethod
|
|
36
36
|
* @entityType DEFAULT (Default)
|
|
37
37
|
* @targetStages StatusStageCancellationRequested
|
|
38
|
-
* @event k1.t-hEOJjsDb.BillingModule.PgPaymentMethod.
|
|
38
|
+
* @event k1.t-hEOJjsDb.BillingModule.PgPaymentMethod.Transition.MovePgPaymentMethodToCancellationRequested
|
|
39
39
|
* @permission schema.action.movepgpaymentmethodtocancellationrequested.trigger
|
|
40
40
|
* @benchmark This action is tracked for performance benchmarks
|
|
41
41
|
*/
|
|
42
|
-
export declare class MovePgPaymentMethodToCancellationRequestedDto extends OdinRecordUpdateDto<
|
|
42
|
+
export declare class MovePgPaymentMethodToCancellationRequestedDto extends OdinRecordUpdateDto<Record<string, any>> {
|
|
43
43
|
/** Used by SDK generators to identify action type */
|
|
44
44
|
static readonly ACTION_TYPE = "UPDATE";
|
|
45
45
|
static readonly ACTION_KEY = "MovePgPaymentMethodToCancellationRequested";
|
|
46
46
|
static readonly MODULE_NAME = "BillingModule";
|
|
47
47
|
static readonly ENTITIES: string[];
|
|
48
48
|
static readonly ENTITY_TYPE = "DEFAULT";
|
|
49
|
-
static readonly EVENT_NAME = "k1.t-hEOJjsDb.BillingModule.PgPaymentMethod.
|
|
49
|
+
static readonly EVENT_NAME = "k1.t-hEOJjsDb.BillingModule.PgPaymentMethod.Transition.MovePgPaymentMethodToCancellationRequested";
|
|
50
|
+
static readonly SCHEMA_ACTION_ID = "f82cefc8-dacc-4b9f-bff5-c0f0e625a77d";
|
|
50
51
|
static readonly PERMISSION = "schema.action.movepgpaymentmethodtocancellationrequested.trigger";
|
|
51
52
|
static readonly TARGET_STAGES: readonly ["StatusStageCancellationRequested"];
|
|
52
|
-
|
|
53
|
-
static readonly
|
|
54
|
-
static readonly
|
|
55
|
-
static readonly STEP_SCHEMA_ACTION_ID = "d197a9f3-23f7-465a-9465-b6b234437393";
|
|
56
|
-
static readonly STEP_SCHEMA_TYPE_ID = "00eb8588-4016-45a3-adc5-f0e485801016";
|
|
57
|
-
static readonly STEP_TYPE = "DEFAULT";
|
|
58
|
-
static readonly AUTO_LINK_PARENT = false;
|
|
53
|
+
static readonly IS_STAGE_TRANSITION = true;
|
|
54
|
+
static readonly IS_MULTI_STEP_FLOW = false;
|
|
55
|
+
static readonly HAS_STEP_LINKS = false;
|
|
59
56
|
readonly actionName: string;
|
|
60
57
|
readonly schemaActionId: string;
|
|
61
58
|
readonly entity: string;
|
|
59
|
+
readonly stageKey: string;
|
|
62
60
|
constructor(record: OdinRecord<any> | {
|
|
63
61
|
id: string;
|
|
64
62
|
entity: string;
|
|
65
63
|
type?: string;
|
|
66
|
-
},
|
|
64
|
+
}, options?: {
|
|
67
65
|
journeyId?: string;
|
|
68
|
-
stageKey?: string;
|
|
69
66
|
});
|
|
67
|
+
/** Step classes that can be used with this action */
|
|
68
|
+
static readonly stepClasses: readonly [];
|
|
69
|
+
steps: [];
|
|
70
70
|
}
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
* @entity PgPaymentMethod
|
|
9
9
|
* @entityType DEFAULT
|
|
10
10
|
* @actionKey MovePgPaymentMethodToCancellationRequested
|
|
11
|
-
* @event k1.t-hEOJjsDb.BillingModule.PgPaymentMethod.
|
|
11
|
+
* @event k1.t-hEOJjsDb.BillingModule.PgPaymentMethod.Transition.MovePgPaymentMethodToCancellationRequested
|
|
12
12
|
*
|
|
13
13
|
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
14
14
|
*/
|
|
@@ -20,28 +20,28 @@ const core_1 = require("@d19n/odin-types/dist/core");
|
|
|
20
20
|
*
|
|
21
21
|
* Move PG Payment Method To Cancellation Requested
|
|
22
22
|
*
|
|
23
|
-
* @actionType
|
|
23
|
+
* @actionType STAGE_TRANSITION - Transitions record to new pipeline stage
|
|
24
24
|
* @module BillingModule
|
|
25
25
|
* @entity PgPaymentMethod
|
|
26
26
|
* @entityType DEFAULT (Default)
|
|
27
27
|
* @targetStages StatusStageCancellationRequested
|
|
28
|
-
* @event k1.t-hEOJjsDb.BillingModule.PgPaymentMethod.
|
|
28
|
+
* @event k1.t-hEOJjsDb.BillingModule.PgPaymentMethod.Transition.MovePgPaymentMethodToCancellationRequested
|
|
29
29
|
* @permission schema.action.movepgpaymentmethodtocancellationrequested.trigger
|
|
30
30
|
* @benchmark This action is tracked for performance benchmarks
|
|
31
31
|
*/
|
|
32
32
|
class MovePgPaymentMethodToCancellationRequestedDto extends core_1.OdinRecordUpdateDto {
|
|
33
|
-
constructor(record,
|
|
33
|
+
constructor(record, options) {
|
|
34
34
|
super({
|
|
35
35
|
id: record.id,
|
|
36
36
|
entity: record.entity,
|
|
37
37
|
type: record.type,
|
|
38
|
-
properties,
|
|
38
|
+
properties: {},
|
|
39
39
|
journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
|
|
40
|
-
stageKey: options === null || options === void 0 ? void 0 : options.stageKey,
|
|
41
40
|
});
|
|
42
41
|
this.actionName = 'MovePgPaymentMethodToCancellationRequested';
|
|
43
|
-
this.schemaActionId = '
|
|
42
|
+
this.schemaActionId = 'f82cefc8-dacc-4b9f-bff5-c0f0e625a77d';
|
|
44
43
|
this.entity = 'BillingModule:PgPaymentMethod';
|
|
44
|
+
this.stageKey = 'StatusStageCancellationRequested';
|
|
45
45
|
}
|
|
46
46
|
}
|
|
47
47
|
exports.MovePgPaymentMethodToCancellationRequestedDto = MovePgPaymentMethodToCancellationRequestedDto;
|
|
@@ -51,13 +51,12 @@ MovePgPaymentMethodToCancellationRequestedDto.ACTION_KEY = 'MovePgPaymentMethodT
|
|
|
51
51
|
MovePgPaymentMethodToCancellationRequestedDto.MODULE_NAME = 'BillingModule';
|
|
52
52
|
MovePgPaymentMethodToCancellationRequestedDto.ENTITIES = ['PgPaymentMethod'];
|
|
53
53
|
MovePgPaymentMethodToCancellationRequestedDto.ENTITY_TYPE = 'DEFAULT';
|
|
54
|
-
MovePgPaymentMethodToCancellationRequestedDto.EVENT_NAME = 'k1.t-hEOJjsDb.BillingModule.PgPaymentMethod.
|
|
54
|
+
MovePgPaymentMethodToCancellationRequestedDto.EVENT_NAME = 'k1.t-hEOJjsDb.BillingModule.PgPaymentMethod.Transition.MovePgPaymentMethodToCancellationRequested';
|
|
55
|
+
MovePgPaymentMethodToCancellationRequestedDto.SCHEMA_ACTION_ID = 'f82cefc8-dacc-4b9f-bff5-c0f0e625a77d';
|
|
55
56
|
MovePgPaymentMethodToCancellationRequestedDto.PERMISSION = 'schema.action.movepgpaymentmethodtocancellationrequested.trigger';
|
|
56
57
|
MovePgPaymentMethodToCancellationRequestedDto.TARGET_STAGES = ['StatusStageCancellationRequested'];
|
|
57
|
-
|
|
58
|
-
MovePgPaymentMethodToCancellationRequestedDto.
|
|
59
|
-
MovePgPaymentMethodToCancellationRequestedDto.
|
|
60
|
-
|
|
61
|
-
MovePgPaymentMethodToCancellationRequestedDto.
|
|
62
|
-
MovePgPaymentMethodToCancellationRequestedDto.STEP_TYPE = 'DEFAULT';
|
|
63
|
-
MovePgPaymentMethodToCancellationRequestedDto.AUTO_LINK_PARENT = false;
|
|
58
|
+
MovePgPaymentMethodToCancellationRequestedDto.IS_STAGE_TRANSITION = true;
|
|
59
|
+
MovePgPaymentMethodToCancellationRequestedDto.IS_MULTI_STEP_FLOW = false;
|
|
60
|
+
MovePgPaymentMethodToCancellationRequestedDto.HAS_STEP_LINKS = false;
|
|
61
|
+
/** Step classes that can be used with this action */
|
|
62
|
+
MovePgPaymentMethodToCancellationRequestedDto.stepClasses = [];
|
|
@@ -100,6 +100,29 @@ export declare enum ModifyServiceRequestFnoModifyStatus {
|
|
|
100
100
|
NOT_SENT = "NOT_SENT",
|
|
101
101
|
SEND_FAILED = "SEND_FAILED"
|
|
102
102
|
}
|
|
103
|
+
/**
|
|
104
|
+
* Valid values for ModifyServiceRequest.FailureReason
|
|
105
|
+
*
|
|
106
|
+
* Why this modify request failed, as one of our own categories. One per request, not per side.
|
|
107
|
+
*
|
|
108
|
+
* @remarks Available options:
|
|
109
|
+
* - `BNG_PROVISION_FAILED` - BNG Provision Failed
|
|
110
|
+
* - `NO_TARGET_ORDER_ITEM` - No Target Order Item
|
|
111
|
+
* - `NOT_ELIGIBLE` - Not Eligible
|
|
112
|
+
* - `SEND_REJECTED` - Send Rejected
|
|
113
|
+
* - `SUPPLIER_CANCELLED` - Supplier Cancelled
|
|
114
|
+
* - `SUPPLIER_REJECTED` - Supplier Rejected
|
|
115
|
+
* - `TIMED_OUT` - Timed Out
|
|
116
|
+
*/
|
|
117
|
+
export declare enum ModifyServiceRequestFailureReason {
|
|
118
|
+
BNG_PROVISION_FAILED = "BNG_PROVISION_FAILED",
|
|
119
|
+
NO_TARGET_ORDER_ITEM = "NO_TARGET_ORDER_ITEM",
|
|
120
|
+
NOT_ELIGIBLE = "NOT_ELIGIBLE",
|
|
121
|
+
SEND_REJECTED = "SEND_REJECTED",
|
|
122
|
+
SUPPLIER_CANCELLED = "SUPPLIER_CANCELLED",
|
|
123
|
+
SUPPLIER_REJECTED = "SUPPLIER_REJECTED",
|
|
124
|
+
TIMED_OUT = "TIMED_OUT"
|
|
125
|
+
}
|
|
103
126
|
/**
|
|
104
127
|
* Property keys for ModifyServiceRequest
|
|
105
128
|
* Use these constants instead of string literals for type safety
|
|
@@ -118,7 +141,11 @@ export declare enum ModifyServiceRequestPropertyKeys {
|
|
|
118
141
|
/** ISP Comment */
|
|
119
142
|
IspComment = "IspComment",
|
|
120
143
|
/** FNO Comment */
|
|
121
|
-
FnoComment = "FnoComment"
|
|
144
|
+
FnoComment = "FnoComment",
|
|
145
|
+
/** Why this modify request failed, as one of our own categories. One per request, not per side. */
|
|
146
|
+
FailureReason = "FailureReason",
|
|
147
|
+
/** The FNO's own problem code from the inbound KCI, stored verbatim. Their value set, not ours. */
|
|
148
|
+
FnoProblemCode = "FnoProblemCode"
|
|
122
149
|
}
|
|
123
150
|
/**
|
|
124
151
|
* Properties for ModifyServiceRequest records
|
|
@@ -164,6 +191,19 @@ export interface ModifyServiceRequestProperties {
|
|
|
164
191
|
* @type {TEXT_LONG}
|
|
165
192
|
*/
|
|
166
193
|
FnoComment: string;
|
|
194
|
+
/** Why this modify request failed, as one of our own categories. One per request, not per side.
|
|
195
|
+
*
|
|
196
|
+
* @type {ENUM}
|
|
197
|
+
* @default
|
|
198
|
+
* @enum {ModifyServiceRequestFailureReason}
|
|
199
|
+
*/
|
|
200
|
+
FailureReason: ModifyServiceRequestFailureReason;
|
|
201
|
+
/** The FNO's own problem code from the inbound KCI, stored verbatim. Their value set, not ours.
|
|
202
|
+
*
|
|
203
|
+
* @type {TEXT}
|
|
204
|
+
* @default
|
|
205
|
+
*/
|
|
206
|
+
FnoProblemCode: string;
|
|
167
207
|
}
|
|
168
208
|
/**
|
|
169
209
|
* ModifyServiceRequest entity from ServiceModule
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
* Generated from Odin schema definition
|
|
13
13
|
*/
|
|
14
14
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
|
-
exports.ROUTING_KEY_LINK_MODIFY_SERVICE_REQUEST_ORDER_DELETED = exports.ROUTING_KEY_LINK_MODIFY_SERVICE_REQUEST_ORDER_CREATED = exports.ROUTING_KEY_LINK_MODIFY_SERVICE_REQUEST_ORDER_KCI_DELETED = exports.ROUTING_KEY_LINK_MODIFY_SERVICE_REQUEST_ORDER_KCI_CREATED = exports.ROUTING_KEY_MODIFY_SERVICE_REQUEST_DEFAULT_DELETED = exports.ROUTING_KEY_MODIFY_SERVICE_REQUEST_DEFAULT_UPDATED = exports.ROUTING_KEY_MODIFY_SERVICE_REQUEST_DEFAULT_CREATED = exports.ROUTING_KEY_MODIFY_SERVICE_REQUEST_DELETED = exports.ROUTING_KEY_MODIFY_SERVICE_REQUEST_UPDATED = exports.ROUTING_KEY_MODIFY_SERVICE_REQUEST_CREATED = exports.ModifyServiceRequest = exports.ModifyServiceRequestPropertyKeys = exports.ModifyServiceRequestFnoModifyStatus = exports.ModifyServiceRequestIspModifyStatus = exports.DefaultModifyServiceRequestStageKeys = exports.DefaultModifyServiceRequestStageNames = exports.ModifyServiceRequestEntityTypes = void 0;
|
|
15
|
+
exports.ROUTING_KEY_LINK_MODIFY_SERVICE_REQUEST_ORDER_DELETED = exports.ROUTING_KEY_LINK_MODIFY_SERVICE_REQUEST_ORDER_CREATED = exports.ROUTING_KEY_LINK_MODIFY_SERVICE_REQUEST_ORDER_KCI_DELETED = exports.ROUTING_KEY_LINK_MODIFY_SERVICE_REQUEST_ORDER_KCI_CREATED = exports.ROUTING_KEY_MODIFY_SERVICE_REQUEST_DEFAULT_DELETED = exports.ROUTING_KEY_MODIFY_SERVICE_REQUEST_DEFAULT_UPDATED = exports.ROUTING_KEY_MODIFY_SERVICE_REQUEST_DEFAULT_CREATED = exports.ROUTING_KEY_MODIFY_SERVICE_REQUEST_DELETED = exports.ROUTING_KEY_MODIFY_SERVICE_REQUEST_UPDATED = exports.ROUTING_KEY_MODIFY_SERVICE_REQUEST_CREATED = exports.ModifyServiceRequest = exports.ModifyServiceRequestPropertyKeys = exports.ModifyServiceRequestFailureReason = exports.ModifyServiceRequestFnoModifyStatus = exports.ModifyServiceRequestIspModifyStatus = exports.DefaultModifyServiceRequestStageKeys = exports.DefaultModifyServiceRequestStageNames = exports.ModifyServiceRequestEntityTypes = void 0;
|
|
16
16
|
const core_1 = require("@d19n/odin-types/dist/core");
|
|
17
17
|
/**
|
|
18
18
|
* Available types for ModifyServiceRequest records
|
|
@@ -105,6 +105,30 @@ var ModifyServiceRequestFnoModifyStatus;
|
|
|
105
105
|
ModifyServiceRequestFnoModifyStatus["NOT_SENT"] = "NOT_SENT";
|
|
106
106
|
ModifyServiceRequestFnoModifyStatus["SEND_FAILED"] = "SEND_FAILED";
|
|
107
107
|
})(ModifyServiceRequestFnoModifyStatus = exports.ModifyServiceRequestFnoModifyStatus || (exports.ModifyServiceRequestFnoModifyStatus = {}));
|
|
108
|
+
/**
|
|
109
|
+
* Valid values for ModifyServiceRequest.FailureReason
|
|
110
|
+
*
|
|
111
|
+
* Why this modify request failed, as one of our own categories. One per request, not per side.
|
|
112
|
+
*
|
|
113
|
+
* @remarks Available options:
|
|
114
|
+
* - `BNG_PROVISION_FAILED` - BNG Provision Failed
|
|
115
|
+
* - `NO_TARGET_ORDER_ITEM` - No Target Order Item
|
|
116
|
+
* - `NOT_ELIGIBLE` - Not Eligible
|
|
117
|
+
* - `SEND_REJECTED` - Send Rejected
|
|
118
|
+
* - `SUPPLIER_CANCELLED` - Supplier Cancelled
|
|
119
|
+
* - `SUPPLIER_REJECTED` - Supplier Rejected
|
|
120
|
+
* - `TIMED_OUT` - Timed Out
|
|
121
|
+
*/
|
|
122
|
+
var ModifyServiceRequestFailureReason;
|
|
123
|
+
(function (ModifyServiceRequestFailureReason) {
|
|
124
|
+
ModifyServiceRequestFailureReason["BNG_PROVISION_FAILED"] = "BNG_PROVISION_FAILED";
|
|
125
|
+
ModifyServiceRequestFailureReason["NO_TARGET_ORDER_ITEM"] = "NO_TARGET_ORDER_ITEM";
|
|
126
|
+
ModifyServiceRequestFailureReason["NOT_ELIGIBLE"] = "NOT_ELIGIBLE";
|
|
127
|
+
ModifyServiceRequestFailureReason["SEND_REJECTED"] = "SEND_REJECTED";
|
|
128
|
+
ModifyServiceRequestFailureReason["SUPPLIER_CANCELLED"] = "SUPPLIER_CANCELLED";
|
|
129
|
+
ModifyServiceRequestFailureReason["SUPPLIER_REJECTED"] = "SUPPLIER_REJECTED";
|
|
130
|
+
ModifyServiceRequestFailureReason["TIMED_OUT"] = "TIMED_OUT";
|
|
131
|
+
})(ModifyServiceRequestFailureReason = exports.ModifyServiceRequestFailureReason || (exports.ModifyServiceRequestFailureReason = {}));
|
|
108
132
|
/**
|
|
109
133
|
* Property keys for ModifyServiceRequest
|
|
110
134
|
* Use these constants instead of string literals for type safety
|
|
@@ -125,6 +149,10 @@ var ModifyServiceRequestPropertyKeys;
|
|
|
125
149
|
ModifyServiceRequestPropertyKeys["IspComment"] = "IspComment";
|
|
126
150
|
/** FNO Comment */
|
|
127
151
|
ModifyServiceRequestPropertyKeys["FnoComment"] = "FnoComment";
|
|
152
|
+
/** Why this modify request failed, as one of our own categories. One per request, not per side. */
|
|
153
|
+
ModifyServiceRequestPropertyKeys["FailureReason"] = "FailureReason";
|
|
154
|
+
/** The FNO's own problem code from the inbound KCI, stored verbatim. Their value set, not ours. */
|
|
155
|
+
ModifyServiceRequestPropertyKeys["FnoProblemCode"] = "FnoProblemCode";
|
|
128
156
|
})(ModifyServiceRequestPropertyKeys = exports.ModifyServiceRequestPropertyKeys || (exports.ModifyServiceRequestPropertyKeys = {}));
|
|
129
157
|
/**
|
|
130
158
|
* ModifyServiceRequest entity from ServiceModule
|
|
@@ -67,7 +67,13 @@ export declare enum YfWifiSurveyPropertyKeys {
|
|
|
67
67
|
/** Whether the homeowner said the property has more than one floor, asked at consent. Null means the question was never reached — a refused survey — which is a different fact from a single-floor answer. */
|
|
68
68
|
PropertyHasMultipleFloors = "PropertyHasMultipleFloors",
|
|
69
69
|
/** Whether the homeowner consented to the engineer using floors beyond the one they entered on. Null means not asked, which is the correct value for a single-floor property and for a refusal; false means asked and withheld, and the app blocks adding floors on that basis. */
|
|
70
|
-
MultiFloorAccessGranted = "MultiFloorAccessGranted"
|
|
70
|
+
MultiFloorAccessGranted = "MultiFloorAccessGranted",
|
|
71
|
+
/** Typed name of whoever signed the consent, as the engineer wrote it. The drawn signature says somebody agreed, not who — it is rarely legible, and the person at the door is often not the account holder. Null on a refused survey, where nobody signed. */
|
|
72
|
+
SignedOffBy = "SignedOffBy",
|
|
73
|
+
/** The engineer's closing note, taken when the survey is finished. Where coverage was poor or unusable the app prompts them to suggest a mesh unit, and the outcome is written into the note's first line ("Mesh unit(s) suggested — customer accepted/declined.") rather than a column of its own, so this one field is the whole account of what was offered and what was said. A declined suggestion is required by the app to carry a reason. Null when the survey ended with nothing to say, and on a refusal. */
|
|
74
|
+
EngineerNote = "EngineerNote",
|
|
75
|
+
/** Whether any part of the property came out poor or unusable. Read off the recorded bands on the device path, and answered by the engineer on the gateway path — iOS has no public RSSI API, so there is no band to read and this column is the only place that answer exists. Null means nobody was asked and nothing was measured: a refused survey. */
|
|
76
|
+
PoorCoverageReported = "PoorCoverageReported"
|
|
71
77
|
}
|
|
72
78
|
/**
|
|
73
79
|
* Properties for YfWifiSurvey records
|
|
@@ -160,6 +166,24 @@ export interface YfWifiSurveyProperties {
|
|
|
160
166
|
* @default
|
|
161
167
|
*/
|
|
162
168
|
MultiFloorAccessGranted: boolean;
|
|
169
|
+
/** Typed name of whoever signed the consent, as the engineer wrote it. The drawn signature says somebody agreed, not who — it is rarely legible, and the person at the door is often not the account holder. Null on a refused survey, where nobody signed.
|
|
170
|
+
*
|
|
171
|
+
* @type {TEXT}
|
|
172
|
+
* @default
|
|
173
|
+
*/
|
|
174
|
+
SignedOffBy: string;
|
|
175
|
+
/** The engineer's closing note, taken when the survey is finished. Where coverage was poor or unusable the app prompts them to suggest a mesh unit, and the outcome is written into the note's first line ("Mesh unit(s) suggested — customer accepted/declined.") rather than a column of its own, so this one field is the whole account of what was offered and what was said. A declined suggestion is required by the app to carry a reason. Null when the survey ended with nothing to say, and on a refusal.
|
|
176
|
+
*
|
|
177
|
+
* @type {TEXT_LONG}
|
|
178
|
+
* @default
|
|
179
|
+
*/
|
|
180
|
+
EngineerNote: string;
|
|
181
|
+
/** Whether any part of the property came out poor or unusable. Read off the recorded bands on the device path, and answered by the engineer on the gateway path — iOS has no public RSSI API, so there is no band to read and this column is the only place that answer exists. Null means nobody was asked and nothing was measured: a refused survey.
|
|
182
|
+
*
|
|
183
|
+
* @type {BOOLEAN}
|
|
184
|
+
* @default
|
|
185
|
+
*/
|
|
186
|
+
PoorCoverageReported: boolean;
|
|
163
187
|
}
|
|
164
188
|
/**
|
|
165
189
|
* YfWifiSurvey entity from FieldServiceModule
|
|
@@ -72,6 +72,12 @@ var YfWifiSurveyPropertyKeys;
|
|
|
72
72
|
YfWifiSurveyPropertyKeys["PropertyHasMultipleFloors"] = "PropertyHasMultipleFloors";
|
|
73
73
|
/** Whether the homeowner consented to the engineer using floors beyond the one they entered on. Null means not asked, which is the correct value for a single-floor property and for a refusal; false means asked and withheld, and the app blocks adding floors on that basis. */
|
|
74
74
|
YfWifiSurveyPropertyKeys["MultiFloorAccessGranted"] = "MultiFloorAccessGranted";
|
|
75
|
+
/** Typed name of whoever signed the consent, as the engineer wrote it. The drawn signature says somebody agreed, not who — it is rarely legible, and the person at the door is often not the account holder. Null on a refused survey, where nobody signed. */
|
|
76
|
+
YfWifiSurveyPropertyKeys["SignedOffBy"] = "SignedOffBy";
|
|
77
|
+
/** The engineer's closing note, taken when the survey is finished. Where coverage was poor or unusable the app prompts them to suggest a mesh unit, and the outcome is written into the note's first line ("Mesh unit(s) suggested — customer accepted/declined.") rather than a column of its own, so this one field is the whole account of what was offered and what was said. A declined suggestion is required by the app to carry a reason. Null when the survey ended with nothing to say, and on a refusal. */
|
|
78
|
+
YfWifiSurveyPropertyKeys["EngineerNote"] = "EngineerNote";
|
|
79
|
+
/** Whether any part of the property came out poor or unusable. Read off the recorded bands on the device path, and answered by the engineer on the gateway path — iOS has no public RSSI API, so there is no band to read and this column is the only place that answer exists. Null means nobody was asked and nothing was measured: a refused survey. */
|
|
80
|
+
YfWifiSurveyPropertyKeys["PoorCoverageReported"] = "PoorCoverageReported";
|
|
75
81
|
})(YfWifiSurveyPropertyKeys = exports.YfWifiSurveyPropertyKeys || (exports.YfWifiSurveyPropertyKeys = {}));
|
|
76
82
|
/**
|
|
77
83
|
* YfWifiSurvey entity from FieldServiceModule
|
|
@@ -55,6 +55,7 @@ import { CreateOrderReferralReferrerNotQualifiedEmailProperties } from '../actio
|
|
|
55
55
|
import { CreateOrderReferralReferrerPendingEmailProperties } from '../actions-v2/CreateOrderReferralReferrerPendingEmailDto';
|
|
56
56
|
import { CreateOrderReferralReferrerQualifiedEmailProperties } from '../actions-v2/CreateOrderReferralReferrerQualifiedEmailDto';
|
|
57
57
|
import { CreateOtsGainingCancellationIssueProperties } from '../actions-v2/CreateOtsGainingCancellationIssueDto';
|
|
58
|
+
import { CreateOtsGainingSwitchCancelledProperties } from '../actions-v2/CreateOtsGainingSwitchCancelledDto';
|
|
58
59
|
import { CreateOtsGainingSwitchCompleteProperties } from '../actions-v2/CreateOtsGainingSwitchCompleteDto';
|
|
59
60
|
import { CreateOtsLosingSwitchConfirmationProperties } from '../actions-v2/CreateOtsLosingSwitchConfirmationDto';
|
|
60
61
|
import { CreateOtsLosingSwitchImpactProperties } from '../actions-v2/CreateOtsLosingSwitchImpactDto';
|
|
@@ -68,6 +69,7 @@ import { CreatePreContractOrderSummaryProperties } from '../actions-v2/CreatePre
|
|
|
68
69
|
import { CreateRecontractOrderConfirmationProperties } from '../actions-v2/CreateRecontractOrderConfirmationDto';
|
|
69
70
|
import { CreateRecontractReminderEmailProperties } from '../actions-v2/CreateRecontractReminderEmailDto';
|
|
70
71
|
import { CreateRegisterInterestEmailProperties } from '../actions-v2/CreateRegisterInterestEmailDto';
|
|
72
|
+
import { CreateRollingContractSummaryProperties } from '../actions-v2/CreateRollingContractSummaryDto';
|
|
71
73
|
import { CreateServiceAppointmentConfirmationProperties } from '../actions-v2/CreateServiceAppointmentConfirmationDto';
|
|
72
74
|
import { CreateServiceAppointmentRescheduledProperties } from '../actions-v2/CreateServiceAppointmentRescheduledDto';
|
|
73
75
|
import { CreateServiceDeactivatedMandateProperties } from '../actions-v2/CreateServiceDeactivatedMandateDto';
|
|
@@ -1312,6 +1314,34 @@ export declare class EmailRecord<TProps = EmailProperties> {
|
|
|
1312
1314
|
journeyId?: string;
|
|
1313
1315
|
stageKey?: string;
|
|
1314
1316
|
}): ActionBuilder;
|
|
1317
|
+
/**
|
|
1318
|
+
* CreateOtsGainingSwitchCancelled
|
|
1319
|
+
*
|
|
1320
|
+
* Creates a new Email record with the specified properties.
|
|
1321
|
+
* Returns an ActionBuilder - call .execute() to create or .dryRun() for debugging.
|
|
1322
|
+
*
|
|
1323
|
+
* @remarks Record type: TRANSACTIONAL
|
|
1324
|
+
*
|
|
1325
|
+
* @param properties - The properties for the new record
|
|
1326
|
+
* @param options - Optional settings
|
|
1327
|
+
* @param options.journeyId - Associate with a journey
|
|
1328
|
+
* @param options.stageKey - Set initial pipeline stage
|
|
1329
|
+
* @returns ActionBuilder - call .execute() to create or .dryRun() for payload
|
|
1330
|
+
*
|
|
1331
|
+
* @example
|
|
1332
|
+
* ```typescript
|
|
1333
|
+
* // Create with properties
|
|
1334
|
+
* const record = odinClient.emails.new();
|
|
1335
|
+
* await record.createOtsGainingSwitchCancelled({ ... }).execute();
|
|
1336
|
+
*
|
|
1337
|
+
* // Dry run (for debugging)
|
|
1338
|
+
* const payload = record.createOtsGainingSwitchCancelled({ ... }).dryRun();
|
|
1339
|
+
* ```
|
|
1340
|
+
*/
|
|
1341
|
+
createOtsGainingSwitchCancelled(properties?: CreateOtsGainingSwitchCancelledProperties, options?: {
|
|
1342
|
+
journeyId?: string;
|
|
1343
|
+
stageKey?: string;
|
|
1344
|
+
}): ActionBuilder;
|
|
1315
1345
|
/**
|
|
1316
1346
|
* CreateOtsGainingSwitchComplete
|
|
1317
1347
|
*
|
|
@@ -1620,6 +1650,34 @@ export declare class EmailRecord<TProps = EmailProperties> {
|
|
|
1620
1650
|
journeyId?: string;
|
|
1621
1651
|
stageKey?: string;
|
|
1622
1652
|
}): ActionBuilder;
|
|
1653
|
+
/**
|
|
1654
|
+
* CreateRollingContractSummary
|
|
1655
|
+
*
|
|
1656
|
+
* Creates a new Email record with the specified properties.
|
|
1657
|
+
* Returns an ActionBuilder - call .execute() to create or .dryRun() for debugging.
|
|
1658
|
+
*
|
|
1659
|
+
* @remarks Record type: TRANSACTIONAL
|
|
1660
|
+
*
|
|
1661
|
+
* @param properties - The properties for the new record
|
|
1662
|
+
* @param options - Optional settings
|
|
1663
|
+
* @param options.journeyId - Associate with a journey
|
|
1664
|
+
* @param options.stageKey - Set initial pipeline stage
|
|
1665
|
+
* @returns ActionBuilder - call .execute() to create or .dryRun() for payload
|
|
1666
|
+
*
|
|
1667
|
+
* @example
|
|
1668
|
+
* ```typescript
|
|
1669
|
+
* // Create with properties
|
|
1670
|
+
* const record = odinClient.emails.new();
|
|
1671
|
+
* await record.createRollingContractSummary({ ... }).execute();
|
|
1672
|
+
*
|
|
1673
|
+
* // Dry run (for debugging)
|
|
1674
|
+
* const payload = record.createRollingContractSummary({ ... }).dryRun();
|
|
1675
|
+
* ```
|
|
1676
|
+
*/
|
|
1677
|
+
createRollingContractSummary(properties?: CreateRollingContractSummaryProperties, options?: {
|
|
1678
|
+
journeyId?: string;
|
|
1679
|
+
stageKey?: string;
|
|
1680
|
+
}): ActionBuilder;
|
|
1623
1681
|
/**
|
|
1624
1682
|
* CreateServiceAppointmentConfirmation
|
|
1625
1683
|
*
|
|
@@ -1643,6 +1643,42 @@ class EmailRecord {
|
|
|
1643
1643
|
};
|
|
1644
1644
|
return new ActionBuilder(this._provider, 'NotificationModule', 'Email', payload, () => { this._pendingLinks = []; });
|
|
1645
1645
|
}
|
|
1646
|
+
/**
|
|
1647
|
+
* CreateOtsGainingSwitchCancelled
|
|
1648
|
+
*
|
|
1649
|
+
* Creates a new Email record with the specified properties.
|
|
1650
|
+
* Returns an ActionBuilder - call .execute() to create or .dryRun() for debugging.
|
|
1651
|
+
*
|
|
1652
|
+
* @remarks Record type: TRANSACTIONAL
|
|
1653
|
+
*
|
|
1654
|
+
* @param properties - The properties for the new record
|
|
1655
|
+
* @param options - Optional settings
|
|
1656
|
+
* @param options.journeyId - Associate with a journey
|
|
1657
|
+
* @param options.stageKey - Set initial pipeline stage
|
|
1658
|
+
* @returns ActionBuilder - call .execute() to create or .dryRun() for payload
|
|
1659
|
+
*
|
|
1660
|
+
* @example
|
|
1661
|
+
* ```typescript
|
|
1662
|
+
* // Create with properties
|
|
1663
|
+
* const record = odinClient.emails.new();
|
|
1664
|
+
* await record.createOtsGainingSwitchCancelled({ ... }).execute();
|
|
1665
|
+
*
|
|
1666
|
+
* // Dry run (for debugging)
|
|
1667
|
+
* const payload = record.createOtsGainingSwitchCancelled({ ... }).dryRun();
|
|
1668
|
+
* ```
|
|
1669
|
+
*/
|
|
1670
|
+
createOtsGainingSwitchCancelled(properties, options) {
|
|
1671
|
+
const payload = {
|
|
1672
|
+
entity: 'NotificationModule:Email',
|
|
1673
|
+
type: 'TRANSACTIONAL',
|
|
1674
|
+
actionName: 'CreateOtsGainingSwitchCancelled',
|
|
1675
|
+
properties: properties || {},
|
|
1676
|
+
associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined,
|
|
1677
|
+
journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
|
|
1678
|
+
stageKey: options === null || options === void 0 ? void 0 : options.stageKey,
|
|
1679
|
+
};
|
|
1680
|
+
return new ActionBuilder(this._provider, 'NotificationModule', 'Email', payload, () => { this._pendingLinks = []; });
|
|
1681
|
+
}
|
|
1646
1682
|
/**
|
|
1647
1683
|
* CreateOtsGainingSwitchComplete
|
|
1648
1684
|
*
|
|
@@ -2039,6 +2075,42 @@ class EmailRecord {
|
|
|
2039
2075
|
};
|
|
2040
2076
|
return new ActionBuilder(this._provider, 'NotificationModule', 'Email', payload, () => { this._pendingLinks = []; });
|
|
2041
2077
|
}
|
|
2078
|
+
/**
|
|
2079
|
+
* CreateRollingContractSummary
|
|
2080
|
+
*
|
|
2081
|
+
* Creates a new Email record with the specified properties.
|
|
2082
|
+
* Returns an ActionBuilder - call .execute() to create or .dryRun() for debugging.
|
|
2083
|
+
*
|
|
2084
|
+
* @remarks Record type: TRANSACTIONAL
|
|
2085
|
+
*
|
|
2086
|
+
* @param properties - The properties for the new record
|
|
2087
|
+
* @param options - Optional settings
|
|
2088
|
+
* @param options.journeyId - Associate with a journey
|
|
2089
|
+
* @param options.stageKey - Set initial pipeline stage
|
|
2090
|
+
* @returns ActionBuilder - call .execute() to create or .dryRun() for payload
|
|
2091
|
+
*
|
|
2092
|
+
* @example
|
|
2093
|
+
* ```typescript
|
|
2094
|
+
* // Create with properties
|
|
2095
|
+
* const record = odinClient.emails.new();
|
|
2096
|
+
* await record.createRollingContractSummary({ ... }).execute();
|
|
2097
|
+
*
|
|
2098
|
+
* // Dry run (for debugging)
|
|
2099
|
+
* const payload = record.createRollingContractSummary({ ... }).dryRun();
|
|
2100
|
+
* ```
|
|
2101
|
+
*/
|
|
2102
|
+
createRollingContractSummary(properties, options) {
|
|
2103
|
+
const payload = {
|
|
2104
|
+
entity: 'NotificationModule:Email',
|
|
2105
|
+
type: 'TRANSACTIONAL',
|
|
2106
|
+
actionName: 'CreateRollingContractSummary',
|
|
2107
|
+
properties: properties || {},
|
|
2108
|
+
associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined,
|
|
2109
|
+
journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
|
|
2110
|
+
stageKey: options === null || options === void 0 ? void 0 : options.stageKey,
|
|
2111
|
+
};
|
|
2112
|
+
return new ActionBuilder(this._provider, 'NotificationModule', 'Email', payload, () => { this._pendingLinks = []; });
|
|
2113
|
+
}
|
|
2042
2114
|
/**
|
|
2043
2115
|
* CreateServiceAppointmentConfirmation
|
|
2044
2116
|
*
|