@d19n/youfibre-odin-sdk 2.0.375 → 2.0.376

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.
@@ -0,0 +1,124 @@
1
+ "use strict";
2
+ /**
3
+ * QaBatchSummary Entity Definition
4
+ *
5
+ * The AI-written overall report on one bulk QA run: the agent or team, what they do well, what recurs, what to coach, with the case numbers behind each point. Written only by youfibre-api-support.
6
+ *
7
+ * @module SupportModule
8
+ * @entity QaBatchSummary
9
+ * @schemaId c932a484-143a-4b2d-bf01-88b9fb9fc9df
10
+ *
11
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
12
+ * Generated from Odin schema definition
13
+ */
14
+ Object.defineProperty(exports, "__esModule", { value: true });
15
+ exports.ROUTING_KEY_QA_BATCH_SUMMARY_DEFAULT_DELETED = exports.ROUTING_KEY_QA_BATCH_SUMMARY_DEFAULT_UPDATED = exports.ROUTING_KEY_QA_BATCH_SUMMARY_DEFAULT_CREATED = exports.ROUTING_KEY_QA_BATCH_SUMMARY_DELETED = exports.ROUTING_KEY_QA_BATCH_SUMMARY_UPDATED = exports.ROUTING_KEY_QA_BATCH_SUMMARY_CREATED = exports.QaBatchSummary = exports.QaBatchSummaryPropertyKeys = exports.QaBatchSummaryStatus = exports.QaBatchSummaryScope = exports.QaBatchSummaryEntityTypes = void 0;
16
+ const core_1 = require("@d19n/odin-types/dist/core");
17
+ /**
18
+ * Available types for QaBatchSummary records
19
+ */
20
+ var QaBatchSummaryEntityTypes;
21
+ (function (QaBatchSummaryEntityTypes) {
22
+ /** This is the default record type */
23
+ QaBatchSummaryEntityTypes["DEFAULT"] = "DEFAULT";
24
+ })(QaBatchSummaryEntityTypes = exports.QaBatchSummaryEntityTypes || (exports.QaBatchSummaryEntityTypes = {}));
25
+ /**
26
+ * Valid values for QaBatchSummary.Scope
27
+ *
28
+ * AGENT: one agent. TEAM: a team, with a per-agent section and a team synthesis.
29
+ *
30
+ * @remarks Available options:
31
+ * - `AGENT` - Agent
32
+ * - `TEAM` - Team
33
+ */
34
+ var QaBatchSummaryScope;
35
+ (function (QaBatchSummaryScope) {
36
+ QaBatchSummaryScope["AGENT"] = "AGENT";
37
+ QaBatchSummaryScope["TEAM"] = "TEAM";
38
+ })(QaBatchSummaryScope = exports.QaBatchSummaryScope || (exports.QaBatchSummaryScope = {}));
39
+ /**
40
+ * Valid values for QaBatchSummary.Status
41
+ *
42
+ * PENDING while the model writes it; COMPLETE when the files are stored; FAILED with Error when it could not be written.
43
+ *
44
+ * @remarks Available options:
45
+ * - `COMPLETE` - Complete
46
+ * - `FAILED` - Failed
47
+ * - `PENDING` - Pending
48
+ */
49
+ var QaBatchSummaryStatus;
50
+ (function (QaBatchSummaryStatus) {
51
+ QaBatchSummaryStatus["COMPLETE"] = "COMPLETE";
52
+ QaBatchSummaryStatus["FAILED"] = "FAILED";
53
+ QaBatchSummaryStatus["PENDING"] = "PENDING";
54
+ })(QaBatchSummaryStatus = exports.QaBatchSummaryStatus || (exports.QaBatchSummaryStatus = {}));
55
+ /**
56
+ * Property keys for QaBatchSummary
57
+ * Use these constants instead of string literals for type safety
58
+ */
59
+ var QaBatchSummaryPropertyKeys;
60
+ (function (QaBatchSummaryPropertyKeys) {
61
+ /** AGENT: one agent. TEAM: a team, with a per-agent section and a team synthesis. */
62
+ QaBatchSummaryPropertyKeys["Scope"] = "Scope";
63
+ /** The agent summarised, for an AGENT summary. */
64
+ QaBatchSummaryPropertyKeys["AgentId"] = "AgentId";
65
+ /** The agent's display name at the time. */
66
+ QaBatchSummaryPropertyKeys["AgentName"] = "AgentName";
67
+ /** The team summarised, for a TEAM summary. */
68
+ QaBatchSummaryPropertyKeys["TeamId"] = "TeamId";
69
+ /** The team's name at the time. */
70
+ QaBatchSummaryPropertyKeys["TeamName"] = "TeamName";
71
+ /** PENDING while the model writes it; COMPLETE when the files are stored; FAILED with Error when it could not be written. */
72
+ QaBatchSummaryPropertyKeys["Status"] = "Status";
73
+ /** How many COMPLETE QA reports of the run the summary was built from. */
74
+ QaBatchSummaryPropertyKeys["ReportCount"] = "ReportCount";
75
+ /** The mean score of the reports read, computed in code. */
76
+ QaBatchSummaryPropertyKeys["AverageScore"] = "AverageScore";
77
+ /** S3 URL of the rendered summary. */
78
+ QaBatchSummaryPropertyKeys["ReportUrl"] = "ReportUrl";
79
+ /** S3 URL of the structured summary: the model's sections plus the figures computed in code. */
80
+ QaBatchSummaryPropertyKeys["SummaryUrl"] = "SummaryUrl";
81
+ /** The model that wrote it, and the prompt version. */
82
+ QaBatchSummaryPropertyKeys["Model"] = "Model";
83
+ /** How many model calls the reports were split across before the final synthesis. */
84
+ QaBatchSummaryPropertyKeys["Chunks"] = "Chunks";
85
+ /** When the summary was stored. */
86
+ QaBatchSummaryPropertyKeys["GeneratedAt"] = "GeneratedAt";
87
+ /** Why the summary could not be written, when Status is FAILED. */
88
+ QaBatchSummaryPropertyKeys["Error"] = "Error";
89
+ /** The bulk QA run this summary is about. */
90
+ QaBatchSummaryPropertyKeys["BatchId"] = "BatchId";
91
+ })(QaBatchSummaryPropertyKeys = exports.QaBatchSummaryPropertyKeys || (exports.QaBatchSummaryPropertyKeys = {}));
92
+ /**
93
+ * QaBatchSummary entity from SupportModule
94
+ *
95
+ * The AI-written overall report on one bulk QA run: the agent or team, what they do well, what recurs, what to coach, with the case numbers behind each point. Written only by youfibre-api-support.
96
+ *
97
+ * @module SupportModule
98
+ * @entity QaBatchSummary
99
+ * @schemaId c932a484-143a-4b2d-bf01-88b9fb9fc9df
100
+ * @recordPrefix QAS
101
+ * @capabilities searchable, updateable, undeletable, triggerable
102
+ */
103
+ class QaBatchSummary extends core_1.OdinRecord {
104
+ }
105
+ exports.QaBatchSummary = QaBatchSummary;
106
+ // ============================================
107
+ // RABBITMQ EVENT ROUTING KEYS
108
+ // ============================================
109
+ /**
110
+ * RabbitMQ routing keys for QaBatchSummary events
111
+ */
112
+ exports.ROUTING_KEY_QA_BATCH_SUMMARY_CREATED = 'SupportModule.QaBatchSummary.SubDbRecordCreated';
113
+ exports.ROUTING_KEY_QA_BATCH_SUMMARY_UPDATED = 'SupportModule.QaBatchSummary.SubDbRecordUpdated';
114
+ exports.ROUTING_KEY_QA_BATCH_SUMMARY_DELETED = 'SupportModule.QaBatchSummary.SubDbRecordDeleted';
115
+ /**
116
+ * Type-specific routing keys for QaBatchSummary events
117
+ * Subscribe to these for events on specific entity types only
118
+ */
119
+ /** This is the default record type created */
120
+ exports.ROUTING_KEY_QA_BATCH_SUMMARY_DEFAULT_CREATED = 'SupportModule.QaBatchSummary.DEFAULT.SubDbRecordCreated';
121
+ /** This is the default record type updated */
122
+ exports.ROUTING_KEY_QA_BATCH_SUMMARY_DEFAULT_UPDATED = 'SupportModule.QaBatchSummary.DEFAULT.SubDbRecordUpdated';
123
+ /** This is the default record type deleted */
124
+ exports.ROUTING_KEY_QA_BATCH_SUMMARY_DEFAULT_DELETED = 'SupportModule.QaBatchSummary.DEFAULT.SubDbRecordDeleted';
@@ -130,64 +130,64 @@ export declare enum VoiceConfigurationPortFromProvider {
130
130
  * Use these constants instead of string literals for type safety
131
131
  */
132
132
  export declare enum VoiceConfigurationPropertyKeys {
133
- /** When the Magrathea "port accepted" customer email was sent for this port. Checked before sending and stamped after -- the redelivery-dedup guard for an at-least-once RabbitMQ consumer whose only prior guard (prevStatus !== nextStatus) was built from message-carried fields and so could not survive a redelivery. Scoped per port (this VoiceConfiguration record), not per contact, so a genuine second port for the same customer still sends. */
134
- PortingUpdateEmailSentAt = "PortingUpdateEmailSentAt",
133
+ /** AuthorizedLOA (Network Operations - VoiceConfiguration) */
134
+ AuthorizedLoa = "AuthorizedLOA",
135
135
  /** ExternalReference */
136
136
  ExternalReference = "ExternalReference",
137
- /** MagratheaOrderLastUpdate (Network Operations - VoiceConfiguration) */
138
- MagratheaOrderLastUpdate = "MagratheaOrderLastUpdate",
139
- /** SystemMessageDate (Network Operations - VoiceConfiguration) */
140
- SystemMessageDate = "SystemMessageDate",
141
- /** the order id provided by magrathea (Network Operations - VoiceConfiguration) */
142
- MagratheaOrderId = "MagratheaOrderId",
143
- /** SipwiseCustomerId (Network Operations - VoiceConfiguration) */
144
- SipwiseCustomerId = "SipwiseCustomerId",
145
- /** VoicePortOperStatus (Network Operations - VoiceConfiguration) */
146
- VoicePortOperStatus = "VoicePortOperStatus",
147
- /** VoicePortAdminStatus (Network Operations - VoiceConfiguration) */
148
- VoicePortAdminStatus = "VoicePortAdminStatus",
149
- /** LastCheckStatusDate (Network Operations - VoiceConfiguration) */
150
- LastCheckStatusDate = "LastCheckStatusDate",
137
+ /** the phone number provided by us to the customer (Network Operations - VoiceConfiguration) */
138
+ IssuedPhoneNumber = "IssuedPhoneNumber",
139
+ /** IssuedPhoneNumberParts (Network Operations - VoiceConfiguration) */
140
+ IssuedPhoneNumberParts = "IssuedPhoneNumberParts",
151
141
  /** Data field for VoiceConfiguration records. Used by Network Operations team. */
152
142
  LastAction = "LastAction",
153
- /** VoiceLineState (Network Operations - VoiceConfiguration) */
154
- VoiceLineState = "VoiceLineState",
155
- /** SipwiseCustomerContactId (Network Operations - VoiceConfiguration) */
156
- SipwiseCustomerContactId = "SipwiseCustomerContactId",
157
- /** AuthorizedLOA (Network Operations - VoiceConfiguration) */
158
- AuthorizedLoa = "AuthorizedLOA",
159
- /** SystemMessage (Network Operations - VoiceConfiguration) */
160
- SystemMessage = "SystemMessage",
161
- /** The parts include CountryCode, AreaCode, SubscriberNumber (Network Operations - VoiceConfiguration) */
162
- PhoneNumberToPortParts = "PhoneNumberToPortParts",
163
- /** OrderItemId (Network Operations - VoiceConfiguration) */
164
- OrderItemId = "OrderItemId",
165
- /** Data field for VoiceConfiguration records. Used by Network Operations team. */
166
- VoiceIp = "VoiceIp",
167
- /** VoiceServerStatus (Network Operations - VoiceConfiguration) */
168
- VoiceServerStatus = "VoiceServerStatus",
169
- /** SipwiseSubscriberId (Network Operations - VoiceConfiguration) */
170
- SipwiseSubscriberId = "SipwiseSubscriberId",
171
- /** MagratheaOrderStatus (Network Operations - VoiceConfiguration) */
172
- MagratheaOrderStatus = "MagratheaOrderStatus",
173
- /** MagratheaOrderLastUpdateTime (Network Operations - VoiceConfiguration) */
174
- MagratheaOrderLastUpdateTime = "MagratheaOrderLastUpdateTime",
175
143
  /** LastActionDate (Network Operations - VoiceConfiguration) */
176
144
  LastActionDate = "LastActionDate",
177
- /** PortFromProvider (Network Operations - VoiceConfiguration) */
178
- PortFromProvider = "PortFromProvider",
145
+ /** LastCheckStatusDate (Network Operations - VoiceConfiguration) */
146
+ LastCheckStatusDate = "LastCheckStatusDate",
147
+ /** the order id provided by magrathea (Network Operations - VoiceConfiguration) */
148
+ MagratheaOrderId = "MagratheaOrderId",
149
+ /** MagratheaOrderLastUpdate (Network Operations - VoiceConfiguration) */
150
+ MagratheaOrderLastUpdate = "MagratheaOrderLastUpdate",
151
+ /** MagratheaOrderLastUpdateTime (Network Operations - VoiceConfiguration) */
152
+ MagratheaOrderLastUpdateTime = "MagratheaOrderLastUpdateTime",
153
+ /** MagratheaOrderStatus (Network Operations - VoiceConfiguration) */
154
+ MagratheaOrderStatus = "MagratheaOrderStatus",
179
155
  /** MagratheaOrderStatusDate (Network Operations - VoiceConfiguration) */
180
156
  MagratheaOrderStatusDate = "MagratheaOrderStatusDate",
181
- /** IssuedPhoneNumberParts (Network Operations - VoiceConfiguration) */
182
- IssuedPhoneNumberParts = "IssuedPhoneNumberParts",
157
+ /** Magrathea Port Date */
158
+ MagratheaPortDate = "MagratheaPortDate",
183
159
  /** NetworkServiceId (Network Operations - VoiceConfiguration) */
184
160
  NetworkServiceId = "NetworkServiceId",
161
+ /** OrderItemId (Network Operations - VoiceConfiguration) */
162
+ OrderItemId = "OrderItemId",
185
163
  /** phone number to port (Network Operations - VoiceConfiguration) */
186
164
  PhoneNumberToPort = "PhoneNumberToPort",
187
- /** the phone number provided by us to the customer (Network Operations - VoiceConfiguration) */
188
- IssuedPhoneNumber = "IssuedPhoneNumber",
189
- /** Magrathea Port Date */
190
- MagratheaPortDate = "MagratheaPortDate"
165
+ /** The parts include CountryCode, AreaCode, SubscriberNumber (Network Operations - VoiceConfiguration) */
166
+ PhoneNumberToPortParts = "PhoneNumberToPortParts",
167
+ /** PortFromProvider (Network Operations - VoiceConfiguration) */
168
+ PortFromProvider = "PortFromProvider",
169
+ /** When the Magrathea "port accepted" customer email was sent for this port. Checked before sending and stamped after -- the redelivery-dedup guard for an at-least-once RabbitMQ consumer whose only prior guard (prevStatus !== nextStatus) was built from message-carried fields and so could not survive a redelivery. Scoped per port (this VoiceConfiguration record), not per contact, so a genuine second port for the same customer still sends. */
170
+ PortingUpdateEmailSentAt = "PortingUpdateEmailSentAt",
171
+ /** SipwiseCustomerContactId (Network Operations - VoiceConfiguration) */
172
+ SipwiseCustomerContactId = "SipwiseCustomerContactId",
173
+ /** SipwiseCustomerId (Network Operations - VoiceConfiguration) */
174
+ SipwiseCustomerId = "SipwiseCustomerId",
175
+ /** SipwiseSubscriberId (Network Operations - VoiceConfiguration) */
176
+ SipwiseSubscriberId = "SipwiseSubscriberId",
177
+ /** SystemMessage (Network Operations - VoiceConfiguration) */
178
+ SystemMessage = "SystemMessage",
179
+ /** SystemMessageDate (Network Operations - VoiceConfiguration) */
180
+ SystemMessageDate = "SystemMessageDate",
181
+ /** Data field for VoiceConfiguration records. Used by Network Operations team. */
182
+ VoiceIp = "VoiceIp",
183
+ /** VoiceLineState (Network Operations - VoiceConfiguration) */
184
+ VoiceLineState = "VoiceLineState",
185
+ /** VoicePortAdminStatus (Network Operations - VoiceConfiguration) */
186
+ VoicePortAdminStatus = "VoicePortAdminStatus",
187
+ /** VoicePortOperStatus (Network Operations - VoiceConfiguration) */
188
+ VoicePortOperStatus = "VoicePortOperStatus",
189
+ /** VoiceServerStatus (Network Operations - VoiceConfiguration) */
190
+ VoiceServerStatus = "VoiceServerStatus"
191
191
  }
192
192
  /**
193
193
  * Properties for VoiceConfiguration records
@@ -195,167 +195,167 @@ export declare enum VoiceConfigurationPropertyKeys {
195
195
  * @see ServiceModule:VoiceConfiguration
196
196
  */
197
197
  export interface VoiceConfigurationProperties {
198
- /** When the Magrathea "port accepted" customer email was sent for this port. Checked before sending and stamped after -- the redelivery-dedup guard for an at-least-once RabbitMQ consumer whose only prior guard (prevStatus !== nextStatus) was built from message-carried fields and so could not survive a redelivery. Scoped per port (this VoiceConfiguration record), not per contact, so a genuine second port for the same customer still sends.
198
+ /** AuthorizedLOA (Network Operations - VoiceConfiguration)
199
199
  *
200
- * @type {DATE_TIME}
201
- * @default
200
+ * @type {BOOLEAN}
202
201
  */
203
- PortingUpdateEmailSentAt: string;
202
+ AuthorizedLoa: boolean;
204
203
  /** ExternalReference
205
204
  *
206
205
  * @type {TEXT}
207
206
  */
208
207
  ExternalReference: string;
209
- /** MagratheaOrderLastUpdate (Network Operations - VoiceConfiguration)
208
+ /** the phone number provided by us to the customer (Network Operations - VoiceConfiguration)
209
+ *
210
+ * @type {PHONE_NUMBER_E164_GB}
211
+ * @pii This field contains personally identifiable information
212
+ */
213
+ IssuedPhoneNumber: string;
214
+ /** IssuedPhoneNumberParts (Network Operations - VoiceConfiguration)
215
+ *
216
+ * @type {JSON}
217
+ * @pii This field contains personally identifiable information
218
+ */
219
+ IssuedPhoneNumberParts: string;
220
+ /** Data field for VoiceConfiguration records. Used by Network Operations team.
210
221
  *
211
222
  * @type {TEXT}
223
+ * @hidden This field is hidden in the UI
212
224
  */
213
- MagratheaOrderLastUpdate: string;
214
- /** SystemMessageDate (Network Operations - VoiceConfiguration)
225
+ LastAction: string;
226
+ /** LastActionDate (Network Operations - VoiceConfiguration)
215
227
  *
216
228
  * @type {DATE_TIME}
217
229
  * @format DD/MM/YYYY hh:mm:ss
218
- * @default
219
230
  * @hidden This field is hidden in the UI
220
231
  */
221
- SystemMessageDate: string;
232
+ LastActionDate: string;
233
+ /** LastCheckStatusDate (Network Operations - VoiceConfiguration)
234
+ *
235
+ * @type {DATE_TIME}
236
+ * @format DD/MM/YYYY hh:mm:ss
237
+ * @hidden This field is hidden in the UI
238
+ */
239
+ LastCheckStatusDate: string;
222
240
  /** the order id provided by magrathea (Network Operations - VoiceConfiguration)
223
241
  *
224
242
  * @type {TEXT}
225
243
  */
226
244
  MagratheaOrderId: string;
227
- /** SipwiseCustomerId (Network Operations - VoiceConfiguration)
245
+ /** MagratheaOrderLastUpdate (Network Operations - VoiceConfiguration)
228
246
  *
229
- * @type {NUMBER}
247
+ * @type {TEXT}
230
248
  */
231
- SipwiseCustomerId: number;
232
- /** VoicePortOperStatus (Network Operations - VoiceConfiguration)
249
+ MagratheaOrderLastUpdate: string;
250
+ /** MagratheaOrderLastUpdateTime (Network Operations - VoiceConfiguration)
233
251
  *
234
252
  * @type {TEXT}
235
253
  */
236
- VoicePortOperStatus: string;
237
- /** VoicePortAdminStatus (Network Operations - VoiceConfiguration)
254
+ MagratheaOrderLastUpdateTime: string;
255
+ /** MagratheaOrderStatus (Network Operations - VoiceConfiguration)
238
256
  *
239
257
  * @type {TEXT}
240
258
  */
241
- VoicePortAdminStatus: string;
242
- /** LastCheckStatusDate (Network Operations - VoiceConfiguration)
259
+ MagratheaOrderStatus: string;
260
+ /** MagratheaOrderStatusDate (Network Operations - VoiceConfiguration)
243
261
  *
244
262
  * @type {DATE_TIME}
245
263
  * @format DD/MM/YYYY hh:mm:ss
246
- * @hidden This field is hidden in the UI
247
264
  */
248
- LastCheckStatusDate: string;
249
- /** Data field for VoiceConfiguration records. Used by Network Operations team.
265
+ MagratheaOrderStatusDate: string;
266
+ /** Magrathea Port Date
250
267
  *
251
- * @type {TEXT}
252
- * @hidden This field is hidden in the UI
268
+ * @type {DATE}
253
269
  */
254
- LastAction: string;
255
- /** VoiceLineState (Network Operations - VoiceConfiguration)
270
+ MagratheaPortDate: string;
271
+ /** NetworkServiceId (Network Operations - VoiceConfiguration)
256
272
  *
257
273
  * @type {TEXT}
258
274
  */
259
- VoiceLineState: string;
260
- /** SipwiseCustomerContactId (Network Operations - VoiceConfiguration)
261
- *
262
- * @type {NUMERIC}
263
- */
264
- SipwiseCustomerContactId: number;
265
- /** AuthorizedLOA (Network Operations - VoiceConfiguration)
275
+ NetworkServiceId: string;
276
+ /** OrderItemId (Network Operations - VoiceConfiguration)
266
277
  *
267
- * @type {BOOLEAN}
278
+ * @type {LOOKUP}
268
279
  */
269
- AuthorizedLoa: boolean;
270
- /** SystemMessage (Network Operations - VoiceConfiguration)
280
+ OrderItemId: string;
281
+ /** phone number to port (Network Operations - VoiceConfiguration)
271
282
  *
272
- * @type {TEXT}
273
- * @hidden This field is hidden in the UI
283
+ * @type {PHONE_NUMBER_E164_GB}
284
+ * @pii This field contains personally identifiable information
274
285
  */
275
- SystemMessage: string;
286
+ PhoneNumberToPort: string;
276
287
  /** The parts include CountryCode, AreaCode, SubscriberNumber (Network Operations - VoiceConfiguration)
277
288
  *
278
289
  * @type {JSON}
279
290
  * @pii This field contains personally identifiable information
280
291
  */
281
292
  PhoneNumberToPortParts: string;
282
- /** OrderItemId (Network Operations - VoiceConfiguration)
293
+ /** PortFromProvider (Network Operations - VoiceConfiguration)
283
294
  *
284
- * @type {LOOKUP}
295
+ * @type {ENUM}
296
+ * @enum {VoiceConfigurationPortFromProvider}
285
297
  */
286
- OrderItemId: string;
287
- /** Data field for VoiceConfiguration records. Used by Network Operations team.
298
+ PortFromProvider: VoiceConfigurationPortFromProvider;
299
+ /** When the Magrathea "port accepted" customer email was sent for this port. Checked before sending and stamped after -- the redelivery-dedup guard for an at-least-once RabbitMQ consumer whose only prior guard (prevStatus !== nextStatus) was built from message-carried fields and so could not survive a redelivery. Scoped per port (this VoiceConfiguration record), not per contact, so a genuine second port for the same customer still sends.
288
300
  *
289
- * @type {TEXT}
301
+ * @type {DATE_TIME}
302
+ * @default
290
303
  */
291
- VoiceIp: string;
292
- /** VoiceServerStatus (Network Operations - VoiceConfiguration)
304
+ PortingUpdateEmailSentAt: string;
305
+ /** SipwiseCustomerContactId (Network Operations - VoiceConfiguration)
293
306
  *
294
- * @type {TEXT}
307
+ * @type {NUMERIC}
295
308
  */
296
- VoiceServerStatus: string;
297
- /** SipwiseSubscriberId (Network Operations - VoiceConfiguration)
309
+ SipwiseCustomerContactId: number;
310
+ /** SipwiseCustomerId (Network Operations - VoiceConfiguration)
298
311
  *
299
312
  * @type {NUMBER}
300
313
  */
301
- SipwiseSubscriberId: number;
302
- /** MagratheaOrderStatus (Network Operations - VoiceConfiguration)
314
+ SipwiseCustomerId: number;
315
+ /** SipwiseSubscriberId (Network Operations - VoiceConfiguration)
303
316
  *
304
- * @type {TEXT}
317
+ * @type {NUMBER}
305
318
  */
306
- MagratheaOrderStatus: string;
307
- /** MagratheaOrderLastUpdateTime (Network Operations - VoiceConfiguration)
319
+ SipwiseSubscriberId: number;
320
+ /** SystemMessage (Network Operations - VoiceConfiguration)
308
321
  *
309
322
  * @type {TEXT}
310
- */
311
- MagratheaOrderLastUpdateTime: string;
312
- /** LastActionDate (Network Operations - VoiceConfiguration)
313
- *
314
- * @type {DATE_TIME}
315
- * @format DD/MM/YYYY hh:mm:ss
316
323
  * @hidden This field is hidden in the UI
317
324
  */
318
- LastActionDate: string;
319
- /** PortFromProvider (Network Operations - VoiceConfiguration)
320
- *
321
- * @type {ENUM}
322
- * @enum {VoiceConfigurationPortFromProvider}
323
- */
324
- PortFromProvider: VoiceConfigurationPortFromProvider;
325
- /** MagratheaOrderStatusDate (Network Operations - VoiceConfiguration)
325
+ SystemMessage: string;
326
+ /** SystemMessageDate (Network Operations - VoiceConfiguration)
326
327
  *
327
328
  * @type {DATE_TIME}
328
329
  * @format DD/MM/YYYY hh:mm:ss
330
+ * @default
331
+ * @hidden This field is hidden in the UI
329
332
  */
330
- MagratheaOrderStatusDate: string;
331
- /** IssuedPhoneNumberParts (Network Operations - VoiceConfiguration)
333
+ SystemMessageDate: string;
334
+ /** Data field for VoiceConfiguration records. Used by Network Operations team.
332
335
  *
333
- * @type {JSON}
334
- * @pii This field contains personally identifiable information
336
+ * @type {TEXT}
335
337
  */
336
- IssuedPhoneNumberParts: string;
337
- /** NetworkServiceId (Network Operations - VoiceConfiguration)
338
+ VoiceIp: string;
339
+ /** VoiceLineState (Network Operations - VoiceConfiguration)
338
340
  *
339
341
  * @type {TEXT}
340
342
  */
341
- NetworkServiceId: string;
342
- /** phone number to port (Network Operations - VoiceConfiguration)
343
+ VoiceLineState: string;
344
+ /** VoicePortAdminStatus (Network Operations - VoiceConfiguration)
343
345
  *
344
- * @type {PHONE_NUMBER_E164_GB}
345
- * @pii This field contains personally identifiable information
346
+ * @type {TEXT}
346
347
  */
347
- PhoneNumberToPort: string;
348
- /** the phone number provided by us to the customer (Network Operations - VoiceConfiguration)
348
+ VoicePortAdminStatus: string;
349
+ /** VoicePortOperStatus (Network Operations - VoiceConfiguration)
349
350
  *
350
- * @type {PHONE_NUMBER_E164_GB}
351
- * @pii This field contains personally identifiable information
351
+ * @type {TEXT}
352
352
  */
353
- IssuedPhoneNumber: string;
354
- /** Magrathea Port Date
353
+ VoicePortOperStatus: string;
354
+ /** VoiceServerStatus (Network Operations - VoiceConfiguration)
355
355
  *
356
- * @type {DATE}
356
+ * @type {TEXT}
357
357
  */
358
- MagratheaPortDate: string;
358
+ VoiceServerStatus: string;
359
359
  }
360
360
  /**
361
361
  * VoiceConfiguration entity from ServiceModule
@@ -135,64 +135,64 @@ var VoiceConfigurationPortFromProvider;
135
135
  */
136
136
  var VoiceConfigurationPropertyKeys;
137
137
  (function (VoiceConfigurationPropertyKeys) {
138
- /** When the Magrathea "port accepted" customer email was sent for this port. Checked before sending and stamped after -- the redelivery-dedup guard for an at-least-once RabbitMQ consumer whose only prior guard (prevStatus !== nextStatus) was built from message-carried fields and so could not survive a redelivery. Scoped per port (this VoiceConfiguration record), not per contact, so a genuine second port for the same customer still sends. */
139
- VoiceConfigurationPropertyKeys["PortingUpdateEmailSentAt"] = "PortingUpdateEmailSentAt";
138
+ /** AuthorizedLOA (Network Operations - VoiceConfiguration) */
139
+ VoiceConfigurationPropertyKeys["AuthorizedLoa"] = "AuthorizedLOA";
140
140
  /** ExternalReference */
141
141
  VoiceConfigurationPropertyKeys["ExternalReference"] = "ExternalReference";
142
- /** MagratheaOrderLastUpdate (Network Operations - VoiceConfiguration) */
143
- VoiceConfigurationPropertyKeys["MagratheaOrderLastUpdate"] = "MagratheaOrderLastUpdate";
144
- /** SystemMessageDate (Network Operations - VoiceConfiguration) */
145
- VoiceConfigurationPropertyKeys["SystemMessageDate"] = "SystemMessageDate";
146
- /** the order id provided by magrathea (Network Operations - VoiceConfiguration) */
147
- VoiceConfigurationPropertyKeys["MagratheaOrderId"] = "MagratheaOrderId";
148
- /** SipwiseCustomerId (Network Operations - VoiceConfiguration) */
149
- VoiceConfigurationPropertyKeys["SipwiseCustomerId"] = "SipwiseCustomerId";
150
- /** VoicePortOperStatus (Network Operations - VoiceConfiguration) */
151
- VoiceConfigurationPropertyKeys["VoicePortOperStatus"] = "VoicePortOperStatus";
152
- /** VoicePortAdminStatus (Network Operations - VoiceConfiguration) */
153
- VoiceConfigurationPropertyKeys["VoicePortAdminStatus"] = "VoicePortAdminStatus";
154
- /** LastCheckStatusDate (Network Operations - VoiceConfiguration) */
155
- VoiceConfigurationPropertyKeys["LastCheckStatusDate"] = "LastCheckStatusDate";
142
+ /** the phone number provided by us to the customer (Network Operations - VoiceConfiguration) */
143
+ VoiceConfigurationPropertyKeys["IssuedPhoneNumber"] = "IssuedPhoneNumber";
144
+ /** IssuedPhoneNumberParts (Network Operations - VoiceConfiguration) */
145
+ VoiceConfigurationPropertyKeys["IssuedPhoneNumberParts"] = "IssuedPhoneNumberParts";
156
146
  /** Data field for VoiceConfiguration records. Used by Network Operations team. */
157
147
  VoiceConfigurationPropertyKeys["LastAction"] = "LastAction";
158
- /** VoiceLineState (Network Operations - VoiceConfiguration) */
159
- VoiceConfigurationPropertyKeys["VoiceLineState"] = "VoiceLineState";
160
- /** SipwiseCustomerContactId (Network Operations - VoiceConfiguration) */
161
- VoiceConfigurationPropertyKeys["SipwiseCustomerContactId"] = "SipwiseCustomerContactId";
162
- /** AuthorizedLOA (Network Operations - VoiceConfiguration) */
163
- VoiceConfigurationPropertyKeys["AuthorizedLoa"] = "AuthorizedLOA";
164
- /** SystemMessage (Network Operations - VoiceConfiguration) */
165
- VoiceConfigurationPropertyKeys["SystemMessage"] = "SystemMessage";
166
- /** The parts include CountryCode, AreaCode, SubscriberNumber (Network Operations - VoiceConfiguration) */
167
- VoiceConfigurationPropertyKeys["PhoneNumberToPortParts"] = "PhoneNumberToPortParts";
168
- /** OrderItemId (Network Operations - VoiceConfiguration) */
169
- VoiceConfigurationPropertyKeys["OrderItemId"] = "OrderItemId";
170
- /** Data field for VoiceConfiguration records. Used by Network Operations team. */
171
- VoiceConfigurationPropertyKeys["VoiceIp"] = "VoiceIp";
172
- /** VoiceServerStatus (Network Operations - VoiceConfiguration) */
173
- VoiceConfigurationPropertyKeys["VoiceServerStatus"] = "VoiceServerStatus";
174
- /** SipwiseSubscriberId (Network Operations - VoiceConfiguration) */
175
- VoiceConfigurationPropertyKeys["SipwiseSubscriberId"] = "SipwiseSubscriberId";
176
- /** MagratheaOrderStatus (Network Operations - VoiceConfiguration) */
177
- VoiceConfigurationPropertyKeys["MagratheaOrderStatus"] = "MagratheaOrderStatus";
178
- /** MagratheaOrderLastUpdateTime (Network Operations - VoiceConfiguration) */
179
- VoiceConfigurationPropertyKeys["MagratheaOrderLastUpdateTime"] = "MagratheaOrderLastUpdateTime";
180
148
  /** LastActionDate (Network Operations - VoiceConfiguration) */
181
149
  VoiceConfigurationPropertyKeys["LastActionDate"] = "LastActionDate";
182
- /** PortFromProvider (Network Operations - VoiceConfiguration) */
183
- VoiceConfigurationPropertyKeys["PortFromProvider"] = "PortFromProvider";
150
+ /** LastCheckStatusDate (Network Operations - VoiceConfiguration) */
151
+ VoiceConfigurationPropertyKeys["LastCheckStatusDate"] = "LastCheckStatusDate";
152
+ /** the order id provided by magrathea (Network Operations - VoiceConfiguration) */
153
+ VoiceConfigurationPropertyKeys["MagratheaOrderId"] = "MagratheaOrderId";
154
+ /** MagratheaOrderLastUpdate (Network Operations - VoiceConfiguration) */
155
+ VoiceConfigurationPropertyKeys["MagratheaOrderLastUpdate"] = "MagratheaOrderLastUpdate";
156
+ /** MagratheaOrderLastUpdateTime (Network Operations - VoiceConfiguration) */
157
+ VoiceConfigurationPropertyKeys["MagratheaOrderLastUpdateTime"] = "MagratheaOrderLastUpdateTime";
158
+ /** MagratheaOrderStatus (Network Operations - VoiceConfiguration) */
159
+ VoiceConfigurationPropertyKeys["MagratheaOrderStatus"] = "MagratheaOrderStatus";
184
160
  /** MagratheaOrderStatusDate (Network Operations - VoiceConfiguration) */
185
161
  VoiceConfigurationPropertyKeys["MagratheaOrderStatusDate"] = "MagratheaOrderStatusDate";
186
- /** IssuedPhoneNumberParts (Network Operations - VoiceConfiguration) */
187
- VoiceConfigurationPropertyKeys["IssuedPhoneNumberParts"] = "IssuedPhoneNumberParts";
162
+ /** Magrathea Port Date */
163
+ VoiceConfigurationPropertyKeys["MagratheaPortDate"] = "MagratheaPortDate";
188
164
  /** NetworkServiceId (Network Operations - VoiceConfiguration) */
189
165
  VoiceConfigurationPropertyKeys["NetworkServiceId"] = "NetworkServiceId";
166
+ /** OrderItemId (Network Operations - VoiceConfiguration) */
167
+ VoiceConfigurationPropertyKeys["OrderItemId"] = "OrderItemId";
190
168
  /** phone number to port (Network Operations - VoiceConfiguration) */
191
169
  VoiceConfigurationPropertyKeys["PhoneNumberToPort"] = "PhoneNumberToPort";
192
- /** the phone number provided by us to the customer (Network Operations - VoiceConfiguration) */
193
- VoiceConfigurationPropertyKeys["IssuedPhoneNumber"] = "IssuedPhoneNumber";
194
- /** Magrathea Port Date */
195
- VoiceConfigurationPropertyKeys["MagratheaPortDate"] = "MagratheaPortDate";
170
+ /** The parts include CountryCode, AreaCode, SubscriberNumber (Network Operations - VoiceConfiguration) */
171
+ VoiceConfigurationPropertyKeys["PhoneNumberToPortParts"] = "PhoneNumberToPortParts";
172
+ /** PortFromProvider (Network Operations - VoiceConfiguration) */
173
+ VoiceConfigurationPropertyKeys["PortFromProvider"] = "PortFromProvider";
174
+ /** When the Magrathea "port accepted" customer email was sent for this port. Checked before sending and stamped after -- the redelivery-dedup guard for an at-least-once RabbitMQ consumer whose only prior guard (prevStatus !== nextStatus) was built from message-carried fields and so could not survive a redelivery. Scoped per port (this VoiceConfiguration record), not per contact, so a genuine second port for the same customer still sends. */
175
+ VoiceConfigurationPropertyKeys["PortingUpdateEmailSentAt"] = "PortingUpdateEmailSentAt";
176
+ /** SipwiseCustomerContactId (Network Operations - VoiceConfiguration) */
177
+ VoiceConfigurationPropertyKeys["SipwiseCustomerContactId"] = "SipwiseCustomerContactId";
178
+ /** SipwiseCustomerId (Network Operations - VoiceConfiguration) */
179
+ VoiceConfigurationPropertyKeys["SipwiseCustomerId"] = "SipwiseCustomerId";
180
+ /** SipwiseSubscriberId (Network Operations - VoiceConfiguration) */
181
+ VoiceConfigurationPropertyKeys["SipwiseSubscriberId"] = "SipwiseSubscriberId";
182
+ /** SystemMessage (Network Operations - VoiceConfiguration) */
183
+ VoiceConfigurationPropertyKeys["SystemMessage"] = "SystemMessage";
184
+ /** SystemMessageDate (Network Operations - VoiceConfiguration) */
185
+ VoiceConfigurationPropertyKeys["SystemMessageDate"] = "SystemMessageDate";
186
+ /** Data field for VoiceConfiguration records. Used by Network Operations team. */
187
+ VoiceConfigurationPropertyKeys["VoiceIp"] = "VoiceIp";
188
+ /** VoiceLineState (Network Operations - VoiceConfiguration) */
189
+ VoiceConfigurationPropertyKeys["VoiceLineState"] = "VoiceLineState";
190
+ /** VoicePortAdminStatus (Network Operations - VoiceConfiguration) */
191
+ VoiceConfigurationPropertyKeys["VoicePortAdminStatus"] = "VoicePortAdminStatus";
192
+ /** VoicePortOperStatus (Network Operations - VoiceConfiguration) */
193
+ VoiceConfigurationPropertyKeys["VoicePortOperStatus"] = "VoicePortOperStatus";
194
+ /** VoiceServerStatus (Network Operations - VoiceConfiguration) */
195
+ VoiceConfigurationPropertyKeys["VoiceServerStatus"] = "VoiceServerStatus";
196
196
  })(VoiceConfigurationPropertyKeys = exports.VoiceConfigurationPropertyKeys || (exports.VoiceConfigurationPropertyKeys = {}));
197
197
  /**
198
198
  * VoiceConfiguration entity from ServiceModule
@@ -26,6 +26,7 @@ import { CreateContactProperties } from '../actions-v2/CreateContactDto';
26
26
  import { CreateContactSalesAppProperties } from '../actions-v2/CreateContactSalesAppDto';
27
27
  import { OrderBuilderCreateContactProperties } from '../actions-v2/OrderBuilderCreateContactDto';
28
28
  import { OrderBuilderUpdateContactProperties } from '../actions-v2/OrderBuilderUpdateContactDto';
29
+ import { SetContactYouFibreTvInterestProperties } from '../actions-v2/SetContactYouFibreTvInterestDto';
29
30
  import { UpdateAdditionalCareProperties } from '../actions-v2/UpdateAdditionalCareDto';
30
31
  import { UpdateContactAppPreferencesProperties } from '../actions-v2/UpdateContactAppPreferencesDto';
31
32
  import { UpdateContactProperties } from '../actions-v2/UpdateContactDto';
@@ -895,6 +896,33 @@ export declare class ContactRecord<TProps = ContactProperties> {
895
896
  journeyId?: string;
896
897
  stageKey?: string;
897
898
  }): ActionBuilder;
899
+ /**
900
+ * SetContactYouFibreTvInterest
901
+ *
902
+ * Updates this Contact record.
903
+ * Returns an ActionBuilder - call .execute() to update or .dryRun() for debugging.
904
+ *
905
+ * @param propertiesOrOptions - Properties to update, or options object
906
+ * @param options - Optional settings (journeyId, stageKey)
907
+ * @returns ActionBuilder - call .execute() to update or .dryRun() for payload
908
+ * @throws Error if called on a new (unsaved) record
909
+ *
910
+ * @example
911
+ * ```typescript
912
+ * const record = await odinClient.contacts.get(id);
913
+ * await record.setContactYouFibreTvInterest({ ... }).execute();
914
+ *
915
+ * // Dry run (for debugging)
916
+ * const payload = record.setContactYouFibreTvInterest({ ... }).dryRun();
917
+ * ```
918
+ */
919
+ setContactYouFibreTvInterest(propertiesOrOptions?: SetContactYouFibreTvInterestProperties | {
920
+ journeyId?: string;
921
+ stageKey?: string;
922
+ }, options?: {
923
+ journeyId?: string;
924
+ stageKey?: string;
925
+ }): ActionBuilder;
898
926
  /**
899
927
  * UpdateAdditionalCare
900
928
  *