@d19n/youfibre-odin-sdk 2.0.370 → 2.0.372
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 +7 -3
- package/dist/actions-v2/CreateNoteForCaseSalesAppDto.d.ts +73 -0
- package/dist/actions-v2/CreateNoteForCaseSalesAppDto.js +59 -0
- package/dist/actions-v2/CreateOutboundDialCampaignDto.d.ts +8 -1
- package/dist/actions-v2/MoveCaseToSolvedWithNoteSalesAppDto.d.ts +171 -0
- package/dist/actions-v2/MoveCaseToSolvedWithNoteSalesAppDto.js +124 -0
- package/dist/actions-v2/OrderBuilderUpdateContactDto.d.ts +182 -0
- package/dist/actions-v2/OrderBuilderUpdateContactDto.js +56 -0
- package/dist/actions-v2/UpdateOutboundDialCampaignCaseDto.d.ts +15 -1
- package/dist/actions-v2/UpdateOutboundDialCampaignCaseOnDialEndDto.d.ts +15 -1
- package/dist/actions-v2/UpdateoutbounddialcampaignDto.d.ts +8 -1
- package/dist/api-sdk-v2/QaBatchApi.d.ts +48 -0
- package/dist/api-sdk-v2/QaBatchApi.js +155 -0
- package/dist/api-sdk-v2/QaReportApi.d.ts +2 -0
- package/dist/api-sdk-v2/QaReportApi.js +6 -0
- package/dist/db-sdk-v2/QaBatchDb.d.ts +120 -0
- package/dist/db-sdk-v2/QaBatchDb.js +204 -0
- package/dist/db-sdk-v2/QaReportDb.d.ts +2 -0
- package/dist/db-sdk-v2/QaReportDb.js +6 -0
- package/dist/entities-v2/AiRouteRequest.d.ts +2 -0
- package/dist/entities-v2/AiRouteRequest.js +2 -0
- package/dist/entities-v2/Document.d.ts +821 -12
- package/dist/entities-v2/Document.js +63 -1
- package/dist/entities-v2/DocumentProcessing.d.ts +7 -1
- package/dist/entities-v2/DocumentProcessing.js +6 -0
- package/dist/entities-v2/EquipmentReturnItem.d.ts +6 -6
- package/dist/entities-v2/EquipmentReturnItem.js +6 -6
- package/dist/entities-v2/HomeMove.d.ts +23 -1
- package/dist/entities-v2/HomeMove.js +17 -1
- package/dist/entities-v2/Note.d.ts +9 -9
- package/dist/entities-v2/Note.js +2 -2
- package/dist/entities-v2/Order.d.ts +9 -1
- package/dist/entities-v2/Order.js +2 -0
- package/dist/entities-v2/OutboundDialCampaign.d.ts +9 -1
- package/dist/entities-v2/OutboundDialCampaign.js +2 -0
- package/dist/entities-v2/OutboundDialCampaignCase.d.ts +17 -1
- package/dist/entities-v2/OutboundDialCampaignCase.js +4 -0
- package/dist/entities-v2/QaBatch.d.ts +235 -0
- package/dist/entities-v2/QaBatch.js +122 -0
- package/dist/entities-v2/QaReport.d.ts +12 -1
- package/dist/entities-v2/QaReport.js +2 -0
- package/dist/entities-v2/Recontract.d.ts +17 -1
- package/dist/entities-v2/Recontract.js +4 -0
- package/dist/entities-v2/Returns.d.ts +30 -30
- package/dist/entities-v2/Returns.js +30 -30
- package/dist/records-v2/CaseRecord.d.ts +87 -0
- package/dist/records-v2/CaseRecord.js +133 -1
- package/dist/records-v2/ContactRecord.d.ts +27 -0
- package/dist/records-v2/ContactRecord.js +29 -0
- package/dist/records-v2/DocumentRecord.d.ts +35 -3
- package/dist/records-v2/DocumentRecord.js +33 -1
- package/dist/records-v2/NoteRecord.d.ts +29 -0
- package/dist/records-v2/NoteRecord.js +36 -0
- package/package.json +1 -1
|
@@ -0,0 +1,235 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* QaBatch Entity Definition
|
|
3
|
+
*
|
|
4
|
+
* One bulk QA run: a share of the cases one agent closed in a period, scored in rounds. Carries who asked, the window, the counts and the state. Written only by youfibre-api-support; never edited by hand.
|
|
5
|
+
*
|
|
6
|
+
* @module SupportModule
|
|
7
|
+
* @entity QaBatch
|
|
8
|
+
* @schemaId 47cd7cfb-d4a1-4028-971b-680b3f40431f
|
|
9
|
+
*
|
|
10
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
11
|
+
* Generated from Odin schema definition
|
|
12
|
+
*/
|
|
13
|
+
import { OdinRecord, OdinLink, LinkedOdinRecord } from '@d19n/odin-types/dist/core';
|
|
14
|
+
import { QaReportProperties } from './QaReport';
|
|
15
|
+
/**
|
|
16
|
+
* Available types for QaBatch records
|
|
17
|
+
*/
|
|
18
|
+
export declare enum QaBatchEntityTypes {
|
|
19
|
+
/** This is the default record type */
|
|
20
|
+
DEFAULT = "DEFAULT"
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Valid values for QaBatch.Status
|
|
24
|
+
*
|
|
25
|
+
* RUNNING while the runner works it; DONE when every picked case is done, failed or skipped; STOPPED when a person stopped it; FAILED when the runner gave up or went stale.
|
|
26
|
+
*
|
|
27
|
+
* @remarks Available options:
|
|
28
|
+
* - `DONE` - Done
|
|
29
|
+
* - `FAILED` - Failed
|
|
30
|
+
* - `RUNNING` - Running
|
|
31
|
+
* - `STOPPED` - Stopped
|
|
32
|
+
*/
|
|
33
|
+
export declare enum QaBatchStatus {
|
|
34
|
+
DONE = "DONE",
|
|
35
|
+
FAILED = "FAILED",
|
|
36
|
+
RUNNING = "RUNNING",
|
|
37
|
+
STOPPED = "STOPPED"
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
* Property keys for QaBatch
|
|
41
|
+
* Use these constants instead of string literals for type safety
|
|
42
|
+
*/
|
|
43
|
+
export declare enum QaBatchPropertyKeys {
|
|
44
|
+
/** The agent whose closed cases the run scores: their assigned-user id, else their owner id, as the QA report attributes a case. */
|
|
45
|
+
AgentId = "AgentId",
|
|
46
|
+
/** The display name of the agent at the time of the run. */
|
|
47
|
+
AgentName = "AgentName",
|
|
48
|
+
/** Start of the period the cases were closed in (inclusive). */
|
|
49
|
+
PeriodFrom = "PeriodFrom",
|
|
50
|
+
/** End of the period the cases were closed in (exclusive). */
|
|
51
|
+
PeriodTo = "PeriodTo",
|
|
52
|
+
/** The share of the closed cases asked for: 10 or 25. */
|
|
53
|
+
Percent = "Percent",
|
|
54
|
+
/** How many cases the agent closed in the period. */
|
|
55
|
+
ClosedCount = "ClosedCount",
|
|
56
|
+
/** How many of those had something to score and no report yet when the run started. */
|
|
57
|
+
ScorableCount = "ScorableCount",
|
|
58
|
+
/** ceil(Percent x Closed), capped at 100: how many the run set out to score. */
|
|
59
|
+
TargetCount = "TargetCount",
|
|
60
|
+
/** How many cases the run picked: the lower of Target and Scorable. */
|
|
61
|
+
PickedCount = "PickedCount",
|
|
62
|
+
/** Reports written so far. */
|
|
63
|
+
DoneCount = "DoneCount",
|
|
64
|
+
/** Cases the model could not score after the retries. */
|
|
65
|
+
FailedCount = "FailedCount",
|
|
66
|
+
/** Cases refused before the model (nothing to score after all). */
|
|
67
|
+
SkippedCount = "SkippedCount",
|
|
68
|
+
/** RUNNING while the runner works it; DONE when every picked case is done, failed or skipped; STOPPED when a person stopped it; FAILED when the runner gave up or went stale. */
|
|
69
|
+
Status = "Status",
|
|
70
|
+
/** How many reports the runner kept in flight at once. */
|
|
71
|
+
Concurrency = "Concurrency",
|
|
72
|
+
/** Display name of the manager who pressed Go. */
|
|
73
|
+
RequestedBy = "RequestedBy",
|
|
74
|
+
/** When the runner took the batch. */
|
|
75
|
+
StartedAt = "StartedAt",
|
|
76
|
+
/** When the runner wrote its last count. */
|
|
77
|
+
FinishedAt = "FinishedAt",
|
|
78
|
+
/** Why the run FAILED, when it did. */
|
|
79
|
+
Error = "Error"
|
|
80
|
+
}
|
|
81
|
+
/**
|
|
82
|
+
* Properties for QaBatch records
|
|
83
|
+
*
|
|
84
|
+
* @see SupportModule:QaBatch
|
|
85
|
+
*/
|
|
86
|
+
export interface QaBatchProperties {
|
|
87
|
+
/** The agent whose closed cases the run scores: their assigned-user id, else their owner id, as the QA report attributes a case.
|
|
88
|
+
*
|
|
89
|
+
* @type {TEXT}
|
|
90
|
+
* @default
|
|
91
|
+
*/
|
|
92
|
+
AgentId: string;
|
|
93
|
+
/** The display name of the agent at the time of the run.
|
|
94
|
+
*
|
|
95
|
+
* @type {TEXT}
|
|
96
|
+
* @default
|
|
97
|
+
*/
|
|
98
|
+
AgentName: string;
|
|
99
|
+
/** Start of the period the cases were closed in (inclusive).
|
|
100
|
+
*
|
|
101
|
+
* @type {DATE_TIME}
|
|
102
|
+
* @default
|
|
103
|
+
*/
|
|
104
|
+
PeriodFrom: string;
|
|
105
|
+
/** End of the period the cases were closed in (exclusive).
|
|
106
|
+
*
|
|
107
|
+
* @type {DATE_TIME}
|
|
108
|
+
* @default
|
|
109
|
+
*/
|
|
110
|
+
PeriodTo: string;
|
|
111
|
+
/** The share of the closed cases asked for: 10 or 25.
|
|
112
|
+
*
|
|
113
|
+
* @type {NUMBER}
|
|
114
|
+
* @default
|
|
115
|
+
*/
|
|
116
|
+
Percent: number;
|
|
117
|
+
/** How many cases the agent closed in the period.
|
|
118
|
+
*
|
|
119
|
+
* @type {NUMBER}
|
|
120
|
+
* @default
|
|
121
|
+
*/
|
|
122
|
+
ClosedCount: number;
|
|
123
|
+
/** How many of those had something to score and no report yet when the run started.
|
|
124
|
+
*
|
|
125
|
+
* @type {NUMBER}
|
|
126
|
+
* @default
|
|
127
|
+
*/
|
|
128
|
+
ScorableCount: number;
|
|
129
|
+
/** ceil(Percent x Closed), capped at 100: how many the run set out to score.
|
|
130
|
+
*
|
|
131
|
+
* @type {NUMBER}
|
|
132
|
+
* @default
|
|
133
|
+
*/
|
|
134
|
+
TargetCount: number;
|
|
135
|
+
/** How many cases the run picked: the lower of Target and Scorable.
|
|
136
|
+
*
|
|
137
|
+
* @type {NUMBER}
|
|
138
|
+
* @default 0
|
|
139
|
+
*/
|
|
140
|
+
PickedCount: number;
|
|
141
|
+
/** Reports written so far.
|
|
142
|
+
*
|
|
143
|
+
* @type {NUMBER}
|
|
144
|
+
* @default 0
|
|
145
|
+
*/
|
|
146
|
+
DoneCount: number;
|
|
147
|
+
/** Cases the model could not score after the retries.
|
|
148
|
+
*
|
|
149
|
+
* @type {NUMBER}
|
|
150
|
+
* @default 0
|
|
151
|
+
*/
|
|
152
|
+
FailedCount: number;
|
|
153
|
+
/** Cases refused before the model (nothing to score after all).
|
|
154
|
+
*
|
|
155
|
+
* @type {NUMBER}
|
|
156
|
+
* @default 0
|
|
157
|
+
*/
|
|
158
|
+
SkippedCount: number;
|
|
159
|
+
/** RUNNING while the runner works it; DONE when every picked case is done, failed or skipped; STOPPED when a person stopped it; FAILED when the runner gave up or went stale.
|
|
160
|
+
*
|
|
161
|
+
* @type {ENUM}
|
|
162
|
+
* @default RUNNING
|
|
163
|
+
* @enum {QaBatchStatus}
|
|
164
|
+
*/
|
|
165
|
+
Status: QaBatchStatus;
|
|
166
|
+
/** How many reports the runner kept in flight at once.
|
|
167
|
+
*
|
|
168
|
+
* @type {NUMBER}
|
|
169
|
+
* @default
|
|
170
|
+
*/
|
|
171
|
+
Concurrency: number;
|
|
172
|
+
/** Display name of the manager who pressed Go.
|
|
173
|
+
*
|
|
174
|
+
* @type {TEXT}
|
|
175
|
+
* @default
|
|
176
|
+
*/
|
|
177
|
+
RequestedBy: string;
|
|
178
|
+
/** When the runner took the batch.
|
|
179
|
+
*
|
|
180
|
+
* @type {DATE_TIME}
|
|
181
|
+
* @default
|
|
182
|
+
*/
|
|
183
|
+
StartedAt: string;
|
|
184
|
+
/** When the runner wrote its last count.
|
|
185
|
+
*
|
|
186
|
+
* @type {DATE_TIME}
|
|
187
|
+
* @default
|
|
188
|
+
*/
|
|
189
|
+
FinishedAt: string;
|
|
190
|
+
/** Why the run FAILED, when it did.
|
|
191
|
+
*
|
|
192
|
+
* @type {TEXT_LONG}
|
|
193
|
+
* @default
|
|
194
|
+
*/
|
|
195
|
+
Error: string;
|
|
196
|
+
}
|
|
197
|
+
/**
|
|
198
|
+
* QaBatch entity from SupportModule
|
|
199
|
+
*
|
|
200
|
+
* One bulk QA run: a share of the cases one agent closed in a period, scored in rounds. Carries who asked, the window, the counts and the state. Written only by youfibre-api-support; never edited by hand.
|
|
201
|
+
*
|
|
202
|
+
* @module SupportModule
|
|
203
|
+
* @entity QaBatch
|
|
204
|
+
* @schemaId 47cd7cfb-d4a1-4028-971b-680b3f40431f
|
|
205
|
+
* @recordPrefix QAB
|
|
206
|
+
* @capabilities searchable, updateable, undeletable, triggerable
|
|
207
|
+
*/
|
|
208
|
+
export declare class QaBatch extends OdinRecord<QaBatchProperties> {
|
|
209
|
+
entity: 'SupportModule:QaBatch';
|
|
210
|
+
type: QaBatchEntityTypes;
|
|
211
|
+
schemaId: '47cd7cfb-d4a1-4028-971b-680b3f40431f';
|
|
212
|
+
properties: QaBatchProperties;
|
|
213
|
+
/** Linked QaReport records (QaBatch__Report) */
|
|
214
|
+
QaReport: OdinLink<LinkedOdinRecord<QaReportProperties>>;
|
|
215
|
+
}
|
|
216
|
+
/**
|
|
217
|
+
* RabbitMQ routing keys for QaBatch events
|
|
218
|
+
*/
|
|
219
|
+
export declare const ROUTING_KEY_QA_BATCH_CREATED = "SupportModule.QaBatch.SubDbRecordCreated";
|
|
220
|
+
export declare const ROUTING_KEY_QA_BATCH_UPDATED = "SupportModule.QaBatch.SubDbRecordUpdated";
|
|
221
|
+
export declare const ROUTING_KEY_QA_BATCH_DELETED = "SupportModule.QaBatch.SubDbRecordDeleted";
|
|
222
|
+
/**
|
|
223
|
+
* Type-specific routing keys for QaBatch events
|
|
224
|
+
* Subscribe to these for events on specific entity types only
|
|
225
|
+
*/
|
|
226
|
+
/** This is the default record type created */
|
|
227
|
+
export declare const ROUTING_KEY_QA_BATCH_DEFAULT_CREATED = "SupportModule.QaBatch.DEFAULT.SubDbRecordCreated";
|
|
228
|
+
/** This is the default record type updated */
|
|
229
|
+
export declare const ROUTING_KEY_QA_BATCH_DEFAULT_UPDATED = "SupportModule.QaBatch.DEFAULT.SubDbRecordUpdated";
|
|
230
|
+
/** This is the default record type deleted */
|
|
231
|
+
export declare const ROUTING_KEY_QA_BATCH_DEFAULT_DELETED = "SupportModule.QaBatch.DEFAULT.SubDbRecordDeleted";
|
|
232
|
+
/** Event: QaBatch__Report link created */
|
|
233
|
+
export declare const ROUTING_KEY_LINK_QA_BATCH_REPORT_CREATED = "SupportModule.QaBatch.QaReport.SubDbRecordAssociationCreated";
|
|
234
|
+
/** Event: QaBatch__Report link deleted */
|
|
235
|
+
export declare const ROUTING_KEY_LINK_QA_BATCH_REPORT_DELETED = "SupportModule.QaBatch.QaReport.SubDbRecordAssociationDeleted";
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* QaBatch Entity Definition
|
|
4
|
+
*
|
|
5
|
+
* One bulk QA run: a share of the cases one agent closed in a period, scored in rounds. Carries who asked, the window, the counts and the state. Written only by youfibre-api-support; never edited by hand.
|
|
6
|
+
*
|
|
7
|
+
* @module SupportModule
|
|
8
|
+
* @entity QaBatch
|
|
9
|
+
* @schemaId 47cd7cfb-d4a1-4028-971b-680b3f40431f
|
|
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_LINK_QA_BATCH_REPORT_DELETED = exports.ROUTING_KEY_LINK_QA_BATCH_REPORT_CREATED = exports.ROUTING_KEY_QA_BATCH_DEFAULT_DELETED = exports.ROUTING_KEY_QA_BATCH_DEFAULT_UPDATED = exports.ROUTING_KEY_QA_BATCH_DEFAULT_CREATED = exports.ROUTING_KEY_QA_BATCH_DELETED = exports.ROUTING_KEY_QA_BATCH_UPDATED = exports.ROUTING_KEY_QA_BATCH_CREATED = exports.QaBatch = exports.QaBatchPropertyKeys = exports.QaBatchStatus = exports.QaBatchEntityTypes = void 0;
|
|
16
|
+
const core_1 = require("@d19n/odin-types/dist/core");
|
|
17
|
+
/**
|
|
18
|
+
* Available types for QaBatch records
|
|
19
|
+
*/
|
|
20
|
+
var QaBatchEntityTypes;
|
|
21
|
+
(function (QaBatchEntityTypes) {
|
|
22
|
+
/** This is the default record type */
|
|
23
|
+
QaBatchEntityTypes["DEFAULT"] = "DEFAULT";
|
|
24
|
+
})(QaBatchEntityTypes = exports.QaBatchEntityTypes || (exports.QaBatchEntityTypes = {}));
|
|
25
|
+
/**
|
|
26
|
+
* Valid values for QaBatch.Status
|
|
27
|
+
*
|
|
28
|
+
* RUNNING while the runner works it; DONE when every picked case is done, failed or skipped; STOPPED when a person stopped it; FAILED when the runner gave up or went stale.
|
|
29
|
+
*
|
|
30
|
+
* @remarks Available options:
|
|
31
|
+
* - `DONE` - Done
|
|
32
|
+
* - `FAILED` - Failed
|
|
33
|
+
* - `RUNNING` - Running
|
|
34
|
+
* - `STOPPED` - Stopped
|
|
35
|
+
*/
|
|
36
|
+
var QaBatchStatus;
|
|
37
|
+
(function (QaBatchStatus) {
|
|
38
|
+
QaBatchStatus["DONE"] = "DONE";
|
|
39
|
+
QaBatchStatus["FAILED"] = "FAILED";
|
|
40
|
+
QaBatchStatus["RUNNING"] = "RUNNING";
|
|
41
|
+
QaBatchStatus["STOPPED"] = "STOPPED";
|
|
42
|
+
})(QaBatchStatus = exports.QaBatchStatus || (exports.QaBatchStatus = {}));
|
|
43
|
+
/**
|
|
44
|
+
* Property keys for QaBatch
|
|
45
|
+
* Use these constants instead of string literals for type safety
|
|
46
|
+
*/
|
|
47
|
+
var QaBatchPropertyKeys;
|
|
48
|
+
(function (QaBatchPropertyKeys) {
|
|
49
|
+
/** The agent whose closed cases the run scores: their assigned-user id, else their owner id, as the QA report attributes a case. */
|
|
50
|
+
QaBatchPropertyKeys["AgentId"] = "AgentId";
|
|
51
|
+
/** The display name of the agent at the time of the run. */
|
|
52
|
+
QaBatchPropertyKeys["AgentName"] = "AgentName";
|
|
53
|
+
/** Start of the period the cases were closed in (inclusive). */
|
|
54
|
+
QaBatchPropertyKeys["PeriodFrom"] = "PeriodFrom";
|
|
55
|
+
/** End of the period the cases were closed in (exclusive). */
|
|
56
|
+
QaBatchPropertyKeys["PeriodTo"] = "PeriodTo";
|
|
57
|
+
/** The share of the closed cases asked for: 10 or 25. */
|
|
58
|
+
QaBatchPropertyKeys["Percent"] = "Percent";
|
|
59
|
+
/** How many cases the agent closed in the period. */
|
|
60
|
+
QaBatchPropertyKeys["ClosedCount"] = "ClosedCount";
|
|
61
|
+
/** How many of those had something to score and no report yet when the run started. */
|
|
62
|
+
QaBatchPropertyKeys["ScorableCount"] = "ScorableCount";
|
|
63
|
+
/** ceil(Percent x Closed), capped at 100: how many the run set out to score. */
|
|
64
|
+
QaBatchPropertyKeys["TargetCount"] = "TargetCount";
|
|
65
|
+
/** How many cases the run picked: the lower of Target and Scorable. */
|
|
66
|
+
QaBatchPropertyKeys["PickedCount"] = "PickedCount";
|
|
67
|
+
/** Reports written so far. */
|
|
68
|
+
QaBatchPropertyKeys["DoneCount"] = "DoneCount";
|
|
69
|
+
/** Cases the model could not score after the retries. */
|
|
70
|
+
QaBatchPropertyKeys["FailedCount"] = "FailedCount";
|
|
71
|
+
/** Cases refused before the model (nothing to score after all). */
|
|
72
|
+
QaBatchPropertyKeys["SkippedCount"] = "SkippedCount";
|
|
73
|
+
/** RUNNING while the runner works it; DONE when every picked case is done, failed or skipped; STOPPED when a person stopped it; FAILED when the runner gave up or went stale. */
|
|
74
|
+
QaBatchPropertyKeys["Status"] = "Status";
|
|
75
|
+
/** How many reports the runner kept in flight at once. */
|
|
76
|
+
QaBatchPropertyKeys["Concurrency"] = "Concurrency";
|
|
77
|
+
/** Display name of the manager who pressed Go. */
|
|
78
|
+
QaBatchPropertyKeys["RequestedBy"] = "RequestedBy";
|
|
79
|
+
/** When the runner took the batch. */
|
|
80
|
+
QaBatchPropertyKeys["StartedAt"] = "StartedAt";
|
|
81
|
+
/** When the runner wrote its last count. */
|
|
82
|
+
QaBatchPropertyKeys["FinishedAt"] = "FinishedAt";
|
|
83
|
+
/** Why the run FAILED, when it did. */
|
|
84
|
+
QaBatchPropertyKeys["Error"] = "Error";
|
|
85
|
+
})(QaBatchPropertyKeys = exports.QaBatchPropertyKeys || (exports.QaBatchPropertyKeys = {}));
|
|
86
|
+
/**
|
|
87
|
+
* QaBatch entity from SupportModule
|
|
88
|
+
*
|
|
89
|
+
* One bulk QA run: a share of the cases one agent closed in a period, scored in rounds. Carries who asked, the window, the counts and the state. Written only by youfibre-api-support; never edited by hand.
|
|
90
|
+
*
|
|
91
|
+
* @module SupportModule
|
|
92
|
+
* @entity QaBatch
|
|
93
|
+
* @schemaId 47cd7cfb-d4a1-4028-971b-680b3f40431f
|
|
94
|
+
* @recordPrefix QAB
|
|
95
|
+
* @capabilities searchable, updateable, undeletable, triggerable
|
|
96
|
+
*/
|
|
97
|
+
class QaBatch extends core_1.OdinRecord {
|
|
98
|
+
}
|
|
99
|
+
exports.QaBatch = QaBatch;
|
|
100
|
+
// ============================================
|
|
101
|
+
// RABBITMQ EVENT ROUTING KEYS
|
|
102
|
+
// ============================================
|
|
103
|
+
/**
|
|
104
|
+
* RabbitMQ routing keys for QaBatch events
|
|
105
|
+
*/
|
|
106
|
+
exports.ROUTING_KEY_QA_BATCH_CREATED = 'SupportModule.QaBatch.SubDbRecordCreated';
|
|
107
|
+
exports.ROUTING_KEY_QA_BATCH_UPDATED = 'SupportModule.QaBatch.SubDbRecordUpdated';
|
|
108
|
+
exports.ROUTING_KEY_QA_BATCH_DELETED = 'SupportModule.QaBatch.SubDbRecordDeleted';
|
|
109
|
+
/**
|
|
110
|
+
* Type-specific routing keys for QaBatch events
|
|
111
|
+
* Subscribe to these for events on specific entity types only
|
|
112
|
+
*/
|
|
113
|
+
/** This is the default record type created */
|
|
114
|
+
exports.ROUTING_KEY_QA_BATCH_DEFAULT_CREATED = 'SupportModule.QaBatch.DEFAULT.SubDbRecordCreated';
|
|
115
|
+
/** This is the default record type updated */
|
|
116
|
+
exports.ROUTING_KEY_QA_BATCH_DEFAULT_UPDATED = 'SupportModule.QaBatch.DEFAULT.SubDbRecordUpdated';
|
|
117
|
+
/** This is the default record type deleted */
|
|
118
|
+
exports.ROUTING_KEY_QA_BATCH_DEFAULT_DELETED = 'SupportModule.QaBatch.DEFAULT.SubDbRecordDeleted';
|
|
119
|
+
/** Event: QaBatch__Report link created */
|
|
120
|
+
exports.ROUTING_KEY_LINK_QA_BATCH_REPORT_CREATED = 'SupportModule.QaBatch.QaReport.SubDbRecordAssociationCreated';
|
|
121
|
+
/** Event: QaBatch__Report link deleted */
|
|
122
|
+
exports.ROUTING_KEY_LINK_QA_BATCH_REPORT_DELETED = 'SupportModule.QaBatch.QaReport.SubDbRecordAssociationDeleted';
|
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
import { OdinRecord, OdinLink, LinkedOdinRecord } from '@d19n/odin-types/dist/core';
|
|
14
14
|
import { CaseProperties } from './Case';
|
|
15
15
|
import { QaReportAmendmentProperties } from './QaReportAmendment';
|
|
16
|
+
import { QaBatchProperties } from './QaBatch';
|
|
16
17
|
/**
|
|
17
18
|
* Available types for QaReport records
|
|
18
19
|
*/
|
|
@@ -161,7 +162,9 @@ export declare enum QaReportPropertyKeys {
|
|
|
161
162
|
/** S3 URL of the amended result JSON: the same shape as QaResultUrl, with the amendment applied and recorded inside it. */
|
|
162
163
|
AmendedResultUrl = "AmendedResultUrl",
|
|
163
164
|
/** Optional note from the manager about the amendment as a whole. */
|
|
164
|
-
AmendmentNote = "AmendmentNote"
|
|
165
|
+
AmendmentNote = "AmendmentNote",
|
|
166
|
+
/** The bulk QA run this report was generated by. Empty for a report generated from the case tab. */
|
|
167
|
+
BatchId = "BatchId"
|
|
165
168
|
}
|
|
166
169
|
/**
|
|
167
170
|
* Properties for QaReport records
|
|
@@ -349,6 +352,12 @@ export interface QaReportProperties {
|
|
|
349
352
|
* @default
|
|
350
353
|
*/
|
|
351
354
|
AmendmentNote: string;
|
|
355
|
+
/** The bulk QA run this report was generated by. Empty for a report generated from the case tab.
|
|
356
|
+
*
|
|
357
|
+
* @type {LOOKUP}
|
|
358
|
+
* @default
|
|
359
|
+
*/
|
|
360
|
+
BatchId: string;
|
|
352
361
|
}
|
|
353
362
|
/**
|
|
354
363
|
* QaReport entity from SupportModule
|
|
@@ -370,6 +379,8 @@ export declare class QaReport extends OdinRecord<QaReportProperties> {
|
|
|
370
379
|
Case: OdinLink<LinkedOdinRecord<CaseProperties>>;
|
|
371
380
|
/** Linked QaReportAmendment records (QaReport__Amendment) */
|
|
372
381
|
QaReportAmendment: OdinLink<LinkedOdinRecord<QaReportAmendmentProperties>>;
|
|
382
|
+
/** Linked QaBatch records (QaBatch__Report) */
|
|
383
|
+
QaBatch: OdinLink<LinkedOdinRecord<QaBatchProperties>>;
|
|
373
384
|
}
|
|
374
385
|
/**
|
|
375
386
|
* RabbitMQ routing keys for QaReport events
|
|
@@ -170,6 +170,8 @@ var QaReportPropertyKeys;
|
|
|
170
170
|
QaReportPropertyKeys["AmendedResultUrl"] = "AmendedResultUrl";
|
|
171
171
|
/** Optional note from the manager about the amendment as a whole. */
|
|
172
172
|
QaReportPropertyKeys["AmendmentNote"] = "AmendmentNote";
|
|
173
|
+
/** The bulk QA run this report was generated by. Empty for a report generated from the case tab. */
|
|
174
|
+
QaReportPropertyKeys["BatchId"] = "BatchId";
|
|
173
175
|
})(QaReportPropertyKeys = exports.QaReportPropertyKeys || (exports.QaReportPropertyKeys = {}));
|
|
174
176
|
/**
|
|
175
177
|
* QaReport entity from SupportModule
|
|
@@ -125,7 +125,11 @@ export declare enum RecontractPropertyKeys {
|
|
|
125
125
|
/** Whether the recontract required a mesh upgrade or not */
|
|
126
126
|
RequiredMeshUpgrade = "RequiredMeshUpgrade",
|
|
127
127
|
/** Why this recontract did not apply. Set on entry to Failed, and on an apply that threw and was left at Applying. Detail: ResolveDeferredRecontract process log. */
|
|
128
|
-
FailureReason = "FailureReason"
|
|
128
|
+
FailureReason = "FailureReason",
|
|
129
|
+
/** Whether the server determined, at this recontract, that the customer could be offered the choice to skip the router/mesh upgrade (no ONT swap, not a mesh quantity increase). Caller-supplied, forwarded verbatim onto the Recontract record — recontracting itself derives no hardware requirement from this (ORD-493). */
|
|
130
|
+
RouterUpgradeDeclineEligible = "RouterUpgradeDeclineEligible",
|
|
131
|
+
/** What the customer chose at this recontract, when offered the choice above. Caller-supplied, forwarded verbatim — a permanent snapshot, unlike the live Order.RouterUpgradeDeclined, which an agent can flip back on reversal (ORD-493). */
|
|
132
|
+
RouterUpgradeDeclined = "RouterUpgradeDeclined"
|
|
129
133
|
}
|
|
130
134
|
/**
|
|
131
135
|
* Properties for Recontract records
|
|
@@ -243,6 +247,18 @@ export interface RecontractProperties {
|
|
|
243
247
|
* @enum {RecontractFailureReason}
|
|
244
248
|
*/
|
|
245
249
|
FailureReason: RecontractFailureReason;
|
|
250
|
+
/** Whether the server determined, at this recontract, that the customer could be offered the choice to skip the router/mesh upgrade (no ONT swap, not a mesh quantity increase). Caller-supplied, forwarded verbatim onto the Recontract record — recontracting itself derives no hardware requirement from this (ORD-493).
|
|
251
|
+
*
|
|
252
|
+
* @type {BOOLEAN}
|
|
253
|
+
* @default
|
|
254
|
+
*/
|
|
255
|
+
RouterUpgradeDeclineEligible: boolean;
|
|
256
|
+
/** What the customer chose at this recontract, when offered the choice above. Caller-supplied, forwarded verbatim — a permanent snapshot, unlike the live Order.RouterUpgradeDeclined, which an agent can flip back on reversal (ORD-493).
|
|
257
|
+
*
|
|
258
|
+
* @type {BOOLEAN}
|
|
259
|
+
* @default
|
|
260
|
+
*/
|
|
261
|
+
RouterUpgradeDeclined: boolean;
|
|
246
262
|
}
|
|
247
263
|
/**
|
|
248
264
|
* Recontract entity from OrderModule
|
|
@@ -133,6 +133,10 @@ var RecontractPropertyKeys;
|
|
|
133
133
|
RecontractPropertyKeys["RequiredMeshUpgrade"] = "RequiredMeshUpgrade";
|
|
134
134
|
/** Why this recontract did not apply. Set on entry to Failed, and on an apply that threw and was left at Applying. Detail: ResolveDeferredRecontract process log. */
|
|
135
135
|
RecontractPropertyKeys["FailureReason"] = "FailureReason";
|
|
136
|
+
/** Whether the server determined, at this recontract, that the customer could be offered the choice to skip the router/mesh upgrade (no ONT swap, not a mesh quantity increase). Caller-supplied, forwarded verbatim onto the Recontract record — recontracting itself derives no hardware requirement from this (ORD-493). */
|
|
137
|
+
RecontractPropertyKeys["RouterUpgradeDeclineEligible"] = "RouterUpgradeDeclineEligible";
|
|
138
|
+
/** What the customer chose at this recontract, when offered the choice above. Caller-supplied, forwarded verbatim — a permanent snapshot, unlike the live Order.RouterUpgradeDeclined, which an agent can flip back on reversal (ORD-493). */
|
|
139
|
+
RecontractPropertyKeys["RouterUpgradeDeclined"] = "RouterUpgradeDeclined";
|
|
136
140
|
})(RecontractPropertyKeys = exports.RecontractPropertyKeys || (exports.RecontractPropertyKeys = {}));
|
|
137
141
|
/**
|
|
138
142
|
* Recontract entity from OrderModule
|
|
@@ -218,14 +218,14 @@ export declare enum ReturnsCpe4Type {
|
|
|
218
218
|
* Cpe 5 Grade (Field Operations - Returns)
|
|
219
219
|
*
|
|
220
220
|
* @remarks Available options:
|
|
221
|
-
* - `
|
|
222
|
-
* - `
|
|
223
|
-
* - `
|
|
221
|
+
* - `E` - Fail - Cosmetic
|
|
222
|
+
* - `F` - Fail - Technical
|
|
223
|
+
* - `D` - Pass
|
|
224
224
|
*/
|
|
225
225
|
export declare enum ReturnsCpe5Grade {
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
226
|
+
FAIL_COSMETIC = "E",
|
|
227
|
+
FAIL_TECHNICAL = "F",
|
|
228
|
+
PASS = "D"
|
|
229
229
|
}
|
|
230
230
|
/**
|
|
231
231
|
* Valid values for Returns.Cpe3Model
|
|
@@ -283,14 +283,14 @@ export declare enum ReturnsCpe3Model {
|
|
|
283
283
|
* Cpe 1 Grade (Field Operations - Returns)
|
|
284
284
|
*
|
|
285
285
|
* @remarks Available options:
|
|
286
|
-
* - `
|
|
287
|
-
* - `
|
|
288
|
-
* - `
|
|
286
|
+
* - `E` - Fail - Cosmetic
|
|
287
|
+
* - `F` - Fail - Technical
|
|
288
|
+
* - `D` - Pass
|
|
289
289
|
*/
|
|
290
290
|
export declare enum ReturnsCpe1Grade {
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
291
|
+
FAIL_COSMETIC = "E",
|
|
292
|
+
FAIL_TECHNICAL = "F",
|
|
293
|
+
PASS = "D"
|
|
294
294
|
}
|
|
295
295
|
/**
|
|
296
296
|
* Valid values for Returns.Cpe2Type
|
|
@@ -473,14 +473,14 @@ export declare enum ReturnsCpe2Model {
|
|
|
473
473
|
* Cpe 4 Grade (Field Operations - Returns)
|
|
474
474
|
*
|
|
475
475
|
* @remarks Available options:
|
|
476
|
-
* - `
|
|
477
|
-
* - `
|
|
478
|
-
* - `
|
|
476
|
+
* - `E` - Fail - Cosmetic
|
|
477
|
+
* - `F` - Fail - Technical
|
|
478
|
+
* - `D` - Pass
|
|
479
479
|
*/
|
|
480
480
|
export declare enum ReturnsCpe4Grade {
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
481
|
+
FAIL_COSMETIC = "E",
|
|
482
|
+
FAIL_TECHNICAL = "F",
|
|
483
|
+
PASS = "D"
|
|
484
484
|
}
|
|
485
485
|
/**
|
|
486
486
|
* Valid values for Returns.InspectedBy
|
|
@@ -507,14 +507,14 @@ export declare enum ReturnsInspectedBy {
|
|
|
507
507
|
* Cpe 3 Grade (Field Operations - Returns)
|
|
508
508
|
*
|
|
509
509
|
* @remarks Available options:
|
|
510
|
-
* - `
|
|
511
|
-
* - `
|
|
512
|
-
* - `
|
|
510
|
+
* - `E` - Fail - Cosmetic
|
|
511
|
+
* - `F` - Fail - Technical
|
|
512
|
+
* - `D` - Pass
|
|
513
513
|
*/
|
|
514
514
|
export declare enum ReturnsCpe3Grade {
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
515
|
+
FAIL_COSMETIC = "E",
|
|
516
|
+
FAIL_TECHNICAL = "F",
|
|
517
|
+
PASS = "D"
|
|
518
518
|
}
|
|
519
519
|
/**
|
|
520
520
|
* Valid values for Returns.Tv1Type
|
|
@@ -535,14 +535,14 @@ export declare enum ReturnsTv1Type {
|
|
|
535
535
|
* Cpe 2 Grade (Field Operations - Returns)
|
|
536
536
|
*
|
|
537
537
|
* @remarks Available options:
|
|
538
|
-
* - `
|
|
539
|
-
* - `
|
|
540
|
-
* - `
|
|
538
|
+
* - `E` - Fail - Cosmetic
|
|
539
|
+
* - `F` - Fail - Technical
|
|
540
|
+
* - `D` - Pass
|
|
541
541
|
*/
|
|
542
542
|
export declare enum ReturnsCpe2Grade {
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
543
|
+
FAIL_COSMETIC = "E",
|
|
544
|
+
FAIL_TECHNICAL = "F",
|
|
545
|
+
PASS = "D"
|
|
546
546
|
}
|
|
547
547
|
/**
|
|
548
548
|
* Property keys for Returns
|
|
@@ -225,15 +225,15 @@ var ReturnsCpe4Type;
|
|
|
225
225
|
* Cpe 5 Grade (Field Operations - Returns)
|
|
226
226
|
*
|
|
227
227
|
* @remarks Available options:
|
|
228
|
-
* - `
|
|
229
|
-
* - `
|
|
230
|
-
* - `
|
|
228
|
+
* - `E` - Fail - Cosmetic
|
|
229
|
+
* - `F` - Fail - Technical
|
|
230
|
+
* - `D` - Pass
|
|
231
231
|
*/
|
|
232
232
|
var ReturnsCpe5Grade;
|
|
233
233
|
(function (ReturnsCpe5Grade) {
|
|
234
|
-
ReturnsCpe5Grade["
|
|
235
|
-
ReturnsCpe5Grade["
|
|
236
|
-
ReturnsCpe5Grade["
|
|
234
|
+
ReturnsCpe5Grade["FAIL_COSMETIC"] = "E";
|
|
235
|
+
ReturnsCpe5Grade["FAIL_TECHNICAL"] = "F";
|
|
236
|
+
ReturnsCpe5Grade["PASS"] = "D";
|
|
237
237
|
})(ReturnsCpe5Grade = exports.ReturnsCpe5Grade || (exports.ReturnsCpe5Grade = {}));
|
|
238
238
|
/**
|
|
239
239
|
* Valid values for Returns.Cpe3Model
|
|
@@ -292,15 +292,15 @@ var ReturnsCpe3Model;
|
|
|
292
292
|
* Cpe 1 Grade (Field Operations - Returns)
|
|
293
293
|
*
|
|
294
294
|
* @remarks Available options:
|
|
295
|
-
* - `
|
|
296
|
-
* - `
|
|
297
|
-
* - `
|
|
295
|
+
* - `E` - Fail - Cosmetic
|
|
296
|
+
* - `F` - Fail - Technical
|
|
297
|
+
* - `D` - Pass
|
|
298
298
|
*/
|
|
299
299
|
var ReturnsCpe1Grade;
|
|
300
300
|
(function (ReturnsCpe1Grade) {
|
|
301
|
-
ReturnsCpe1Grade["
|
|
302
|
-
ReturnsCpe1Grade["
|
|
303
|
-
ReturnsCpe1Grade["
|
|
301
|
+
ReturnsCpe1Grade["FAIL_COSMETIC"] = "E";
|
|
302
|
+
ReturnsCpe1Grade["FAIL_TECHNICAL"] = "F";
|
|
303
|
+
ReturnsCpe1Grade["PASS"] = "D";
|
|
304
304
|
})(ReturnsCpe1Grade = exports.ReturnsCpe1Grade || (exports.ReturnsCpe1Grade = {}));
|
|
305
305
|
/**
|
|
306
306
|
* Valid values for Returns.Cpe2Type
|
|
@@ -488,15 +488,15 @@ var ReturnsCpe2Model;
|
|
|
488
488
|
* Cpe 4 Grade (Field Operations - Returns)
|
|
489
489
|
*
|
|
490
490
|
* @remarks Available options:
|
|
491
|
-
* - `
|
|
492
|
-
* - `
|
|
493
|
-
* - `
|
|
491
|
+
* - `E` - Fail - Cosmetic
|
|
492
|
+
* - `F` - Fail - Technical
|
|
493
|
+
* - `D` - Pass
|
|
494
494
|
*/
|
|
495
495
|
var ReturnsCpe4Grade;
|
|
496
496
|
(function (ReturnsCpe4Grade) {
|
|
497
|
-
ReturnsCpe4Grade["
|
|
498
|
-
ReturnsCpe4Grade["
|
|
499
|
-
ReturnsCpe4Grade["
|
|
497
|
+
ReturnsCpe4Grade["FAIL_COSMETIC"] = "E";
|
|
498
|
+
ReturnsCpe4Grade["FAIL_TECHNICAL"] = "F";
|
|
499
|
+
ReturnsCpe4Grade["PASS"] = "D";
|
|
500
500
|
})(ReturnsCpe4Grade = exports.ReturnsCpe4Grade || (exports.ReturnsCpe4Grade = {}));
|
|
501
501
|
/**
|
|
502
502
|
* Valid values for Returns.InspectedBy
|
|
@@ -524,15 +524,15 @@ var ReturnsInspectedBy;
|
|
|
524
524
|
* Cpe 3 Grade (Field Operations - Returns)
|
|
525
525
|
*
|
|
526
526
|
* @remarks Available options:
|
|
527
|
-
* - `
|
|
528
|
-
* - `
|
|
529
|
-
* - `
|
|
527
|
+
* - `E` - Fail - Cosmetic
|
|
528
|
+
* - `F` - Fail - Technical
|
|
529
|
+
* - `D` - Pass
|
|
530
530
|
*/
|
|
531
531
|
var ReturnsCpe3Grade;
|
|
532
532
|
(function (ReturnsCpe3Grade) {
|
|
533
|
-
ReturnsCpe3Grade["
|
|
534
|
-
ReturnsCpe3Grade["
|
|
535
|
-
ReturnsCpe3Grade["
|
|
533
|
+
ReturnsCpe3Grade["FAIL_COSMETIC"] = "E";
|
|
534
|
+
ReturnsCpe3Grade["FAIL_TECHNICAL"] = "F";
|
|
535
|
+
ReturnsCpe3Grade["PASS"] = "D";
|
|
536
536
|
})(ReturnsCpe3Grade = exports.ReturnsCpe3Grade || (exports.ReturnsCpe3Grade = {}));
|
|
537
537
|
/**
|
|
538
538
|
* Valid values for Returns.Tv1Type
|
|
@@ -554,15 +554,15 @@ var ReturnsTv1Type;
|
|
|
554
554
|
* Cpe 2 Grade (Field Operations - Returns)
|
|
555
555
|
*
|
|
556
556
|
* @remarks Available options:
|
|
557
|
-
* - `
|
|
558
|
-
* - `
|
|
559
|
-
* - `
|
|
557
|
+
* - `E` - Fail - Cosmetic
|
|
558
|
+
* - `F` - Fail - Technical
|
|
559
|
+
* - `D` - Pass
|
|
560
560
|
*/
|
|
561
561
|
var ReturnsCpe2Grade;
|
|
562
562
|
(function (ReturnsCpe2Grade) {
|
|
563
|
-
ReturnsCpe2Grade["
|
|
564
|
-
ReturnsCpe2Grade["
|
|
565
|
-
ReturnsCpe2Grade["
|
|
563
|
+
ReturnsCpe2Grade["FAIL_COSMETIC"] = "E";
|
|
564
|
+
ReturnsCpe2Grade["FAIL_TECHNICAL"] = "F";
|
|
565
|
+
ReturnsCpe2Grade["PASS"] = "D";
|
|
566
566
|
})(ReturnsCpe2Grade = exports.ReturnsCpe2Grade || (exports.ReturnsCpe2Grade = {}));
|
|
567
567
|
/**
|
|
568
568
|
* Property keys for Returns
|