@d19n/youfibre-odin-sdk 2.0.233-beta.5 → 2.0.233-beta.6
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 +4 -1
- package/dist/actions-v2/MoveMsrToHeldDto.d.ts +115 -0
- package/dist/actions-v2/MoveMsrToHeldDto.js +80 -0
- package/dist/actions-v2/UpdateCallAnalyticsDto.d.ts +1 -17
- package/dist/actions-v2/UpdateCallOnInboundCallAnsweredDto.d.ts +10 -3
- package/dist/actions-v2/UpdateCallOnInboundCallCompletedDto.d.ts +8 -1
- package/dist/actions-v2/UpdateCallOnNumberCallStatusDto.d.ts +4 -4
- package/dist/actions-v2/UpdateCallOnOutboundDialActionDto.d.ts +2 -2
- package/dist/entities-v2/Call.d.ts +10 -24
- package/dist/entities-v2/Call.js +2 -6
- package/dist/records-v2/ModifyServiceRequestRecord.d.ts +25 -0
- package/dist/records-v2/ModifyServiceRequestRecord.js +29 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -359,7 +359,7 @@ This SDK includes **171** entities across **12** modules.
|
|
|
359
359
|
|
|
360
360
|
## Actions
|
|
361
361
|
|
|
362
|
-
This SDK includes **
|
|
362
|
+
This SDK includes **746** actions.
|
|
363
363
|
|
|
364
364
|
### Action Types
|
|
365
365
|
|
|
@@ -1501,6 +1501,7 @@ This SDK includes **745** actions.
|
|
|
1501
1501
|
| `CreateModifyServiceRequest` | CREATE | k1.t-hEOJjsDb.ServiceModule.ModifyServiceRequest.Create.CreateModifyServiceRequest |
|
|
1502
1502
|
| `MoveMsrToComplete` | STAGE_TRANSITION | k1.t-hEOJjsDb.ServiceModule.ModifyServiceRequest.Update.UpdateModifyServiceRequest |
|
|
1503
1503
|
| `MoveMsrToFailed` | STAGE_TRANSITION | k1.t-hEOJjsDb.ServiceModule.ModifyServiceRequest.Update.UpdateModifyServiceRequest |
|
|
1504
|
+
| `MoveMsrToHeld` | STAGE_TRANSITION | k1.t-hEOJjsDb.ServiceModule.ModifyServiceRequest.Transition.MoveMsrToHeld |
|
|
1504
1505
|
| `MoveMsrToInProgress` | STAGE_TRANSITION | k1.t-hEOJjsDb.ServiceModule.ModifyServiceRequest.Update.UpdateModifyServiceRequest |
|
|
1505
1506
|
| `UpdateModifyServiceRequest` | UPDATE | k1.t-hEOJjsDb.ServiceModule.ModifyServiceRequest.Update.UpdateModifyServiceRequest |
|
|
1506
1507
|
|
|
@@ -1508,6 +1509,8 @@ This SDK includes **745** actions.
|
|
|
1508
1509
|
|
|
1509
1510
|
**MoveMsrToFailed Target Stages:** `ModifyServiceRequestStateStageFailed`
|
|
1510
1511
|
|
|
1512
|
+
**MoveMsrToHeld Target Stages:** `ModifyServiceRequestStateStageHeld`
|
|
1513
|
+
|
|
1511
1514
|
**MoveMsrToInProgress Target Stages:** `ModifyServiceRequestStateStageInProgress`
|
|
1512
1515
|
|
|
1513
1516
|
#### NetworkDevice
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* MoveMsrToHeld Action DTO
|
|
3
|
+
*
|
|
4
|
+
* MoveMsrToHeld
|
|
5
|
+
*
|
|
6
|
+
* @module ServiceModule
|
|
7
|
+
* @entity ModifyServiceRequest
|
|
8
|
+
* @entityType DEFAULT
|
|
9
|
+
* @actionKey MoveMsrToHeld
|
|
10
|
+
* @event k1.t-hEOJjsDb.ServiceModule.ModifyServiceRequest.Transition.MoveMsrToHeld
|
|
11
|
+
*
|
|
12
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
13
|
+
*/
|
|
14
|
+
import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
|
|
15
|
+
declare type StepClassMap = {};
|
|
16
|
+
/**
|
|
17
|
+
* Link definition for connecting steps in MoveMsrToHeld
|
|
18
|
+
*/
|
|
19
|
+
export interface MoveMsrToHeldStepLink {
|
|
20
|
+
/**
|
|
21
|
+
* The stepKey of the target step to link TO
|
|
22
|
+
* Must reference another step's stepKey in the same flow
|
|
23
|
+
*/
|
|
24
|
+
stepKey: string;
|
|
25
|
+
/**
|
|
26
|
+
* The schema association ID (UUID) defining the relationship
|
|
27
|
+
* Use the association.id from the schema association definition
|
|
28
|
+
* @example "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
|
|
29
|
+
*/
|
|
30
|
+
schemaAssociationId: string;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Step definition with linking metadata for MoveMsrToHeld
|
|
34
|
+
*/
|
|
35
|
+
export interface MoveMsrToHeldStepDefinition {
|
|
36
|
+
/** Unique identifier for this step */
|
|
37
|
+
stepKey: string;
|
|
38
|
+
/** The DTO class name for this step */
|
|
39
|
+
dtoClass: string;
|
|
40
|
+
/** The entity this step creates (Module:Entity format) */
|
|
41
|
+
entity: string;
|
|
42
|
+
/** Links to create after this step executes */
|
|
43
|
+
linksTo: MoveMsrToHeldStepLink[] | null;
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* Type-safe step keys for MoveMsrToHeld
|
|
47
|
+
*/
|
|
48
|
+
export declare const MoveMsrToHeldSteps: {
|
|
49
|
+
readonly step_1: "step_1";
|
|
50
|
+
};
|
|
51
|
+
export declare type MoveMsrToHeldStepKey = typeof MoveMsrToHeldSteps[keyof typeof MoveMsrToHeldSteps];
|
|
52
|
+
/**
|
|
53
|
+
* RabbitMQ message payload for MoveMsrToHeld step flow events
|
|
54
|
+
*
|
|
55
|
+
* @event k1.t-hEOJjsDb.ServiceModule.ModifyServiceRequest.Transition.MoveMsrToHeld
|
|
56
|
+
*/
|
|
57
|
+
export interface MoveMsrToHeldMessage extends OdinRecordUpdatedEvent<MoveMsrToHeldDto, {}> {
|
|
58
|
+
}
|
|
59
|
+
/**
|
|
60
|
+
* Properties for MoveMsrToHeld action
|
|
61
|
+
*
|
|
62
|
+
*/
|
|
63
|
+
export interface MoveMsrToHeldProperties {
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* MoveMsrToHeld
|
|
67
|
+
*
|
|
68
|
+
* @actionType STAGE_TRANSITION - Transitions record to new pipeline stage
|
|
69
|
+
* @module ServiceModule
|
|
70
|
+
* @entity ModifyServiceRequest
|
|
71
|
+
* @entityType DEFAULT (Default)
|
|
72
|
+
* @targetStages ModifyServiceRequestStateStageHeld
|
|
73
|
+
* @event k1.t-hEOJjsDb.ServiceModule.ModifyServiceRequest.Transition.MoveMsrToHeld
|
|
74
|
+
* @permission schema.action.movemsrtoheld.trigger
|
|
75
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
76
|
+
*/
|
|
77
|
+
export declare class MoveMsrToHeldDto extends OdinRecordUpdateDto<Record<string, any>> {
|
|
78
|
+
/** Used by SDK generators to identify action type */
|
|
79
|
+
static readonly ACTION_TYPE = "UPDATE";
|
|
80
|
+
static readonly ACTION_KEY = "MoveMsrToHeld";
|
|
81
|
+
static readonly MODULE_NAME = "ServiceModule";
|
|
82
|
+
static readonly ENTITIES: string[];
|
|
83
|
+
static readonly ENTITY_TYPE = "DEFAULT";
|
|
84
|
+
static readonly EVENT_NAME = "k1.t-hEOJjsDb.ServiceModule.ModifyServiceRequest.Transition.MoveMsrToHeld";
|
|
85
|
+
static readonly SCHEMA_ACTION_ID = "a2331418-7935-4f84-a449-7691942cb218";
|
|
86
|
+
static readonly PERMISSION = "schema.action.movemsrtoheld.trigger";
|
|
87
|
+
static readonly TARGET_STAGES: readonly ["ModifyServiceRequestStateStageHeld"];
|
|
88
|
+
static readonly IS_STAGE_TRANSITION = true;
|
|
89
|
+
static readonly IS_MULTI_STEP_FLOW = false;
|
|
90
|
+
static readonly HAS_STEP_LINKS = false;
|
|
91
|
+
/**
|
|
92
|
+
* Step definitions with linking metadata
|
|
93
|
+
* Used by SDK and backend for auto-linking after step execution
|
|
94
|
+
*/
|
|
95
|
+
static readonly stepDefinitions: MoveMsrToHeldStepDefinition[];
|
|
96
|
+
/** Type-safe step key accessor */
|
|
97
|
+
static readonly Steps: {
|
|
98
|
+
readonly step_1: "step_1";
|
|
99
|
+
};
|
|
100
|
+
readonly actionName: string;
|
|
101
|
+
readonly schemaActionId: string;
|
|
102
|
+
readonly entity: string;
|
|
103
|
+
readonly stageKey: string;
|
|
104
|
+
constructor(record: OdinRecord<any> | {
|
|
105
|
+
id: string;
|
|
106
|
+
entity: string;
|
|
107
|
+
type?: string;
|
|
108
|
+
}, options?: {
|
|
109
|
+
journeyId?: string;
|
|
110
|
+
});
|
|
111
|
+
/** Step classes that can be used with this action */
|
|
112
|
+
static readonly stepClasses: readonly [];
|
|
113
|
+
steps: StepClassMap[(typeof MoveMsrToHeldDto.stepClasses)[number]][];
|
|
114
|
+
}
|
|
115
|
+
export {};
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* MoveMsrToHeld Action DTO
|
|
4
|
+
*
|
|
5
|
+
* MoveMsrToHeld
|
|
6
|
+
*
|
|
7
|
+
* @module ServiceModule
|
|
8
|
+
* @entity ModifyServiceRequest
|
|
9
|
+
* @entityType DEFAULT
|
|
10
|
+
* @actionKey MoveMsrToHeld
|
|
11
|
+
* @event k1.t-hEOJjsDb.ServiceModule.ModifyServiceRequest.Transition.MoveMsrToHeld
|
|
12
|
+
*
|
|
13
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.MoveMsrToHeldDto = exports.MoveMsrToHeldSteps = void 0;
|
|
17
|
+
const core_1 = require("@d19n/odin-types/dist/core");
|
|
18
|
+
/**
|
|
19
|
+
* Type-safe step keys for MoveMsrToHeld
|
|
20
|
+
*/
|
|
21
|
+
exports.MoveMsrToHeldSteps = {
|
|
22
|
+
step_1: 'step_1',
|
|
23
|
+
};
|
|
24
|
+
/**
|
|
25
|
+
* MoveMsrToHeld
|
|
26
|
+
*
|
|
27
|
+
* @actionType STAGE_TRANSITION - Transitions record to new pipeline stage
|
|
28
|
+
* @module ServiceModule
|
|
29
|
+
* @entity ModifyServiceRequest
|
|
30
|
+
* @entityType DEFAULT (Default)
|
|
31
|
+
* @targetStages ModifyServiceRequestStateStageHeld
|
|
32
|
+
* @event k1.t-hEOJjsDb.ServiceModule.ModifyServiceRequest.Transition.MoveMsrToHeld
|
|
33
|
+
* @permission schema.action.movemsrtoheld.trigger
|
|
34
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
35
|
+
*/
|
|
36
|
+
class MoveMsrToHeldDto extends core_1.OdinRecordUpdateDto {
|
|
37
|
+
constructor(record, options) {
|
|
38
|
+
super({
|
|
39
|
+
id: record.id,
|
|
40
|
+
entity: record.entity,
|
|
41
|
+
type: record.type,
|
|
42
|
+
properties: {},
|
|
43
|
+
journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
|
|
44
|
+
});
|
|
45
|
+
this.actionName = 'MoveMsrToHeld';
|
|
46
|
+
this.schemaActionId = 'a2331418-7935-4f84-a449-7691942cb218';
|
|
47
|
+
this.entity = 'ServiceModule:ModifyServiceRequest';
|
|
48
|
+
this.stageKey = 'ModifyServiceRequestStateStageHeld';
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
exports.MoveMsrToHeldDto = MoveMsrToHeldDto;
|
|
52
|
+
/** Used by SDK generators to identify action type */
|
|
53
|
+
MoveMsrToHeldDto.ACTION_TYPE = 'UPDATE';
|
|
54
|
+
MoveMsrToHeldDto.ACTION_KEY = 'MoveMsrToHeld';
|
|
55
|
+
MoveMsrToHeldDto.MODULE_NAME = 'ServiceModule';
|
|
56
|
+
MoveMsrToHeldDto.ENTITIES = ['ModifyServiceRequest'];
|
|
57
|
+
MoveMsrToHeldDto.ENTITY_TYPE = 'DEFAULT';
|
|
58
|
+
MoveMsrToHeldDto.EVENT_NAME = 'k1.t-hEOJjsDb.ServiceModule.ModifyServiceRequest.Transition.MoveMsrToHeld';
|
|
59
|
+
MoveMsrToHeldDto.SCHEMA_ACTION_ID = 'a2331418-7935-4f84-a449-7691942cb218';
|
|
60
|
+
MoveMsrToHeldDto.PERMISSION = 'schema.action.movemsrtoheld.trigger';
|
|
61
|
+
MoveMsrToHeldDto.TARGET_STAGES = ['ModifyServiceRequestStateStageHeld'];
|
|
62
|
+
MoveMsrToHeldDto.IS_STAGE_TRANSITION = true;
|
|
63
|
+
MoveMsrToHeldDto.IS_MULTI_STEP_FLOW = false;
|
|
64
|
+
MoveMsrToHeldDto.HAS_STEP_LINKS = false;
|
|
65
|
+
/**
|
|
66
|
+
* Step definitions with linking metadata
|
|
67
|
+
* Used by SDK and backend for auto-linking after step execution
|
|
68
|
+
*/
|
|
69
|
+
MoveMsrToHeldDto.stepDefinitions = [
|
|
70
|
+
{
|
|
71
|
+
stepKey: 'step_1',
|
|
72
|
+
dtoClass: 'unknown',
|
|
73
|
+
entity: 'unknown',
|
|
74
|
+
linksTo: null
|
|
75
|
+
}
|
|
76
|
+
];
|
|
77
|
+
/** Type-safe step key accessor */
|
|
78
|
+
MoveMsrToHeldDto.Steps = exports.MoveMsrToHeldSteps;
|
|
79
|
+
/** Step classes that can be used with this action */
|
|
80
|
+
MoveMsrToHeldDto.stepClasses = [];
|
|
@@ -21,7 +21,7 @@ export interface UpdateCallAnalyticsMessage extends OdinRecordUpdatedEvent<Updat
|
|
|
21
21
|
/**
|
|
22
22
|
* Properties for UpdateCallAnalytics action
|
|
23
23
|
*
|
|
24
|
-
* @property Required fields:
|
|
24
|
+
* @property Required fields: 4
|
|
25
25
|
* @property Optional fields: 1
|
|
26
26
|
*/
|
|
27
27
|
export interface UpdateCallAnalyticsProperties {
|
|
@@ -41,14 +41,6 @@ export interface UpdateCallAnalyticsProperties {
|
|
|
41
41
|
* @required
|
|
42
42
|
*/
|
|
43
43
|
TimeInProgress: string;
|
|
44
|
-
/**
|
|
45
|
-
* TimeInInitiated
|
|
46
|
-
*
|
|
47
|
-
* TimeInInitiated (Communications - Call)
|
|
48
|
-
* @type {TEXT}
|
|
49
|
-
* @required
|
|
50
|
-
*/
|
|
51
|
-
TimeInInitiated: string;
|
|
52
44
|
/**
|
|
53
45
|
* CustomerHoldTotalSec
|
|
54
46
|
*
|
|
@@ -65,14 +57,6 @@ export interface UpdateCallAnalyticsProperties {
|
|
|
65
57
|
* @required
|
|
66
58
|
*/
|
|
67
59
|
AgentHoldTotalSec: string;
|
|
68
|
-
/**
|
|
69
|
-
* RingingTimeTotalSec
|
|
70
|
-
*
|
|
71
|
-
* RingingTimeTotalSec
|
|
72
|
-
* @type {TEXT}
|
|
73
|
-
* @required
|
|
74
|
-
*/
|
|
75
|
-
RingingTimeTotalSec: string;
|
|
76
60
|
/**
|
|
77
61
|
* Time in IVR
|
|
78
62
|
*
|
|
@@ -22,7 +22,7 @@ export interface UpdateCallOnInboundCallAnsweredMessage extends OdinRecordUpdate
|
|
|
22
22
|
* Properties for UpdateCallOnInboundCallAnswered action
|
|
23
23
|
*
|
|
24
24
|
* @property Required fields: 4
|
|
25
|
-
* @property Optional fields:
|
|
25
|
+
* @property Optional fields: 4
|
|
26
26
|
*/
|
|
27
27
|
export interface UpdateCallOnInboundCallAnsweredProperties {
|
|
28
28
|
/**
|
|
@@ -53,10 +53,10 @@ export interface UpdateCallOnInboundCallAnsweredProperties {
|
|
|
53
53
|
* QueueTime
|
|
54
54
|
*
|
|
55
55
|
* Seconds spent in queue (Communications - Call)
|
|
56
|
-
* @type {
|
|
56
|
+
* @type {TEXT}
|
|
57
57
|
* @required
|
|
58
58
|
*/
|
|
59
|
-
QueueTime:
|
|
59
|
+
QueueTime: string;
|
|
60
60
|
/**
|
|
61
61
|
* RingingDuration
|
|
62
62
|
*
|
|
@@ -78,6 +78,13 @@ export interface UpdateCallOnInboundCallAnsweredProperties {
|
|
|
78
78
|
* @type {DATE_TIME}
|
|
79
79
|
*/
|
|
80
80
|
QueueEntryTime?: string | null;
|
|
81
|
+
/**
|
|
82
|
+
* To
|
|
83
|
+
*
|
|
84
|
+
* Data field for Call records. Used by Communications team.
|
|
85
|
+
* @type {TEXT}
|
|
86
|
+
*/
|
|
87
|
+
To?: string | null;
|
|
81
88
|
}
|
|
82
89
|
/**
|
|
83
90
|
* UpdateCallOnInboundCallAnswered
|
|
@@ -22,7 +22,7 @@ export interface UpdateCallOnInboundCallCompletedMessage extends OdinRecordUpdat
|
|
|
22
22
|
* Properties for UpdateCallOnInboundCallCompleted action
|
|
23
23
|
*
|
|
24
24
|
* @property Required fields: 3
|
|
25
|
-
* @property Optional fields:
|
|
25
|
+
* @property Optional fields: 2
|
|
26
26
|
*/
|
|
27
27
|
export interface UpdateCallOnInboundCallCompletedProperties {
|
|
28
28
|
/**
|
|
@@ -56,6 +56,13 @@ export interface UpdateCallOnInboundCallCompletedProperties {
|
|
|
56
56
|
* @type {DATE_TIME}
|
|
57
57
|
*/
|
|
58
58
|
EndTime?: string | null;
|
|
59
|
+
/**
|
|
60
|
+
* RecordingStatus
|
|
61
|
+
*
|
|
62
|
+
* RecordingStatus (Communications - Call)
|
|
63
|
+
* @type {TEXT}
|
|
64
|
+
*/
|
|
65
|
+
RecordingStatus?: string | null;
|
|
59
66
|
}
|
|
60
67
|
/**
|
|
61
68
|
* UpdateCallOnInboundCallCompleted
|
|
@@ -53,18 +53,18 @@ export interface UpdateCallOnNumberCallStatusProperties {
|
|
|
53
53
|
* TotalDuration
|
|
54
54
|
*
|
|
55
55
|
* Total call duration in seconds from customer perspective (Communications - Call)
|
|
56
|
-
* @type {
|
|
56
|
+
* @type {TEXT}
|
|
57
57
|
* @required
|
|
58
58
|
*/
|
|
59
|
-
TotalDuration:
|
|
59
|
+
TotalDuration: string;
|
|
60
60
|
/**
|
|
61
61
|
* QueueTime
|
|
62
62
|
*
|
|
63
63
|
* Seconds spent in queue (Communications - Call)
|
|
64
|
-
* @type {
|
|
64
|
+
* @type {TEXT}
|
|
65
65
|
* @required
|
|
66
66
|
*/
|
|
67
|
-
QueueTime:
|
|
67
|
+
QueueTime: string;
|
|
68
68
|
}
|
|
69
69
|
/**
|
|
70
70
|
* UpdateCallOnNumberCallStatus
|
|
@@ -53,10 +53,10 @@ export interface UpdateCallOnOutboundDialActionProperties {
|
|
|
53
53
|
* TotalDuration
|
|
54
54
|
*
|
|
55
55
|
* Total call duration in seconds from customer perspective (Communications - Call)
|
|
56
|
-
* @type {
|
|
56
|
+
* @type {TEXT}
|
|
57
57
|
* @required
|
|
58
58
|
*/
|
|
59
|
-
TotalDuration:
|
|
59
|
+
TotalDuration: string;
|
|
60
60
|
}
|
|
61
61
|
/**
|
|
62
62
|
* UpdateCallOnOutboundDialAction
|
|
@@ -151,8 +151,6 @@ export declare enum CallPropertyKeys {
|
|
|
151
151
|
CallStatus = "CallStatus",
|
|
152
152
|
/** transcription url from AWS (Communications - Call) */
|
|
153
153
|
TranscriptionUrl = "TranscriptionUrl",
|
|
154
|
-
/** TimeInInitiated (Communications - Call) */
|
|
155
|
-
TimeInInitiated = "TimeInInitiated",
|
|
156
154
|
/** the source channel (Communications - Call) */
|
|
157
155
|
Channel = "Channel",
|
|
158
156
|
/** RecordingUrl (Communications - Call) */
|
|
@@ -167,10 +165,10 @@ export declare enum CallPropertyKeys {
|
|
|
167
165
|
CallStage = "CallStage",
|
|
168
166
|
/** the external id from the call management system (Communications - Call) */
|
|
169
167
|
ExternalId = "ExternalId",
|
|
170
|
-
/** Seconds spent in queue (Communications - Call) */
|
|
171
|
-
QueueTime = "QueueTime",
|
|
172
168
|
/** WorkOrderId (Communications - Call) */
|
|
173
169
|
WorkOrderId = "WorkOrderId",
|
|
170
|
+
/** Seconds spent in queue (Communications - Call) */
|
|
171
|
+
QueueTime = "QueueTime",
|
|
174
172
|
/** TransferCallId (Communications - Call) */
|
|
175
173
|
TransferCallId = "TransferCallId",
|
|
176
174
|
/** Wrap up taskSid (Communications - Call) */
|
|
@@ -224,9 +222,7 @@ export declare enum CallPropertyKeys {
|
|
|
224
222
|
/** IVRDuration */
|
|
225
223
|
IvrDuration = "IVRDuration",
|
|
226
224
|
/** CallEndReason */
|
|
227
|
-
CallEndReason = "CallEndReason"
|
|
228
|
-
/** RingingTimeTotalSec */
|
|
229
|
-
RingingTimeTotalSec = "RingingTimeTotalSec"
|
|
225
|
+
CallEndReason = "CallEndReason"
|
|
230
226
|
}
|
|
231
227
|
/**
|
|
232
228
|
* Properties for Call records
|
|
@@ -292,11 +288,6 @@ export interface CallProperties {
|
|
|
292
288
|
* @type {TEXT}
|
|
293
289
|
*/
|
|
294
290
|
TranscriptionUrl: string;
|
|
295
|
-
/** TimeInInitiated (Communications - Call)
|
|
296
|
-
*
|
|
297
|
-
* @type {TEXT}
|
|
298
|
-
*/
|
|
299
|
-
TimeInInitiated: string;
|
|
300
291
|
/** the source channel (Communications - Call)
|
|
301
292
|
*
|
|
302
293
|
* @type {TEXT}
|
|
@@ -336,17 +327,17 @@ export interface CallProperties {
|
|
|
336
327
|
* @hidden This field is hidden in the UI
|
|
337
328
|
*/
|
|
338
329
|
ExternalId: string;
|
|
339
|
-
/** Seconds spent in queue (Communications - Call)
|
|
340
|
-
*
|
|
341
|
-
* @type {NUMBER}
|
|
342
|
-
*/
|
|
343
|
-
QueueTime: number;
|
|
344
330
|
/** WorkOrderId (Communications - Call)
|
|
345
331
|
*
|
|
346
332
|
* @type {LOOKUP}
|
|
347
333
|
* @hidden This field is hidden in the UI
|
|
348
334
|
*/
|
|
349
335
|
WorkOrderId: string;
|
|
336
|
+
/** Seconds spent in queue (Communications - Call)
|
|
337
|
+
*
|
|
338
|
+
* @type {TEXT}
|
|
339
|
+
*/
|
|
340
|
+
QueueTime: string;
|
|
350
341
|
/** TransferCallId (Communications - Call)
|
|
351
342
|
*
|
|
352
343
|
* @type {UUID}
|
|
@@ -431,9 +422,9 @@ export interface CallProperties {
|
|
|
431
422
|
CustomerConnection: string;
|
|
432
423
|
/** Total call duration in seconds from customer perspective (Communications - Call)
|
|
433
424
|
*
|
|
434
|
-
* @type {
|
|
425
|
+
* @type {TEXT}
|
|
435
426
|
*/
|
|
436
|
-
TotalDuration:
|
|
427
|
+
TotalDuration: string;
|
|
437
428
|
/** RecordingDuration (Communications - Call)
|
|
438
429
|
*
|
|
439
430
|
* @type {TEXT}
|
|
@@ -485,11 +476,6 @@ export interface CallProperties {
|
|
|
485
476
|
* @enum {CallCallEndReason}
|
|
486
477
|
*/
|
|
487
478
|
CallEndReason: CallCallEndReason;
|
|
488
|
-
/** RingingTimeTotalSec
|
|
489
|
-
*
|
|
490
|
-
* @type {TEXT}
|
|
491
|
-
*/
|
|
492
|
-
RingingTimeTotalSec: string;
|
|
493
479
|
}
|
|
494
480
|
/**
|
|
495
481
|
* Call entity from NotificationModule
|
package/dist/entities-v2/Call.js
CHANGED
|
@@ -150,8 +150,6 @@ var CallPropertyKeys;
|
|
|
150
150
|
CallPropertyKeys["CallStatus"] = "CallStatus";
|
|
151
151
|
/** transcription url from AWS (Communications - Call) */
|
|
152
152
|
CallPropertyKeys["TranscriptionUrl"] = "TranscriptionUrl";
|
|
153
|
-
/** TimeInInitiated (Communications - Call) */
|
|
154
|
-
CallPropertyKeys["TimeInInitiated"] = "TimeInInitiated";
|
|
155
153
|
/** the source channel (Communications - Call) */
|
|
156
154
|
CallPropertyKeys["Channel"] = "Channel";
|
|
157
155
|
/** RecordingUrl (Communications - Call) */
|
|
@@ -166,10 +164,10 @@ var CallPropertyKeys;
|
|
|
166
164
|
CallPropertyKeys["CallStage"] = "CallStage";
|
|
167
165
|
/** the external id from the call management system (Communications - Call) */
|
|
168
166
|
CallPropertyKeys["ExternalId"] = "ExternalId";
|
|
169
|
-
/** Seconds spent in queue (Communications - Call) */
|
|
170
|
-
CallPropertyKeys["QueueTime"] = "QueueTime";
|
|
171
167
|
/** WorkOrderId (Communications - Call) */
|
|
172
168
|
CallPropertyKeys["WorkOrderId"] = "WorkOrderId";
|
|
169
|
+
/** Seconds spent in queue (Communications - Call) */
|
|
170
|
+
CallPropertyKeys["QueueTime"] = "QueueTime";
|
|
173
171
|
/** TransferCallId (Communications - Call) */
|
|
174
172
|
CallPropertyKeys["TransferCallId"] = "TransferCallId";
|
|
175
173
|
/** Wrap up taskSid (Communications - Call) */
|
|
@@ -224,8 +222,6 @@ var CallPropertyKeys;
|
|
|
224
222
|
CallPropertyKeys["IvrDuration"] = "IVRDuration";
|
|
225
223
|
/** CallEndReason */
|
|
226
224
|
CallPropertyKeys["CallEndReason"] = "CallEndReason";
|
|
227
|
-
/** RingingTimeTotalSec */
|
|
228
|
-
CallPropertyKeys["RingingTimeTotalSec"] = "RingingTimeTotalSec";
|
|
229
225
|
})(CallPropertyKeys = exports.CallPropertyKeys || (exports.CallPropertyKeys = {}));
|
|
230
226
|
/**
|
|
231
227
|
* Call entity from NotificationModule
|
|
@@ -481,6 +481,31 @@ export declare class ModifyServiceRequestRecord<TProps = ModifyServiceRequestPro
|
|
|
481
481
|
moveMsrToFailed(options?: {
|
|
482
482
|
journeyId?: string;
|
|
483
483
|
}): MoveMsrToFailedFlowBuilder;
|
|
484
|
+
/**
|
|
485
|
+
* MoveMsrToHeld
|
|
486
|
+
*
|
|
487
|
+
* Transitions this ModifyServiceRequest record to a new pipeline stage.
|
|
488
|
+
* Returns an ActionBuilder - call .execute() to transition or .dryRun() for debugging.
|
|
489
|
+
*
|
|
490
|
+
* @remarks Transitions to stage: ModifyServiceRequestStateStageHeld
|
|
491
|
+
*
|
|
492
|
+
* @param options - Optional settings
|
|
493
|
+
* @param options.journeyId - Associate with a journey
|
|
494
|
+
* @returns ActionBuilder - call .execute() to transition or .dryRun() for payload
|
|
495
|
+
* @throws Error if called on a new (unsaved) record
|
|
496
|
+
*
|
|
497
|
+
* @example
|
|
498
|
+
* ```typescript
|
|
499
|
+
* const record = await odinClient.modifyServiceRequests.get(id);
|
|
500
|
+
* await record.moveMsrToHeld().execute();
|
|
501
|
+
*
|
|
502
|
+
* // Dry run (for debugging)
|
|
503
|
+
* const payload = record.moveMsrToHeld().dryRun();
|
|
504
|
+
* ```
|
|
505
|
+
*/
|
|
506
|
+
moveMsrToHeld(options?: {
|
|
507
|
+
journeyId?: string;
|
|
508
|
+
}): ActionBuilder;
|
|
484
509
|
/**
|
|
485
510
|
* MoveMsrToInProgress
|
|
486
511
|
*
|
|
@@ -712,6 +712,35 @@ class ModifyServiceRequestRecord {
|
|
|
712
712
|
throw new Error('moveMsrToFailed requires an existing record. Use accessor.get() first.');
|
|
713
713
|
return new MoveMsrToFailedFlowBuilder(this, this._provider, this._pendingLinks, options);
|
|
714
714
|
}
|
|
715
|
+
/**
|
|
716
|
+
* MoveMsrToHeld
|
|
717
|
+
*
|
|
718
|
+
* Transitions this ModifyServiceRequest record to a new pipeline stage.
|
|
719
|
+
* Returns an ActionBuilder - call .execute() to transition or .dryRun() for debugging.
|
|
720
|
+
*
|
|
721
|
+
* @remarks Transitions to stage: ModifyServiceRequestStateStageHeld
|
|
722
|
+
*
|
|
723
|
+
* @param options - Optional settings
|
|
724
|
+
* @param options.journeyId - Associate with a journey
|
|
725
|
+
* @returns ActionBuilder - call .execute() to transition or .dryRun() for payload
|
|
726
|
+
* @throws Error if called on a new (unsaved) record
|
|
727
|
+
*
|
|
728
|
+
* @example
|
|
729
|
+
* ```typescript
|
|
730
|
+
* const record = await odinClient.modifyServiceRequests.get(id);
|
|
731
|
+
* await record.moveMsrToHeld().execute();
|
|
732
|
+
*
|
|
733
|
+
* // Dry run (for debugging)
|
|
734
|
+
* const payload = record.moveMsrToHeld().dryRun();
|
|
735
|
+
* ```
|
|
736
|
+
*/
|
|
737
|
+
moveMsrToHeld(options) {
|
|
738
|
+
var _a;
|
|
739
|
+
if (!((_a = this._record) === null || _a === void 0 ? void 0 : _a.id))
|
|
740
|
+
throw new Error('moveMsrToHeld requires an existing record. Use accessor.get() first.');
|
|
741
|
+
const payload = Object.assign({ id: this._record.id, entity: this._record.entity, type: this._record.type, actionName: 'MoveMsrToHeld', associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined, stageKey: 'ModifyServiceRequestStateStageHeld' }, options);
|
|
742
|
+
return new ActionBuilder(this._provider, 'ServiceModule', 'ModifyServiceRequest', payload, () => { this._pendingLinks = []; });
|
|
743
|
+
}
|
|
715
744
|
/**
|
|
716
745
|
* MoveMsrToInProgress
|
|
717
746
|
*
|