@d19n/youfibre-odin-sdk 2.0.321 → 2.0.323
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/CreateOutboundDialSessionDto.d.ts +15 -1
- 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/actions-v2/UpdateOutboundDialCampaignCaseDto.d.ts +29 -1
- package/dist/actions-v2/UpdateOutboundDialCampaignCaseOnDialEndDto.d.ts +29 -1
- package/dist/actions-v2/UpdateOutboundDialSessionOnAmdResultDto.d.ts +15 -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/OutboundDialCampaignCase.d.ts +33 -1
- package/dist/entities-v2/OutboundDialCampaignCase.js +8 -0
- package/dist/entities-v2/OutboundDialSession.d.ts +17 -1
- package/dist/entities-v2/OutboundDialSession.js +4 -0
- 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
package/README.md
CHANGED
|
@@ -124,7 +124,7 @@ await workOrder.completeWorkOrder({ ... });
|
|
|
124
124
|
|
|
125
125
|
## Entities
|
|
126
126
|
|
|
127
|
-
This SDK includes **
|
|
127
|
+
This SDK includes **187** entities across **12** modules.
|
|
128
128
|
|
|
129
129
|
### CrmModule
|
|
130
130
|
|
|
@@ -208,13 +208,18 @@ This SDK includes **182** entities across **12** modules.
|
|
|
208
208
|
| **Case** | Case Entity Definition | OUTAGE |
|
|
209
209
|
| **CaseAction** | CaseAction Entity Definition | DEFAULT |
|
|
210
210
|
| **CaseQueueListView** | CaseQueueListView Entity Definition | DEFAULT |
|
|
211
|
+
| **CoachingSession** | CoachingSession Entity Definition | DEFAULT |
|
|
211
212
|
| **KnowledgeArticle** | KnowledgeArticle Entity Definition | RELEASE_NOTE, USER_GUIDE |
|
|
212
213
|
| **LinearIssue** | LinearIssue Entity Definition | DEFAULT |
|
|
213
214
|
| **Note** | Note Entity Definition | DEFAULT |
|
|
214
215
|
| **OutboundDialCampaign** | OutboundDialCampaign Entity Definition | DEFAULT |
|
|
215
216
|
| **OutboundDialCampaignCase** | OutboundDialCampaignCase Entity Definition | DEFAULT |
|
|
216
217
|
| **OutboundDialSession** | OutboundDialSession Entity Definition | DEFAULT |
|
|
218
|
+
| **QaEvaluation** | QaEvaluation Entity Definition | DEFAULT |
|
|
219
|
+
| **QaEvaluationAnswer** | QaEvaluationAnswer Entity Definition | DEFAULT |
|
|
217
220
|
| **QaReport** | QaReport Entity Definition | DEFAULT |
|
|
221
|
+
| **QaScorecardQuestion** | QaScorecardQuestion Entity Definition | DEFAULT |
|
|
222
|
+
| **QaScorecardTemplate** | QaScorecardTemplate Entity Definition | DEFAULT |
|
|
218
223
|
| **Queue** | Queue Entity Definition | DEFAULT |
|
|
219
224
|
| **QueueChange** | QueueChange Entity Definition | DEFAULT |
|
|
220
225
|
| **SupportTask** | SupportTask Entity Definition | DEFAULT |
|
|
@@ -296,7 +301,7 @@ This SDK includes **182** entities across **12** modules.
|
|
|
296
301
|
| **CustomerDeviceAta** | CustomerDeviceAta Entity Definition | DEFAULT |
|
|
297
302
|
| **CustomerDeviceOnt** | CustomerDeviceOnt Entity Definition | DEFAULT |
|
|
298
303
|
| **CustomerDeviceOntRemoval** | CustomerDeviceOntRemoval Entity Definition | DEFAULT |
|
|
299
|
-
| **CustomerDeviceRouter** | CustomerDeviceRouter Entity Definition |
|
|
304
|
+
| **CustomerDeviceRouter** | CustomerDeviceRouter Entity Definition | CPE_ROUTER, MESH |
|
|
300
305
|
| **CustomerPhonePorting** | CustomerPhonePorting Entity Definition | DEFAULT |
|
|
301
306
|
| **McPendingEvent** | McPendingEvent Entity Definition | DEFAULT |
|
|
302
307
|
| **MobileCdr** | MobileCdr Entity Definition | DEFAULT |
|
|
@@ -112,12 +112,12 @@ export declare class CompleteServiceWorkOrderDto extends OdinRecordUpdateDto<Com
|
|
|
112
112
|
});
|
|
113
113
|
}
|
|
114
114
|
/**
|
|
115
|
-
* Properties for
|
|
115
|
+
* Properties for CreateYfFieldVisitOutcomeForm action
|
|
116
116
|
*
|
|
117
117
|
* @property Required fields: 57
|
|
118
118
|
* @property Optional fields: 3
|
|
119
119
|
*/
|
|
120
|
-
export interface
|
|
120
|
+
export interface CreateYfFieldVisitOutcomeFormProperties {
|
|
121
121
|
/**
|
|
122
122
|
* ServiceVisitDateTime
|
|
123
123
|
*
|
|
@@ -147,10 +147,10 @@ export interface YfFieldVisitOutcomeFormProperties {
|
|
|
147
147
|
/**
|
|
148
148
|
* Location
|
|
149
149
|
*
|
|
150
|
-
* The property visited
|
|
150
|
+
* The property visited. Prefilled from the work order title, which is where a work order's address actually lives.
|
|
151
151
|
* @type {TEXT}
|
|
152
152
|
* @required
|
|
153
|
-
* @default Dynamic: {
|
|
153
|
+
* @default Dynamic: {source_record_title}
|
|
154
154
|
*/
|
|
155
155
|
Location: string;
|
|
156
156
|
/**
|
|
@@ -631,36 +631,36 @@ export interface YfFieldVisitOutcomeFormProperties {
|
|
|
631
631
|
* @module FieldServiceModule
|
|
632
632
|
* @entity YfFieldVisitOutcomeForm
|
|
633
633
|
* @entityType OUTCOME_FORM (Outcome Form)
|
|
634
|
-
* @event k1.t-hEOJjsDb.FieldServiceModule.YfFieldVisitOutcomeForm.Create.
|
|
635
|
-
* @permission schema.action.
|
|
634
|
+
* @event k1.t-hEOJjsDb.FieldServiceModule.YfFieldVisitOutcomeForm.Create.CreateYfFieldVisitOutcomeForm
|
|
635
|
+
* @permission schema.action.createyffieldvisitoutcomeform.trigger
|
|
636
636
|
* @benchmark This action is tracked for performance benchmarks
|
|
637
637
|
*/
|
|
638
|
-
export declare class
|
|
638
|
+
export declare class CreateYfFieldVisitOutcomeFormDto extends OdinRecordCreateDto<CreateYfFieldVisitOutcomeFormProperties> {
|
|
639
639
|
/** Used by SDK generators to identify action type */
|
|
640
640
|
static readonly ACTION_TYPE = "CREATE";
|
|
641
|
-
static readonly ACTION_KEY = "
|
|
641
|
+
static readonly ACTION_KEY = "CreateYfFieldVisitOutcomeForm";
|
|
642
642
|
static readonly MODULE_NAME = "FieldServiceModule";
|
|
643
643
|
static readonly ENTITIES: string[];
|
|
644
644
|
static readonly ENTITY_TYPE = "OUTCOME_FORM";
|
|
645
|
-
static readonly EVENT_NAME = "k1.t-hEOJjsDb.FieldServiceModule.YfFieldVisitOutcomeForm.Create.
|
|
646
|
-
static readonly PERMISSION = "schema.action.
|
|
645
|
+
static readonly EVENT_NAME = "k1.t-hEOJjsDb.FieldServiceModule.YfFieldVisitOutcomeForm.Create.CreateYfFieldVisitOutcomeForm";
|
|
646
|
+
static readonly PERMISSION = "schema.action.createyffieldvisitoutcomeform.trigger";
|
|
647
647
|
/** Step metadata - entity this action targets */
|
|
648
648
|
static readonly STEP_ENTITY = "FieldServiceModule:YfFieldVisitOutcomeForm";
|
|
649
649
|
static readonly STEP_SCHEMA_ID = "cca6f70d-9b11-42b6-9439-c3672d871e14";
|
|
650
|
-
static readonly STEP_SCHEMA_ACTION_ID = "
|
|
650
|
+
static readonly STEP_SCHEMA_ACTION_ID = "d5636eb5-9716-492e-8bc2-767659ef8080";
|
|
651
651
|
static readonly STEP_SCHEMA_TYPE_ID = "334af74f-77ed-4196-9e9b-a4dc31b5c864";
|
|
652
652
|
static readonly STEP_TYPE = "OUTCOME_FORM";
|
|
653
653
|
static readonly AUTO_LINK_PARENT = true;
|
|
654
654
|
readonly actionName: string;
|
|
655
655
|
readonly schemaActionId: string;
|
|
656
656
|
readonly entity: string;
|
|
657
|
-
constructor(properties:
|
|
657
|
+
constructor(properties: CreateYfFieldVisitOutcomeFormProperties, options?: {
|
|
658
658
|
journeyId?: string;
|
|
659
659
|
});
|
|
660
660
|
}
|
|
661
661
|
declare type StepClassMap = {
|
|
662
662
|
CompleteServiceWorkOrderDto: CompleteServiceWorkOrderDto;
|
|
663
|
-
|
|
663
|
+
CreateYfFieldVisitOutcomeFormDto: CreateYfFieldVisitOutcomeFormDto;
|
|
664
664
|
};
|
|
665
665
|
/**
|
|
666
666
|
* Link definition for connecting steps in CompleteServiceWorkOrderFlow
|
|
@@ -762,7 +762,7 @@ export declare class CompleteServiceWorkOrderFlowDto extends OdinRecordUpdateDto
|
|
|
762
762
|
journeyId?: string;
|
|
763
763
|
});
|
|
764
764
|
/** Step classes that can be used with this action */
|
|
765
|
-
static readonly stepClasses: readonly ["CompleteServiceWorkOrderDto", "
|
|
765
|
+
static readonly stepClasses: readonly ["CompleteServiceWorkOrderDto", "CreateYfFieldVisitOutcomeFormDto"];
|
|
766
766
|
steps: StepClassMap[(typeof CompleteServiceWorkOrderFlowDto.stepClasses)[number]][];
|
|
767
767
|
}
|
|
768
768
|
export {};
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
14
14
|
*/
|
|
15
15
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
-
exports.CompleteServiceWorkOrderFlowDto = exports.CompleteServiceWorkOrderFlowSteps = exports.
|
|
16
|
+
exports.CompleteServiceWorkOrderFlowDto = exports.CompleteServiceWorkOrderFlowSteps = exports.CreateYfFieldVisitOutcomeFormDto = exports.CompleteServiceWorkOrderDto = void 0;
|
|
17
17
|
const core_1 = require("@d19n/odin-types/dist/core");
|
|
18
18
|
/**
|
|
19
19
|
* CompleteServiceWorkOrder
|
|
@@ -68,11 +68,11 @@ CompleteServiceWorkOrderDto.AUTO_LINK_PARENT = false;
|
|
|
68
68
|
* @module FieldServiceModule
|
|
69
69
|
* @entity YfFieldVisitOutcomeForm
|
|
70
70
|
* @entityType OUTCOME_FORM (Outcome Form)
|
|
71
|
-
* @event k1.t-hEOJjsDb.FieldServiceModule.YfFieldVisitOutcomeForm.Create.
|
|
72
|
-
* @permission schema.action.
|
|
71
|
+
* @event k1.t-hEOJjsDb.FieldServiceModule.YfFieldVisitOutcomeForm.Create.CreateYfFieldVisitOutcomeForm
|
|
72
|
+
* @permission schema.action.createyffieldvisitoutcomeform.trigger
|
|
73
73
|
* @benchmark This action is tracked for performance benchmarks
|
|
74
74
|
*/
|
|
75
|
-
class
|
|
75
|
+
class CreateYfFieldVisitOutcomeFormDto extends core_1.OdinRecordCreateDto {
|
|
76
76
|
constructor(properties, options) {
|
|
77
77
|
super({
|
|
78
78
|
entity: 'FieldServiceModule:YfFieldVisitOutcomeForm',
|
|
@@ -80,27 +80,27 @@ class YfFieldVisitOutcomeFormDto extends core_1.OdinRecordCreateDto {
|
|
|
80
80
|
properties,
|
|
81
81
|
journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
|
|
82
82
|
});
|
|
83
|
-
this.actionName = '
|
|
84
|
-
this.schemaActionId = '
|
|
83
|
+
this.actionName = 'CreateYfFieldVisitOutcomeForm';
|
|
84
|
+
this.schemaActionId = 'd5636eb5-9716-492e-8bc2-767659ef8080';
|
|
85
85
|
this.entity = 'FieldServiceModule:YfFieldVisitOutcomeForm';
|
|
86
86
|
}
|
|
87
87
|
}
|
|
88
|
-
exports.
|
|
88
|
+
exports.CreateYfFieldVisitOutcomeFormDto = CreateYfFieldVisitOutcomeFormDto;
|
|
89
89
|
/** Used by SDK generators to identify action type */
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
90
|
+
CreateYfFieldVisitOutcomeFormDto.ACTION_TYPE = 'CREATE';
|
|
91
|
+
CreateYfFieldVisitOutcomeFormDto.ACTION_KEY = 'CreateYfFieldVisitOutcomeForm';
|
|
92
|
+
CreateYfFieldVisitOutcomeFormDto.MODULE_NAME = 'FieldServiceModule';
|
|
93
|
+
CreateYfFieldVisitOutcomeFormDto.ENTITIES = ['YfFieldVisitOutcomeForm'];
|
|
94
|
+
CreateYfFieldVisitOutcomeFormDto.ENTITY_TYPE = 'OUTCOME_FORM';
|
|
95
|
+
CreateYfFieldVisitOutcomeFormDto.EVENT_NAME = 'k1.t-hEOJjsDb.FieldServiceModule.YfFieldVisitOutcomeForm.Create.CreateYfFieldVisitOutcomeForm';
|
|
96
|
+
CreateYfFieldVisitOutcomeFormDto.PERMISSION = 'schema.action.createyffieldvisitoutcomeform.trigger';
|
|
97
97
|
/** Step metadata - entity this action targets */
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
98
|
+
CreateYfFieldVisitOutcomeFormDto.STEP_ENTITY = 'FieldServiceModule:YfFieldVisitOutcomeForm';
|
|
99
|
+
CreateYfFieldVisitOutcomeFormDto.STEP_SCHEMA_ID = 'cca6f70d-9b11-42b6-9439-c3672d871e14';
|
|
100
|
+
CreateYfFieldVisitOutcomeFormDto.STEP_SCHEMA_ACTION_ID = 'd5636eb5-9716-492e-8bc2-767659ef8080';
|
|
101
|
+
CreateYfFieldVisitOutcomeFormDto.STEP_SCHEMA_TYPE_ID = '334af74f-77ed-4196-9e9b-a4dc31b5c864';
|
|
102
|
+
CreateYfFieldVisitOutcomeFormDto.STEP_TYPE = 'OUTCOME_FORM';
|
|
103
|
+
CreateYfFieldVisitOutcomeFormDto.AUTO_LINK_PARENT = true;
|
|
104
104
|
/**
|
|
105
105
|
* Type-safe step keys for CompleteServiceWorkOrderFlow
|
|
106
106
|
*/
|
|
@@ -164,7 +164,7 @@ CompleteServiceWorkOrderFlowDto.stepDefinitions = [
|
|
|
164
164
|
},
|
|
165
165
|
{
|
|
166
166
|
stepKey: 'step_2',
|
|
167
|
-
dtoClass: '
|
|
167
|
+
dtoClass: 'CreateYfFieldVisitOutcomeFormDto',
|
|
168
168
|
entity: 'FieldServiceModule:YfFieldVisitOutcomeForm',
|
|
169
169
|
linksTo: null
|
|
170
170
|
}
|
|
@@ -172,4 +172,4 @@ CompleteServiceWorkOrderFlowDto.stepDefinitions = [
|
|
|
172
172
|
/** Type-safe step key accessor */
|
|
173
173
|
CompleteServiceWorkOrderFlowDto.Steps = exports.CompleteServiceWorkOrderFlowSteps;
|
|
174
174
|
/** Step classes that can be used with this action */
|
|
175
|
-
CompleteServiceWorkOrderFlowDto.stepClasses = ['CompleteServiceWorkOrderDto', '
|
|
175
|
+
CompleteServiceWorkOrderFlowDto.stepClasses = ['CompleteServiceWorkOrderDto', 'CreateYfFieldVisitOutcomeFormDto'];
|
|
@@ -22,7 +22,7 @@ export interface CreateOutboundDialSessionMessage extends OdinRecordCreatedEvent
|
|
|
22
22
|
* Properties for CreateOutboundDialSession action
|
|
23
23
|
*
|
|
24
24
|
* @property Required fields: 9
|
|
25
|
-
* @property Optional fields:
|
|
25
|
+
* @property Optional fields: 2
|
|
26
26
|
*/
|
|
27
27
|
export interface CreateOutboundDialSessionProperties {
|
|
28
28
|
/**
|
|
@@ -101,6 +101,20 @@ export interface CreateOutboundDialSessionProperties {
|
|
|
101
101
|
* @default 0
|
|
102
102
|
*/
|
|
103
103
|
NoAnswerCount: number;
|
|
104
|
+
/**
|
|
105
|
+
* BusyCount
|
|
106
|
+
*
|
|
107
|
+
* Dial attempts in this session that ended BUSY. Previously folded into NoAnswerCount (CASES-1830). Sibling of AttemptsCount / ConnectedCount / MachineCount / NoAnswerCount; zeroed at session creation like them.
|
|
108
|
+
* @type {NUMBER}
|
|
109
|
+
*/
|
|
110
|
+
BusyCount?: number | null;
|
|
111
|
+
/**
|
|
112
|
+
* FailedCount
|
|
113
|
+
*
|
|
114
|
+
* Dial attempts in this session that ended FAILED (carrier failure / cancelled). Previously folded into NoAnswerCount (CASES-1830). Sibling of AttemptsCount / ConnectedCount / MachineCount / NoAnswerCount; zeroed at session creation like them.
|
|
115
|
+
* @type {NUMBER}
|
|
116
|
+
*/
|
|
117
|
+
FailedCount?: number | null;
|
|
104
118
|
}
|
|
105
119
|
/**
|
|
106
120
|
* CreateOutboundDialSession
|
|
@@ -23,7 +23,7 @@ export interface DefaultServiceWorkOrderEditFormMessage extends OdinRecordUpdate
|
|
|
23
23
|
* Properties for DefaultServiceWorkOrderEditForm action
|
|
24
24
|
*
|
|
25
25
|
* @property Required fields: 0
|
|
26
|
-
* @property Optional fields:
|
|
26
|
+
* @property Optional fields: 7
|
|
27
27
|
*/
|
|
28
28
|
export interface DefaultServiceWorkOrderEditFormProperties {
|
|
29
29
|
/**
|
|
@@ -47,6 +47,13 @@ export interface DefaultServiceWorkOrderEditFormProperties {
|
|
|
47
47
|
* @type {BOOLEAN}
|
|
48
48
|
*/
|
|
49
49
|
TLOSVerified?: boolean | null;
|
|
50
|
+
/**
|
|
51
|
+
* PreventableWorkOrder
|
|
52
|
+
*
|
|
53
|
+
* PreventableWorkOrder
|
|
54
|
+
* @type {ENUM}
|
|
55
|
+
*/
|
|
56
|
+
PreventableWorkOrder?: string | null;
|
|
50
57
|
/**
|
|
51
58
|
* Provider
|
|
52
59
|
*
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* UpdateCustomerDeviceBattery Action DTO
|
|
3
3
|
*
|
|
4
|
-
*
|
|
4
|
+
* Update the serial number on a battery pack device.
|
|
5
5
|
*
|
|
6
6
|
* @module ServiceModule
|
|
7
7
|
* @entity CustomerDevice
|
|
@@ -37,6 +37,8 @@ export interface UpdateCustomerDeviceBatteryProperties {
|
|
|
37
37
|
/**
|
|
38
38
|
* UpdateCustomerDeviceBattery
|
|
39
39
|
*
|
|
40
|
+
* Update the serial number on a battery pack device.
|
|
41
|
+
*
|
|
40
42
|
* @actionType UPDATE - Updates an existing CustomerDevice record
|
|
41
43
|
* @module ServiceModule
|
|
42
44
|
* @entity CustomerDevice
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/**
|
|
3
3
|
* UpdateCustomerDeviceBattery Action DTO
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
* Update the serial number on a battery pack device.
|
|
6
6
|
*
|
|
7
7
|
* @module ServiceModule
|
|
8
8
|
* @entity CustomerDevice
|
|
@@ -18,6 +18,8 @@ const core_1 = require("@d19n/odin-types/dist/core");
|
|
|
18
18
|
/**
|
|
19
19
|
* UpdateCustomerDeviceBattery
|
|
20
20
|
*
|
|
21
|
+
* Update the serial number on a battery pack device.
|
|
22
|
+
*
|
|
21
23
|
* @actionType UPDATE - Updates an existing CustomerDevice record
|
|
22
24
|
* @module ServiceModule
|
|
23
25
|
* @entity CustomerDevice
|
|
@@ -22,7 +22,7 @@ export interface UpdateOutboundDialCampaignCaseMessage extends OdinRecordUpdated
|
|
|
22
22
|
* Properties for UpdateOutboundDialCampaignCase action
|
|
23
23
|
*
|
|
24
24
|
* @property Required fields: 0
|
|
25
|
-
* @property Optional fields:
|
|
25
|
+
* @property Optional fields: 7
|
|
26
26
|
*/
|
|
27
27
|
export interface UpdateOutboundDialCampaignCaseProperties {
|
|
28
28
|
/**
|
|
@@ -46,6 +46,34 @@ export interface UpdateOutboundDialCampaignCaseProperties {
|
|
|
46
46
|
* @type {ENUM}
|
|
47
47
|
*/
|
|
48
48
|
Status?: string | null;
|
|
49
|
+
/**
|
|
50
|
+
* DialAttemptCount
|
|
51
|
+
*
|
|
52
|
+
* How many times this campaign has dialled this case. Per-campaign successor to Case.DialAttemptCount, whose single budget was shared by every campaign the case was enrolled in (CASES-1829). Compared against the campaign MaxRetries to decide PENDING vs EXHAUSTED.
|
|
53
|
+
* @type {NUMBER}
|
|
54
|
+
*/
|
|
55
|
+
DialAttemptCount?: number | null;
|
|
56
|
+
/**
|
|
57
|
+
* NextDialAt
|
|
58
|
+
*
|
|
59
|
+
* When the retry backoff elapses and this junction becomes dialable again in THIS campaign. Null when no retry is scheduled (connected, exhausted, or never dialled). Per-campaign successor to Case.NextDialAt.
|
|
60
|
+
* @type {DATE_TIME}
|
|
61
|
+
*/
|
|
62
|
+
NextDialAt?: string | null;
|
|
63
|
+
/**
|
|
64
|
+
* LastDialAt
|
|
65
|
+
*
|
|
66
|
+
* When this campaign last dialled this case. Per-campaign successor to Case.LastDialAt.
|
|
67
|
+
* @type {DATE_TIME}
|
|
68
|
+
*/
|
|
69
|
+
LastDialAt?: string | null;
|
|
70
|
+
/**
|
|
71
|
+
* LastDialOutcome
|
|
72
|
+
*
|
|
73
|
+
* Outcome of this campaign's most recent dial of this case: CONNECTED, NO_ANSWER, BUSY, MACHINE or FAILED (the dialer's LastDialOutcome union). TEXT, not ENUM: the dialer is the only writer and a schema enum would need option shepherding on every new outcome. Per-campaign successor to Case.LastDialOutcome.
|
|
74
|
+
* @type {TEXT}
|
|
75
|
+
*/
|
|
76
|
+
LastDialOutcome?: string | null;
|
|
49
77
|
}
|
|
50
78
|
/**
|
|
51
79
|
* UpdateOutboundDialCampaignCase
|
|
@@ -22,7 +22,7 @@ export interface UpdateOutboundDialCampaignCaseOnDialEndMessage extends OdinReco
|
|
|
22
22
|
* Properties for UpdateOutboundDialCampaignCaseOnDialEnd action
|
|
23
23
|
*
|
|
24
24
|
* @property Required fields: 1
|
|
25
|
-
* @property Optional fields:
|
|
25
|
+
* @property Optional fields: 5
|
|
26
26
|
*/
|
|
27
27
|
export interface UpdateOutboundDialCampaignCaseOnDialEndProperties {
|
|
28
28
|
/**
|
|
@@ -40,6 +40,34 @@ export interface UpdateOutboundDialCampaignCaseOnDialEndProperties {
|
|
|
40
40
|
* @type {LOOKUP}
|
|
41
41
|
*/
|
|
42
42
|
CurrentCallId?: string | null;
|
|
43
|
+
/**
|
|
44
|
+
* DialAttemptCount
|
|
45
|
+
*
|
|
46
|
+
* How many times this campaign has dialled this case. Per-campaign successor to Case.DialAttemptCount, whose single budget was shared by every campaign the case was enrolled in (CASES-1829). Compared against the campaign MaxRetries to decide PENDING vs EXHAUSTED.
|
|
47
|
+
* @type {NUMBER}
|
|
48
|
+
*/
|
|
49
|
+
DialAttemptCount?: number | null;
|
|
50
|
+
/**
|
|
51
|
+
* NextDialAt
|
|
52
|
+
*
|
|
53
|
+
* When the retry backoff elapses and this junction becomes dialable again in THIS campaign. Null when no retry is scheduled (connected, exhausted, or never dialled). Per-campaign successor to Case.NextDialAt.
|
|
54
|
+
* @type {DATE_TIME}
|
|
55
|
+
*/
|
|
56
|
+
NextDialAt?: string | null;
|
|
57
|
+
/**
|
|
58
|
+
* LastDialAt
|
|
59
|
+
*
|
|
60
|
+
* When this campaign last dialled this case. Per-campaign successor to Case.LastDialAt.
|
|
61
|
+
* @type {DATE_TIME}
|
|
62
|
+
*/
|
|
63
|
+
LastDialAt?: string | null;
|
|
64
|
+
/**
|
|
65
|
+
* LastDialOutcome
|
|
66
|
+
*
|
|
67
|
+
* Outcome of this campaign's most recent dial of this case: CONNECTED, NO_ANSWER, BUSY, MACHINE or FAILED (the dialer's LastDialOutcome union). TEXT, not ENUM: the dialer is the only writer and a schema enum would need option shepherding on every new outcome. Per-campaign successor to Case.LastDialOutcome.
|
|
68
|
+
* @type {TEXT}
|
|
69
|
+
*/
|
|
70
|
+
LastDialOutcome?: string | null;
|
|
43
71
|
}
|
|
44
72
|
/**
|
|
45
73
|
* UpdateOutboundDialCampaignCaseOnDialEnd
|
|
@@ -22,7 +22,7 @@ export interface UpdateOutboundDialSessionOnAmdResultMessage extends OdinRecordU
|
|
|
22
22
|
* Properties for UpdateOutboundDialSessionOnAmdResult action
|
|
23
23
|
*
|
|
24
24
|
* @property Required fields: 1
|
|
25
|
-
* @property Optional fields:
|
|
25
|
+
* @property Optional fields: 5
|
|
26
26
|
*/
|
|
27
27
|
export interface UpdateOutboundDialSessionOnAmdResultProperties {
|
|
28
28
|
/**
|
|
@@ -54,6 +54,20 @@ export interface UpdateOutboundDialSessionOnAmdResultProperties {
|
|
|
54
54
|
* @type {NUMBER}
|
|
55
55
|
*/
|
|
56
56
|
NoAnswerCount?: number | null;
|
|
57
|
+
/**
|
|
58
|
+
* BusyCount
|
|
59
|
+
*
|
|
60
|
+
* Dial attempts in this session that ended BUSY. Previously folded into NoAnswerCount (CASES-1830). Sibling of AttemptsCount / ConnectedCount / MachineCount / NoAnswerCount; zeroed at session creation like them.
|
|
61
|
+
* @type {NUMBER}
|
|
62
|
+
*/
|
|
63
|
+
BusyCount?: number | null;
|
|
64
|
+
/**
|
|
65
|
+
* FailedCount
|
|
66
|
+
*
|
|
67
|
+
* Dial attempts in this session that ended FAILED (carrier failure / cancelled). Previously folded into NoAnswerCount (CASES-1830). Sibling of AttemptsCount / ConnectedCount / MachineCount / NoAnswerCount; zeroed at session creation like them.
|
|
68
|
+
* @type {NUMBER}
|
|
69
|
+
*/
|
|
70
|
+
FailedCount?: number | null;
|
|
57
71
|
}
|
|
58
72
|
/**
|
|
59
73
|
* UpdateOutboundDialSessionOnAmdResult
|
|
@@ -46,6 +46,8 @@ export declare class CaseApi extends ApiProvider {
|
|
|
46
46
|
private _outbounddialsession?;
|
|
47
47
|
private _call?;
|
|
48
48
|
private _qareport?;
|
|
49
|
+
private _qaevaluation?;
|
|
50
|
+
private _coachingsession?;
|
|
49
51
|
constructor(authParams?: OauthParams, authToken?: string);
|
|
50
52
|
get activitylog(): ApiRecordLinkManager;
|
|
51
53
|
get caseaction(): ApiRecordLinkManager;
|
|
@@ -76,6 +78,8 @@ export declare class CaseApi extends ApiProvider {
|
|
|
76
78
|
get outbounddialsession(): ApiRecordLinkManager;
|
|
77
79
|
get call(): ApiRecordLinkManager;
|
|
78
80
|
get qareport(): ApiRecordLinkManager;
|
|
81
|
+
get qaevaluation(): ApiRecordLinkManager;
|
|
82
|
+
get coachingsession(): ApiRecordLinkManager;
|
|
79
83
|
setRecord(sourceRecord: any): void;
|
|
80
84
|
schema(): Promise<import("@d19n/odin-types/dist/core").OdinSchema>;
|
|
81
85
|
search(params: Partial<OdinSearchV2>): Promise<import("@d19n/odin-sdk-generator/dist/odin-sdk-types").OdinSearchResponse<import("@d19n/odin-types/dist/core").OdinRecord<CaseProperties>>>;
|
|
@@ -207,6 +207,18 @@ class CaseApi extends api_provider_1.ApiProvider {
|
|
|
207
207
|
}
|
|
208
208
|
return this._qareport;
|
|
209
209
|
}
|
|
210
|
+
get qaevaluation() {
|
|
211
|
+
if (!this._qaevaluation) {
|
|
212
|
+
this._qaevaluation = new api_record_link_manager_1.ApiRecordLinkManager(this.authParams, 'SupportModule:Case', 'SupportModule:QaEvaluation', 'Case__QaEvaluation');
|
|
213
|
+
}
|
|
214
|
+
return this._qaevaluation;
|
|
215
|
+
}
|
|
216
|
+
get coachingsession() {
|
|
217
|
+
if (!this._coachingsession) {
|
|
218
|
+
this._coachingsession = new api_record_link_manager_1.ApiRecordLinkManager(this.authParams, 'SupportModule:Case', 'SupportModule:CoachingSession', 'Case__CoachingSession');
|
|
219
|
+
}
|
|
220
|
+
return this._coachingsession;
|
|
221
|
+
}
|
|
210
222
|
// ============================================
|
|
211
223
|
// STANDARD METHODS (Unchanged API)
|
|
212
224
|
// ============================================
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
import { OauthParams } from '@d19n/odin-sdk-generator/dist/odin-sdk-types';
|
|
2
|
+
import { ApiProvider } from '@d19n/odin-sdk-generator/dist/api.provider';
|
|
3
|
+
import { OdinSearchV2, OdinRecordCreateDto, OdinRecordUpdateDto } from '@d19n/odin-types/dist/core';
|
|
4
|
+
import { ApiRecordLinkManager } from '@d19n/odin-sdk-generator/dist/api.record.link.manager';
|
|
5
|
+
import { CoachingSessionProperties } from '../entities-v2/CoachingSession';
|
|
6
|
+
/**
|
|
7
|
+
* @deprecated Use OdinApiClient.
|
|
8
|
+
*
|
|
9
|
+
* Migration:
|
|
10
|
+
* - Old: new CoachingSessionApi(authParams).get(id)
|
|
11
|
+
* - New: new odin.coachingsession.get(id)
|
|
12
|
+
*
|
|
13
|
+
* The new OdinApiClient returns typed record wrappers with action methods.
|
|
14
|
+
*/
|
|
15
|
+
export declare class CoachingSessionApi extends ApiProvider {
|
|
16
|
+
protected readonly authToken?: string;
|
|
17
|
+
private readonly moduleName;
|
|
18
|
+
private readonly entityName;
|
|
19
|
+
private sourceRecord;
|
|
20
|
+
private _qaevaluation?;
|
|
21
|
+
private _case?;
|
|
22
|
+
constructor(authParams?: OauthParams, authToken?: string);
|
|
23
|
+
get qaevaluation(): ApiRecordLinkManager;
|
|
24
|
+
get case(): ApiRecordLinkManager;
|
|
25
|
+
setRecord(sourceRecord: any): void;
|
|
26
|
+
schema(): Promise<import("@d19n/odin-types/dist/core").OdinSchema>;
|
|
27
|
+
search(params: Partial<OdinSearchV2>): Promise<import("@d19n/odin-sdk-generator/dist/odin-sdk-types").OdinSearchResponse<import("@d19n/odin-types/dist/core").OdinRecord<CoachingSessionProperties>>>;
|
|
28
|
+
searchAndPaginate(params: Partial<OdinSearchV2>): Promise<import("@d19n/odin-sdk-generator/dist/odin-sdk-types").OdinSearchResponse<import("@d19n/odin-types/dist/core").OdinRecord<CoachingSessionProperties>>>;
|
|
29
|
+
reIndex(body: {
|
|
30
|
+
id: string;
|
|
31
|
+
schemaId: string;
|
|
32
|
+
}[]): Promise<any>;
|
|
33
|
+
get(coachingSessionId: string): Promise<import("@d19n/odin-types/dist/core").OdinRecord<CoachingSessionProperties>>;
|
|
34
|
+
getMany(coachingSessionIds: string[]): Promise<import("@d19n/odin-types/dist/core").OdinRecord<CoachingSessionProperties>[]>;
|
|
35
|
+
upsert(upsertDto: OdinRecordCreateDto): Promise<import("@d19n/odin-sdk-generator/dist/odin-sdk-types").IDbRecordCreateUpdateRes>;
|
|
36
|
+
upsertMany(upsertDtos: OdinRecordCreateDto[]): Promise<import("@d19n/odin-sdk-generator/dist/odin-sdk-types").IDbRecordCreateUpdateRes[]>;
|
|
37
|
+
update(updateDto: OdinRecordUpdateDto): Promise<import("@d19n/odin-sdk-generator/dist/odin-sdk-types").IDbRecordCreateUpdateRes>;
|
|
38
|
+
updateMany(updateDtos: OdinRecordUpdateDto[]): Promise<import("@d19n/odin-sdk-generator/dist/odin-sdk-types").IDbRecordCreateUpdateRes[]>;
|
|
39
|
+
delete(coachingSessionId: string): Promise<import("@d19n/odin-sdk-generator/dist/odin-sdk-types").OdinDeleteResponse[]>;
|
|
40
|
+
deleteMany(coachingSessionIds: string[]): Promise<import("@d19n/odin-sdk-generator/dist/odin-sdk-types").OdinDeleteResponse[]>;
|
|
41
|
+
restore(coachingSessionIds: string[]): Promise<import("@d19n/odin-sdk-generator/dist/odin-sdk-types").OdinRestoreResponse[]>;
|
|
42
|
+
applyAction(dto: any): Promise<any[]>;
|
|
43
|
+
bulkApplyActions(dtos: any[]): Promise<any[]>;
|
|
44
|
+
getVersions(): Promise<{
|
|
45
|
+
[key: string]: Record<string, any>;
|
|
46
|
+
}>;
|
|
47
|
+
getRevisionTimeline(): Promise<{
|
|
48
|
+
[key: string]: Record<string, any>[];
|
|
49
|
+
}>;
|
|
50
|
+
}
|