@d19n/youfibre-odin-sdk 2.0.208-beta.2 → 2.0.208-beta.3
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 +12 -7
- package/dist/actions-v2/CancelActiveOrderDto.d.ts +19 -11
- package/dist/actions-v2/CreateChurnRequestDto.d.ts +19 -11
- package/dist/actions-v2/CreateCityfibreKciDto.d.ts +262 -0
- package/dist/actions-v2/CreateCityfibreKciDto.js +156 -0
- package/dist/actions-v2/CreateCityfibreOrderKciCommittedDto.d.ts +95 -0
- package/dist/actions-v2/CreateCityfibreOrderKciCommittedDto.js +57 -0
- package/dist/actions-v2/CreateCityfibreOrderKciCompletedDto.d.ts +95 -0
- package/dist/actions-v2/CreateCityfibreOrderKciCompletedDto.js +57 -0
- package/dist/actions-v2/CreateCityfibreOrderKciDto.d.ts +89 -0
- package/dist/actions-v2/CreateCityfibreOrderKciDto.js +52 -0
- package/dist/actions-v2/DefaultUpdateChurnRequestDto.d.ts +1 -15
- package/dist/actions-v2/MoveOrderFromDeactivatedToCancelledDto.d.ts +19 -11
- package/dist/actions-v2/MoveOrderFromPendingCancellationToCancelledDto.d.ts +19 -11
- package/dist/actions-v2/SyncTwilioTaskQueueDto.d.ts +10 -0
- package/dist/actions-v2/UpdateTwilioTaskQueueDto.d.ts +93 -0
- package/dist/actions-v2/UpdateTwilioTaskQueueDto.js +56 -0
- package/dist/entities-v2/ChurnRequest.d.ts +8 -1
- package/dist/entities-v2/ChurnRequest.js +2 -0
- package/dist/records-v2/OrderKciRecord.d.ts +87 -0
- package/dist/records-v2/OrderKciRecord.js +108 -0
- package/dist/records-v2/OrderRecord.d.ts +94 -0
- package/dist/records-v2/OrderRecord.js +148 -1
- package/dist/records-v2/TwilioTaskQueueRecord.d.ts +30 -3
- package/dist/records-v2/TwilioTaskQueueRecord.js +34 -5
- package/dist/records-v2/index.d.ts +1 -1
- package/dist/records-v2/index.js +5 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -357,7 +357,7 @@ This SDK includes **169** entities across **12** modules.
|
|
|
357
357
|
|
|
358
358
|
## Actions
|
|
359
359
|
|
|
360
|
-
This SDK includes **
|
|
360
|
+
This SDK includes **701** actions.
|
|
361
361
|
|
|
362
362
|
### Action Types
|
|
363
363
|
|
|
@@ -1323,6 +1323,16 @@ This SDK includes **696** actions.
|
|
|
1323
1323
|
| `UpdateEmail` | UPDATE | k1.t-hEOJjsDb.NotificationModule.Email.Update.UpdateEmail |
|
|
1324
1324
|
| `UpdateSupportEmail` | UPDATE | k1.t-hEOJjsDb.NotificationModule.Email.Update.UpdateSupportEmail |
|
|
1325
1325
|
|
|
1326
|
+
#### OrderKci
|
|
1327
|
+
|
|
1328
|
+
| Action | Type | Event |
|
|
1329
|
+
|--------|------|-------|
|
|
1330
|
+
| `CreateCityfibreKci` | CREATE | k1.t-hEOJjsDb.OrderModule.OrderKci.Create.CreateCityfibreOrderKciCommitted |
|
|
1331
|
+
| `CreateCityfibreOrderKciCommitted` | CREATE | k1.t-hEOJjsDb.OrderModule.OrderKci.Create.CreateCityfibreOrderKciCommitted |
|
|
1332
|
+
| `CreateCityfibreOrderKciCompleted` | CREATE | k1.t-hEOJjsDb.OrderModule.OrderKci.Create.CreateCityfibreOrderKciCompleted |
|
|
1333
|
+
| `CreateCityfibreOrderKci` | CREATE | k1.t-hEOJjsDb.OrderModule.OrderKci.Create.CreateCityfibreOrderKci |
|
|
1334
|
+
| `CreateOrderKci` | CREATE | k1.t-hEOJjsDb.OrderModule.OrderKci.Create.CreateOrderKci |
|
|
1335
|
+
|
|
1326
1336
|
#### Config
|
|
1327
1337
|
|
|
1328
1338
|
| Action | Type | Event |
|
|
@@ -1517,12 +1527,6 @@ This SDK includes **696** actions.
|
|
|
1517
1527
|
| `CreateOrderCheck` | CREATE | k1.t-hEOJjsDb.ServiceModule.OrderCheck.Create.CreateOrderCheck |
|
|
1518
1528
|
| `Update` | UPDATE | k1.t-hEOJjsDb.ServiceModule.OrderCheck.Update.Update |
|
|
1519
1529
|
|
|
1520
|
-
#### OrderKci
|
|
1521
|
-
|
|
1522
|
-
| Action | Type | Event |
|
|
1523
|
-
|--------|------|-------|
|
|
1524
|
-
| `CreateOrderKci` | CREATE | k1.t-hEOJjsDb.OrderModule.OrderKci.Create.CreateOrderKci |
|
|
1525
|
-
|
|
1526
1530
|
#### Referral
|
|
1527
1531
|
|
|
1528
1532
|
| Action | Type | Event |
|
|
@@ -1894,6 +1898,7 @@ This SDK includes **696** actions.
|
|
|
1894
1898
|
|--------|------|-------|
|
|
1895
1899
|
| `CreateTwilioTaskQueue` | CREATE | k1.t-hEOJjsDb.SupportModule.TwilioTaskQueue.Create.CreateTwilioTaskQueue |
|
|
1896
1900
|
| `SyncTwilioTaskQueue` | UPDATE | k1.t-hEOJjsDb.SupportModule.TwilioTaskQueue.Update.SyncTwilioTaskQueue |
|
|
1901
|
+
| `UpdateTwilioTaskQueue` | UPDATE | k1.t-hEOJjsDb.SupportModule.TwilioTaskQueue.Update.UpdateTwilioTaskQueue |
|
|
1897
1902
|
|
|
1898
1903
|
#### TwilioUserUpdate
|
|
1899
1904
|
|
|
@@ -14,8 +14,8 @@ import { OdinRecord, OdinRecordCreateDto, OdinRecordUpdateDto, OdinRecordUpdated
|
|
|
14
14
|
/**
|
|
15
15
|
* Properties for CreateChurnRequest action
|
|
16
16
|
*
|
|
17
|
-
* @property Required fields:
|
|
18
|
-
* @property Optional fields:
|
|
17
|
+
* @property Required fields: 3
|
|
18
|
+
* @property Optional fields: 2
|
|
19
19
|
*/
|
|
20
20
|
export interface CreateChurnRequestProperties {
|
|
21
21
|
/**
|
|
@@ -35,15 +35,6 @@ export interface CreateChurnRequestProperties {
|
|
|
35
35
|
* @required
|
|
36
36
|
*/
|
|
37
37
|
Reason: string;
|
|
38
|
-
/**
|
|
39
|
-
* Customer Relocation Address
|
|
40
|
-
*
|
|
41
|
-
* Customer Relocation Address
|
|
42
|
-
* @type {LOOKUP}
|
|
43
|
-
* @required
|
|
44
|
-
* @visibleWhen Reason = ["SALES_MOVE_OUT","SALES_MOVE_OUT_IN_AREA"]
|
|
45
|
-
*/
|
|
46
|
-
MovingToAddress: string;
|
|
47
38
|
/**
|
|
48
39
|
* comment
|
|
49
40
|
*
|
|
@@ -52,6 +43,23 @@ export interface CreateChurnRequestProperties {
|
|
|
52
43
|
* @required
|
|
53
44
|
*/
|
|
54
45
|
Comment: string;
|
|
46
|
+
/**
|
|
47
|
+
* Customer does not want to provide their new Address info
|
|
48
|
+
*
|
|
49
|
+
* Select
|
|
50
|
+
* @type {BOOLEAN}
|
|
51
|
+
* @visibleWhen Reason = ["SALES_MOVE_OUT","SALES_MOVE_OUT_IN_AREA"]
|
|
52
|
+
*/
|
|
53
|
+
CustomerAddressInfoNotProvided?: boolean | null;
|
|
54
|
+
/**
|
|
55
|
+
* Customer Relocation Address
|
|
56
|
+
*
|
|
57
|
+
* Customer Relocation Address
|
|
58
|
+
* @type {LOOKUP}
|
|
59
|
+
* @visibleWhen Reason = ["SALES_MOVE_OUT","SALES_MOVE_OUT_IN_AREA"]
|
|
60
|
+
* @requiredWhen CustomerAddressInfoNotProvided = ["false"]
|
|
61
|
+
*/
|
|
62
|
+
MovingToAddress?: string | null;
|
|
55
63
|
}
|
|
56
64
|
/**
|
|
57
65
|
* CreateChurnRequest
|
|
@@ -22,8 +22,8 @@ export interface CreateChurnRequestMessage extends OdinRecordCreatedEvent<Create
|
|
|
22
22
|
/**
|
|
23
23
|
* Properties for CreateChurnRequest action
|
|
24
24
|
*
|
|
25
|
-
* @property Required fields:
|
|
26
|
-
* @property Optional fields:
|
|
25
|
+
* @property Required fields: 3
|
|
26
|
+
* @property Optional fields: 2
|
|
27
27
|
*/
|
|
28
28
|
export interface CreateChurnRequestProperties {
|
|
29
29
|
/**
|
|
@@ -43,15 +43,6 @@ export interface CreateChurnRequestProperties {
|
|
|
43
43
|
* @required
|
|
44
44
|
*/
|
|
45
45
|
Reason: string;
|
|
46
|
-
/**
|
|
47
|
-
* Customer Relocation Address
|
|
48
|
-
*
|
|
49
|
-
* Customer Relocation Address
|
|
50
|
-
* @type {LOOKUP}
|
|
51
|
-
* @required
|
|
52
|
-
* @visibleWhen Reason = ["SALES_MOVE_OUT","SALES_MOVE_OUT_IN_AREA"]
|
|
53
|
-
*/
|
|
54
|
-
MovingToAddress: string;
|
|
55
46
|
/**
|
|
56
47
|
* comment
|
|
57
48
|
*
|
|
@@ -60,6 +51,23 @@ export interface CreateChurnRequestProperties {
|
|
|
60
51
|
* @required
|
|
61
52
|
*/
|
|
62
53
|
Comment: string;
|
|
54
|
+
/**
|
|
55
|
+
* Customer does not want to provide their new Address info
|
|
56
|
+
*
|
|
57
|
+
* Select
|
|
58
|
+
* @type {BOOLEAN}
|
|
59
|
+
* @visibleWhen Reason = ["SALES_MOVE_OUT","SALES_MOVE_OUT_IN_AREA"]
|
|
60
|
+
*/
|
|
61
|
+
CustomerAddressInfoNotProvided?: boolean | null;
|
|
62
|
+
/**
|
|
63
|
+
* Customer Relocation Address
|
|
64
|
+
*
|
|
65
|
+
* Customer Relocation Address
|
|
66
|
+
* @type {LOOKUP}
|
|
67
|
+
* @visibleWhen Reason = ["SALES_MOVE_OUT","SALES_MOVE_OUT_IN_AREA"]
|
|
68
|
+
* @requiredWhen CustomerAddressInfoNotProvided = ["false"]
|
|
69
|
+
*/
|
|
70
|
+
MovingToAddress?: string | null;
|
|
63
71
|
}
|
|
64
72
|
/**
|
|
65
73
|
* CreateChurnRequest
|
|
@@ -0,0 +1,262 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* CreateCityfibreKci Action DTO
|
|
3
|
+
*
|
|
4
|
+
* Create a KCI for CityFibre
|
|
5
|
+
*
|
|
6
|
+
* @module OrderModule
|
|
7
|
+
* @entity Order
|
|
8
|
+
* @actionKey CreateCityfibreKci
|
|
9
|
+
* @event k1.t-hEOJjsDb.OrderModule.Order.Flow.CreateCityfibreKci
|
|
10
|
+
*
|
|
11
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
12
|
+
*/
|
|
13
|
+
import { OdinRecord, OdinRecordCreateDto, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
|
|
14
|
+
/**
|
|
15
|
+
* Properties for CreateCityfibreOrderKciCommitted action
|
|
16
|
+
*
|
|
17
|
+
* @property Required fields: 3
|
|
18
|
+
* @property Optional fields: 2
|
|
19
|
+
*/
|
|
20
|
+
export interface CreateCityfibreOrderKciCommittedProperties {
|
|
21
|
+
/**
|
|
22
|
+
* Supplier ID (CityFibre Order ID)
|
|
23
|
+
*
|
|
24
|
+
* Unique identifier for this service order update
|
|
25
|
+
* @type {TEXT}
|
|
26
|
+
* @required
|
|
27
|
+
*/
|
|
28
|
+
SupplierId: string;
|
|
29
|
+
/**
|
|
30
|
+
* IssuedOn
|
|
31
|
+
*
|
|
32
|
+
* Date/time when supplier issued this update
|
|
33
|
+
* @type {DATE_TIME}
|
|
34
|
+
* @required
|
|
35
|
+
*/
|
|
36
|
+
IssuedOn: string;
|
|
37
|
+
/**
|
|
38
|
+
* Reason Code
|
|
39
|
+
*
|
|
40
|
+
* Reason for this KCI
|
|
41
|
+
* @type {TEXT}
|
|
42
|
+
* @required
|
|
43
|
+
* @default COMMITTED
|
|
44
|
+
*/
|
|
45
|
+
ReasonCode: string;
|
|
46
|
+
/**
|
|
47
|
+
* Supplier Notes
|
|
48
|
+
*
|
|
49
|
+
* Note(s) about the order relating to this KCI
|
|
50
|
+
* @type {TEXT}
|
|
51
|
+
*/
|
|
52
|
+
SupplierNotes?: string | null;
|
|
53
|
+
}
|
|
54
|
+
/**
|
|
55
|
+
* CreateCityfibreOrderKciCommitted
|
|
56
|
+
*
|
|
57
|
+
* @actionType CREATE - Creates a new OrderKci record
|
|
58
|
+
* @module OrderModule
|
|
59
|
+
* @entity OrderKci
|
|
60
|
+
* @entityType COMMITTED (Committed)
|
|
61
|
+
* @event k1.t-hEOJjsDb.OrderModule.OrderKci.Create.CreateCityfibreOrderKciCommitted
|
|
62
|
+
* @permission schema.action.createcityfibreorderkcicommitted.trigger
|
|
63
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
64
|
+
*/
|
|
65
|
+
export declare class CreateCityfibreOrderKciCommittedDto extends OdinRecordCreateDto<CreateCityfibreOrderKciCommittedProperties> {
|
|
66
|
+
/** Used by SDK generators to identify action type */
|
|
67
|
+
static readonly ACTION_TYPE = "CREATE";
|
|
68
|
+
static readonly ACTION_KEY = "CreateCityfibreOrderKciCommitted";
|
|
69
|
+
static readonly MODULE_NAME = "OrderModule";
|
|
70
|
+
static readonly ENTITIES: string[];
|
|
71
|
+
static readonly ENTITY_TYPE = "COMMITTED";
|
|
72
|
+
static readonly EVENT_NAME = "k1.t-hEOJjsDb.OrderModule.OrderKci.Create.CreateCityfibreOrderKciCommitted";
|
|
73
|
+
static readonly PERMISSION = "schema.action.createcityfibreorderkcicommitted.trigger";
|
|
74
|
+
/** Step metadata - entity this action targets */
|
|
75
|
+
static readonly STEP_ENTITY = "OrderModule:OrderKci";
|
|
76
|
+
static readonly STEP_SCHEMA_ID = "01e7f5bf-80e5-467f-9138-d1d12b2cca1e";
|
|
77
|
+
static readonly STEP_SCHEMA_ACTION_ID = "c396062f-6c3c-4106-a8ac-28ab3116ad3f";
|
|
78
|
+
static readonly STEP_SCHEMA_TYPE_ID = "66b6372b-5228-4658-bc5f-d8b16987df73";
|
|
79
|
+
static readonly STEP_TYPE = "COMMITTED";
|
|
80
|
+
static readonly AUTO_LINK_PARENT = true;
|
|
81
|
+
readonly actionName: string;
|
|
82
|
+
readonly schemaActionId: string;
|
|
83
|
+
readonly entity: string;
|
|
84
|
+
constructor(properties: CreateCityfibreOrderKciCommittedProperties, options?: {
|
|
85
|
+
journeyId?: string;
|
|
86
|
+
});
|
|
87
|
+
}
|
|
88
|
+
/**
|
|
89
|
+
* Properties for CreateCityfibreOrderKciCompleted action
|
|
90
|
+
*
|
|
91
|
+
* @property Required fields: 3
|
|
92
|
+
* @property Optional fields: 1
|
|
93
|
+
*/
|
|
94
|
+
export interface CreateCityfibreOrderKciCompletedProperties {
|
|
95
|
+
/**
|
|
96
|
+
* Supplier ID (CityFibre Order ID)
|
|
97
|
+
*
|
|
98
|
+
* Unique identifier for this service order update
|
|
99
|
+
* @type {TEXT}
|
|
100
|
+
* @required
|
|
101
|
+
*/
|
|
102
|
+
SupplierId: string;
|
|
103
|
+
/**
|
|
104
|
+
* IssuedOn
|
|
105
|
+
*
|
|
106
|
+
* Date/time when supplier issued this update
|
|
107
|
+
* @type {DATE_TIME}
|
|
108
|
+
* @required
|
|
109
|
+
*/
|
|
110
|
+
IssuedOn: string;
|
|
111
|
+
/**
|
|
112
|
+
* Reason Code
|
|
113
|
+
*
|
|
114
|
+
* Reason for this KCI
|
|
115
|
+
* @type {TEXT}
|
|
116
|
+
* @required
|
|
117
|
+
* @default COMPLETED
|
|
118
|
+
*/
|
|
119
|
+
ReasonCode: string;
|
|
120
|
+
/**
|
|
121
|
+
* Supplier Notes
|
|
122
|
+
*
|
|
123
|
+
* Note(s) about the order relating to this KCI
|
|
124
|
+
* @type {TEXT}
|
|
125
|
+
*/
|
|
126
|
+
SupplierNotes?: string | null;
|
|
127
|
+
}
|
|
128
|
+
/**
|
|
129
|
+
* CreateCityfibreOrderKciCompleted
|
|
130
|
+
*
|
|
131
|
+
* @actionType CREATE - Creates a new OrderKci record
|
|
132
|
+
* @module OrderModule
|
|
133
|
+
* @entity OrderKci
|
|
134
|
+
* @entityType COMPLETED (Completed)
|
|
135
|
+
* @event k1.t-hEOJjsDb.OrderModule.OrderKci.Create.CreateCityfibreOrderKciCompleted
|
|
136
|
+
* @permission schema.action.createcityfibreorderkcicompleted.trigger
|
|
137
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
138
|
+
*/
|
|
139
|
+
export declare class CreateCityfibreOrderKciCompletedDto extends OdinRecordCreateDto<CreateCityfibreOrderKciCompletedProperties> {
|
|
140
|
+
/** Used by SDK generators to identify action type */
|
|
141
|
+
static readonly ACTION_TYPE = "CREATE";
|
|
142
|
+
static readonly ACTION_KEY = "CreateCityfibreOrderKciCompleted";
|
|
143
|
+
static readonly MODULE_NAME = "OrderModule";
|
|
144
|
+
static readonly ENTITIES: string[];
|
|
145
|
+
static readonly ENTITY_TYPE = "COMPLETED";
|
|
146
|
+
static readonly EVENT_NAME = "k1.t-hEOJjsDb.OrderModule.OrderKci.Create.CreateCityfibreOrderKciCompleted";
|
|
147
|
+
static readonly PERMISSION = "schema.action.createcityfibreorderkcicompleted.trigger";
|
|
148
|
+
/** Step metadata - entity this action targets */
|
|
149
|
+
static readonly STEP_ENTITY = "OrderModule:OrderKci";
|
|
150
|
+
static readonly STEP_SCHEMA_ID = "01e7f5bf-80e5-467f-9138-d1d12b2cca1e";
|
|
151
|
+
static readonly STEP_SCHEMA_ACTION_ID = "e84bb991-957d-40e6-9946-ddd40bdb05db";
|
|
152
|
+
static readonly STEP_SCHEMA_TYPE_ID = "5d46928f-6e97-414f-bd38-f9f5e72c3be0";
|
|
153
|
+
static readonly STEP_TYPE = "COMPLETED";
|
|
154
|
+
static readonly AUTO_LINK_PARENT = true;
|
|
155
|
+
readonly actionName: string;
|
|
156
|
+
readonly schemaActionId: string;
|
|
157
|
+
readonly entity: string;
|
|
158
|
+
constructor(properties: CreateCityfibreOrderKciCompletedProperties, options?: {
|
|
159
|
+
journeyId?: string;
|
|
160
|
+
});
|
|
161
|
+
}
|
|
162
|
+
declare type StepClassMap = {
|
|
163
|
+
CreateCityfibreOrderKciCommittedDto: CreateCityfibreOrderKciCommittedDto;
|
|
164
|
+
CreateCityfibreOrderKciCompletedDto: CreateCityfibreOrderKciCompletedDto;
|
|
165
|
+
};
|
|
166
|
+
/**
|
|
167
|
+
* Link definition for connecting steps in CreateCityfibreKci
|
|
168
|
+
*/
|
|
169
|
+
export interface CreateCityfibreKciStepLink {
|
|
170
|
+
/**
|
|
171
|
+
* The stepKey of the target step to link TO
|
|
172
|
+
* Must reference another step's stepKey in the same flow
|
|
173
|
+
*/
|
|
174
|
+
stepKey: string;
|
|
175
|
+
/**
|
|
176
|
+
* The schema association ID (UUID) defining the relationship
|
|
177
|
+
* Use the association.id from the schema association definition
|
|
178
|
+
* @example "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
|
|
179
|
+
*/
|
|
180
|
+
schemaAssociationId: string;
|
|
181
|
+
}
|
|
182
|
+
/**
|
|
183
|
+
* Step definition with linking metadata for CreateCityfibreKci
|
|
184
|
+
*/
|
|
185
|
+
export interface CreateCityfibreKciStepDefinition {
|
|
186
|
+
/** Unique identifier for this step */
|
|
187
|
+
stepKey: string;
|
|
188
|
+
/** The DTO class name for this step */
|
|
189
|
+
dtoClass: string;
|
|
190
|
+
/** The entity this step creates (Module:Entity format) */
|
|
191
|
+
entity: string;
|
|
192
|
+
/** Links to create after this step executes */
|
|
193
|
+
linksTo: CreateCityfibreKciStepLink[] | null;
|
|
194
|
+
}
|
|
195
|
+
/**
|
|
196
|
+
* Type-safe step keys for CreateCityfibreKci
|
|
197
|
+
*/
|
|
198
|
+
export declare const CreateCityfibreKciSteps: {
|
|
199
|
+
readonly create_cityfibre_kci: "create_cityfibre_kci";
|
|
200
|
+
};
|
|
201
|
+
export declare type CreateCityfibreKciStepKey = typeof CreateCityfibreKciSteps[keyof typeof CreateCityfibreKciSteps];
|
|
202
|
+
/**
|
|
203
|
+
* RabbitMQ message payload for CreateCityfibreKci step flow events
|
|
204
|
+
*
|
|
205
|
+
* @event k1.t-hEOJjsDb.OrderModule.Order.Flow.CreateCityfibreKci
|
|
206
|
+
*/
|
|
207
|
+
export interface CreateCityfibreKciMessage extends OdinRecordUpdatedEvent<CreateCityfibreKciDto, {}> {
|
|
208
|
+
}
|
|
209
|
+
/**
|
|
210
|
+
* Properties for CreateCityfibreKci action
|
|
211
|
+
*
|
|
212
|
+
*/
|
|
213
|
+
export interface CreateCityfibreKciProperties {
|
|
214
|
+
}
|
|
215
|
+
/**
|
|
216
|
+
* CreateCityfibreKci
|
|
217
|
+
*
|
|
218
|
+
* Create a KCI for CityFibre
|
|
219
|
+
*
|
|
220
|
+
* @actionType MULTI_STEP_FLOW - Multi-step workflow action
|
|
221
|
+
* @module OrderModule
|
|
222
|
+
* @entity Order
|
|
223
|
+
* @event k1.t-hEOJjsDb.OrderModule.Order.Flow.CreateCityfibreKci
|
|
224
|
+
* @permission schema.action.createcityfibrekci.trigger
|
|
225
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
226
|
+
*/
|
|
227
|
+
export declare class CreateCityfibreKciDto extends OdinRecordUpdateDto<Record<string, any>> {
|
|
228
|
+
/** Used by SDK generators to identify action type */
|
|
229
|
+
static readonly ACTION_TYPE = "UPDATE";
|
|
230
|
+
static readonly ACTION_KEY = "CreateCityfibreKci";
|
|
231
|
+
static readonly MODULE_NAME = "OrderModule";
|
|
232
|
+
static readonly ENTITIES: string[];
|
|
233
|
+
static readonly EVENT_NAME = "k1.t-hEOJjsDb.OrderModule.Order.Flow.CreateCityfibreKci";
|
|
234
|
+
static readonly SCHEMA_ACTION_ID = "9c8ed659-c67c-4f97-bfef-e590a3a8a9b1";
|
|
235
|
+
static readonly PERMISSION = "schema.action.createcityfibrekci.trigger";
|
|
236
|
+
static readonly IS_STAGE_TRANSITION = false;
|
|
237
|
+
static readonly IS_MULTI_STEP_FLOW = true;
|
|
238
|
+
static readonly HAS_STEP_LINKS = false;
|
|
239
|
+
/**
|
|
240
|
+
* Step definitions with linking metadata
|
|
241
|
+
* Used by SDK and backend for auto-linking after step execution
|
|
242
|
+
*/
|
|
243
|
+
static readonly stepDefinitions: CreateCityfibreKciStepDefinition[];
|
|
244
|
+
/** Type-safe step key accessor */
|
|
245
|
+
static readonly Steps: {
|
|
246
|
+
readonly create_cityfibre_kci: "create_cityfibre_kci";
|
|
247
|
+
};
|
|
248
|
+
readonly actionName: string;
|
|
249
|
+
readonly schemaActionId: string;
|
|
250
|
+
readonly entity: string;
|
|
251
|
+
constructor(record: OdinRecord<any> | {
|
|
252
|
+
id: string;
|
|
253
|
+
entity: string;
|
|
254
|
+
type?: string;
|
|
255
|
+
}, options?: {
|
|
256
|
+
journeyId?: string;
|
|
257
|
+
});
|
|
258
|
+
/** Step classes that can be used with this action */
|
|
259
|
+
static readonly stepClasses: readonly ["CreateCityfibreOrderKciCommittedDto", "CreateCityfibreOrderKciCompletedDto"];
|
|
260
|
+
steps: StepClassMap[(typeof CreateCityfibreKciDto.stepClasses)[number]][];
|
|
261
|
+
}
|
|
262
|
+
export {};
|
|
@@ -0,0 +1,156 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* CreateCityfibreKci Action DTO
|
|
4
|
+
*
|
|
5
|
+
* Create a KCI for CityFibre
|
|
6
|
+
*
|
|
7
|
+
* @module OrderModule
|
|
8
|
+
* @entity Order
|
|
9
|
+
* @actionKey CreateCityfibreKci
|
|
10
|
+
* @event k1.t-hEOJjsDb.OrderModule.Order.Flow.CreateCityfibreKci
|
|
11
|
+
*
|
|
12
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
13
|
+
*/
|
|
14
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
|
+
exports.CreateCityfibreKciDto = exports.CreateCityfibreKciSteps = exports.CreateCityfibreOrderKciCompletedDto = exports.CreateCityfibreOrderKciCommittedDto = void 0;
|
|
16
|
+
const core_1 = require("@d19n/odin-types/dist/core");
|
|
17
|
+
/**
|
|
18
|
+
* CreateCityfibreOrderKciCommitted
|
|
19
|
+
*
|
|
20
|
+
* @actionType CREATE - Creates a new OrderKci record
|
|
21
|
+
* @module OrderModule
|
|
22
|
+
* @entity OrderKci
|
|
23
|
+
* @entityType COMMITTED (Committed)
|
|
24
|
+
* @event k1.t-hEOJjsDb.OrderModule.OrderKci.Create.CreateCityfibreOrderKciCommitted
|
|
25
|
+
* @permission schema.action.createcityfibreorderkcicommitted.trigger
|
|
26
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
27
|
+
*/
|
|
28
|
+
class CreateCityfibreOrderKciCommittedDto extends core_1.OdinRecordCreateDto {
|
|
29
|
+
constructor(properties, options) {
|
|
30
|
+
super({
|
|
31
|
+
entity: 'OrderModule:OrderKci',
|
|
32
|
+
type: 'COMMITTED',
|
|
33
|
+
properties,
|
|
34
|
+
journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
|
|
35
|
+
});
|
|
36
|
+
this.actionName = 'CreateCityfibreOrderKciCommitted';
|
|
37
|
+
this.schemaActionId = 'c396062f-6c3c-4106-a8ac-28ab3116ad3f';
|
|
38
|
+
this.entity = 'OrderModule:OrderKci';
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
exports.CreateCityfibreOrderKciCommittedDto = CreateCityfibreOrderKciCommittedDto;
|
|
42
|
+
/** Used by SDK generators to identify action type */
|
|
43
|
+
CreateCityfibreOrderKciCommittedDto.ACTION_TYPE = 'CREATE';
|
|
44
|
+
CreateCityfibreOrderKciCommittedDto.ACTION_KEY = 'CreateCityfibreOrderKciCommitted';
|
|
45
|
+
CreateCityfibreOrderKciCommittedDto.MODULE_NAME = 'OrderModule';
|
|
46
|
+
CreateCityfibreOrderKciCommittedDto.ENTITIES = ['OrderKci'];
|
|
47
|
+
CreateCityfibreOrderKciCommittedDto.ENTITY_TYPE = 'COMMITTED';
|
|
48
|
+
CreateCityfibreOrderKciCommittedDto.EVENT_NAME = 'k1.t-hEOJjsDb.OrderModule.OrderKci.Create.CreateCityfibreOrderKciCommitted';
|
|
49
|
+
CreateCityfibreOrderKciCommittedDto.PERMISSION = 'schema.action.createcityfibreorderkcicommitted.trigger';
|
|
50
|
+
/** Step metadata - entity this action targets */
|
|
51
|
+
CreateCityfibreOrderKciCommittedDto.STEP_ENTITY = 'OrderModule:OrderKci';
|
|
52
|
+
CreateCityfibreOrderKciCommittedDto.STEP_SCHEMA_ID = '01e7f5bf-80e5-467f-9138-d1d12b2cca1e';
|
|
53
|
+
CreateCityfibreOrderKciCommittedDto.STEP_SCHEMA_ACTION_ID = 'c396062f-6c3c-4106-a8ac-28ab3116ad3f';
|
|
54
|
+
CreateCityfibreOrderKciCommittedDto.STEP_SCHEMA_TYPE_ID = '66b6372b-5228-4658-bc5f-d8b16987df73';
|
|
55
|
+
CreateCityfibreOrderKciCommittedDto.STEP_TYPE = 'COMMITTED';
|
|
56
|
+
CreateCityfibreOrderKciCommittedDto.AUTO_LINK_PARENT = true;
|
|
57
|
+
/**
|
|
58
|
+
* CreateCityfibreOrderKciCompleted
|
|
59
|
+
*
|
|
60
|
+
* @actionType CREATE - Creates a new OrderKci record
|
|
61
|
+
* @module OrderModule
|
|
62
|
+
* @entity OrderKci
|
|
63
|
+
* @entityType COMPLETED (Completed)
|
|
64
|
+
* @event k1.t-hEOJjsDb.OrderModule.OrderKci.Create.CreateCityfibreOrderKciCompleted
|
|
65
|
+
* @permission schema.action.createcityfibreorderkcicompleted.trigger
|
|
66
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
67
|
+
*/
|
|
68
|
+
class CreateCityfibreOrderKciCompletedDto extends core_1.OdinRecordCreateDto {
|
|
69
|
+
constructor(properties, options) {
|
|
70
|
+
super({
|
|
71
|
+
entity: 'OrderModule:OrderKci',
|
|
72
|
+
type: 'COMPLETED',
|
|
73
|
+
properties,
|
|
74
|
+
journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
|
|
75
|
+
});
|
|
76
|
+
this.actionName = 'CreateCityfibreOrderKciCompleted';
|
|
77
|
+
this.schemaActionId = 'e84bb991-957d-40e6-9946-ddd40bdb05db';
|
|
78
|
+
this.entity = 'OrderModule:OrderKci';
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
exports.CreateCityfibreOrderKciCompletedDto = CreateCityfibreOrderKciCompletedDto;
|
|
82
|
+
/** Used by SDK generators to identify action type */
|
|
83
|
+
CreateCityfibreOrderKciCompletedDto.ACTION_TYPE = 'CREATE';
|
|
84
|
+
CreateCityfibreOrderKciCompletedDto.ACTION_KEY = 'CreateCityfibreOrderKciCompleted';
|
|
85
|
+
CreateCityfibreOrderKciCompletedDto.MODULE_NAME = 'OrderModule';
|
|
86
|
+
CreateCityfibreOrderKciCompletedDto.ENTITIES = ['OrderKci'];
|
|
87
|
+
CreateCityfibreOrderKciCompletedDto.ENTITY_TYPE = 'COMPLETED';
|
|
88
|
+
CreateCityfibreOrderKciCompletedDto.EVENT_NAME = 'k1.t-hEOJjsDb.OrderModule.OrderKci.Create.CreateCityfibreOrderKciCompleted';
|
|
89
|
+
CreateCityfibreOrderKciCompletedDto.PERMISSION = 'schema.action.createcityfibreorderkcicompleted.trigger';
|
|
90
|
+
/** Step metadata - entity this action targets */
|
|
91
|
+
CreateCityfibreOrderKciCompletedDto.STEP_ENTITY = 'OrderModule:OrderKci';
|
|
92
|
+
CreateCityfibreOrderKciCompletedDto.STEP_SCHEMA_ID = '01e7f5bf-80e5-467f-9138-d1d12b2cca1e';
|
|
93
|
+
CreateCityfibreOrderKciCompletedDto.STEP_SCHEMA_ACTION_ID = 'e84bb991-957d-40e6-9946-ddd40bdb05db';
|
|
94
|
+
CreateCityfibreOrderKciCompletedDto.STEP_SCHEMA_TYPE_ID = '5d46928f-6e97-414f-bd38-f9f5e72c3be0';
|
|
95
|
+
CreateCityfibreOrderKciCompletedDto.STEP_TYPE = 'COMPLETED';
|
|
96
|
+
CreateCityfibreOrderKciCompletedDto.AUTO_LINK_PARENT = true;
|
|
97
|
+
/**
|
|
98
|
+
* Type-safe step keys for CreateCityfibreKci
|
|
99
|
+
*/
|
|
100
|
+
exports.CreateCityfibreKciSteps = {
|
|
101
|
+
create_cityfibre_kci: 'create_cityfibre_kci',
|
|
102
|
+
};
|
|
103
|
+
/**
|
|
104
|
+
* CreateCityfibreKci
|
|
105
|
+
*
|
|
106
|
+
* Create a KCI for CityFibre
|
|
107
|
+
*
|
|
108
|
+
* @actionType MULTI_STEP_FLOW - Multi-step workflow action
|
|
109
|
+
* @module OrderModule
|
|
110
|
+
* @entity Order
|
|
111
|
+
* @event k1.t-hEOJjsDb.OrderModule.Order.Flow.CreateCityfibreKci
|
|
112
|
+
* @permission schema.action.createcityfibrekci.trigger
|
|
113
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
114
|
+
*/
|
|
115
|
+
class CreateCityfibreKciDto extends core_1.OdinRecordUpdateDto {
|
|
116
|
+
constructor(record, options) {
|
|
117
|
+
super({
|
|
118
|
+
id: record.id,
|
|
119
|
+
entity: record.entity,
|
|
120
|
+
type: record.type,
|
|
121
|
+
properties: {},
|
|
122
|
+
journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
|
|
123
|
+
});
|
|
124
|
+
this.actionName = 'CreateCityfibreKci';
|
|
125
|
+
this.schemaActionId = '9c8ed659-c67c-4f97-bfef-e590a3a8a9b1';
|
|
126
|
+
this.entity = 'OrderModule:Order';
|
|
127
|
+
}
|
|
128
|
+
}
|
|
129
|
+
exports.CreateCityfibreKciDto = CreateCityfibreKciDto;
|
|
130
|
+
/** Used by SDK generators to identify action type */
|
|
131
|
+
CreateCityfibreKciDto.ACTION_TYPE = 'UPDATE';
|
|
132
|
+
CreateCityfibreKciDto.ACTION_KEY = 'CreateCityfibreKci';
|
|
133
|
+
CreateCityfibreKciDto.MODULE_NAME = 'OrderModule';
|
|
134
|
+
CreateCityfibreKciDto.ENTITIES = ['Order'];
|
|
135
|
+
CreateCityfibreKciDto.EVENT_NAME = 'k1.t-hEOJjsDb.OrderModule.Order.Flow.CreateCityfibreKci';
|
|
136
|
+
CreateCityfibreKciDto.SCHEMA_ACTION_ID = '9c8ed659-c67c-4f97-bfef-e590a3a8a9b1';
|
|
137
|
+
CreateCityfibreKciDto.PERMISSION = 'schema.action.createcityfibrekci.trigger';
|
|
138
|
+
CreateCityfibreKciDto.IS_STAGE_TRANSITION = false;
|
|
139
|
+
CreateCityfibreKciDto.IS_MULTI_STEP_FLOW = true;
|
|
140
|
+
CreateCityfibreKciDto.HAS_STEP_LINKS = false;
|
|
141
|
+
/**
|
|
142
|
+
* Step definitions with linking metadata
|
|
143
|
+
* Used by SDK and backend for auto-linking after step execution
|
|
144
|
+
*/
|
|
145
|
+
CreateCityfibreKciDto.stepDefinitions = [
|
|
146
|
+
{
|
|
147
|
+
stepKey: 'create_cityfibre_kci',
|
|
148
|
+
dtoClass: 'CreateCityfibreOrderKciCommittedDto',
|
|
149
|
+
entity: 'OrderModule:OrderKci',
|
|
150
|
+
linksTo: null
|
|
151
|
+
}
|
|
152
|
+
];
|
|
153
|
+
/** Type-safe step key accessor */
|
|
154
|
+
CreateCityfibreKciDto.Steps = exports.CreateCityfibreKciSteps;
|
|
155
|
+
/** Step classes that can be used with this action */
|
|
156
|
+
CreateCityfibreKciDto.stepClasses = ['CreateCityfibreOrderKciCommittedDto', 'CreateCityfibreOrderKciCompletedDto'];
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* CreateCityfibreOrderKciCommitted Action DTO
|
|
3
|
+
*
|
|
4
|
+
* CreateCityfibreOrderKciCommitted
|
|
5
|
+
*
|
|
6
|
+
* @module OrderModule
|
|
7
|
+
* @entity OrderKci
|
|
8
|
+
* @entityType COMMITTED
|
|
9
|
+
* @actionKey CreateCityfibreOrderKciCommitted
|
|
10
|
+
* @event k1.t-hEOJjsDb.OrderModule.OrderKci.Create.CreateCityfibreOrderKciCommitted
|
|
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 CreateCityfibreOrderKciCommitted created events
|
|
17
|
+
*
|
|
18
|
+
* @event k1.t-hEOJjsDb.OrderModule.OrderKci.Create.CreateCityfibreOrderKciCommitted
|
|
19
|
+
*/
|
|
20
|
+
export interface CreateCityfibreOrderKciCommittedMessage extends OdinRecordCreatedEvent<CreateCityfibreOrderKciCommittedDto, CreateCityfibreOrderKciCommittedProperties> {
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Properties for CreateCityfibreOrderKciCommitted action
|
|
24
|
+
*
|
|
25
|
+
* @property Required fields: 3
|
|
26
|
+
* @property Optional fields: 2
|
|
27
|
+
*/
|
|
28
|
+
export interface CreateCityfibreOrderKciCommittedProperties {
|
|
29
|
+
/**
|
|
30
|
+
* Supplier ID (CityFibre Order ID)
|
|
31
|
+
*
|
|
32
|
+
* Unique identifier for this service order update
|
|
33
|
+
* @type {TEXT}
|
|
34
|
+
* @required
|
|
35
|
+
*/
|
|
36
|
+
SupplierId: string;
|
|
37
|
+
/**
|
|
38
|
+
* IssuedOn
|
|
39
|
+
*
|
|
40
|
+
* Date/time when supplier issued this update
|
|
41
|
+
* @type {DATE_TIME}
|
|
42
|
+
* @required
|
|
43
|
+
*/
|
|
44
|
+
IssuedOn: string;
|
|
45
|
+
/**
|
|
46
|
+
* Reason Code
|
|
47
|
+
*
|
|
48
|
+
* Reason for this KCI
|
|
49
|
+
* @type {TEXT}
|
|
50
|
+
* @required
|
|
51
|
+
* @default COMMITTED
|
|
52
|
+
*/
|
|
53
|
+
ReasonCode: string;
|
|
54
|
+
/**
|
|
55
|
+
* Supplier Notes
|
|
56
|
+
*
|
|
57
|
+
* Note(s) about the order relating to this KCI
|
|
58
|
+
* @type {TEXT}
|
|
59
|
+
*/
|
|
60
|
+
SupplierNotes?: string | null;
|
|
61
|
+
}
|
|
62
|
+
/**
|
|
63
|
+
* CreateCityfibreOrderKciCommitted
|
|
64
|
+
*
|
|
65
|
+
* @actionType CREATE - Creates a new OrderKci record
|
|
66
|
+
* @module OrderModule
|
|
67
|
+
* @entity OrderKci
|
|
68
|
+
* @entityType COMMITTED (Committed)
|
|
69
|
+
* @event k1.t-hEOJjsDb.OrderModule.OrderKci.Create.CreateCityfibreOrderKciCommitted
|
|
70
|
+
* @permission schema.action.createcityfibreorderkcicommitted.trigger
|
|
71
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
72
|
+
*/
|
|
73
|
+
export declare class CreateCityfibreOrderKciCommittedDto extends OdinRecordCreateDto<CreateCityfibreOrderKciCommittedProperties> {
|
|
74
|
+
/** Used by SDK generators to identify action type */
|
|
75
|
+
static readonly ACTION_TYPE = "CREATE";
|
|
76
|
+
static readonly ACTION_KEY = "CreateCityfibreOrderKciCommitted";
|
|
77
|
+
static readonly MODULE_NAME = "OrderModule";
|
|
78
|
+
static readonly ENTITIES: string[];
|
|
79
|
+
static readonly ENTITY_TYPE = "COMMITTED";
|
|
80
|
+
static readonly EVENT_NAME = "k1.t-hEOJjsDb.OrderModule.OrderKci.Create.CreateCityfibreOrderKciCommitted";
|
|
81
|
+
static readonly PERMISSION = "schema.action.createcityfibreorderkcicommitted.trigger";
|
|
82
|
+
/** Step metadata - entity this action targets */
|
|
83
|
+
static readonly STEP_ENTITY = "OrderModule:OrderKci";
|
|
84
|
+
static readonly STEP_SCHEMA_ID = "01e7f5bf-80e5-467f-9138-d1d12b2cca1e";
|
|
85
|
+
static readonly STEP_SCHEMA_ACTION_ID = "c396062f-6c3c-4106-a8ac-28ab3116ad3f";
|
|
86
|
+
static readonly STEP_SCHEMA_TYPE_ID = "66b6372b-5228-4658-bc5f-d8b16987df73";
|
|
87
|
+
static readonly STEP_TYPE = "COMMITTED";
|
|
88
|
+
static readonly AUTO_LINK_PARENT = true;
|
|
89
|
+
readonly actionName: string;
|
|
90
|
+
readonly schemaActionId: string;
|
|
91
|
+
readonly entity: string;
|
|
92
|
+
constructor(properties: CreateCityfibreOrderKciCommittedProperties, options?: {
|
|
93
|
+
journeyId?: string;
|
|
94
|
+
});
|
|
95
|
+
}
|