@d19n/youfibre-odin-sdk 2.0.4 → 2.0.6
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 **558** actions.
|
|
356
356
|
|
|
357
357
|
### Action Types
|
|
358
358
|
|
|
@@ -1581,6 +1581,7 @@ This SDK includes **557** actions.
|
|
|
1581
1581
|
| Action | Type | Event |
|
|
1582
1582
|
|--------|------|-------|
|
|
1583
1583
|
| `CreateRecontractVoiceConfiguration` | CREATE | k1.t-hEOJjsDb.ServiceModule.VoiceConfiguration.Create.CreateRecontractVoiceConfiguration |
|
|
1584
|
+
| `CreateVoiceConfiguration` | CREATE | k1.t-t-hEOJjsDb.ServiceModule.VoiceConfiguration.Create.CreateVoiceConfiguration |
|
|
1584
1585
|
| `UpdateVoiceConfiguration` | UPDATE | k1.t-hEOJjsDb.ServiceModule.VoiceConfiguration.Update.UpdateVoiceConfiguration |
|
|
1585
1586
|
|
|
1586
1587
|
#### SalesTerritory
|
|
@@ -0,0 +1,208 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* CreateVoiceConfiguration Action DTO
|
|
3
|
+
*
|
|
4
|
+
* Create Voice Configuration
|
|
5
|
+
*
|
|
6
|
+
* @module ServiceModule
|
|
7
|
+
* @entity VoiceConfiguration
|
|
8
|
+
* @actionKey CreateVoiceConfiguration
|
|
9
|
+
* @event k1.t-t-hEOJjsDb.ServiceModule.VoiceConfiguration.Create.CreateVoiceConfiguration
|
|
10
|
+
*
|
|
11
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
12
|
+
*/
|
|
13
|
+
import { OdinRecordCreateDto, OdinRecordCreatedEvent } from '@d19n/odin-types/dist/core';
|
|
14
|
+
/**
|
|
15
|
+
* RabbitMQ message payload for CreateVoiceConfiguration created events
|
|
16
|
+
*
|
|
17
|
+
* @event k1.t-t-hEOJjsDb.ServiceModule.VoiceConfiguration.Create.CreateVoiceConfiguration
|
|
18
|
+
*/
|
|
19
|
+
export interface CreateVoiceConfigurationMessage extends OdinRecordCreatedEvent<CreateVoiceConfigurationDto, CreateVoiceConfigurationProperties> {
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Properties for CreateVoiceConfiguration action
|
|
23
|
+
*
|
|
24
|
+
* @property Required fields: 0
|
|
25
|
+
* @property Optional fields: 21
|
|
26
|
+
*/
|
|
27
|
+
export interface CreateVoiceConfigurationProperties {
|
|
28
|
+
/**
|
|
29
|
+
* NetworkServiceId
|
|
30
|
+
*
|
|
31
|
+
* NetworkServiceId (Network Operations - VoiceConfiguration)
|
|
32
|
+
* @type {TEXT}
|
|
33
|
+
*/
|
|
34
|
+
NetworkServiceId?: string | null;
|
|
35
|
+
/**
|
|
36
|
+
* IssuedPhoneNumberParts
|
|
37
|
+
*
|
|
38
|
+
* IssuedPhoneNumberParts (Network Operations - VoiceConfiguration)
|
|
39
|
+
* @type {JSON}
|
|
40
|
+
*/
|
|
41
|
+
IssuedPhoneNumberParts?: string | null;
|
|
42
|
+
/**
|
|
43
|
+
* PhoneNumberToPortParts
|
|
44
|
+
*
|
|
45
|
+
* The parts include CountryCode, AreaCode, SubscriberNumber (Network Operations - VoiceConfiguration)
|
|
46
|
+
* @type {JSON}
|
|
47
|
+
*/
|
|
48
|
+
PhoneNumberToPortParts?: string | null;
|
|
49
|
+
/**
|
|
50
|
+
* AuthorizedLOA
|
|
51
|
+
*
|
|
52
|
+
* AuthorizedLOA (Network Operations - VoiceConfiguration)
|
|
53
|
+
* @type {BOOLEAN}
|
|
54
|
+
*/
|
|
55
|
+
AuthorizedLOA?: boolean | null;
|
|
56
|
+
/**
|
|
57
|
+
* MagratheaOrderStatus
|
|
58
|
+
*
|
|
59
|
+
* MagratheaOrderStatus (Network Operations - VoiceConfiguration)
|
|
60
|
+
* @type {TEXT}
|
|
61
|
+
*/
|
|
62
|
+
MagratheaOrderStatus?: string | null;
|
|
63
|
+
/**
|
|
64
|
+
* MagratheaOrderStatusDate
|
|
65
|
+
*
|
|
66
|
+
* MagratheaOrderStatusDate (Network Operations - VoiceConfiguration)
|
|
67
|
+
* @type {DATE_TIME}
|
|
68
|
+
* @format DD/MM/YYYY hh:mm:ss
|
|
69
|
+
*/
|
|
70
|
+
MagratheaOrderStatusDate?: string | null;
|
|
71
|
+
/**
|
|
72
|
+
* PortFromProvider
|
|
73
|
+
*
|
|
74
|
+
* PortFromProvider (Network Operations - VoiceConfiguration)
|
|
75
|
+
* @type {ENUM}
|
|
76
|
+
*/
|
|
77
|
+
PortFromProvider?: string | null;
|
|
78
|
+
/**
|
|
79
|
+
* SipwiseSubscriberId
|
|
80
|
+
*
|
|
81
|
+
* SipwiseSubscriberId (Network Operations - VoiceConfiguration)
|
|
82
|
+
* @type {NUMBER}
|
|
83
|
+
*/
|
|
84
|
+
SipwiseSubscriberId?: number | null;
|
|
85
|
+
/**
|
|
86
|
+
* IssuedPhoneNumber
|
|
87
|
+
*
|
|
88
|
+
* the phone number provided by us to the customer (Network Operations - VoiceConfiguration)
|
|
89
|
+
* @type {TEXT}
|
|
90
|
+
*/
|
|
91
|
+
IssuedPhoneNumber?: string | null;
|
|
92
|
+
/**
|
|
93
|
+
* SipwiseCustomerContactId
|
|
94
|
+
*
|
|
95
|
+
* SipwiseCustomerContactId (Network Operations - VoiceConfiguration)
|
|
96
|
+
* @type {NUMERIC}
|
|
97
|
+
*/
|
|
98
|
+
SipwiseCustomerContactId?: number | null;
|
|
99
|
+
/**
|
|
100
|
+
* SipwiseCustomerId
|
|
101
|
+
*
|
|
102
|
+
* SipwiseCustomerId (Network Operations - VoiceConfiguration)
|
|
103
|
+
* @type {NUMBER}
|
|
104
|
+
*/
|
|
105
|
+
SipwiseCustomerId?: number | null;
|
|
106
|
+
/**
|
|
107
|
+
* VoiceLineState
|
|
108
|
+
*
|
|
109
|
+
* VoiceLineState (Network Operations - VoiceConfiguration)
|
|
110
|
+
* @type {TEXT}
|
|
111
|
+
*/
|
|
112
|
+
VoiceLineState?: string | null;
|
|
113
|
+
/**
|
|
114
|
+
* MagratheaOrderId
|
|
115
|
+
*
|
|
116
|
+
* the order id provided by magrathea (Network Operations - VoiceConfiguration)
|
|
117
|
+
* @type {TEXT}
|
|
118
|
+
*/
|
|
119
|
+
MagratheaOrderId?: string | null;
|
|
120
|
+
/**
|
|
121
|
+
* PhoneNumberToPort
|
|
122
|
+
*
|
|
123
|
+
* phone number to port (Network Operations - VoiceConfiguration)
|
|
124
|
+
* @type {TEXT}
|
|
125
|
+
*/
|
|
126
|
+
PhoneNumberToPort?: string | null;
|
|
127
|
+
/**
|
|
128
|
+
* VoiceServerStatus
|
|
129
|
+
*
|
|
130
|
+
* VoiceServerStatus (Network Operations - VoiceConfiguration)
|
|
131
|
+
* @type {TEXT}
|
|
132
|
+
*/
|
|
133
|
+
VoiceServerStatus?: string | null;
|
|
134
|
+
/**
|
|
135
|
+
* VoicePortAdminStatus
|
|
136
|
+
*
|
|
137
|
+
* VoicePortAdminStatus (Network Operations - VoiceConfiguration)
|
|
138
|
+
* @type {TEXT}
|
|
139
|
+
*/
|
|
140
|
+
VoicePortAdminStatus?: string | null;
|
|
141
|
+
/**
|
|
142
|
+
* VoiceIp
|
|
143
|
+
*
|
|
144
|
+
* Data field for VoiceConfiguration records. Used by Network Operations team.
|
|
145
|
+
* @type {TEXT}
|
|
146
|
+
*/
|
|
147
|
+
VoiceIp?: string | null;
|
|
148
|
+
/**
|
|
149
|
+
* VoicePortOperStatus
|
|
150
|
+
*
|
|
151
|
+
* VoicePortOperStatus (Network Operations - VoiceConfiguration)
|
|
152
|
+
* @type {TEXT}
|
|
153
|
+
*/
|
|
154
|
+
VoicePortOperStatus?: string | null;
|
|
155
|
+
/**
|
|
156
|
+
* MagratheaOrderLastUpdateTime
|
|
157
|
+
*
|
|
158
|
+
* MagratheaOrderLastUpdateTime (Network Operations - VoiceConfiguration)
|
|
159
|
+
* @type {TEXT}
|
|
160
|
+
*/
|
|
161
|
+
MagratheaOrderLastUpdateTime?: string | null;
|
|
162
|
+
/**
|
|
163
|
+
* MagratheaOrderLastUpdate
|
|
164
|
+
*
|
|
165
|
+
* MagratheaOrderLastUpdate (Network Operations - VoiceConfiguration)
|
|
166
|
+
* @type {TEXT}
|
|
167
|
+
*/
|
|
168
|
+
MagratheaOrderLastUpdate?: string | null;
|
|
169
|
+
/**
|
|
170
|
+
* OrderItemId
|
|
171
|
+
*
|
|
172
|
+
* OrderItemId (Network Operations - VoiceConfiguration)
|
|
173
|
+
* @type {LOOKUP}
|
|
174
|
+
*/
|
|
175
|
+
OrderItemId?: string | null;
|
|
176
|
+
}
|
|
177
|
+
/**
|
|
178
|
+
* CreateVoiceConfiguration
|
|
179
|
+
*
|
|
180
|
+
* Create Voice Configuration
|
|
181
|
+
*
|
|
182
|
+
* @actionType CREATE - Creates a new VoiceConfiguration record
|
|
183
|
+
* @module ServiceModule
|
|
184
|
+
* @entity VoiceConfiguration
|
|
185
|
+
* @event k1.t-t-hEOJjsDb.ServiceModule.VoiceConfiguration.Create.CreateVoiceConfiguration
|
|
186
|
+
* @permission schema.action.createvoiceconfiguration.trigger
|
|
187
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
188
|
+
*/
|
|
189
|
+
export declare class CreateVoiceConfigurationDto extends OdinRecordCreateDto<CreateVoiceConfigurationProperties> {
|
|
190
|
+
/** Used by SDK generators to identify action type */
|
|
191
|
+
static readonly ACTION_TYPE = "CREATE";
|
|
192
|
+
static readonly ACTION_KEY = "CreateVoiceConfiguration";
|
|
193
|
+
static readonly MODULE_NAME = "ServiceModule";
|
|
194
|
+
static readonly ENTITIES: string[];
|
|
195
|
+
static readonly EVENT_NAME = "k1.t-t-hEOJjsDb.ServiceModule.VoiceConfiguration.Create.CreateVoiceConfiguration";
|
|
196
|
+
static readonly PERMISSION = "schema.action.createvoiceconfiguration.trigger";
|
|
197
|
+
/** Step metadata - entity this action targets */
|
|
198
|
+
static readonly STEP_ENTITY = "ServiceModule:VoiceConfiguration";
|
|
199
|
+
static readonly STEP_SCHEMA_ID = "47c52e0a-b0f8-4f6b-a77b-9a715e0df9cd";
|
|
200
|
+
static readonly STEP_SCHEMA_ACTION_ID = "92cb29bf-f1c9-4631-8468-235840124fc2";
|
|
201
|
+
static readonly AUTO_LINK_PARENT = true;
|
|
202
|
+
readonly actionName: string;
|
|
203
|
+
readonly schemaActionId: string;
|
|
204
|
+
readonly entity: string;
|
|
205
|
+
constructor(properties: CreateVoiceConfigurationProperties, options?: {
|
|
206
|
+
journeyId?: string;
|
|
207
|
+
});
|
|
208
|
+
}
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* CreateVoiceConfiguration Action DTO
|
|
4
|
+
*
|
|
5
|
+
* Create Voice Configuration
|
|
6
|
+
*
|
|
7
|
+
* @module ServiceModule
|
|
8
|
+
* @entity VoiceConfiguration
|
|
9
|
+
* @actionKey CreateVoiceConfiguration
|
|
10
|
+
* @event k1.t-t-hEOJjsDb.ServiceModule.VoiceConfiguration.Create.CreateVoiceConfiguration
|
|
11
|
+
*
|
|
12
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
13
|
+
*/
|
|
14
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
|
+
exports.CreateVoiceConfigurationDto = void 0;
|
|
16
|
+
const core_1 = require("@d19n/odin-types/dist/core");
|
|
17
|
+
/**
|
|
18
|
+
* CreateVoiceConfiguration
|
|
19
|
+
*
|
|
20
|
+
* Create Voice Configuration
|
|
21
|
+
*
|
|
22
|
+
* @actionType CREATE - Creates a new VoiceConfiguration record
|
|
23
|
+
* @module ServiceModule
|
|
24
|
+
* @entity VoiceConfiguration
|
|
25
|
+
* @event k1.t-t-hEOJjsDb.ServiceModule.VoiceConfiguration.Create.CreateVoiceConfiguration
|
|
26
|
+
* @permission schema.action.createvoiceconfiguration.trigger
|
|
27
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
28
|
+
*/
|
|
29
|
+
class CreateVoiceConfigurationDto extends core_1.OdinRecordCreateDto {
|
|
30
|
+
constructor(properties, options) {
|
|
31
|
+
super({
|
|
32
|
+
entity: 'ServiceModule:VoiceConfiguration',
|
|
33
|
+
type: undefined,
|
|
34
|
+
properties,
|
|
35
|
+
journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
|
|
36
|
+
});
|
|
37
|
+
this.actionName = 'CreateVoiceConfiguration';
|
|
38
|
+
this.schemaActionId = '92cb29bf-f1c9-4631-8468-235840124fc2';
|
|
39
|
+
this.entity = 'ServiceModule:VoiceConfiguration';
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
exports.CreateVoiceConfigurationDto = CreateVoiceConfigurationDto;
|
|
43
|
+
/** Used by SDK generators to identify action type */
|
|
44
|
+
CreateVoiceConfigurationDto.ACTION_TYPE = 'CREATE';
|
|
45
|
+
CreateVoiceConfigurationDto.ACTION_KEY = 'CreateVoiceConfiguration';
|
|
46
|
+
CreateVoiceConfigurationDto.MODULE_NAME = 'ServiceModule';
|
|
47
|
+
CreateVoiceConfigurationDto.ENTITIES = ['VoiceConfiguration'];
|
|
48
|
+
CreateVoiceConfigurationDto.EVENT_NAME = 'k1.t-t-hEOJjsDb.ServiceModule.VoiceConfiguration.Create.CreateVoiceConfiguration';
|
|
49
|
+
CreateVoiceConfigurationDto.PERMISSION = 'schema.action.createvoiceconfiguration.trigger';
|
|
50
|
+
/** Step metadata - entity this action targets */
|
|
51
|
+
CreateVoiceConfigurationDto.STEP_ENTITY = 'ServiceModule:VoiceConfiguration';
|
|
52
|
+
CreateVoiceConfigurationDto.STEP_SCHEMA_ID = '47c52e0a-b0f8-4f6b-a77b-9a715e0df9cd';
|
|
53
|
+
CreateVoiceConfigurationDto.STEP_SCHEMA_ACTION_ID = '92cb29bf-f1c9-4631-8468-235840124fc2';
|
|
54
|
+
CreateVoiceConfigurationDto.AUTO_LINK_PARENT = true;
|
|
@@ -22,6 +22,7 @@ import { IOdinProvider } from '@d19n/odin-sdk-generator/dist/odin-sdk-types';
|
|
|
22
22
|
import { RecordLinkManager } from '@d19n/odin-sdk-generator/dist/record-link-manager';
|
|
23
23
|
import { VoiceConfigurationProperties } from '../entities-v2/VoiceConfiguration';
|
|
24
24
|
import { CreateRecontractVoiceConfigurationProperties } from '../actions-v2/CreateRecontractVoiceConfigurationDto';
|
|
25
|
+
import { CreateVoiceConfigurationProperties } from '../actions-v2/CreateVoiceConfigurationDto';
|
|
25
26
|
import { UpdateVoiceConfigurationProperties } from '../actions-v2/UpdateVoiceConfigurationDto';
|
|
26
27
|
import { OrderItemRecord } from './OrderItemRecord';
|
|
27
28
|
/**
|
|
@@ -180,6 +181,34 @@ export declare class VoiceConfigurationRecord<TProps = VoiceConfigurationPropert
|
|
|
180
181
|
journeyId?: string;
|
|
181
182
|
stageKey?: string;
|
|
182
183
|
}): ActionBuilder;
|
|
184
|
+
/**
|
|
185
|
+
* CreateVoiceConfiguration
|
|
186
|
+
*
|
|
187
|
+
* Creates a new VoiceConfiguration record with the specified properties.
|
|
188
|
+
* Returns an ActionBuilder - call .execute() to create or .dryRun() for debugging.
|
|
189
|
+
*
|
|
190
|
+
* @param properties - The properties for the new record
|
|
191
|
+
* @param options - Optional settings
|
|
192
|
+
* @param options.type - Override the record type
|
|
193
|
+
* @param options.journeyId - Associate with a journey
|
|
194
|
+
* @param options.stageKey - Set initial pipeline stage
|
|
195
|
+
* @returns ActionBuilder - call .execute() to create or .dryRun() for payload
|
|
196
|
+
*
|
|
197
|
+
* @example
|
|
198
|
+
* ```typescript
|
|
199
|
+
* // Create with properties
|
|
200
|
+
* const record = odinClient.voiceConfigurations.new();
|
|
201
|
+
* await record.createVoiceConfiguration({ ... }).execute();
|
|
202
|
+
*
|
|
203
|
+
* // Dry run (for debugging)
|
|
204
|
+
* const payload = record.createVoiceConfiguration({ ... }).dryRun();
|
|
205
|
+
* ```
|
|
206
|
+
*/
|
|
207
|
+
createVoiceConfiguration(properties?: CreateVoiceConfigurationProperties, options?: {
|
|
208
|
+
type?: string;
|
|
209
|
+
journeyId?: string;
|
|
210
|
+
stageKey?: string;
|
|
211
|
+
}): ActionBuilder;
|
|
183
212
|
/**
|
|
184
213
|
* UpdateVoiceConfiguration
|
|
185
214
|
*
|
|
@@ -245,6 +245,42 @@ class VoiceConfigurationRecord {
|
|
|
245
245
|
};
|
|
246
246
|
return new ActionBuilder(this._provider, 'ServiceModule', 'VoiceConfiguration', payload, () => { this._pendingLinks = []; });
|
|
247
247
|
}
|
|
248
|
+
/**
|
|
249
|
+
* CreateVoiceConfiguration
|
|
250
|
+
*
|
|
251
|
+
* Creates a new VoiceConfiguration record with the specified properties.
|
|
252
|
+
* Returns an ActionBuilder - call .execute() to create or .dryRun() for debugging.
|
|
253
|
+
*
|
|
254
|
+
* @param properties - The properties for the new record
|
|
255
|
+
* @param options - Optional settings
|
|
256
|
+
* @param options.type - Override the record type
|
|
257
|
+
* @param options.journeyId - Associate with a journey
|
|
258
|
+
* @param options.stageKey - Set initial pipeline stage
|
|
259
|
+
* @returns ActionBuilder - call .execute() to create or .dryRun() for payload
|
|
260
|
+
*
|
|
261
|
+
* @example
|
|
262
|
+
* ```typescript
|
|
263
|
+
* // Create with properties
|
|
264
|
+
* const record = odinClient.voiceConfigurations.new();
|
|
265
|
+
* await record.createVoiceConfiguration({ ... }).execute();
|
|
266
|
+
*
|
|
267
|
+
* // Dry run (for debugging)
|
|
268
|
+
* const payload = record.createVoiceConfiguration({ ... }).dryRun();
|
|
269
|
+
* ```
|
|
270
|
+
*/
|
|
271
|
+
createVoiceConfiguration(properties, options) {
|
|
272
|
+
var _a, _b;
|
|
273
|
+
const payload = {
|
|
274
|
+
entity: 'ServiceModule:VoiceConfiguration',
|
|
275
|
+
type: (_a = options === null || options === void 0 ? void 0 : options.type) !== null && _a !== void 0 ? _a : (_b = this._record) === null || _b === void 0 ? void 0 : _b.type,
|
|
276
|
+
actionName: 'CreateVoiceConfiguration',
|
|
277
|
+
properties: properties || {},
|
|
278
|
+
associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined,
|
|
279
|
+
journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
|
|
280
|
+
stageKey: options === null || options === void 0 ? void 0 : options.stageKey,
|
|
281
|
+
};
|
|
282
|
+
return new ActionBuilder(this._provider, 'ServiceModule', 'VoiceConfiguration', payload, () => { this._pendingLinks = []; });
|
|
283
|
+
}
|
|
248
284
|
// ============================================
|
|
249
285
|
// UPDATE ACTIONS (require existing record)
|
|
250
286
|
// ============================================
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@d19n/youfibre-odin-sdk",
|
|
3
|
-
"version": "2.0.
|
|
3
|
+
"version": "2.0.6",
|
|
4
4
|
"description": "",
|
|
5
5
|
"author": "@d19n",
|
|
6
6
|
"license": "UNLICENSED",
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
"typescript": "4.8.4"
|
|
12
12
|
},
|
|
13
13
|
"dependencies": {
|
|
14
|
-
"@d19n/odin-sdk-generator": "^3.0.
|
|
14
|
+
"@d19n/odin-sdk-generator": "^3.0.231",
|
|
15
15
|
"@d19n/odin-types": "^3.0.30"
|
|
16
16
|
},
|
|
17
17
|
"scripts": {
|