@d19n/youfibre-odin-sdk 2.0.376 → 2.0.377
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 +2 -1
- package/dist/api-sdk-v2/DocumentApi.d.ts +2 -0
- package/dist/api-sdk-v2/DocumentApi.js +6 -0
- package/dist/api-sdk-v2/DocumentValueApi.d.ts +48 -0
- package/dist/api-sdk-v2/DocumentValueApi.js +155 -0
- package/dist/db-sdk-v2/DocumentDb.d.ts +2 -0
- package/dist/db-sdk-v2/DocumentDb.js +6 -0
- package/dist/db-sdk-v2/DocumentValueDb.d.ts +120 -0
- package/dist/db-sdk-v2/DocumentValueDb.js +204 -0
- package/dist/entities-v2/Document.d.ts +165 -2
- package/dist/entities-v2/Document.js +17 -1
- package/dist/entities-v2/DocumentProcessing.d.ts +2 -0
- package/dist/entities-v2/DocumentProcessing.js +2 -0
- package/dist/entities-v2/DocumentValue.d.ts +213 -0
- package/dist/entities-v2/DocumentValue.js +130 -0
- package/dist/entities-v2/QaReport.d.ts +17 -1
- package/dist/entities-v2/QaReport.js +4 -0
- package/dist/entities-v2/Recontract.d.ts +2 -0
- package/dist/entities-v2/Recontract.js +2 -0
- package/dist/entities-v2/VoiceConfiguration.d.ts +130 -130
- package/dist/entities-v2/VoiceConfiguration.js +46 -46
- package/package.json +1 -1
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* DocumentValue Entity Definition
|
|
4
|
+
*
|
|
5
|
+
* One extracted value of a document: the field, the value, where it came from (section, quote, page), the model's confidence, and its review state. Linked to the Document.
|
|
6
|
+
*
|
|
7
|
+
* @module AiModule
|
|
8
|
+
* @entity DocumentValue
|
|
9
|
+
* @schemaId 96afdaae-fb15-4a46-bb1c-67ef9509e02d
|
|
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_DOCUMENT_VALUE_DEFAULT_DELETED = exports.ROUTING_KEY_DOCUMENT_VALUE_DEFAULT_UPDATED = exports.ROUTING_KEY_DOCUMENT_VALUE_DEFAULT_CREATED = exports.ROUTING_KEY_DOCUMENT_VALUE_DELETED = exports.ROUTING_KEY_DOCUMENT_VALUE_UPDATED = exports.ROUTING_KEY_DOCUMENT_VALUE_CREATED = exports.DocumentValue = exports.DocumentValuePropertyKeys = exports.DocumentValueReviewState = exports.DocumentValueKind = exports.DocumentValueEntityTypes = void 0;
|
|
16
|
+
const core_1 = require("@d19n/odin-types/dist/core");
|
|
17
|
+
/**
|
|
18
|
+
* Available types for DocumentValue records
|
|
19
|
+
*/
|
|
20
|
+
var DocumentValueEntityTypes;
|
|
21
|
+
(function (DocumentValueEntityTypes) {
|
|
22
|
+
/** This is the default record type */
|
|
23
|
+
DocumentValueEntityTypes["DEFAULT"] = "DEFAULT";
|
|
24
|
+
})(DocumentValueEntityTypes = exports.DocumentValueEntityTypes || (exports.DocumentValueEntityTypes = {}));
|
|
25
|
+
/**
|
|
26
|
+
* Valid values for DocumentValue.Kind
|
|
27
|
+
*
|
|
28
|
+
* The type of the value, from the field list.
|
|
29
|
+
*
|
|
30
|
+
* @remarks Available options:
|
|
31
|
+
* - `BOOLEAN` - Boolean
|
|
32
|
+
* - `DATE` - Date
|
|
33
|
+
* - `MONEY` - Money
|
|
34
|
+
* - `NUMBER` - Number
|
|
35
|
+
* - `PARTY` - Party
|
|
36
|
+
* - `TEXT` - Text
|
|
37
|
+
*/
|
|
38
|
+
var DocumentValueKind;
|
|
39
|
+
(function (DocumentValueKind) {
|
|
40
|
+
DocumentValueKind["BOOLEAN"] = "BOOLEAN";
|
|
41
|
+
DocumentValueKind["DATE"] = "DATE";
|
|
42
|
+
DocumentValueKind["MONEY"] = "MONEY";
|
|
43
|
+
DocumentValueKind["NUMBER"] = "NUMBER";
|
|
44
|
+
DocumentValueKind["PARTY"] = "PARTY";
|
|
45
|
+
DocumentValueKind["TEXT"] = "TEXT";
|
|
46
|
+
})(DocumentValueKind = exports.DocumentValueKind || (exports.DocumentValueKind = {}));
|
|
47
|
+
/**
|
|
48
|
+
* Valid values for DocumentValue.ReviewState
|
|
49
|
+
*
|
|
50
|
+
* Where the value stands with a person: needs review, confirmed, corrected, or not found in the document.
|
|
51
|
+
*
|
|
52
|
+
* @remarks Available options:
|
|
53
|
+
* - `CONFIRMED` - Confirmed
|
|
54
|
+
* - `CORRECTED` - Corrected
|
|
55
|
+
* - `NEEDS_REVIEW` - Needs review
|
|
56
|
+
* - `NOT_FOUND` - Not found
|
|
57
|
+
*/
|
|
58
|
+
var DocumentValueReviewState;
|
|
59
|
+
(function (DocumentValueReviewState) {
|
|
60
|
+
DocumentValueReviewState["CONFIRMED"] = "CONFIRMED";
|
|
61
|
+
DocumentValueReviewState["CORRECTED"] = "CORRECTED";
|
|
62
|
+
DocumentValueReviewState["NEEDS_REVIEW"] = "NEEDS_REVIEW";
|
|
63
|
+
DocumentValueReviewState["NOT_FOUND"] = "NOT_FOUND";
|
|
64
|
+
})(DocumentValueReviewState = exports.DocumentValueReviewState || (exports.DocumentValueReviewState = {}));
|
|
65
|
+
/**
|
|
66
|
+
* Property keys for DocumentValue
|
|
67
|
+
* Use these constants instead of string literals for type safety
|
|
68
|
+
*/
|
|
69
|
+
var DocumentValuePropertyKeys;
|
|
70
|
+
(function (DocumentValuePropertyKeys) {
|
|
71
|
+
/** The field name from the field list for the document type, e.g. GoverningLaw, PaymentDays. */
|
|
72
|
+
DocumentValuePropertyKeys["Field"] = "Field";
|
|
73
|
+
/** The type of the value, from the field list. */
|
|
74
|
+
DocumentValuePropertyKeys["Kind"] = "Kind";
|
|
75
|
+
/** The value as text, after any correction. Blank when the document does not state it (see ReviewState NOT_FOUND). */
|
|
76
|
+
DocumentValuePropertyKeys["Value"] = "Value";
|
|
77
|
+
/** What the model extracted, kept beside a correction. Equal to Value until a person corrects it. */
|
|
78
|
+
DocumentValuePropertyKeys["ModelValue"] = "ModelValue";
|
|
79
|
+
/** The field list the value was extracted with, e.g. NDA. */
|
|
80
|
+
DocumentValuePropertyKeys["SchemaName"] = "SchemaName";
|
|
81
|
+
/** The version of that field list. */
|
|
82
|
+
DocumentValuePropertyKeys["SchemaVersion"] = "SchemaVersion";
|
|
83
|
+
/** How sure the model was, 0 to 1. */
|
|
84
|
+
DocumentValuePropertyKeys["Confidence"] = "Confidence";
|
|
85
|
+
/** The id of the section in sections.json the value was read from. */
|
|
86
|
+
DocumentValuePropertyKeys["SectionId"] = "SectionId";
|
|
87
|
+
/** The passage, copied word for word from that section, the value rests on; checked against the stored text before the row is written. */
|
|
88
|
+
DocumentValuePropertyKeys["Quote"] = "Quote";
|
|
89
|
+
/** The page of the section. */
|
|
90
|
+
DocumentValuePropertyKeys["Page"] = "Page";
|
|
91
|
+
/** Where the value stands with a person: needs review, confirmed, corrected, or not found in the document. */
|
|
92
|
+
DocumentValuePropertyKeys["ReviewState"] = "ReviewState";
|
|
93
|
+
/** The user who confirmed or corrected the value. */
|
|
94
|
+
DocumentValuePropertyKeys["ReviewedBy"] = "ReviewedBy";
|
|
95
|
+
/** When the value was confirmed or corrected. */
|
|
96
|
+
DocumentValuePropertyKeys["ReviewedAt"] = "ReviewedAt";
|
|
97
|
+
})(DocumentValuePropertyKeys = exports.DocumentValuePropertyKeys || (exports.DocumentValuePropertyKeys = {}));
|
|
98
|
+
/**
|
|
99
|
+
* DocumentValue entity from AiModule
|
|
100
|
+
*
|
|
101
|
+
* One extracted value of a document: the field, the value, where it came from (section, quote, page), the model's confidence, and its review state. Linked to the Document.
|
|
102
|
+
*
|
|
103
|
+
* @module AiModule
|
|
104
|
+
* @entity DocumentValue
|
|
105
|
+
* @schemaId 96afdaae-fb15-4a46-bb1c-67ef9509e02d
|
|
106
|
+
* @recordPrefix DOV
|
|
107
|
+
* @capabilities searchable, updateable, undeletable, triggerable
|
|
108
|
+
*/
|
|
109
|
+
class DocumentValue extends core_1.OdinRecord {
|
|
110
|
+
}
|
|
111
|
+
exports.DocumentValue = DocumentValue;
|
|
112
|
+
// ============================================
|
|
113
|
+
// RABBITMQ EVENT ROUTING KEYS
|
|
114
|
+
// ============================================
|
|
115
|
+
/**
|
|
116
|
+
* RabbitMQ routing keys for DocumentValue events
|
|
117
|
+
*/
|
|
118
|
+
exports.ROUTING_KEY_DOCUMENT_VALUE_CREATED = 'AiModule.DocumentValue.SubDbRecordCreated';
|
|
119
|
+
exports.ROUTING_KEY_DOCUMENT_VALUE_UPDATED = 'AiModule.DocumentValue.SubDbRecordUpdated';
|
|
120
|
+
exports.ROUTING_KEY_DOCUMENT_VALUE_DELETED = 'AiModule.DocumentValue.SubDbRecordDeleted';
|
|
121
|
+
/**
|
|
122
|
+
* Type-specific routing keys for DocumentValue events
|
|
123
|
+
* Subscribe to these for events on specific entity types only
|
|
124
|
+
*/
|
|
125
|
+
/** This is the default record type created */
|
|
126
|
+
exports.ROUTING_KEY_DOCUMENT_VALUE_DEFAULT_CREATED = 'AiModule.DocumentValue.DEFAULT.SubDbRecordCreated';
|
|
127
|
+
/** This is the default record type updated */
|
|
128
|
+
exports.ROUTING_KEY_DOCUMENT_VALUE_DEFAULT_UPDATED = 'AiModule.DocumentValue.DEFAULT.SubDbRecordUpdated';
|
|
129
|
+
/** This is the default record type deleted */
|
|
130
|
+
exports.ROUTING_KEY_DOCUMENT_VALUE_DEFAULT_DELETED = 'AiModule.DocumentValue.DEFAULT.SubDbRecordDeleted';
|
|
@@ -164,7 +164,11 @@ export declare enum QaReportPropertyKeys {
|
|
|
164
164
|
/** Optional note from the manager about the amendment as a whole. */
|
|
165
165
|
AmendmentNote = "AmendmentNote",
|
|
166
166
|
/** The bulk QA run this report was generated by. Empty for a report generated from the case tab. */
|
|
167
|
-
BatchId = "BatchId"
|
|
167
|
+
BatchId = "BatchId",
|
|
168
|
+
/** The model's verdict per rubric item key, the auto-fails it triggered and PASS/FAIL, as {"result","items","autoFails"}. Written once with the report; never changed. */
|
|
169
|
+
ItemVerdicts = "ItemVerdicts",
|
|
170
|
+
/** The same shape as ItemVerdicts after a manager's amendment. Empty when the report has not been amended; cleared on restore. */
|
|
171
|
+
AmendedItemVerdicts = "AmendedItemVerdicts"
|
|
168
172
|
}
|
|
169
173
|
/**
|
|
170
174
|
* Properties for QaReport records
|
|
@@ -358,6 +362,18 @@ export interface QaReportProperties {
|
|
|
358
362
|
* @default
|
|
359
363
|
*/
|
|
360
364
|
BatchId: string;
|
|
365
|
+
/** The model's verdict per rubric item key, the auto-fails it triggered and PASS/FAIL, as {"result","items","autoFails"}. Written once with the report; never changed.
|
|
366
|
+
*
|
|
367
|
+
* @type {JSON}
|
|
368
|
+
* @default
|
|
369
|
+
*/
|
|
370
|
+
ItemVerdicts: string;
|
|
371
|
+
/** The same shape as ItemVerdicts after a manager's amendment. Empty when the report has not been amended; cleared on restore.
|
|
372
|
+
*
|
|
373
|
+
* @type {JSON}
|
|
374
|
+
* @default
|
|
375
|
+
*/
|
|
376
|
+
AmendedItemVerdicts: string;
|
|
361
377
|
}
|
|
362
378
|
/**
|
|
363
379
|
* QaReport entity from SupportModule
|
|
@@ -172,6 +172,10 @@ var QaReportPropertyKeys;
|
|
|
172
172
|
QaReportPropertyKeys["AmendmentNote"] = "AmendmentNote";
|
|
173
173
|
/** The bulk QA run this report was generated by. Empty for a report generated from the case tab. */
|
|
174
174
|
QaReportPropertyKeys["BatchId"] = "BatchId";
|
|
175
|
+
/** The model's verdict per rubric item key, the auto-fails it triggered and PASS/FAIL, as {"result","items","autoFails"}. Written once with the report; never changed. */
|
|
176
|
+
QaReportPropertyKeys["ItemVerdicts"] = "ItemVerdicts";
|
|
177
|
+
/** The same shape as ItemVerdicts after a manager's amendment. Empty when the report has not been amended; cleared on restore. */
|
|
178
|
+
QaReportPropertyKeys["AmendedItemVerdicts"] = "AmendedItemVerdicts";
|
|
175
179
|
})(QaReportPropertyKeys = exports.QaReportPropertyKeys || (exports.QaReportPropertyKeys = {}));
|
|
176
180
|
/**
|
|
177
181
|
* QaReport entity from SupportModule
|
|
@@ -58,12 +58,14 @@ export declare enum DefaultRecontractStageKeys {
|
|
|
58
58
|
* - `AGENT` - Agent
|
|
59
59
|
* - `CUSTOMER_APP` - Customer App
|
|
60
60
|
* - `CUSTOMER_PORTAL` - Customer Portal
|
|
61
|
+
* - `SPEED_CHANGE` - Speed Change
|
|
61
62
|
* - `WEB_RECONTRACT` - Website
|
|
62
63
|
*/
|
|
63
64
|
export declare enum RecontractSource {
|
|
64
65
|
AGENT = "AGENT",
|
|
65
66
|
CUSTOMER_APP = "CUSTOMER_APP",
|
|
66
67
|
CUSTOMER_PORTAL = "CUSTOMER_PORTAL",
|
|
68
|
+
SPEED_CHANGE = "SPEED_CHANGE",
|
|
67
69
|
WEBSITE = "WEB_RECONTRACT"
|
|
68
70
|
}
|
|
69
71
|
/**
|
|
@@ -62,6 +62,7 @@ var DefaultRecontractStageKeys;
|
|
|
62
62
|
* - `AGENT` - Agent
|
|
63
63
|
* - `CUSTOMER_APP` - Customer App
|
|
64
64
|
* - `CUSTOMER_PORTAL` - Customer Portal
|
|
65
|
+
* - `SPEED_CHANGE` - Speed Change
|
|
65
66
|
* - `WEB_RECONTRACT` - Website
|
|
66
67
|
*/
|
|
67
68
|
var RecontractSource;
|
|
@@ -69,6 +70,7 @@ var RecontractSource;
|
|
|
69
70
|
RecontractSource["AGENT"] = "AGENT";
|
|
70
71
|
RecontractSource["CUSTOMER_APP"] = "CUSTOMER_APP";
|
|
71
72
|
RecontractSource["CUSTOMER_PORTAL"] = "CUSTOMER_PORTAL";
|
|
73
|
+
RecontractSource["SPEED_CHANGE"] = "SPEED_CHANGE";
|
|
72
74
|
RecontractSource["WEBSITE"] = "WEB_RECONTRACT";
|
|
73
75
|
})(RecontractSource = exports.RecontractSource || (exports.RecontractSource = {}));
|
|
74
76
|
/**
|
|
@@ -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
|
-
/**
|
|
134
|
-
|
|
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",
|
|
135
135
|
/** ExternalReference */
|
|
136
136
|
ExternalReference = "ExternalReference",
|
|
137
|
-
/** the phone number provided by us to the customer (Network Operations - VoiceConfiguration) */
|
|
138
|
-
IssuedPhoneNumber = "IssuedPhoneNumber",
|
|
139
|
-
/** IssuedPhoneNumberParts (Network Operations - VoiceConfiguration) */
|
|
140
|
-
IssuedPhoneNumberParts = "IssuedPhoneNumberParts",
|
|
141
|
-
/** Data field for VoiceConfiguration records. Used by Network Operations team. */
|
|
142
|
-
LastAction = "LastAction",
|
|
143
|
-
/** LastActionDate (Network Operations - VoiceConfiguration) */
|
|
144
|
-
LastActionDate = "LastActionDate",
|
|
145
|
-
/** LastCheckStatusDate (Network Operations - VoiceConfiguration) */
|
|
146
|
-
LastCheckStatusDate = "LastCheckStatusDate",
|
|
147
|
-
/** the order id provided by magrathea (Network Operations - VoiceConfiguration) */
|
|
148
|
-
MagratheaOrderId = "MagratheaOrderId",
|
|
149
137
|
/** MagratheaOrderLastUpdate (Network Operations - VoiceConfiguration) */
|
|
150
138
|
MagratheaOrderLastUpdate = "MagratheaOrderLastUpdate",
|
|
151
|
-
/**
|
|
152
|
-
|
|
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",
|
|
151
|
+
/** Data field for VoiceConfiguration records. Used by Network Operations team. */
|
|
152
|
+
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",
|
|
153
171
|
/** MagratheaOrderStatus (Network Operations - VoiceConfiguration) */
|
|
154
172
|
MagratheaOrderStatus = "MagratheaOrderStatus",
|
|
173
|
+
/** MagratheaOrderLastUpdateTime (Network Operations - VoiceConfiguration) */
|
|
174
|
+
MagratheaOrderLastUpdateTime = "MagratheaOrderLastUpdateTime",
|
|
175
|
+
/** LastActionDate (Network Operations - VoiceConfiguration) */
|
|
176
|
+
LastActionDate = "LastActionDate",
|
|
177
|
+
/** PortFromProvider (Network Operations - VoiceConfiguration) */
|
|
178
|
+
PortFromProvider = "PortFromProvider",
|
|
155
179
|
/** MagratheaOrderStatusDate (Network Operations - VoiceConfiguration) */
|
|
156
180
|
MagratheaOrderStatusDate = "MagratheaOrderStatusDate",
|
|
157
|
-
/**
|
|
158
|
-
|
|
181
|
+
/** IssuedPhoneNumberParts (Network Operations - VoiceConfiguration) */
|
|
182
|
+
IssuedPhoneNumberParts = "IssuedPhoneNumberParts",
|
|
159
183
|
/** NetworkServiceId (Network Operations - VoiceConfiguration) */
|
|
160
184
|
NetworkServiceId = "NetworkServiceId",
|
|
161
|
-
/** OrderItemId (Network Operations - VoiceConfiguration) */
|
|
162
|
-
OrderItemId = "OrderItemId",
|
|
163
185
|
/** phone number to port (Network Operations - VoiceConfiguration) */
|
|
164
186
|
PhoneNumberToPort = "PhoneNumberToPort",
|
|
165
|
-
/**
|
|
166
|
-
|
|
167
|
-
/**
|
|
168
|
-
|
|
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"
|
|
187
|
+
/** the phone number provided by us to the customer (Network Operations - VoiceConfiguration) */
|
|
188
|
+
IssuedPhoneNumber = "IssuedPhoneNumber",
|
|
189
|
+
/** Magrathea Port Date */
|
|
190
|
+
MagratheaPortDate = "MagratheaPortDate"
|
|
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
|
-
/**
|
|
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.
|
|
199
199
|
*
|
|
200
|
-
* @type {
|
|
200
|
+
* @type {DATE_TIME}
|
|
201
|
+
* @default
|
|
201
202
|
*/
|
|
202
|
-
|
|
203
|
+
PortingUpdateEmailSentAt: string;
|
|
203
204
|
/** ExternalReference
|
|
204
205
|
*
|
|
205
206
|
* @type {TEXT}
|
|
206
207
|
*/
|
|
207
208
|
ExternalReference: string;
|
|
208
|
-
/**
|
|
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.
|
|
209
|
+
/** MagratheaOrderLastUpdate (Network Operations - VoiceConfiguration)
|
|
221
210
|
*
|
|
222
211
|
* @type {TEXT}
|
|
223
|
-
* @hidden This field is hidden in the UI
|
|
224
|
-
*/
|
|
225
|
-
LastAction: string;
|
|
226
|
-
/** LastActionDate (Network Operations - VoiceConfiguration)
|
|
227
|
-
*
|
|
228
|
-
* @type {DATE_TIME}
|
|
229
|
-
* @format DD/MM/YYYY hh:mm:ss
|
|
230
|
-
* @hidden This field is hidden in the UI
|
|
231
212
|
*/
|
|
232
|
-
|
|
233
|
-
/**
|
|
213
|
+
MagratheaOrderLastUpdate: string;
|
|
214
|
+
/** SystemMessageDate (Network Operations - VoiceConfiguration)
|
|
234
215
|
*
|
|
235
216
|
* @type {DATE_TIME}
|
|
236
217
|
* @format DD/MM/YYYY hh:mm:ss
|
|
218
|
+
* @default
|
|
237
219
|
* @hidden This field is hidden in the UI
|
|
238
220
|
*/
|
|
239
|
-
|
|
221
|
+
SystemMessageDate: string;
|
|
240
222
|
/** the order id provided by magrathea (Network Operations - VoiceConfiguration)
|
|
241
223
|
*
|
|
242
224
|
* @type {TEXT}
|
|
243
225
|
*/
|
|
244
226
|
MagratheaOrderId: string;
|
|
245
|
-
/**
|
|
227
|
+
/** SipwiseCustomerId (Network Operations - VoiceConfiguration)
|
|
246
228
|
*
|
|
247
|
-
* @type {
|
|
229
|
+
* @type {NUMBER}
|
|
248
230
|
*/
|
|
249
|
-
|
|
250
|
-
/**
|
|
231
|
+
SipwiseCustomerId: number;
|
|
232
|
+
/** VoicePortOperStatus (Network Operations - VoiceConfiguration)
|
|
251
233
|
*
|
|
252
234
|
* @type {TEXT}
|
|
253
235
|
*/
|
|
254
|
-
|
|
255
|
-
/**
|
|
236
|
+
VoicePortOperStatus: string;
|
|
237
|
+
/** VoicePortAdminStatus (Network Operations - VoiceConfiguration)
|
|
256
238
|
*
|
|
257
239
|
* @type {TEXT}
|
|
258
240
|
*/
|
|
259
|
-
|
|
260
|
-
/**
|
|
241
|
+
VoicePortAdminStatus: string;
|
|
242
|
+
/** LastCheckStatusDate (Network Operations - VoiceConfiguration)
|
|
261
243
|
*
|
|
262
244
|
* @type {DATE_TIME}
|
|
263
245
|
* @format DD/MM/YYYY hh:mm:ss
|
|
246
|
+
* @hidden This field is hidden in the UI
|
|
264
247
|
*/
|
|
265
|
-
|
|
266
|
-
/**
|
|
248
|
+
LastCheckStatusDate: string;
|
|
249
|
+
/** Data field for VoiceConfiguration records. Used by Network Operations team.
|
|
267
250
|
*
|
|
268
|
-
* @type {
|
|
251
|
+
* @type {TEXT}
|
|
252
|
+
* @hidden This field is hidden in the UI
|
|
269
253
|
*/
|
|
270
|
-
|
|
271
|
-
/**
|
|
254
|
+
LastAction: string;
|
|
255
|
+
/** VoiceLineState (Network Operations - VoiceConfiguration)
|
|
272
256
|
*
|
|
273
257
|
* @type {TEXT}
|
|
274
258
|
*/
|
|
275
|
-
|
|
276
|
-
/**
|
|
259
|
+
VoiceLineState: string;
|
|
260
|
+
/** SipwiseCustomerContactId (Network Operations - VoiceConfiguration)
|
|
277
261
|
*
|
|
278
|
-
* @type {
|
|
262
|
+
* @type {NUMERIC}
|
|
279
263
|
*/
|
|
280
|
-
|
|
281
|
-
/**
|
|
264
|
+
SipwiseCustomerContactId: number;
|
|
265
|
+
/** AuthorizedLOA (Network Operations - VoiceConfiguration)
|
|
282
266
|
*
|
|
283
|
-
* @type {
|
|
284
|
-
* @pii This field contains personally identifiable information
|
|
267
|
+
* @type {BOOLEAN}
|
|
285
268
|
*/
|
|
286
|
-
|
|
269
|
+
AuthorizedLoa: boolean;
|
|
270
|
+
/** SystemMessage (Network Operations - VoiceConfiguration)
|
|
271
|
+
*
|
|
272
|
+
* @type {TEXT}
|
|
273
|
+
* @hidden This field is hidden in the UI
|
|
274
|
+
*/
|
|
275
|
+
SystemMessage: string;
|
|
287
276
|
/** The parts include CountryCode, AreaCode, SubscriberNumber (Network Operations - VoiceConfiguration)
|
|
288
277
|
*
|
|
289
278
|
* @type {JSON}
|
|
290
279
|
* @pii This field contains personally identifiable information
|
|
291
280
|
*/
|
|
292
281
|
PhoneNumberToPortParts: string;
|
|
293
|
-
/**
|
|
294
|
-
*
|
|
295
|
-
* @type {ENUM}
|
|
296
|
-
* @enum {VoiceConfigurationPortFromProvider}
|
|
297
|
-
*/
|
|
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.
|
|
282
|
+
/** OrderItemId (Network Operations - VoiceConfiguration)
|
|
300
283
|
*
|
|
301
|
-
* @type {
|
|
302
|
-
* @default
|
|
284
|
+
* @type {LOOKUP}
|
|
303
285
|
*/
|
|
304
|
-
|
|
305
|
-
/**
|
|
286
|
+
OrderItemId: string;
|
|
287
|
+
/** Data field for VoiceConfiguration records. Used by Network Operations team.
|
|
306
288
|
*
|
|
307
|
-
* @type {
|
|
289
|
+
* @type {TEXT}
|
|
308
290
|
*/
|
|
309
|
-
|
|
310
|
-
/**
|
|
291
|
+
VoiceIp: string;
|
|
292
|
+
/** VoiceServerStatus (Network Operations - VoiceConfiguration)
|
|
311
293
|
*
|
|
312
|
-
* @type {
|
|
294
|
+
* @type {TEXT}
|
|
313
295
|
*/
|
|
314
|
-
|
|
296
|
+
VoiceServerStatus: string;
|
|
315
297
|
/** SipwiseSubscriberId (Network Operations - VoiceConfiguration)
|
|
316
298
|
*
|
|
317
299
|
* @type {NUMBER}
|
|
318
300
|
*/
|
|
319
301
|
SipwiseSubscriberId: number;
|
|
320
|
-
/**
|
|
302
|
+
/** MagratheaOrderStatus (Network Operations - VoiceConfiguration)
|
|
321
303
|
*
|
|
322
304
|
* @type {TEXT}
|
|
323
|
-
* @hidden This field is hidden in the UI
|
|
324
305
|
*/
|
|
325
|
-
|
|
326
|
-
/**
|
|
306
|
+
MagratheaOrderStatus: string;
|
|
307
|
+
/** MagratheaOrderLastUpdateTime (Network Operations - VoiceConfiguration)
|
|
308
|
+
*
|
|
309
|
+
* @type {TEXT}
|
|
310
|
+
*/
|
|
311
|
+
MagratheaOrderLastUpdateTime: string;
|
|
312
|
+
/** LastActionDate (Network Operations - VoiceConfiguration)
|
|
327
313
|
*
|
|
328
314
|
* @type {DATE_TIME}
|
|
329
315
|
* @format DD/MM/YYYY hh:mm:ss
|
|
330
|
-
* @default
|
|
331
316
|
* @hidden This field is hidden in the UI
|
|
332
317
|
*/
|
|
333
|
-
|
|
334
|
-
/**
|
|
318
|
+
LastActionDate: string;
|
|
319
|
+
/** PortFromProvider (Network Operations - VoiceConfiguration)
|
|
335
320
|
*
|
|
336
|
-
* @type {
|
|
321
|
+
* @type {ENUM}
|
|
322
|
+
* @enum {VoiceConfigurationPortFromProvider}
|
|
337
323
|
*/
|
|
338
|
-
|
|
339
|
-
/**
|
|
324
|
+
PortFromProvider: VoiceConfigurationPortFromProvider;
|
|
325
|
+
/** MagratheaOrderStatusDate (Network Operations - VoiceConfiguration)
|
|
340
326
|
*
|
|
341
|
-
* @type {
|
|
327
|
+
* @type {DATE_TIME}
|
|
328
|
+
* @format DD/MM/YYYY hh:mm:ss
|
|
342
329
|
*/
|
|
343
|
-
|
|
344
|
-
/**
|
|
330
|
+
MagratheaOrderStatusDate: string;
|
|
331
|
+
/** IssuedPhoneNumberParts (Network Operations - VoiceConfiguration)
|
|
345
332
|
*
|
|
346
|
-
* @type {
|
|
333
|
+
* @type {JSON}
|
|
334
|
+
* @pii This field contains personally identifiable information
|
|
347
335
|
*/
|
|
348
|
-
|
|
349
|
-
/**
|
|
336
|
+
IssuedPhoneNumberParts: string;
|
|
337
|
+
/** NetworkServiceId (Network Operations - VoiceConfiguration)
|
|
350
338
|
*
|
|
351
339
|
* @type {TEXT}
|
|
352
340
|
*/
|
|
353
|
-
|
|
354
|
-
/**
|
|
341
|
+
NetworkServiceId: string;
|
|
342
|
+
/** phone number to port (Network Operations - VoiceConfiguration)
|
|
355
343
|
*
|
|
356
|
-
* @type {
|
|
344
|
+
* @type {PHONE_NUMBER_E164_GB}
|
|
345
|
+
* @pii This field contains personally identifiable information
|
|
357
346
|
*/
|
|
358
|
-
|
|
347
|
+
PhoneNumberToPort: string;
|
|
348
|
+
/** the phone number provided by us to the customer (Network Operations - VoiceConfiguration)
|
|
349
|
+
*
|
|
350
|
+
* @type {PHONE_NUMBER_E164_GB}
|
|
351
|
+
* @pii This field contains personally identifiable information
|
|
352
|
+
*/
|
|
353
|
+
IssuedPhoneNumber: string;
|
|
354
|
+
/** Magrathea Port Date
|
|
355
|
+
*
|
|
356
|
+
* @type {DATE}
|
|
357
|
+
*/
|
|
358
|
+
MagratheaPortDate: string;
|
|
359
359
|
}
|
|
360
360
|
/**
|
|
361
361
|
* VoiceConfiguration entity from ServiceModule
|