@d19n/youfibre-odin-sdk 2.0.135 → 2.0.136
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -1
- package/dist/actions-v2/UpdateCustomerCallLegOnIncomingCallCompletedDto.d.ts +88 -0
- package/dist/actions-v2/UpdateCustomerCallLegOnIncomingCallCompletedDto.js +56 -0
- package/dist/records-v2/CallLegRecord.d.ts +27 -0
- package/dist/records-v2/CallLegRecord.js +29 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -353,7 +353,7 @@ This SDK includes **165** entities across **12** modules.
|
|
|
353
353
|
|
|
354
354
|
## Actions
|
|
355
355
|
|
|
356
|
-
This SDK includes **
|
|
356
|
+
This SDK includes **687** actions.
|
|
357
357
|
|
|
358
358
|
### Action Types
|
|
359
359
|
|
|
@@ -1210,6 +1210,7 @@ This SDK includes **686** actions.
|
|
|
1210
1210
|
| `UpdateCall` | UPDATE | k1.t-hEOJjsDb.NotificationModule.CallLeg.Update.UpdateCall |
|
|
1211
1211
|
| `UpdateCustomerCallLegOnIncomingCallAnswered` | UPDATE | k1.t-hEOJjsDb.NotificationModule.CallLeg.Update.UpdateCustomerCallLegOnIncomingCallAnswered |
|
|
1212
1212
|
| `UpdateCustomerCallLegOnIncomingCallCanceled` | UPDATE | k1.t-hEOJjsDb.NotificationModule.CallLeg.Update.UpdateCustomerCallLegOnIncomingCallCanceled |
|
|
1213
|
+
| `UpdateCustomerCallLegOnIncomingCallCompleted` | UPDATE | k1.t-hEOJjsDb.NotificationModule.CallLeg.Update.UpdateCustomerCallLegOnIncomingCallCompleted |
|
|
1213
1214
|
| `UpdateCustomerCallLegOnIncomingCallFailed` | UPDATE | k1.t-hEOJjsDb.NotificationModule.CallLeg.Update.UpdateCustomerCallLegOnIncomingCallFailed |
|
|
1214
1215
|
| `UpdateCustomerCallLegOnIncomingCallNoAnswer` | UPDATE | k1.t-hEOJjsDb.NotificationModule.CallLeg.Update.UpdateCustomerCallLegOnIncomingCallNoAnswer |
|
|
1215
1216
|
| `UpdateCustomerCallLegOnIncomingCallRinging` | UPDATE | k1.t-hEOJjsDb.NotificationModule.CallLeg.Update.UpdateCustomerCallLegOnIncomingCallRinging |
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* UpdateCustomerCallLegOnIncomingCallCompleted Action DTO
|
|
3
|
+
*
|
|
4
|
+
* Update customer call leg on incoming call completed
|
|
5
|
+
*
|
|
6
|
+
* @module NotificationModule
|
|
7
|
+
* @entity CallLeg
|
|
8
|
+
* @actionKey UpdateCustomerCallLegOnIncomingCallCompleted
|
|
9
|
+
* @event k1.t-hEOJjsDb.NotificationModule.CallLeg.Update.UpdateCustomerCallLegOnIncomingCallCompleted
|
|
10
|
+
*
|
|
11
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
12
|
+
*/
|
|
13
|
+
import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
|
|
14
|
+
/**
|
|
15
|
+
* RabbitMQ message payload for UpdateCustomerCallLegOnIncomingCallCompleted updated events
|
|
16
|
+
*
|
|
17
|
+
* @event k1.t-hEOJjsDb.NotificationModule.CallLeg.Update.UpdateCustomerCallLegOnIncomingCallCompleted
|
|
18
|
+
*/
|
|
19
|
+
export interface UpdateCustomerCallLegOnIncomingCallCompletedMessage extends OdinRecordUpdatedEvent<UpdateCustomerCallLegOnIncomingCallCompletedDto, UpdateCustomerCallLegOnIncomingCallCompletedProperties> {
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Properties for UpdateCustomerCallLegOnIncomingCallCompleted action
|
|
23
|
+
*
|
|
24
|
+
* @property Required fields: 2
|
|
25
|
+
* @property Optional fields: 1
|
|
26
|
+
*/
|
|
27
|
+
export interface UpdateCustomerCallLegOnIncomingCallCompletedProperties {
|
|
28
|
+
/**
|
|
29
|
+
* EndedAt
|
|
30
|
+
*
|
|
31
|
+
* Data field for CallLeg records. Used by Communications team.
|
|
32
|
+
* @type {DATE_TIME}
|
|
33
|
+
* @required
|
|
34
|
+
*/
|
|
35
|
+
EndedAt: string;
|
|
36
|
+
/**
|
|
37
|
+
* Status
|
|
38
|
+
*
|
|
39
|
+
* Status indicator for CallLeg records. Tracks lifecycle state. Used by Communications team.
|
|
40
|
+
* @type {ENUM}
|
|
41
|
+
* @required
|
|
42
|
+
*/
|
|
43
|
+
Status: string;
|
|
44
|
+
/**
|
|
45
|
+
* Duration
|
|
46
|
+
*
|
|
47
|
+
* Duration of THIS leg only in seconds (Communications - CallLeg)
|
|
48
|
+
* @type {NUMBER}
|
|
49
|
+
*/
|
|
50
|
+
Duration?: number | null;
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
* UpdateCustomerCallLegOnIncomingCallCompleted
|
|
54
|
+
*
|
|
55
|
+
* Update customer call leg on incoming call completed
|
|
56
|
+
*
|
|
57
|
+
* @actionType UPDATE - Updates an existing CallLeg record
|
|
58
|
+
* @module NotificationModule
|
|
59
|
+
* @entity CallLeg
|
|
60
|
+
* @event k1.t-hEOJjsDb.NotificationModule.CallLeg.Update.UpdateCustomerCallLegOnIncomingCallCompleted
|
|
61
|
+
* @permission schema.action.updatecustomercalllegonincomingcallcompleted.trigger
|
|
62
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
63
|
+
*/
|
|
64
|
+
export declare class UpdateCustomerCallLegOnIncomingCallCompletedDto extends OdinRecordUpdateDto<UpdateCustomerCallLegOnIncomingCallCompletedProperties> {
|
|
65
|
+
/** Used by SDK generators to identify action type */
|
|
66
|
+
static readonly ACTION_TYPE = "UPDATE";
|
|
67
|
+
static readonly ACTION_KEY = "UpdateCustomerCallLegOnIncomingCallCompleted";
|
|
68
|
+
static readonly MODULE_NAME = "NotificationModule";
|
|
69
|
+
static readonly ENTITIES: string[];
|
|
70
|
+
static readonly EVENT_NAME = "k1.t-hEOJjsDb.NotificationModule.CallLeg.Update.UpdateCustomerCallLegOnIncomingCallCompleted";
|
|
71
|
+
static readonly PERMISSION = "schema.action.updatecustomercalllegonincomingcallcompleted.trigger";
|
|
72
|
+
/** Step metadata - entity this action targets */
|
|
73
|
+
static readonly STEP_ENTITY = "NotificationModule:CallLeg";
|
|
74
|
+
static readonly STEP_SCHEMA_ID = "75c59745-35fb-44b9-b3f2-7563101fdcec";
|
|
75
|
+
static readonly STEP_SCHEMA_ACTION_ID = "2a9223e7-e81f-4efc-9d61-2949d93f1932";
|
|
76
|
+
static readonly AUTO_LINK_PARENT = false;
|
|
77
|
+
readonly actionName: string;
|
|
78
|
+
readonly schemaActionId: string;
|
|
79
|
+
readonly entity: string;
|
|
80
|
+
constructor(record: OdinRecord<any> | {
|
|
81
|
+
id: string;
|
|
82
|
+
entity: string;
|
|
83
|
+
type?: string;
|
|
84
|
+
}, properties: UpdateCustomerCallLegOnIncomingCallCompletedProperties, options?: {
|
|
85
|
+
journeyId?: string;
|
|
86
|
+
stageKey?: string;
|
|
87
|
+
});
|
|
88
|
+
}
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* UpdateCustomerCallLegOnIncomingCallCompleted Action DTO
|
|
4
|
+
*
|
|
5
|
+
* Update customer call leg on incoming call completed
|
|
6
|
+
*
|
|
7
|
+
* @module NotificationModule
|
|
8
|
+
* @entity CallLeg
|
|
9
|
+
* @actionKey UpdateCustomerCallLegOnIncomingCallCompleted
|
|
10
|
+
* @event k1.t-hEOJjsDb.NotificationModule.CallLeg.Update.UpdateCustomerCallLegOnIncomingCallCompleted
|
|
11
|
+
*
|
|
12
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
13
|
+
*/
|
|
14
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
|
+
exports.UpdateCustomerCallLegOnIncomingCallCompletedDto = void 0;
|
|
16
|
+
const core_1 = require("@d19n/odin-types/dist/core");
|
|
17
|
+
/**
|
|
18
|
+
* UpdateCustomerCallLegOnIncomingCallCompleted
|
|
19
|
+
*
|
|
20
|
+
* Update customer call leg on incoming call completed
|
|
21
|
+
*
|
|
22
|
+
* @actionType UPDATE - Updates an existing CallLeg record
|
|
23
|
+
* @module NotificationModule
|
|
24
|
+
* @entity CallLeg
|
|
25
|
+
* @event k1.t-hEOJjsDb.NotificationModule.CallLeg.Update.UpdateCustomerCallLegOnIncomingCallCompleted
|
|
26
|
+
* @permission schema.action.updatecustomercalllegonincomingcallcompleted.trigger
|
|
27
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
28
|
+
*/
|
|
29
|
+
class UpdateCustomerCallLegOnIncomingCallCompletedDto extends core_1.OdinRecordUpdateDto {
|
|
30
|
+
constructor(record, properties, options) {
|
|
31
|
+
super({
|
|
32
|
+
id: record.id,
|
|
33
|
+
entity: record.entity,
|
|
34
|
+
type: record.type,
|
|
35
|
+
properties,
|
|
36
|
+
journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
|
|
37
|
+
stageKey: options === null || options === void 0 ? void 0 : options.stageKey,
|
|
38
|
+
});
|
|
39
|
+
this.actionName = 'UpdateCustomerCallLegOnIncomingCallCompleted';
|
|
40
|
+
this.schemaActionId = '2a9223e7-e81f-4efc-9d61-2949d93f1932';
|
|
41
|
+
this.entity = 'NotificationModule:CallLeg';
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
exports.UpdateCustomerCallLegOnIncomingCallCompletedDto = UpdateCustomerCallLegOnIncomingCallCompletedDto;
|
|
45
|
+
/** Used by SDK generators to identify action type */
|
|
46
|
+
UpdateCustomerCallLegOnIncomingCallCompletedDto.ACTION_TYPE = 'UPDATE';
|
|
47
|
+
UpdateCustomerCallLegOnIncomingCallCompletedDto.ACTION_KEY = 'UpdateCustomerCallLegOnIncomingCallCompleted';
|
|
48
|
+
UpdateCustomerCallLegOnIncomingCallCompletedDto.MODULE_NAME = 'NotificationModule';
|
|
49
|
+
UpdateCustomerCallLegOnIncomingCallCompletedDto.ENTITIES = ['CallLeg'];
|
|
50
|
+
UpdateCustomerCallLegOnIncomingCallCompletedDto.EVENT_NAME = 'k1.t-hEOJjsDb.NotificationModule.CallLeg.Update.UpdateCustomerCallLegOnIncomingCallCompleted';
|
|
51
|
+
UpdateCustomerCallLegOnIncomingCallCompletedDto.PERMISSION = 'schema.action.updatecustomercalllegonincomingcallcompleted.trigger';
|
|
52
|
+
/** Step metadata - entity this action targets */
|
|
53
|
+
UpdateCustomerCallLegOnIncomingCallCompletedDto.STEP_ENTITY = 'NotificationModule:CallLeg';
|
|
54
|
+
UpdateCustomerCallLegOnIncomingCallCompletedDto.STEP_SCHEMA_ID = '75c59745-35fb-44b9-b3f2-7563101fdcec';
|
|
55
|
+
UpdateCustomerCallLegOnIncomingCallCompletedDto.STEP_SCHEMA_ACTION_ID = '2a9223e7-e81f-4efc-9d61-2949d93f1932';
|
|
56
|
+
UpdateCustomerCallLegOnIncomingCallCompletedDto.AUTO_LINK_PARENT = false;
|
|
@@ -39,6 +39,7 @@ import { UpdateAgentCallLegOnOutboundCallRingingProperties } from '../actions-v2
|
|
|
39
39
|
import { UpdateCallProperties } from '../actions-v2/UpdateCallDto';
|
|
40
40
|
import { UpdateCustomerCallLegOnIncomingCallAnsweredProperties } from '../actions-v2/UpdateCustomerCallLegOnIncomingCallAnsweredDto';
|
|
41
41
|
import { UpdateCustomerCallLegOnIncomingCallCanceledProperties } from '../actions-v2/UpdateCustomerCallLegOnIncomingCallCanceledDto';
|
|
42
|
+
import { UpdateCustomerCallLegOnIncomingCallCompletedProperties } from '../actions-v2/UpdateCustomerCallLegOnIncomingCallCompletedDto';
|
|
42
43
|
import { UpdateCustomerCallLegOnIncomingCallFailedProperties } from '../actions-v2/UpdateCustomerCallLegOnIncomingCallFailedDto';
|
|
43
44
|
import { UpdateCustomerCallLegOnIncomingCallNoAnswerProperties } from '../actions-v2/UpdateCustomerCallLegOnIncomingCallNoAnswerDto';
|
|
44
45
|
import { UpdateCustomerCallLegOnIncomingCallRingingProperties } from '../actions-v2/UpdateCustomerCallLegOnIncomingCallRingingDto';
|
|
@@ -656,6 +657,32 @@ export declare class CallLegRecord<TProps = CallLegProperties> {
|
|
|
656
657
|
journeyId?: string;
|
|
657
658
|
stageKey?: string;
|
|
658
659
|
}): ActionBuilder;
|
|
660
|
+
/**
|
|
661
|
+
* UpdateCustomerCallLegOnIncomingCallCompleted
|
|
662
|
+
*
|
|
663
|
+
* Updates this CallLeg record with the specified properties.
|
|
664
|
+
* Returns an ActionBuilder - call .execute() to update or .dryRun() for debugging.
|
|
665
|
+
*
|
|
666
|
+
* @param properties - Required properties for this action
|
|
667
|
+
* @param options - Optional settings
|
|
668
|
+
* @param options.journeyId - Associate with a journey
|
|
669
|
+
* @param options.stageKey - Transition to pipeline stage
|
|
670
|
+
* @returns ActionBuilder - call .execute() to update or .dryRun() for payload
|
|
671
|
+
* @throws Error if called on a new (unsaved) record
|
|
672
|
+
*
|
|
673
|
+
* @example
|
|
674
|
+
* ```typescript
|
|
675
|
+
* const record = await odinClient.callLegs.get(id);
|
|
676
|
+
* await record.updateCustomerCallLegOnIncomingCallCompleted({ ... }).execute();
|
|
677
|
+
*
|
|
678
|
+
* // Dry run (for debugging)
|
|
679
|
+
* const payload = record.updateCustomerCallLegOnIncomingCallCompleted({ ... }).dryRun();
|
|
680
|
+
* ```
|
|
681
|
+
*/
|
|
682
|
+
updateCustomerCallLegOnIncomingCallCompleted(properties: UpdateCustomerCallLegOnIncomingCallCompletedProperties, options?: {
|
|
683
|
+
journeyId?: string;
|
|
684
|
+
stageKey?: string;
|
|
685
|
+
}): ActionBuilder;
|
|
659
686
|
/**
|
|
660
687
|
* UpdateCustomerCallLegOnIncomingCallFailed
|
|
661
688
|
*
|
|
@@ -781,6 +781,35 @@ class CallLegRecord {
|
|
|
781
781
|
const payload = Object.assign({ id: this._record.id, entity: this._record.entity, type: this._record.type, actionName: 'UpdateCustomerCallLegOnIncomingCallCanceled', properties, associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined }, options);
|
|
782
782
|
return new ActionBuilder(this._provider, 'NotificationModule', 'CallLeg', payload, () => { this._pendingLinks = []; });
|
|
783
783
|
}
|
|
784
|
+
/**
|
|
785
|
+
* UpdateCustomerCallLegOnIncomingCallCompleted
|
|
786
|
+
*
|
|
787
|
+
* Updates this CallLeg record with the specified properties.
|
|
788
|
+
* Returns an ActionBuilder - call .execute() to update or .dryRun() for debugging.
|
|
789
|
+
*
|
|
790
|
+
* @param properties - Required properties for this action
|
|
791
|
+
* @param options - Optional settings
|
|
792
|
+
* @param options.journeyId - Associate with a journey
|
|
793
|
+
* @param options.stageKey - Transition to pipeline stage
|
|
794
|
+
* @returns ActionBuilder - call .execute() to update or .dryRun() for payload
|
|
795
|
+
* @throws Error if called on a new (unsaved) record
|
|
796
|
+
*
|
|
797
|
+
* @example
|
|
798
|
+
* ```typescript
|
|
799
|
+
* const record = await odinClient.callLegs.get(id);
|
|
800
|
+
* await record.updateCustomerCallLegOnIncomingCallCompleted({ ... }).execute();
|
|
801
|
+
*
|
|
802
|
+
* // Dry run (for debugging)
|
|
803
|
+
* const payload = record.updateCustomerCallLegOnIncomingCallCompleted({ ... }).dryRun();
|
|
804
|
+
* ```
|
|
805
|
+
*/
|
|
806
|
+
updateCustomerCallLegOnIncomingCallCompleted(properties, options) {
|
|
807
|
+
var _a;
|
|
808
|
+
if (!((_a = this._record) === null || _a === void 0 ? void 0 : _a.id))
|
|
809
|
+
throw new Error('updateCustomerCallLegOnIncomingCallCompleted requires an existing record. Use accessor.get() first.');
|
|
810
|
+
const payload = Object.assign({ id: this._record.id, entity: this._record.entity, type: this._record.type, actionName: 'UpdateCustomerCallLegOnIncomingCallCompleted', properties, associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined }, options);
|
|
811
|
+
return new ActionBuilder(this._provider, 'NotificationModule', 'CallLeg', payload, () => { this._pendingLinks = []; });
|
|
812
|
+
}
|
|
784
813
|
/**
|
|
785
814
|
* UpdateCustomerCallLegOnIncomingCallFailed
|
|
786
815
|
*
|