@d19n/youfibre-odin-sdk 2.0.102-beta.3 → 2.0.102
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/SendDirectDebitCreatedEmailDto.d.ts +8 -1
- package/dist/actions-v2/SendDirectDebitFailedEmailDto.d.ts +8 -1
- package/dist/actions-v2/SendDirectDebitSetupConfirmationEmailDto.d.ts +8 -1
- package/dist/actions-v2/SendDirectDebitSetupRequestDto.d.ts +8 -1
- package/dist/actions-v2/SendRefundTransactionEmailDto.d.ts +8 -1
- package/dist/actions-v2/UpdateCallOnTaskRouterAssignDto.d.ts +96 -0
- package/dist/actions-v2/UpdateCallOnTaskRouterAssignDto.js +56 -0
- package/dist/records-v2/CallRecord.d.ts +27 -0
- package/dist/records-v2/CallRecord.js +29 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -352,7 +352,7 @@ This SDK includes **164** entities across **12** modules.
|
|
|
352
352
|
|
|
353
353
|
## Actions
|
|
354
354
|
|
|
355
|
-
This SDK includes **
|
|
355
|
+
This SDK includes **620** actions.
|
|
356
356
|
|
|
357
357
|
### Action Types
|
|
358
358
|
|
|
@@ -1171,6 +1171,7 @@ This SDK includes **619** actions.
|
|
|
1171
1171
|
| Action | Type | Event |
|
|
1172
1172
|
|--------|------|-------|
|
|
1173
1173
|
| `CreateCall` | CREATE | k1.t-hEOJjsDb.NotificationModule.Call.Create.CreateCall |
|
|
1174
|
+
| `UpdateCallOnTaskRouterAssign` | UPDATE | k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCallOnTaskRouterAssign |
|
|
1174
1175
|
| `UpdateCallTranscriptionUrl` | UPDATE | k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCallTranscriptionUrl |
|
|
1175
1176
|
|
|
1176
1177
|
#### CallEvent
|
|
@@ -23,7 +23,7 @@ export interface SendDirectDebitCreatedEmailMessage extends OdinRecordCreatedEve
|
|
|
23
23
|
* Properties for SendDirectDebitCreatedEmail action
|
|
24
24
|
*
|
|
25
25
|
* @property Required fields: 0
|
|
26
|
-
* @property Optional fields:
|
|
26
|
+
* @property Optional fields: 9
|
|
27
27
|
*/
|
|
28
28
|
export interface SendDirectDebitCreatedEmailProperties {
|
|
29
29
|
/**
|
|
@@ -82,6 +82,13 @@ export interface SendDirectDebitCreatedEmailProperties {
|
|
|
82
82
|
* @type {TEXT}
|
|
83
83
|
*/
|
|
84
84
|
Title?: string | null;
|
|
85
|
+
/**
|
|
86
|
+
* Subject
|
|
87
|
+
*
|
|
88
|
+
* Data field for Email records. Used by Communications team.
|
|
89
|
+
* @type {TEXT}
|
|
90
|
+
*/
|
|
91
|
+
Subject?: string | null;
|
|
85
92
|
}
|
|
86
93
|
/**
|
|
87
94
|
* SendDirectDebitCreatedEmail
|
|
@@ -23,7 +23,7 @@ export interface SendDirectDebitFailedEmailMessage extends OdinRecordCreatedEven
|
|
|
23
23
|
* Properties for SendDirectDebitFailedEmail action
|
|
24
24
|
*
|
|
25
25
|
* @property Required fields: 0
|
|
26
|
-
* @property Optional fields:
|
|
26
|
+
* @property Optional fields: 9
|
|
27
27
|
*/
|
|
28
28
|
export interface SendDirectDebitFailedEmailProperties {
|
|
29
29
|
/**
|
|
@@ -82,6 +82,13 @@ export interface SendDirectDebitFailedEmailProperties {
|
|
|
82
82
|
* @type {TEXT}
|
|
83
83
|
*/
|
|
84
84
|
Title?: string | null;
|
|
85
|
+
/**
|
|
86
|
+
* Subject
|
|
87
|
+
*
|
|
88
|
+
* Data field for Email records. Used by Communications team.
|
|
89
|
+
* @type {TEXT}
|
|
90
|
+
*/
|
|
91
|
+
Subject?: string | null;
|
|
85
92
|
}
|
|
86
93
|
/**
|
|
87
94
|
* SendDirectDebitFailedEmail
|
|
@@ -23,7 +23,7 @@ export interface SendDirectDebitSetupConfirmationEmailMessage extends OdinRecord
|
|
|
23
23
|
* Properties for SendDirectDebitSetupConfirmationEmail action
|
|
24
24
|
*
|
|
25
25
|
* @property Required fields: 0
|
|
26
|
-
* @property Optional fields:
|
|
26
|
+
* @property Optional fields: 9
|
|
27
27
|
*/
|
|
28
28
|
export interface SendDirectDebitSetupConfirmationEmailProperties {
|
|
29
29
|
/**
|
|
@@ -82,6 +82,13 @@ export interface SendDirectDebitSetupConfirmationEmailProperties {
|
|
|
82
82
|
* @type {TEXT}
|
|
83
83
|
*/
|
|
84
84
|
Title?: string | null;
|
|
85
|
+
/**
|
|
86
|
+
* Subject
|
|
87
|
+
*
|
|
88
|
+
* Data field for Email records. Used by Communications team.
|
|
89
|
+
* @type {TEXT}
|
|
90
|
+
*/
|
|
91
|
+
Subject?: string | null;
|
|
85
92
|
}
|
|
86
93
|
/**
|
|
87
94
|
* SendDirectDebitSetupConfirmationEmail
|
|
@@ -23,7 +23,7 @@ export interface SendDirectDebitSetupRequestMessage extends OdinRecordCreatedEve
|
|
|
23
23
|
* Properties for SendDirectDebitSetupRequest action
|
|
24
24
|
*
|
|
25
25
|
* @property Required fields: 0
|
|
26
|
-
* @property Optional fields:
|
|
26
|
+
* @property Optional fields: 9
|
|
27
27
|
*/
|
|
28
28
|
export interface SendDirectDebitSetupRequestProperties {
|
|
29
29
|
/**
|
|
@@ -82,6 +82,13 @@ export interface SendDirectDebitSetupRequestProperties {
|
|
|
82
82
|
* @type {TEXT}
|
|
83
83
|
*/
|
|
84
84
|
Title?: string | null;
|
|
85
|
+
/**
|
|
86
|
+
* Subject
|
|
87
|
+
*
|
|
88
|
+
* Data field for Email records. Used by Communications team.
|
|
89
|
+
* @type {TEXT}
|
|
90
|
+
*/
|
|
91
|
+
Subject?: string | null;
|
|
85
92
|
}
|
|
86
93
|
/**
|
|
87
94
|
* SendDirectDebitSetupRequest
|
|
@@ -22,7 +22,7 @@ export interface SendRefundTransactionEmailMessage extends OdinRecordCreatedEven
|
|
|
22
22
|
* Properties for SendRefundTransactionEmail action
|
|
23
23
|
*
|
|
24
24
|
* @property Required fields: 0
|
|
25
|
-
* @property Optional fields:
|
|
25
|
+
* @property Optional fields: 9
|
|
26
26
|
*/
|
|
27
27
|
export interface SendRefundTransactionEmailProperties {
|
|
28
28
|
/**
|
|
@@ -81,6 +81,13 @@ export interface SendRefundTransactionEmailProperties {
|
|
|
81
81
|
* @type {TEXT}
|
|
82
82
|
*/
|
|
83
83
|
Title?: string | null;
|
|
84
|
+
/**
|
|
85
|
+
* Subject
|
|
86
|
+
*
|
|
87
|
+
* Data field for Email records. Used by Communications team.
|
|
88
|
+
* @type {TEXT}
|
|
89
|
+
*/
|
|
90
|
+
Subject?: string | null;
|
|
84
91
|
}
|
|
85
92
|
/**
|
|
86
93
|
* SendRefundTransactionEmail
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* UpdateCallOnTaskRouterAssign Action DTO
|
|
3
|
+
*
|
|
4
|
+
* Update call on twillio Task Router Assign
|
|
5
|
+
*
|
|
6
|
+
* @module NotificationModule
|
|
7
|
+
* @entity Call
|
|
8
|
+
* @actionKey UpdateCallOnTaskRouterAssign
|
|
9
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCallOnTaskRouterAssign
|
|
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 UpdateCallOnTaskRouterAssign updated events
|
|
16
|
+
*
|
|
17
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCallOnTaskRouterAssign
|
|
18
|
+
*/
|
|
19
|
+
export interface UpdateCallOnTaskRouterAssignMessage extends OdinRecordUpdatedEvent<UpdateCallOnTaskRouterAssignDto, UpdateCallOnTaskRouterAssignProperties> {
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Properties for UpdateCallOnTaskRouterAssign action
|
|
23
|
+
*
|
|
24
|
+
* @property Required fields: 3
|
|
25
|
+
* @property Optional fields: 1
|
|
26
|
+
*/
|
|
27
|
+
export interface UpdateCallOnTaskRouterAssignProperties {
|
|
28
|
+
/**
|
|
29
|
+
* TaskSid
|
|
30
|
+
*
|
|
31
|
+
* Wrap up taskSid (Communications - Call)
|
|
32
|
+
* @type {TEXT}
|
|
33
|
+
* @required
|
|
34
|
+
*/
|
|
35
|
+
TaskSid: string;
|
|
36
|
+
/**
|
|
37
|
+
* CurrentAgentEmail
|
|
38
|
+
*
|
|
39
|
+
* Email of currently assigned agent (Communications - Call)
|
|
40
|
+
* @type {TEXT}
|
|
41
|
+
* @required
|
|
42
|
+
*/
|
|
43
|
+
CurrentAgentEmail: string;
|
|
44
|
+
/**
|
|
45
|
+
* user Id
|
|
46
|
+
*
|
|
47
|
+
* The Odin user that handled the call (Communications - Call)
|
|
48
|
+
* @type {UUID}
|
|
49
|
+
* @required
|
|
50
|
+
*/
|
|
51
|
+
UserId: string;
|
|
52
|
+
/**
|
|
53
|
+
* QueueName
|
|
54
|
+
*
|
|
55
|
+
* Display name/title for Call records. Primary identifier for Communications team.
|
|
56
|
+
* @type {TEXT}
|
|
57
|
+
*/
|
|
58
|
+
QueueName?: string | null;
|
|
59
|
+
}
|
|
60
|
+
/**
|
|
61
|
+
* UpdateCallOnTaskRouterAssign
|
|
62
|
+
*
|
|
63
|
+
* Update call on twillio Task Router Assign
|
|
64
|
+
*
|
|
65
|
+
* @actionType UPDATE - Updates an existing Call record
|
|
66
|
+
* @module NotificationModule
|
|
67
|
+
* @entity Call
|
|
68
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCallOnTaskRouterAssign
|
|
69
|
+
* @permission schema.action.updatecallontaskrouterassign.trigger
|
|
70
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
71
|
+
*/
|
|
72
|
+
export declare class UpdateCallOnTaskRouterAssignDto extends OdinRecordUpdateDto<UpdateCallOnTaskRouterAssignProperties> {
|
|
73
|
+
/** Used by SDK generators to identify action type */
|
|
74
|
+
static readonly ACTION_TYPE = "UPDATE";
|
|
75
|
+
static readonly ACTION_KEY = "UpdateCallOnTaskRouterAssign";
|
|
76
|
+
static readonly MODULE_NAME = "NotificationModule";
|
|
77
|
+
static readonly ENTITIES: string[];
|
|
78
|
+
static readonly EVENT_NAME = "k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCallOnTaskRouterAssign";
|
|
79
|
+
static readonly PERMISSION = "schema.action.updatecallontaskrouterassign.trigger";
|
|
80
|
+
/** Step metadata - entity this action targets */
|
|
81
|
+
static readonly STEP_ENTITY = "NotificationModule:Call";
|
|
82
|
+
static readonly STEP_SCHEMA_ID = "e157f15c-6846-4bfb-bc92-aed4c4084e9f";
|
|
83
|
+
static readonly STEP_SCHEMA_ACTION_ID = "41f37514-6f46-4e7f-be4e-8abb33f36656";
|
|
84
|
+
static readonly AUTO_LINK_PARENT = false;
|
|
85
|
+
readonly actionName: string;
|
|
86
|
+
readonly schemaActionId: string;
|
|
87
|
+
readonly entity: string;
|
|
88
|
+
constructor(record: OdinRecord<any> | {
|
|
89
|
+
id: string;
|
|
90
|
+
entity: string;
|
|
91
|
+
type?: string;
|
|
92
|
+
}, properties: UpdateCallOnTaskRouterAssignProperties, options?: {
|
|
93
|
+
journeyId?: string;
|
|
94
|
+
stageKey?: string;
|
|
95
|
+
});
|
|
96
|
+
}
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* UpdateCallOnTaskRouterAssign Action DTO
|
|
4
|
+
*
|
|
5
|
+
* Update call on twillio Task Router Assign
|
|
6
|
+
*
|
|
7
|
+
* @module NotificationModule
|
|
8
|
+
* @entity Call
|
|
9
|
+
* @actionKey UpdateCallOnTaskRouterAssign
|
|
10
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCallOnTaskRouterAssign
|
|
11
|
+
*
|
|
12
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
13
|
+
*/
|
|
14
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
|
+
exports.UpdateCallOnTaskRouterAssignDto = void 0;
|
|
16
|
+
const core_1 = require("@d19n/odin-types/dist/core");
|
|
17
|
+
/**
|
|
18
|
+
* UpdateCallOnTaskRouterAssign
|
|
19
|
+
*
|
|
20
|
+
* Update call on twillio Task Router Assign
|
|
21
|
+
*
|
|
22
|
+
* @actionType UPDATE - Updates an existing Call record
|
|
23
|
+
* @module NotificationModule
|
|
24
|
+
* @entity Call
|
|
25
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCallOnTaskRouterAssign
|
|
26
|
+
* @permission schema.action.updatecallontaskrouterassign.trigger
|
|
27
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
28
|
+
*/
|
|
29
|
+
class UpdateCallOnTaskRouterAssignDto 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 = 'UpdateCallOnTaskRouterAssign';
|
|
40
|
+
this.schemaActionId = '41f37514-6f46-4e7f-be4e-8abb33f36656';
|
|
41
|
+
this.entity = 'NotificationModule:Call';
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
exports.UpdateCallOnTaskRouterAssignDto = UpdateCallOnTaskRouterAssignDto;
|
|
45
|
+
/** Used by SDK generators to identify action type */
|
|
46
|
+
UpdateCallOnTaskRouterAssignDto.ACTION_TYPE = 'UPDATE';
|
|
47
|
+
UpdateCallOnTaskRouterAssignDto.ACTION_KEY = 'UpdateCallOnTaskRouterAssign';
|
|
48
|
+
UpdateCallOnTaskRouterAssignDto.MODULE_NAME = 'NotificationModule';
|
|
49
|
+
UpdateCallOnTaskRouterAssignDto.ENTITIES = ['Call'];
|
|
50
|
+
UpdateCallOnTaskRouterAssignDto.EVENT_NAME = 'k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCallOnTaskRouterAssign';
|
|
51
|
+
UpdateCallOnTaskRouterAssignDto.PERMISSION = 'schema.action.updatecallontaskrouterassign.trigger';
|
|
52
|
+
/** Step metadata - entity this action targets */
|
|
53
|
+
UpdateCallOnTaskRouterAssignDto.STEP_ENTITY = 'NotificationModule:Call';
|
|
54
|
+
UpdateCallOnTaskRouterAssignDto.STEP_SCHEMA_ID = 'e157f15c-6846-4bfb-bc92-aed4c4084e9f';
|
|
55
|
+
UpdateCallOnTaskRouterAssignDto.STEP_SCHEMA_ACTION_ID = '41f37514-6f46-4e7f-be4e-8abb33f36656';
|
|
56
|
+
UpdateCallOnTaskRouterAssignDto.AUTO_LINK_PARENT = false;
|
|
@@ -25,6 +25,7 @@ import { RecordLinkManager } from '@d19n/odin-sdk-generator/dist/record-link-man
|
|
|
25
25
|
import { CallProperties } from '../entities-v2/Call';
|
|
26
26
|
import { CreateCallProperties } from '../actions-v2/CreateCallDto';
|
|
27
27
|
import { CreateCallBuilder } from '../actions-v2/CreateCallDto';
|
|
28
|
+
import { UpdateCallOnTaskRouterAssignProperties } from '../actions-v2/UpdateCallOnTaskRouterAssignDto';
|
|
28
29
|
import { UpdateCallTranscriptionUrlProperties } from '../actions-v2/UpdateCallTranscriptionUrlDto';
|
|
29
30
|
import { LeadRecord } from './LeadRecord';
|
|
30
31
|
import { FileRecord } from './FileRecord';
|
|
@@ -358,6 +359,32 @@ export declare class CallRecord<TProps = CallProperties> {
|
|
|
358
359
|
journeyId?: string;
|
|
359
360
|
stageKey?: string;
|
|
360
361
|
}): CreateCallBuilder;
|
|
362
|
+
/**
|
|
363
|
+
* UpdateCallOnTaskRouterAssign
|
|
364
|
+
*
|
|
365
|
+
* Updates this Call record with the specified properties.
|
|
366
|
+
* Returns an ActionBuilder - call .execute() to update or .dryRun() for debugging.
|
|
367
|
+
*
|
|
368
|
+
* @param properties - Required properties for this action
|
|
369
|
+
* @param options - Optional settings
|
|
370
|
+
* @param options.journeyId - Associate with a journey
|
|
371
|
+
* @param options.stageKey - Transition to pipeline stage
|
|
372
|
+
* @returns ActionBuilder - call .execute() to update or .dryRun() for payload
|
|
373
|
+
* @throws Error if called on a new (unsaved) record
|
|
374
|
+
*
|
|
375
|
+
* @example
|
|
376
|
+
* ```typescript
|
|
377
|
+
* const record = await odinClient.calls.get(id);
|
|
378
|
+
* await record.updateCallOnTaskRouterAssign({ ... }).execute();
|
|
379
|
+
*
|
|
380
|
+
* // Dry run (for debugging)
|
|
381
|
+
* const payload = record.updateCallOnTaskRouterAssign({ ... }).dryRun();
|
|
382
|
+
* ```
|
|
383
|
+
*/
|
|
384
|
+
updateCallOnTaskRouterAssign(properties: UpdateCallOnTaskRouterAssignProperties, options?: {
|
|
385
|
+
journeyId?: string;
|
|
386
|
+
stageKey?: string;
|
|
387
|
+
}): ActionBuilder;
|
|
361
388
|
/**
|
|
362
389
|
* UpdateCallTranscriptionUrl
|
|
363
390
|
*
|
|
@@ -506,6 +506,35 @@ class CallRecord {
|
|
|
506
506
|
// ============================================
|
|
507
507
|
// UPDATE ACTIONS (require existing record)
|
|
508
508
|
// ============================================
|
|
509
|
+
/**
|
|
510
|
+
* UpdateCallOnTaskRouterAssign
|
|
511
|
+
*
|
|
512
|
+
* Updates this Call record with the specified properties.
|
|
513
|
+
* Returns an ActionBuilder - call .execute() to update or .dryRun() for debugging.
|
|
514
|
+
*
|
|
515
|
+
* @param properties - Required properties for this action
|
|
516
|
+
* @param options - Optional settings
|
|
517
|
+
* @param options.journeyId - Associate with a journey
|
|
518
|
+
* @param options.stageKey - Transition to pipeline stage
|
|
519
|
+
* @returns ActionBuilder - call .execute() to update or .dryRun() for payload
|
|
520
|
+
* @throws Error if called on a new (unsaved) record
|
|
521
|
+
*
|
|
522
|
+
* @example
|
|
523
|
+
* ```typescript
|
|
524
|
+
* const record = await odinClient.calls.get(id);
|
|
525
|
+
* await record.updateCallOnTaskRouterAssign({ ... }).execute();
|
|
526
|
+
*
|
|
527
|
+
* // Dry run (for debugging)
|
|
528
|
+
* const payload = record.updateCallOnTaskRouterAssign({ ... }).dryRun();
|
|
529
|
+
* ```
|
|
530
|
+
*/
|
|
531
|
+
updateCallOnTaskRouterAssign(properties, options) {
|
|
532
|
+
var _a;
|
|
533
|
+
if (!((_a = this._record) === null || _a === void 0 ? void 0 : _a.id))
|
|
534
|
+
throw new Error('updateCallOnTaskRouterAssign requires an existing record. Use accessor.get() first.');
|
|
535
|
+
const payload = Object.assign({ id: this._record.id, entity: this._record.entity, type: this._record.type, actionName: 'UpdateCallOnTaskRouterAssign', properties, associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined }, options);
|
|
536
|
+
return new ActionBuilder(this._provider, 'NotificationModule', 'Call', payload, () => { this._pendingLinks = []; });
|
|
537
|
+
}
|
|
509
538
|
/**
|
|
510
539
|
* UpdateCallTranscriptionUrl
|
|
511
540
|
*
|