@d19n/youfibre-odin-sdk 2.0.321 → 2.0.322
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 -2
- package/dist/actions-v2/CompleteServiceWorkOrderFlowDto.d.ts +14 -14
- package/dist/actions-v2/CompleteServiceWorkOrderFlowDto.js +22 -22
- package/dist/actions-v2/DefaultServiceWorkOrderEditFormDto.d.ts +8 -1
- package/dist/actions-v2/UpdateCustomerDeviceBatteryDto.d.ts +3 -1
- package/dist/actions-v2/UpdateCustomerDeviceBatteryDto.js +3 -1
- package/dist/api-sdk-v2/CaseApi.d.ts +4 -0
- package/dist/api-sdk-v2/CaseApi.js +12 -0
- package/dist/api-sdk-v2/CoachingSessionApi.d.ts +50 -0
- package/dist/api-sdk-v2/CoachingSessionApi.js +161 -0
- package/dist/api-sdk-v2/QaEvaluationAnswerApi.d.ts +48 -0
- package/dist/api-sdk-v2/QaEvaluationAnswerApi.js +155 -0
- package/dist/api-sdk-v2/QaEvaluationApi.d.ts +54 -0
- package/dist/api-sdk-v2/QaEvaluationApi.js +173 -0
- package/dist/api-sdk-v2/QaScorecardQuestionApi.d.ts +48 -0
- package/dist/api-sdk-v2/QaScorecardQuestionApi.js +155 -0
- package/dist/api-sdk-v2/QaScorecardTemplateApi.d.ts +50 -0
- package/dist/api-sdk-v2/QaScorecardTemplateApi.js +161 -0
- package/dist/db-sdk-v2/CaseDb.d.ts +4 -0
- package/dist/db-sdk-v2/CaseDb.js +12 -0
- package/dist/db-sdk-v2/CoachingSessionDb.d.ts +122 -0
- package/dist/db-sdk-v2/CoachingSessionDb.js +210 -0
- package/dist/db-sdk-v2/QaEvaluationAnswerDb.d.ts +120 -0
- package/dist/db-sdk-v2/QaEvaluationAnswerDb.js +204 -0
- package/dist/db-sdk-v2/QaEvaluationDb.d.ts +126 -0
- package/dist/db-sdk-v2/QaEvaluationDb.js +222 -0
- package/dist/db-sdk-v2/QaScorecardQuestionDb.d.ts +120 -0
- package/dist/db-sdk-v2/QaScorecardQuestionDb.js +204 -0
- package/dist/db-sdk-v2/QaScorecardTemplateDb.d.ts +122 -0
- package/dist/db-sdk-v2/QaScorecardTemplateDb.js +210 -0
- package/dist/entities-v2/Case.d.ts +14 -0
- package/dist/entities-v2/Case.js +9 -1
- package/dist/entities-v2/CoachingSession.d.ts +247 -0
- package/dist/entities-v2/CoachingSession.js +145 -0
- package/dist/entities-v2/CustomerDeviceRouter.d.ts +258 -8
- package/dist/entities-v2/CustomerDeviceRouter.js +17 -9
- package/dist/entities-v2/QaEvaluation.d.ts +361 -0
- package/dist/entities-v2/QaEvaluation.js +217 -0
- package/dist/entities-v2/QaEvaluationAnswer.d.ts +127 -0
- package/dist/entities-v2/QaEvaluationAnswer.js +92 -0
- package/dist/entities-v2/QaScorecardQuestion.d.ts +155 -0
- package/dist/entities-v2/QaScorecardQuestion.js +96 -0
- package/dist/entities-v2/QaScorecardTemplate.d.ts +152 -0
- package/dist/entities-v2/QaScorecardTemplate.js +114 -0
- package/dist/entities-v2/WorkOrder.d.ts +210 -1
- package/dist/entities-v2/WorkOrder.js +22 -4
- package/dist/entities-v2/YfFieldVisitOutcomeForm.d.ts +4 -3
- package/dist/entities-v2/YfFieldVisitOutcomeForm.js +2 -1
- package/dist/records-v2/CustomerDeviceRouterRecord.d.ts +38 -2
- package/dist/records-v2/CustomerDeviceRouterRecord.js +37 -0
- package/dist/records-v2/WorkOrderRecord.d.ts +4 -4
- package/dist/records-v2/WorkOrderRecord.js +4 -4
- package/dist/records-v2/YfFieldVisitOutcomeFormRecord.d.ts +5 -4
- package/dist/records-v2/YfFieldVisitOutcomeFormRecord.js +5 -5
- package/package.json +1 -1
|
@@ -0,0 +1,247 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* CoachingSession Entity Definition
|
|
3
|
+
*
|
|
4
|
+
* One coaching conversation with one agent, normally created from a submitted QA evaluation. Tracked to completion, acknowledged by the agent, and measured by the change in their QA scores either side.
|
|
5
|
+
*
|
|
6
|
+
* @module SupportModule
|
|
7
|
+
* @entity CoachingSession
|
|
8
|
+
* @schemaId d1cf0d88-2b19-4ae1-b565-8d1b04e50522
|
|
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 { QaEvaluationProperties } from './QaEvaluation';
|
|
15
|
+
import { CaseProperties } from './Case';
|
|
16
|
+
/**
|
|
17
|
+
* Available types for CoachingSession records
|
|
18
|
+
*/
|
|
19
|
+
export declare enum CoachingSessionEntityTypes {
|
|
20
|
+
/** This is the default record type */
|
|
21
|
+
DEFAULT = "DEFAULT"
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* Pipeline stage names for DEFAULT CoachingSession
|
|
25
|
+
* Pipeline: Coaching Session Pipeline
|
|
26
|
+
* Scheduled → Completed → Acknowledged, with Cancelled reachable from either live stage. Overdue is NOT a stage: it is Scheduled with DueAt in the past, derived at read time.
|
|
27
|
+
*/
|
|
28
|
+
export declare enum DefaultCoachingSessionStageNames {
|
|
29
|
+
/** Booked, not yet held. Reads as overdue wherever DueAt has passed. (default) */
|
|
30
|
+
Scheduled = "Scheduled",
|
|
31
|
+
/** The conversation happened and the coach recorded what was agreed. Not terminal — the agent has not yet confirmed understanding. */
|
|
32
|
+
Completed = "Completed",
|
|
33
|
+
/** The coached agent confirmed understanding. The success state, and the only one that shows the process actually worked. (success) */
|
|
34
|
+
Acknowledged = "Acknowledged",
|
|
35
|
+
/** The session will not happen. Excluded from the completion-rate denominator, so cancelling is never a way to improve the number. (fail) */
|
|
36
|
+
Cancelled = "Cancelled"
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* Pipeline stage keys for DEFAULT CoachingSession
|
|
40
|
+
* Use these keys when transitioning between stages
|
|
41
|
+
*/
|
|
42
|
+
export declare enum DefaultCoachingSessionStageKeys {
|
|
43
|
+
/** Booked, not yet held. Reads as overdue wherever DueAt has passed. */
|
|
44
|
+
CoachingSessionStageScheduled = "CoachingSessionStageScheduled",
|
|
45
|
+
/** The conversation happened and the coach recorded what was agreed. Not terminal — the agent has not yet confirmed understanding. */
|
|
46
|
+
CoachingSessionStageCompleted = "CoachingSessionStageCompleted",
|
|
47
|
+
/** The coached agent confirmed understanding. The success state, and the only one that shows the process actually worked. */
|
|
48
|
+
CoachingSessionStageAcknowledged = "CoachingSessionStageAcknowledged",
|
|
49
|
+
/** The session will not happen. Excluded from the completion-rate denominator, so cancelling is never a way to improve the number. */
|
|
50
|
+
CoachingSessionStageCancelled = "CoachingSessionStageCancelled"
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
* Valid values for CoachingSession.FocusArea
|
|
54
|
+
*
|
|
55
|
+
* What the session is about, for reporting across a team.
|
|
56
|
+
*
|
|
57
|
+
* @remarks Available options:
|
|
58
|
+
* - `COMPLIANCE` - Compliance
|
|
59
|
+
* - `PROCESS` - Process
|
|
60
|
+
* - `SKILLS` - Skills
|
|
61
|
+
* - `SOFT_SKILLS` - Soft skills
|
|
62
|
+
*/
|
|
63
|
+
export declare enum CoachingSessionFocusArea {
|
|
64
|
+
COMPLIANCE = "COMPLIANCE",
|
|
65
|
+
PROCESS = "PROCESS",
|
|
66
|
+
SKILLS = "SKILLS",
|
|
67
|
+
SOFT_SKILLS = "SOFT_SKILLS"
|
|
68
|
+
}
|
|
69
|
+
/**
|
|
70
|
+
* Property keys for CoachingSession
|
|
71
|
+
* Use these constants instead of string literals for type safety
|
|
72
|
+
*/
|
|
73
|
+
export declare enum CoachingSessionPropertyKeys {
|
|
74
|
+
/** Point-in-time name of the coached agent. */
|
|
75
|
+
AgentName = "AgentName",
|
|
76
|
+
/** Who is running the session — the principal that created it. */
|
|
77
|
+
CoachId = "CoachId",
|
|
78
|
+
/** What the session is about, for reporting across a team. */
|
|
79
|
+
FocusArea = "FocusArea",
|
|
80
|
+
/** The coach’s commitment. A Scheduled session past this date reads as overdue — derived at read time, never stored as a stage. */
|
|
81
|
+
DueAt = "DueAt",
|
|
82
|
+
/** When the agent confirmed understanding. Only the coached agent can set it; a coach cannot acknowledge on their behalf. */
|
|
83
|
+
AgentAcknowledgedAt = "AgentAcknowledgedAt",
|
|
84
|
+
/** The evaluation that triggered the session, if any. Coaching can also be raised directly against a Case. */
|
|
85
|
+
SourceQaEvaluationId = "SourceQaEvaluationId",
|
|
86
|
+
/** Point-in-time name of the coach. */
|
|
87
|
+
CoachName = "CoachName",
|
|
88
|
+
/** The agent’s team when the session was created. */
|
|
89
|
+
TeamId = "TeamId",
|
|
90
|
+
/** Scorecard question ids that triggered the session, e.g. ["EMAIL.BEHAV.12"]. Ids rather than prose so recurring themes and repeat failures are countable across a team. */
|
|
91
|
+
Themes = "Themes",
|
|
92
|
+
/** When the conversation happened. The anchor for the effectiveness windows — the agent’s scores 30 days either side of this. */
|
|
93
|
+
CompletedAt = "CompletedAt",
|
|
94
|
+
/** The coached agent. Only this user may acknowledge the session. */
|
|
95
|
+
AgentId = "AgentId",
|
|
96
|
+
/** Why the session was raised, in the coach’s words. */
|
|
97
|
+
Reason = "Reason",
|
|
98
|
+
/** What the agent agreed to do differently. */
|
|
99
|
+
ActionItems = "ActionItems",
|
|
100
|
+
/** What good looks like next time — what the follow-up will be measured against. */
|
|
101
|
+
ExpectedOutcome = "ExpectedOutcome",
|
|
102
|
+
/** When the session is booked for. */
|
|
103
|
+
ScheduledAt = "ScheduledAt",
|
|
104
|
+
/** The previous session this one follows up, so a reassessment chain can be read end to end. */
|
|
105
|
+
FollowUpOfId = "FollowUpOfId"
|
|
106
|
+
}
|
|
107
|
+
/**
|
|
108
|
+
* Properties for CoachingSession records
|
|
109
|
+
*
|
|
110
|
+
* @see SupportModule:CoachingSession
|
|
111
|
+
*/
|
|
112
|
+
export interface CoachingSessionProperties {
|
|
113
|
+
/** Point-in-time name of the coached agent.
|
|
114
|
+
*
|
|
115
|
+
* @type {TEXT}
|
|
116
|
+
* @default
|
|
117
|
+
*/
|
|
118
|
+
AgentName: string;
|
|
119
|
+
/** Who is running the session — the principal that created it.
|
|
120
|
+
*
|
|
121
|
+
* @type {TEXT}
|
|
122
|
+
* @default
|
|
123
|
+
*/
|
|
124
|
+
CoachId: string;
|
|
125
|
+
/** What the session is about, for reporting across a team.
|
|
126
|
+
*
|
|
127
|
+
* @type {ENUM}
|
|
128
|
+
* @default
|
|
129
|
+
* @enum {CoachingSessionFocusArea}
|
|
130
|
+
*/
|
|
131
|
+
FocusArea: CoachingSessionFocusArea;
|
|
132
|
+
/** The coach’s commitment. A Scheduled session past this date reads as overdue — derived at read time, never stored as a stage.
|
|
133
|
+
*
|
|
134
|
+
* @type {DATE_TIME}
|
|
135
|
+
* @default
|
|
136
|
+
*/
|
|
137
|
+
DueAt: string;
|
|
138
|
+
/** When the agent confirmed understanding. Only the coached agent can set it; a coach cannot acknowledge on their behalf.
|
|
139
|
+
*
|
|
140
|
+
* @type {DATE_TIME}
|
|
141
|
+
* @default
|
|
142
|
+
*/
|
|
143
|
+
AgentAcknowledgedAt: string;
|
|
144
|
+
/** The evaluation that triggered the session, if any. Coaching can also be raised directly against a Case.
|
|
145
|
+
*
|
|
146
|
+
* @type {TEXT}
|
|
147
|
+
* @default
|
|
148
|
+
*/
|
|
149
|
+
SourceQaEvaluationId: string;
|
|
150
|
+
/** Point-in-time name of the coach.
|
|
151
|
+
*
|
|
152
|
+
* @type {TEXT}
|
|
153
|
+
* @default
|
|
154
|
+
*/
|
|
155
|
+
CoachName: string;
|
|
156
|
+
/** The agent’s team when the session was created.
|
|
157
|
+
*
|
|
158
|
+
* @type {TEXT}
|
|
159
|
+
* @default
|
|
160
|
+
*/
|
|
161
|
+
TeamId: string;
|
|
162
|
+
/** Scorecard question ids that triggered the session, e.g. ["EMAIL.BEHAV.12"]. Ids rather than prose so recurring themes and repeat failures are countable across a team.
|
|
163
|
+
*
|
|
164
|
+
* @type {JSON}
|
|
165
|
+
* @default
|
|
166
|
+
*/
|
|
167
|
+
Themes: string;
|
|
168
|
+
/** When the conversation happened. The anchor for the effectiveness windows — the agent’s scores 30 days either side of this.
|
|
169
|
+
*
|
|
170
|
+
* @type {DATE_TIME}
|
|
171
|
+
* @default
|
|
172
|
+
*/
|
|
173
|
+
CompletedAt: string;
|
|
174
|
+
/** The coached agent. Only this user may acknowledge the session.
|
|
175
|
+
*
|
|
176
|
+
* @type {TEXT}
|
|
177
|
+
* @default
|
|
178
|
+
*/
|
|
179
|
+
AgentId: string;
|
|
180
|
+
/** Why the session was raised, in the coach’s words.
|
|
181
|
+
*
|
|
182
|
+
* @type {TEXT_LONG}
|
|
183
|
+
* @default
|
|
184
|
+
*/
|
|
185
|
+
Reason: string;
|
|
186
|
+
/** What the agent agreed to do differently.
|
|
187
|
+
*
|
|
188
|
+
* @type {TEXT_LONG}
|
|
189
|
+
* @default
|
|
190
|
+
*/
|
|
191
|
+
ActionItems: string;
|
|
192
|
+
/** What good looks like next time — what the follow-up will be measured against.
|
|
193
|
+
*
|
|
194
|
+
* @type {TEXT_LONG}
|
|
195
|
+
* @default
|
|
196
|
+
*/
|
|
197
|
+
ExpectedOutcome: string;
|
|
198
|
+
/** When the session is booked for.
|
|
199
|
+
*
|
|
200
|
+
* @type {DATE_TIME}
|
|
201
|
+
* @default
|
|
202
|
+
*/
|
|
203
|
+
ScheduledAt: string;
|
|
204
|
+
/** The previous session this one follows up, so a reassessment chain can be read end to end.
|
|
205
|
+
*
|
|
206
|
+
* @type {TEXT}
|
|
207
|
+
* @default
|
|
208
|
+
*/
|
|
209
|
+
FollowUpOfId: string;
|
|
210
|
+
}
|
|
211
|
+
/**
|
|
212
|
+
* CoachingSession entity from SupportModule
|
|
213
|
+
*
|
|
214
|
+
* One coaching conversation with one agent, normally created from a submitted QA evaluation. Tracked to completion, acknowledged by the agent, and measured by the change in their QA scores either side.
|
|
215
|
+
*
|
|
216
|
+
* @module SupportModule
|
|
217
|
+
* @entity CoachingSession
|
|
218
|
+
* @schemaId d1cf0d88-2b19-4ae1-b565-8d1b04e50522
|
|
219
|
+
* @recordPrefix COACH
|
|
220
|
+
* @capabilities searchable, updateable, undeletable, triggerable
|
|
221
|
+
*/
|
|
222
|
+
export declare class CoachingSession extends OdinRecord<CoachingSessionProperties> {
|
|
223
|
+
entity: 'SupportModule:CoachingSession';
|
|
224
|
+
type: CoachingSessionEntityTypes;
|
|
225
|
+
schemaId: 'd1cf0d88-2b19-4ae1-b565-8d1b04e50522';
|
|
226
|
+
properties: CoachingSessionProperties;
|
|
227
|
+
/** Linked QaEvaluation records (QaEvaluation__CoachingSession) */
|
|
228
|
+
QaEvaluation: OdinLink<LinkedOdinRecord<QaEvaluationProperties>>;
|
|
229
|
+
/** Linked Case records (Case__CoachingSession) */
|
|
230
|
+
Case: OdinLink<LinkedOdinRecord<CaseProperties>>;
|
|
231
|
+
}
|
|
232
|
+
/**
|
|
233
|
+
* RabbitMQ routing keys for CoachingSession events
|
|
234
|
+
*/
|
|
235
|
+
export declare const ROUTING_KEY_COACHING_SESSION_CREATED = "SupportModule.CoachingSession.SubDbRecordCreated";
|
|
236
|
+
export declare const ROUTING_KEY_COACHING_SESSION_UPDATED = "SupportModule.CoachingSession.SubDbRecordUpdated";
|
|
237
|
+
export declare const ROUTING_KEY_COACHING_SESSION_DELETED = "SupportModule.CoachingSession.SubDbRecordDeleted";
|
|
238
|
+
/**
|
|
239
|
+
* Type-specific routing keys for CoachingSession events
|
|
240
|
+
* Subscribe to these for events on specific entity types only
|
|
241
|
+
*/
|
|
242
|
+
/** This is the default record type created */
|
|
243
|
+
export declare const ROUTING_KEY_COACHING_SESSION_DEFAULT_CREATED = "SupportModule.CoachingSession.DEFAULT.SubDbRecordCreated";
|
|
244
|
+
/** This is the default record type updated */
|
|
245
|
+
export declare const ROUTING_KEY_COACHING_SESSION_DEFAULT_UPDATED = "SupportModule.CoachingSession.DEFAULT.SubDbRecordUpdated";
|
|
246
|
+
/** This is the default record type deleted */
|
|
247
|
+
export declare const ROUTING_KEY_COACHING_SESSION_DEFAULT_DELETED = "SupportModule.CoachingSession.DEFAULT.SubDbRecordDeleted";
|
|
@@ -0,0 +1,145 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* CoachingSession Entity Definition
|
|
4
|
+
*
|
|
5
|
+
* One coaching conversation with one agent, normally created from a submitted QA evaluation. Tracked to completion, acknowledged by the agent, and measured by the change in their QA scores either side.
|
|
6
|
+
*
|
|
7
|
+
* @module SupportModule
|
|
8
|
+
* @entity CoachingSession
|
|
9
|
+
* @schemaId d1cf0d88-2b19-4ae1-b565-8d1b04e50522
|
|
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_COACHING_SESSION_DEFAULT_DELETED = exports.ROUTING_KEY_COACHING_SESSION_DEFAULT_UPDATED = exports.ROUTING_KEY_COACHING_SESSION_DEFAULT_CREATED = exports.ROUTING_KEY_COACHING_SESSION_DELETED = exports.ROUTING_KEY_COACHING_SESSION_UPDATED = exports.ROUTING_KEY_COACHING_SESSION_CREATED = exports.CoachingSession = exports.CoachingSessionPropertyKeys = exports.CoachingSessionFocusArea = exports.DefaultCoachingSessionStageKeys = exports.DefaultCoachingSessionStageNames = exports.CoachingSessionEntityTypes = void 0;
|
|
16
|
+
const core_1 = require("@d19n/odin-types/dist/core");
|
|
17
|
+
/**
|
|
18
|
+
* Available types for CoachingSession records
|
|
19
|
+
*/
|
|
20
|
+
var CoachingSessionEntityTypes;
|
|
21
|
+
(function (CoachingSessionEntityTypes) {
|
|
22
|
+
/** This is the default record type */
|
|
23
|
+
CoachingSessionEntityTypes["DEFAULT"] = "DEFAULT";
|
|
24
|
+
})(CoachingSessionEntityTypes = exports.CoachingSessionEntityTypes || (exports.CoachingSessionEntityTypes = {}));
|
|
25
|
+
/**
|
|
26
|
+
* Pipeline stage names for DEFAULT CoachingSession
|
|
27
|
+
* Pipeline: Coaching Session Pipeline
|
|
28
|
+
* Scheduled → Completed → Acknowledged, with Cancelled reachable from either live stage. Overdue is NOT a stage: it is Scheduled with DueAt in the past, derived at read time.
|
|
29
|
+
*/
|
|
30
|
+
var DefaultCoachingSessionStageNames;
|
|
31
|
+
(function (DefaultCoachingSessionStageNames) {
|
|
32
|
+
/** Booked, not yet held. Reads as overdue wherever DueAt has passed. (default) */
|
|
33
|
+
DefaultCoachingSessionStageNames["Scheduled"] = "Scheduled";
|
|
34
|
+
/** The conversation happened and the coach recorded what was agreed. Not terminal — the agent has not yet confirmed understanding. */
|
|
35
|
+
DefaultCoachingSessionStageNames["Completed"] = "Completed";
|
|
36
|
+
/** The coached agent confirmed understanding. The success state, and the only one that shows the process actually worked. (success) */
|
|
37
|
+
DefaultCoachingSessionStageNames["Acknowledged"] = "Acknowledged";
|
|
38
|
+
/** The session will not happen. Excluded from the completion-rate denominator, so cancelling is never a way to improve the number. (fail) */
|
|
39
|
+
DefaultCoachingSessionStageNames["Cancelled"] = "Cancelled";
|
|
40
|
+
})(DefaultCoachingSessionStageNames = exports.DefaultCoachingSessionStageNames || (exports.DefaultCoachingSessionStageNames = {}));
|
|
41
|
+
/**
|
|
42
|
+
* Pipeline stage keys for DEFAULT CoachingSession
|
|
43
|
+
* Use these keys when transitioning between stages
|
|
44
|
+
*/
|
|
45
|
+
var DefaultCoachingSessionStageKeys;
|
|
46
|
+
(function (DefaultCoachingSessionStageKeys) {
|
|
47
|
+
/** Booked, not yet held. Reads as overdue wherever DueAt has passed. */
|
|
48
|
+
DefaultCoachingSessionStageKeys["CoachingSessionStageScheduled"] = "CoachingSessionStageScheduled";
|
|
49
|
+
/** The conversation happened and the coach recorded what was agreed. Not terminal — the agent has not yet confirmed understanding. */
|
|
50
|
+
DefaultCoachingSessionStageKeys["CoachingSessionStageCompleted"] = "CoachingSessionStageCompleted";
|
|
51
|
+
/** The coached agent confirmed understanding. The success state, and the only one that shows the process actually worked. */
|
|
52
|
+
DefaultCoachingSessionStageKeys["CoachingSessionStageAcknowledged"] = "CoachingSessionStageAcknowledged";
|
|
53
|
+
/** The session will not happen. Excluded from the completion-rate denominator, so cancelling is never a way to improve the number. */
|
|
54
|
+
DefaultCoachingSessionStageKeys["CoachingSessionStageCancelled"] = "CoachingSessionStageCancelled";
|
|
55
|
+
})(DefaultCoachingSessionStageKeys = exports.DefaultCoachingSessionStageKeys || (exports.DefaultCoachingSessionStageKeys = {}));
|
|
56
|
+
/**
|
|
57
|
+
* Valid values for CoachingSession.FocusArea
|
|
58
|
+
*
|
|
59
|
+
* What the session is about, for reporting across a team.
|
|
60
|
+
*
|
|
61
|
+
* @remarks Available options:
|
|
62
|
+
* - `COMPLIANCE` - Compliance
|
|
63
|
+
* - `PROCESS` - Process
|
|
64
|
+
* - `SKILLS` - Skills
|
|
65
|
+
* - `SOFT_SKILLS` - Soft skills
|
|
66
|
+
*/
|
|
67
|
+
var CoachingSessionFocusArea;
|
|
68
|
+
(function (CoachingSessionFocusArea) {
|
|
69
|
+
CoachingSessionFocusArea["COMPLIANCE"] = "COMPLIANCE";
|
|
70
|
+
CoachingSessionFocusArea["PROCESS"] = "PROCESS";
|
|
71
|
+
CoachingSessionFocusArea["SKILLS"] = "SKILLS";
|
|
72
|
+
CoachingSessionFocusArea["SOFT_SKILLS"] = "SOFT_SKILLS";
|
|
73
|
+
})(CoachingSessionFocusArea = exports.CoachingSessionFocusArea || (exports.CoachingSessionFocusArea = {}));
|
|
74
|
+
/**
|
|
75
|
+
* Property keys for CoachingSession
|
|
76
|
+
* Use these constants instead of string literals for type safety
|
|
77
|
+
*/
|
|
78
|
+
var CoachingSessionPropertyKeys;
|
|
79
|
+
(function (CoachingSessionPropertyKeys) {
|
|
80
|
+
/** Point-in-time name of the coached agent. */
|
|
81
|
+
CoachingSessionPropertyKeys["AgentName"] = "AgentName";
|
|
82
|
+
/** Who is running the session — the principal that created it. */
|
|
83
|
+
CoachingSessionPropertyKeys["CoachId"] = "CoachId";
|
|
84
|
+
/** What the session is about, for reporting across a team. */
|
|
85
|
+
CoachingSessionPropertyKeys["FocusArea"] = "FocusArea";
|
|
86
|
+
/** The coach’s commitment. A Scheduled session past this date reads as overdue — derived at read time, never stored as a stage. */
|
|
87
|
+
CoachingSessionPropertyKeys["DueAt"] = "DueAt";
|
|
88
|
+
/** When the agent confirmed understanding. Only the coached agent can set it; a coach cannot acknowledge on their behalf. */
|
|
89
|
+
CoachingSessionPropertyKeys["AgentAcknowledgedAt"] = "AgentAcknowledgedAt";
|
|
90
|
+
/** The evaluation that triggered the session, if any. Coaching can also be raised directly against a Case. */
|
|
91
|
+
CoachingSessionPropertyKeys["SourceQaEvaluationId"] = "SourceQaEvaluationId";
|
|
92
|
+
/** Point-in-time name of the coach. */
|
|
93
|
+
CoachingSessionPropertyKeys["CoachName"] = "CoachName";
|
|
94
|
+
/** The agent’s team when the session was created. */
|
|
95
|
+
CoachingSessionPropertyKeys["TeamId"] = "TeamId";
|
|
96
|
+
/** Scorecard question ids that triggered the session, e.g. ["EMAIL.BEHAV.12"]. Ids rather than prose so recurring themes and repeat failures are countable across a team. */
|
|
97
|
+
CoachingSessionPropertyKeys["Themes"] = "Themes";
|
|
98
|
+
/** When the conversation happened. The anchor for the effectiveness windows — the agent’s scores 30 days either side of this. */
|
|
99
|
+
CoachingSessionPropertyKeys["CompletedAt"] = "CompletedAt";
|
|
100
|
+
/** The coached agent. Only this user may acknowledge the session. */
|
|
101
|
+
CoachingSessionPropertyKeys["AgentId"] = "AgentId";
|
|
102
|
+
/** Why the session was raised, in the coach’s words. */
|
|
103
|
+
CoachingSessionPropertyKeys["Reason"] = "Reason";
|
|
104
|
+
/** What the agent agreed to do differently. */
|
|
105
|
+
CoachingSessionPropertyKeys["ActionItems"] = "ActionItems";
|
|
106
|
+
/** What good looks like next time — what the follow-up will be measured against. */
|
|
107
|
+
CoachingSessionPropertyKeys["ExpectedOutcome"] = "ExpectedOutcome";
|
|
108
|
+
/** When the session is booked for. */
|
|
109
|
+
CoachingSessionPropertyKeys["ScheduledAt"] = "ScheduledAt";
|
|
110
|
+
/** The previous session this one follows up, so a reassessment chain can be read end to end. */
|
|
111
|
+
CoachingSessionPropertyKeys["FollowUpOfId"] = "FollowUpOfId";
|
|
112
|
+
})(CoachingSessionPropertyKeys = exports.CoachingSessionPropertyKeys || (exports.CoachingSessionPropertyKeys = {}));
|
|
113
|
+
/**
|
|
114
|
+
* CoachingSession entity from SupportModule
|
|
115
|
+
*
|
|
116
|
+
* One coaching conversation with one agent, normally created from a submitted QA evaluation. Tracked to completion, acknowledged by the agent, and measured by the change in their QA scores either side.
|
|
117
|
+
*
|
|
118
|
+
* @module SupportModule
|
|
119
|
+
* @entity CoachingSession
|
|
120
|
+
* @schemaId d1cf0d88-2b19-4ae1-b565-8d1b04e50522
|
|
121
|
+
* @recordPrefix COACH
|
|
122
|
+
* @capabilities searchable, updateable, undeletable, triggerable
|
|
123
|
+
*/
|
|
124
|
+
class CoachingSession extends core_1.OdinRecord {
|
|
125
|
+
}
|
|
126
|
+
exports.CoachingSession = CoachingSession;
|
|
127
|
+
// ============================================
|
|
128
|
+
// RABBITMQ EVENT ROUTING KEYS
|
|
129
|
+
// ============================================
|
|
130
|
+
/**
|
|
131
|
+
* RabbitMQ routing keys for CoachingSession events
|
|
132
|
+
*/
|
|
133
|
+
exports.ROUTING_KEY_COACHING_SESSION_CREATED = 'SupportModule.CoachingSession.SubDbRecordCreated';
|
|
134
|
+
exports.ROUTING_KEY_COACHING_SESSION_UPDATED = 'SupportModule.CoachingSession.SubDbRecordUpdated';
|
|
135
|
+
exports.ROUTING_KEY_COACHING_SESSION_DELETED = 'SupportModule.CoachingSession.SubDbRecordDeleted';
|
|
136
|
+
/**
|
|
137
|
+
* Type-specific routing keys for CoachingSession events
|
|
138
|
+
* Subscribe to these for events on specific entity types only
|
|
139
|
+
*/
|
|
140
|
+
/** This is the default record type created */
|
|
141
|
+
exports.ROUTING_KEY_COACHING_SESSION_DEFAULT_CREATED = 'SupportModule.CoachingSession.DEFAULT.SubDbRecordCreated';
|
|
142
|
+
/** This is the default record type updated */
|
|
143
|
+
exports.ROUTING_KEY_COACHING_SESSION_DEFAULT_UPDATED = 'SupportModule.CoachingSession.DEFAULT.SubDbRecordUpdated';
|
|
144
|
+
/** This is the default record type deleted */
|
|
145
|
+
exports.ROUTING_KEY_COACHING_SESSION_DEFAULT_DELETED = 'SupportModule.CoachingSession.DEFAULT.SubDbRecordDeleted';
|
|
@@ -23,8 +23,10 @@ import { WorkOrderProperties } from './WorkOrder';
|
|
|
23
23
|
* Available types for CustomerDeviceRouter records
|
|
24
24
|
*/
|
|
25
25
|
export declare enum CustomerDeviceRouterEntityTypes {
|
|
26
|
-
/**
|
|
27
|
-
|
|
26
|
+
/** CPE Router */
|
|
27
|
+
CPE_ROUTER = "CPE_ROUTER",
|
|
28
|
+
/** Mesh */
|
|
29
|
+
MESH = "MESH"
|
|
28
30
|
}
|
|
29
31
|
/**
|
|
30
32
|
* Valid values for CustomerDeviceRouter.Model
|
|
@@ -224,6 +226,248 @@ export interface CustomerDeviceRouterProperties {
|
|
|
224
226
|
*/
|
|
225
227
|
LastAction: string;
|
|
226
228
|
}
|
|
229
|
+
/**
|
|
230
|
+
* Properties for CPE_ROUTER CustomerDeviceRouter records
|
|
231
|
+
*
|
|
232
|
+
* @see ServiceModule:CustomerDeviceRouter
|
|
233
|
+
*/
|
|
234
|
+
export interface CpeRouterCustomerDeviceRouterProperties {
|
|
235
|
+
/** network status (Network Operations - CustomerDeviceRouter)
|
|
236
|
+
*
|
|
237
|
+
* @type {TEXT}
|
|
238
|
+
* @hidden This field is hidden in the UI
|
|
239
|
+
*/
|
|
240
|
+
NetworkStatus: string;
|
|
241
|
+
/** the device ownership transfer defined in eero (Network Operations - CustomerDeviceRouter)
|
|
242
|
+
*
|
|
243
|
+
* @type {JSON}
|
|
244
|
+
* @hidden This field is hidden in the UI
|
|
245
|
+
*/
|
|
246
|
+
EeroTransfer: string;
|
|
247
|
+
/** Data field for CustomerDeviceRouter records. Used by Network Operations team.
|
|
248
|
+
*
|
|
249
|
+
* @type {NUMERIC}
|
|
250
|
+
* @hidden This field is hidden in the UI
|
|
251
|
+
*/
|
|
252
|
+
SpeedUp: number;
|
|
253
|
+
/** Data field for CustomerDeviceRouter records. Used by Network Operations team.
|
|
254
|
+
*
|
|
255
|
+
* @type {NUMERIC}
|
|
256
|
+
* @hidden This field is hidden in the UI
|
|
257
|
+
*/
|
|
258
|
+
SpeedDown: number;
|
|
259
|
+
/** Contact information field for CustomerDeviceRouter. Used by Network Operations team for communication.
|
|
260
|
+
*
|
|
261
|
+
* @type {TEXT}
|
|
262
|
+
*/
|
|
263
|
+
IpAddress: string;
|
|
264
|
+
/** Data field for CustomerDeviceRouter records. Used by Network Operations team.
|
|
265
|
+
*
|
|
266
|
+
* @type {TEXT}
|
|
267
|
+
* @hidden This field is hidden in the UI
|
|
268
|
+
*/
|
|
269
|
+
HeartBeat: string;
|
|
270
|
+
/** Data field for CustomerDeviceRouter records. Used by Network Operations team.
|
|
271
|
+
*
|
|
272
|
+
* @type {BOOLEAN}
|
|
273
|
+
*/
|
|
274
|
+
Online: boolean;
|
|
275
|
+
/** speed check date (Network Operations - CustomerDeviceRouter)
|
|
276
|
+
*
|
|
277
|
+
* @type {DATE_TIME}
|
|
278
|
+
* @format DD/MM/YYYY hh:mm:ss
|
|
279
|
+
* @hidden This field is hidden in the UI
|
|
280
|
+
*/
|
|
281
|
+
SpeedCheckDate: string;
|
|
282
|
+
/** wifi password (Network Operations - CustomerDeviceRouter)
|
|
283
|
+
*
|
|
284
|
+
* @type {TEXT}
|
|
285
|
+
*/
|
|
286
|
+
WifiPassword: string;
|
|
287
|
+
/** model of the customer device (Network Operations - CustomerDeviceRouter)
|
|
288
|
+
*
|
|
289
|
+
* @type {ENUM}
|
|
290
|
+
* @enum {CustomerDeviceRouterModel}
|
|
291
|
+
*/
|
|
292
|
+
Model: CustomerDeviceRouterModel;
|
|
293
|
+
/** Reference identifier for CustomerDeviceRouter relationships. Used for data integrity.
|
|
294
|
+
*
|
|
295
|
+
* @type {TEXT}
|
|
296
|
+
*/
|
|
297
|
+
WifiSsid: string;
|
|
298
|
+
/** IpAddressStatic (Network Operations - CustomerDeviceRouter)
|
|
299
|
+
*
|
|
300
|
+
* @type {BOOLEAN}
|
|
301
|
+
*/
|
|
302
|
+
IpAddressStatic: boolean;
|
|
303
|
+
/** network status last checked (Network Operations - CustomerDeviceRouter)
|
|
304
|
+
*
|
|
305
|
+
* @type {DATE_TIME}
|
|
306
|
+
* @format DD/MM/YYYY hh:mm:ss
|
|
307
|
+
* @hidden This field is hidden in the UI
|
|
308
|
+
*/
|
|
309
|
+
NetworkStatusLastChecked: string;
|
|
310
|
+
/** serial number for the customer device, scanned during install (Network Operations - CustomerDeviceRouter)
|
|
311
|
+
*
|
|
312
|
+
* @type {TEXT}
|
|
313
|
+
*/
|
|
314
|
+
SerialNumber: string;
|
|
315
|
+
/** the owner defined in eero (Network Operations - CustomerDeviceRouter)
|
|
316
|
+
*
|
|
317
|
+
* @type {TEXT}
|
|
318
|
+
* @hidden This field is hidden in the UI
|
|
319
|
+
*/
|
|
320
|
+
EeroOwner: string;
|
|
321
|
+
/** LastHeartBeat (Network Operations - CustomerDeviceRouter)
|
|
322
|
+
*
|
|
323
|
+
* @type {DATE_TIME}
|
|
324
|
+
* @format DD/MM/YYYY hh:mm:ss
|
|
325
|
+
* @hidden This field is hidden in the UI
|
|
326
|
+
*/
|
|
327
|
+
LastHeartBeat: string;
|
|
328
|
+
/** mac address (Network Operations - CustomerDeviceRouter)
|
|
329
|
+
*
|
|
330
|
+
* @type {TEXT}
|
|
331
|
+
*/
|
|
332
|
+
MacAddress: string;
|
|
333
|
+
/** installer defined in eero (Network Operations - CustomerDeviceRouter)
|
|
334
|
+
*
|
|
335
|
+
* @type {TEXT}
|
|
336
|
+
* @hidden This field is hidden in the UI
|
|
337
|
+
*/
|
|
338
|
+
EeroInstaller: string;
|
|
339
|
+
/** LastActionDate (Network Operations - CustomerDeviceRouter)
|
|
340
|
+
*
|
|
341
|
+
* @type {DATE_TIME}
|
|
342
|
+
*/
|
|
343
|
+
LastActionDate: string;
|
|
344
|
+
/** Data field for CustomerDeviceRouter records. Used by Network Operations team.
|
|
345
|
+
*
|
|
346
|
+
* @type {TEXT}
|
|
347
|
+
*/
|
|
348
|
+
LastAction: string;
|
|
349
|
+
}
|
|
350
|
+
/**
|
|
351
|
+
* Properties for MESH CustomerDeviceRouter records
|
|
352
|
+
*
|
|
353
|
+
* @see ServiceModule:CustomerDeviceRouter
|
|
354
|
+
*/
|
|
355
|
+
export interface MeshCustomerDeviceRouterProperties {
|
|
356
|
+
/** network status (Network Operations - CustomerDeviceRouter)
|
|
357
|
+
*
|
|
358
|
+
* @type {TEXT}
|
|
359
|
+
* @hidden This field is hidden in the UI
|
|
360
|
+
*/
|
|
361
|
+
NetworkStatus: string;
|
|
362
|
+
/** the device ownership transfer defined in eero (Network Operations - CustomerDeviceRouter)
|
|
363
|
+
*
|
|
364
|
+
* @type {JSON}
|
|
365
|
+
* @hidden This field is hidden in the UI
|
|
366
|
+
*/
|
|
367
|
+
EeroTransfer: string;
|
|
368
|
+
/** Data field for CustomerDeviceRouter records. Used by Network Operations team.
|
|
369
|
+
*
|
|
370
|
+
* @type {NUMERIC}
|
|
371
|
+
* @hidden This field is hidden in the UI
|
|
372
|
+
*/
|
|
373
|
+
SpeedUp: number;
|
|
374
|
+
/** Data field for CustomerDeviceRouter records. Used by Network Operations team.
|
|
375
|
+
*
|
|
376
|
+
* @type {NUMERIC}
|
|
377
|
+
* @hidden This field is hidden in the UI
|
|
378
|
+
*/
|
|
379
|
+
SpeedDown: number;
|
|
380
|
+
/** Contact information field for CustomerDeviceRouter. Used by Network Operations team for communication.
|
|
381
|
+
*
|
|
382
|
+
* @type {TEXT}
|
|
383
|
+
*/
|
|
384
|
+
IpAddress: string;
|
|
385
|
+
/** Data field for CustomerDeviceRouter records. Used by Network Operations team.
|
|
386
|
+
*
|
|
387
|
+
* @type {TEXT}
|
|
388
|
+
* @hidden This field is hidden in the UI
|
|
389
|
+
*/
|
|
390
|
+
HeartBeat: string;
|
|
391
|
+
/** Data field for CustomerDeviceRouter records. Used by Network Operations team.
|
|
392
|
+
*
|
|
393
|
+
* @type {BOOLEAN}
|
|
394
|
+
*/
|
|
395
|
+
Online: boolean;
|
|
396
|
+
/** speed check date (Network Operations - CustomerDeviceRouter)
|
|
397
|
+
*
|
|
398
|
+
* @type {DATE_TIME}
|
|
399
|
+
* @format DD/MM/YYYY hh:mm:ss
|
|
400
|
+
* @hidden This field is hidden in the UI
|
|
401
|
+
*/
|
|
402
|
+
SpeedCheckDate: string;
|
|
403
|
+
/** wifi password (Network Operations - CustomerDeviceRouter)
|
|
404
|
+
*
|
|
405
|
+
* @type {TEXT}
|
|
406
|
+
*/
|
|
407
|
+
WifiPassword: string;
|
|
408
|
+
/** model of the customer device (Network Operations - CustomerDeviceRouter)
|
|
409
|
+
*
|
|
410
|
+
* @type {ENUM}
|
|
411
|
+
* @enum {CustomerDeviceRouterModel}
|
|
412
|
+
*/
|
|
413
|
+
Model: CustomerDeviceRouterModel;
|
|
414
|
+
/** Reference identifier for CustomerDeviceRouter relationships. Used for data integrity.
|
|
415
|
+
*
|
|
416
|
+
* @type {TEXT}
|
|
417
|
+
*/
|
|
418
|
+
WifiSsid: string;
|
|
419
|
+
/** IpAddressStatic (Network Operations - CustomerDeviceRouter)
|
|
420
|
+
*
|
|
421
|
+
* @type {BOOLEAN}
|
|
422
|
+
*/
|
|
423
|
+
IpAddressStatic: boolean;
|
|
424
|
+
/** network status last checked (Network Operations - CustomerDeviceRouter)
|
|
425
|
+
*
|
|
426
|
+
* @type {DATE_TIME}
|
|
427
|
+
* @format DD/MM/YYYY hh:mm:ss
|
|
428
|
+
* @hidden This field is hidden in the UI
|
|
429
|
+
*/
|
|
430
|
+
NetworkStatusLastChecked: string;
|
|
431
|
+
/** serial number for the customer device, scanned during install (Network Operations - CustomerDeviceRouter)
|
|
432
|
+
*
|
|
433
|
+
* @type {TEXT}
|
|
434
|
+
*/
|
|
435
|
+
SerialNumber: string;
|
|
436
|
+
/** the owner defined in eero (Network Operations - CustomerDeviceRouter)
|
|
437
|
+
*
|
|
438
|
+
* @type {TEXT}
|
|
439
|
+
* @hidden This field is hidden in the UI
|
|
440
|
+
*/
|
|
441
|
+
EeroOwner: string;
|
|
442
|
+
/** LastHeartBeat (Network Operations - CustomerDeviceRouter)
|
|
443
|
+
*
|
|
444
|
+
* @type {DATE_TIME}
|
|
445
|
+
* @format DD/MM/YYYY hh:mm:ss
|
|
446
|
+
* @hidden This field is hidden in the UI
|
|
447
|
+
*/
|
|
448
|
+
LastHeartBeat: string;
|
|
449
|
+
/** mac address (Network Operations - CustomerDeviceRouter)
|
|
450
|
+
*
|
|
451
|
+
* @type {TEXT}
|
|
452
|
+
*/
|
|
453
|
+
MacAddress: string;
|
|
454
|
+
/** installer defined in eero (Network Operations - CustomerDeviceRouter)
|
|
455
|
+
*
|
|
456
|
+
* @type {TEXT}
|
|
457
|
+
* @hidden This field is hidden in the UI
|
|
458
|
+
*/
|
|
459
|
+
EeroInstaller: string;
|
|
460
|
+
/** LastActionDate (Network Operations - CustomerDeviceRouter)
|
|
461
|
+
*
|
|
462
|
+
* @type {DATE_TIME}
|
|
463
|
+
*/
|
|
464
|
+
LastActionDate: string;
|
|
465
|
+
/** Data field for CustomerDeviceRouter records. Used by Network Operations team.
|
|
466
|
+
*
|
|
467
|
+
* @type {TEXT}
|
|
468
|
+
*/
|
|
469
|
+
LastAction: string;
|
|
470
|
+
}
|
|
227
471
|
/**
|
|
228
472
|
* CustomerDeviceRouter entity from ServiceModule
|
|
229
473
|
*
|
|
@@ -268,12 +512,18 @@ export declare const ROUTING_KEY_CUSTOMER_DEVICE_ROUTER_DELETED = "ServiceModule
|
|
|
268
512
|
* Type-specific routing keys for CustomerDeviceRouter events
|
|
269
513
|
* Subscribe to these for events on specific entity types only
|
|
270
514
|
*/
|
|
271
|
-
/**
|
|
272
|
-
export declare const
|
|
273
|
-
/**
|
|
274
|
-
export declare const
|
|
275
|
-
/**
|
|
276
|
-
export declare const
|
|
515
|
+
/** CPE Router created */
|
|
516
|
+
export declare const ROUTING_KEY_CUSTOMER_DEVICE_ROUTER_CPE_ROUTER_CREATED = "ServiceModule.CustomerDeviceRouter.CPE_ROUTER.SubDbRecordCreated";
|
|
517
|
+
/** CPE Router updated */
|
|
518
|
+
export declare const ROUTING_KEY_CUSTOMER_DEVICE_ROUTER_CPE_ROUTER_UPDATED = "ServiceModule.CustomerDeviceRouter.CPE_ROUTER.SubDbRecordUpdated";
|
|
519
|
+
/** CPE Router deleted */
|
|
520
|
+
export declare const ROUTING_KEY_CUSTOMER_DEVICE_ROUTER_CPE_ROUTER_DELETED = "ServiceModule.CustomerDeviceRouter.CPE_ROUTER.SubDbRecordDeleted";
|
|
521
|
+
/** Mesh created */
|
|
522
|
+
export declare const ROUTING_KEY_CUSTOMER_DEVICE_ROUTER_MESH_CREATED = "ServiceModule.CustomerDeviceRouter.MESH.SubDbRecordCreated";
|
|
523
|
+
/** Mesh updated */
|
|
524
|
+
export declare const ROUTING_KEY_CUSTOMER_DEVICE_ROUTER_MESH_UPDATED = "ServiceModule.CustomerDeviceRouter.MESH.SubDbRecordUpdated";
|
|
525
|
+
/** Mesh deleted */
|
|
526
|
+
export declare const ROUTING_KEY_CUSTOMER_DEVICE_ROUTER_MESH_DELETED = "ServiceModule.CustomerDeviceRouter.MESH.SubDbRecordDeleted";
|
|
277
527
|
/** Event: CustomerDeviceRouter__File link created */
|
|
278
528
|
export declare const ROUTING_KEY_LINK_CUSTOMER_DEVICE_ROUTER_FILE_CREATED = "ServiceModule.CustomerDeviceRouter.File.SubDbRecordAssociationCreated";
|
|
279
529
|
/** Event: CustomerDeviceRouter__File link deleted */
|