ultracart_rest_api_v2_typescript 4.1.69 → 4.1.70
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
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
# UltraCart Typescript SDK
|
|
2
|
-
## ultracart_rest_api_v2_typescript@4.1.
|
|
2
|
+
## ultracart_rest_api_v2_typescript@4.1.70
|
|
3
3
|
|
|
4
4
|
Every API method call has a sample for every language SDK. See https://github.com/UltraCart/sdk_samples
|
|
5
5
|
|
|
6
6
|
Installation
|
|
7
7
|
|
|
8
8
|
```
|
|
9
|
-
npm install ultracart_rest_api_v2_typescript@4.1.
|
|
9
|
+
npm install ultracart_rest_api_v2_typescript@4.1.70 --save
|
|
10
10
|
```
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
@@ -85,6 +85,7 @@ Not every change is committed to every SDK.
|
|
|
85
85
|
|
|
86
86
|
| Version | Date | Comments |
|
|
87
87
|
| --: | :-: | --- |
|
|
88
|
+
| 4.1.70 | 04/03/2026 | conversation pbx - queue callback settings |
|
|
88
89
|
| 4.1.69 | 03/31/2026 | conversations - user specific audio methods |
|
|
89
90
|
| 4.1.68 | 03/31/2026 | oauth - device support |
|
|
90
91
|
| 4.1.67 | 02/24/2026 | customer activity - sms and sms_stop fields added |
|
|
@@ -40,6 +40,78 @@ export interface ConversationPbxQueue {
|
|
|
40
40
|
* @memberof ConversationPbxQueue
|
|
41
41
|
*/
|
|
42
42
|
automatic_coach_agent_uuid?: string;
|
|
43
|
+
/**
|
|
44
|
+
* Custom audio file UUID for the callback offer prompt
|
|
45
|
+
* @type {string}
|
|
46
|
+
* @memberof ConversationPbxQueue
|
|
47
|
+
*/
|
|
48
|
+
callback_announce_audio_uuid?: string;
|
|
49
|
+
/**
|
|
50
|
+
* Custom TTS text for the callback offer prompt
|
|
51
|
+
* @type {string}
|
|
52
|
+
* @memberof ConversationPbxQueue
|
|
53
|
+
*/
|
|
54
|
+
callback_announce_say?: string;
|
|
55
|
+
/**
|
|
56
|
+
* Custom audio file UUID for the callback confirmation message
|
|
57
|
+
* @type {string}
|
|
58
|
+
* @memberof ConversationPbxQueue
|
|
59
|
+
*/
|
|
60
|
+
callback_confirm_audio_uuid?: string;
|
|
61
|
+
/**
|
|
62
|
+
* Custom TTS text for the callback confirmation message
|
|
63
|
+
* @type {string}
|
|
64
|
+
* @memberof ConversationPbxQueue
|
|
65
|
+
*/
|
|
66
|
+
callback_confirm_say?: string;
|
|
67
|
+
/**
|
|
68
|
+
* If true, the callback option is enabled for this queue
|
|
69
|
+
* @type {boolean}
|
|
70
|
+
* @memberof ConversationPbxQueue
|
|
71
|
+
*/
|
|
72
|
+
callback_enabled?: boolean;
|
|
73
|
+
/**
|
|
74
|
+
* When true, only offer callbacks during business hours
|
|
75
|
+
* @type {boolean}
|
|
76
|
+
* @memberof ConversationPbxQueue
|
|
77
|
+
*/
|
|
78
|
+
callback_hours_only?: boolean;
|
|
79
|
+
/**
|
|
80
|
+
* Maximum number of times the system will attempt to call the customer back
|
|
81
|
+
* @type {number}
|
|
82
|
+
* @memberof ConversationPbxQueue
|
|
83
|
+
*/
|
|
84
|
+
callback_max_attempts?: number;
|
|
85
|
+
/**
|
|
86
|
+
* Maximum number of times the callback option is offered to a caller per call
|
|
87
|
+
* @type {number}
|
|
88
|
+
* @memberof ConversationPbxQueue
|
|
89
|
+
*/
|
|
90
|
+
callback_max_offers?: number;
|
|
91
|
+
/**
|
|
92
|
+
* Maximum number of pending callbacks allowed per queue
|
|
93
|
+
* @type {number}
|
|
94
|
+
* @memberof ConversationPbxQueue
|
|
95
|
+
*/
|
|
96
|
+
callback_max_pending?: number;
|
|
97
|
+
/**
|
|
98
|
+
* Seconds a caller must wait in queue before the callback option is offered
|
|
99
|
+
* @type {number}
|
|
100
|
+
* @memberof ConversationPbxQueue
|
|
101
|
+
*/
|
|
102
|
+
callback_offer_after_seconds?: number;
|
|
103
|
+
/**
|
|
104
|
+
* Seconds between repeat callback offers to the same caller
|
|
105
|
+
* @type {number}
|
|
106
|
+
* @memberof ConversationPbxQueue
|
|
107
|
+
*/
|
|
108
|
+
callback_offer_interval_seconds?: number;
|
|
109
|
+
/**
|
|
110
|
+
* Delay in seconds between callback retry attempts
|
|
111
|
+
* @type {number}
|
|
112
|
+
* @memberof ConversationPbxQueue
|
|
113
|
+
*/
|
|
114
|
+
callback_retry_delay_seconds?: number;
|
|
43
115
|
/**
|
|
44
116
|
* Conversation Pbx Queue unique identifier
|
|
45
117
|
* @type {string}
|
|
@@ -59,6 +59,18 @@ function ConversationPbxQueueFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
59
59
|
'ai_timeout_seconds': !(0, runtime_1.exists)(json, 'ai_timeout_seconds') ? undefined : json['ai_timeout_seconds'],
|
|
60
60
|
'announce_queue_position': !(0, runtime_1.exists)(json, 'announce_queue_position') ? undefined : json['announce_queue_position'],
|
|
61
61
|
'automatic_coach_agent_uuid': !(0, runtime_1.exists)(json, 'automatic_coach_agent_uuid') ? undefined : json['automatic_coach_agent_uuid'],
|
|
62
|
+
'callback_announce_audio_uuid': !(0, runtime_1.exists)(json, 'callback_announce_audio_uuid') ? undefined : json['callback_announce_audio_uuid'],
|
|
63
|
+
'callback_announce_say': !(0, runtime_1.exists)(json, 'callback_announce_say') ? undefined : json['callback_announce_say'],
|
|
64
|
+
'callback_confirm_audio_uuid': !(0, runtime_1.exists)(json, 'callback_confirm_audio_uuid') ? undefined : json['callback_confirm_audio_uuid'],
|
|
65
|
+
'callback_confirm_say': !(0, runtime_1.exists)(json, 'callback_confirm_say') ? undefined : json['callback_confirm_say'],
|
|
66
|
+
'callback_enabled': !(0, runtime_1.exists)(json, 'callback_enabled') ? undefined : json['callback_enabled'],
|
|
67
|
+
'callback_hours_only': !(0, runtime_1.exists)(json, 'callback_hours_only') ? undefined : json['callback_hours_only'],
|
|
68
|
+
'callback_max_attempts': !(0, runtime_1.exists)(json, 'callback_max_attempts') ? undefined : json['callback_max_attempts'],
|
|
69
|
+
'callback_max_offers': !(0, runtime_1.exists)(json, 'callback_max_offers') ? undefined : json['callback_max_offers'],
|
|
70
|
+
'callback_max_pending': !(0, runtime_1.exists)(json, 'callback_max_pending') ? undefined : json['callback_max_pending'],
|
|
71
|
+
'callback_offer_after_seconds': !(0, runtime_1.exists)(json, 'callback_offer_after_seconds') ? undefined : json['callback_offer_after_seconds'],
|
|
72
|
+
'callback_offer_interval_seconds': !(0, runtime_1.exists)(json, 'callback_offer_interval_seconds') ? undefined : json['callback_offer_interval_seconds'],
|
|
73
|
+
'callback_retry_delay_seconds': !(0, runtime_1.exists)(json, 'callback_retry_delay_seconds') ? undefined : json['callback_retry_delay_seconds'],
|
|
62
74
|
'conversation_pbx_queue_uuid': !(0, runtime_1.exists)(json, 'conversation_pbx_queue_uuid') ? undefined : json['conversation_pbx_queue_uuid'],
|
|
63
75
|
'conversation_voicemail_mailbox_uuid': !(0, runtime_1.exists)(json, 'conversation_voicemail_mailbox_uuid') ? undefined : json['conversation_voicemail_mailbox_uuid'],
|
|
64
76
|
'hold_conversation_pbx_audio_uuid': !(0, runtime_1.exists)(json, 'hold_conversation_pbx_audio_uuid') ? undefined : json['hold_conversation_pbx_audio_uuid'],
|
|
@@ -94,6 +106,18 @@ function ConversationPbxQueueToJSON(value) {
|
|
|
94
106
|
'ai_timeout_seconds': value.ai_timeout_seconds,
|
|
95
107
|
'announce_queue_position': value.announce_queue_position,
|
|
96
108
|
'automatic_coach_agent_uuid': value.automatic_coach_agent_uuid,
|
|
109
|
+
'callback_announce_audio_uuid': value.callback_announce_audio_uuid,
|
|
110
|
+
'callback_announce_say': value.callback_announce_say,
|
|
111
|
+
'callback_confirm_audio_uuid': value.callback_confirm_audio_uuid,
|
|
112
|
+
'callback_confirm_say': value.callback_confirm_say,
|
|
113
|
+
'callback_enabled': value.callback_enabled,
|
|
114
|
+
'callback_hours_only': value.callback_hours_only,
|
|
115
|
+
'callback_max_attempts': value.callback_max_attempts,
|
|
116
|
+
'callback_max_offers': value.callback_max_offers,
|
|
117
|
+
'callback_max_pending': value.callback_max_pending,
|
|
118
|
+
'callback_offer_after_seconds': value.callback_offer_after_seconds,
|
|
119
|
+
'callback_offer_interval_seconds': value.callback_offer_interval_seconds,
|
|
120
|
+
'callback_retry_delay_seconds': value.callback_retry_delay_seconds,
|
|
97
121
|
'conversation_pbx_queue_uuid': value.conversation_pbx_queue_uuid,
|
|
98
122
|
'conversation_voicemail_mailbox_uuid': value.conversation_voicemail_mailbox_uuid,
|
|
99
123
|
'hold_conversation_pbx_audio_uuid': value.hold_conversation_pbx_audio_uuid,
|
package/package.json
CHANGED
|
@@ -50,6 +50,78 @@ export interface ConversationPbxQueue {
|
|
|
50
50
|
* @memberof ConversationPbxQueue
|
|
51
51
|
*/
|
|
52
52
|
automatic_coach_agent_uuid?: string;
|
|
53
|
+
/**
|
|
54
|
+
* Custom audio file UUID for the callback offer prompt
|
|
55
|
+
* @type {string}
|
|
56
|
+
* @memberof ConversationPbxQueue
|
|
57
|
+
*/
|
|
58
|
+
callback_announce_audio_uuid?: string;
|
|
59
|
+
/**
|
|
60
|
+
* Custom TTS text for the callback offer prompt
|
|
61
|
+
* @type {string}
|
|
62
|
+
* @memberof ConversationPbxQueue
|
|
63
|
+
*/
|
|
64
|
+
callback_announce_say?: string;
|
|
65
|
+
/**
|
|
66
|
+
* Custom audio file UUID for the callback confirmation message
|
|
67
|
+
* @type {string}
|
|
68
|
+
* @memberof ConversationPbxQueue
|
|
69
|
+
*/
|
|
70
|
+
callback_confirm_audio_uuid?: string;
|
|
71
|
+
/**
|
|
72
|
+
* Custom TTS text for the callback confirmation message
|
|
73
|
+
* @type {string}
|
|
74
|
+
* @memberof ConversationPbxQueue
|
|
75
|
+
*/
|
|
76
|
+
callback_confirm_say?: string;
|
|
77
|
+
/**
|
|
78
|
+
* If true, the callback option is enabled for this queue
|
|
79
|
+
* @type {boolean}
|
|
80
|
+
* @memberof ConversationPbxQueue
|
|
81
|
+
*/
|
|
82
|
+
callback_enabled?: boolean;
|
|
83
|
+
/**
|
|
84
|
+
* When true, only offer callbacks during business hours
|
|
85
|
+
* @type {boolean}
|
|
86
|
+
* @memberof ConversationPbxQueue
|
|
87
|
+
*/
|
|
88
|
+
callback_hours_only?: boolean;
|
|
89
|
+
/**
|
|
90
|
+
* Maximum number of times the system will attempt to call the customer back
|
|
91
|
+
* @type {number}
|
|
92
|
+
* @memberof ConversationPbxQueue
|
|
93
|
+
*/
|
|
94
|
+
callback_max_attempts?: number;
|
|
95
|
+
/**
|
|
96
|
+
* Maximum number of times the callback option is offered to a caller per call
|
|
97
|
+
* @type {number}
|
|
98
|
+
* @memberof ConversationPbxQueue
|
|
99
|
+
*/
|
|
100
|
+
callback_max_offers?: number;
|
|
101
|
+
/**
|
|
102
|
+
* Maximum number of pending callbacks allowed per queue
|
|
103
|
+
* @type {number}
|
|
104
|
+
* @memberof ConversationPbxQueue
|
|
105
|
+
*/
|
|
106
|
+
callback_max_pending?: number;
|
|
107
|
+
/**
|
|
108
|
+
* Seconds a caller must wait in queue before the callback option is offered
|
|
109
|
+
* @type {number}
|
|
110
|
+
* @memberof ConversationPbxQueue
|
|
111
|
+
*/
|
|
112
|
+
callback_offer_after_seconds?: number;
|
|
113
|
+
/**
|
|
114
|
+
* Seconds between repeat callback offers to the same caller
|
|
115
|
+
* @type {number}
|
|
116
|
+
* @memberof ConversationPbxQueue
|
|
117
|
+
*/
|
|
118
|
+
callback_offer_interval_seconds?: number;
|
|
119
|
+
/**
|
|
120
|
+
* Delay in seconds between callback retry attempts
|
|
121
|
+
* @type {number}
|
|
122
|
+
* @memberof ConversationPbxQueue
|
|
123
|
+
*/
|
|
124
|
+
callback_retry_delay_seconds?: number;
|
|
53
125
|
/**
|
|
54
126
|
* Conversation Pbx Queue unique identifier
|
|
55
127
|
* @type {string}
|
|
@@ -226,6 +298,18 @@ export function ConversationPbxQueueFromJSONTyped(json: any, ignoreDiscriminator
|
|
|
226
298
|
'ai_timeout_seconds': !exists(json, 'ai_timeout_seconds') ? undefined : json['ai_timeout_seconds'],
|
|
227
299
|
'announce_queue_position': !exists(json, 'announce_queue_position') ? undefined : json['announce_queue_position'],
|
|
228
300
|
'automatic_coach_agent_uuid': !exists(json, 'automatic_coach_agent_uuid') ? undefined : json['automatic_coach_agent_uuid'],
|
|
301
|
+
'callback_announce_audio_uuid': !exists(json, 'callback_announce_audio_uuid') ? undefined : json['callback_announce_audio_uuid'],
|
|
302
|
+
'callback_announce_say': !exists(json, 'callback_announce_say') ? undefined : json['callback_announce_say'],
|
|
303
|
+
'callback_confirm_audio_uuid': !exists(json, 'callback_confirm_audio_uuid') ? undefined : json['callback_confirm_audio_uuid'],
|
|
304
|
+
'callback_confirm_say': !exists(json, 'callback_confirm_say') ? undefined : json['callback_confirm_say'],
|
|
305
|
+
'callback_enabled': !exists(json, 'callback_enabled') ? undefined : json['callback_enabled'],
|
|
306
|
+
'callback_hours_only': !exists(json, 'callback_hours_only') ? undefined : json['callback_hours_only'],
|
|
307
|
+
'callback_max_attempts': !exists(json, 'callback_max_attempts') ? undefined : json['callback_max_attempts'],
|
|
308
|
+
'callback_max_offers': !exists(json, 'callback_max_offers') ? undefined : json['callback_max_offers'],
|
|
309
|
+
'callback_max_pending': !exists(json, 'callback_max_pending') ? undefined : json['callback_max_pending'],
|
|
310
|
+
'callback_offer_after_seconds': !exists(json, 'callback_offer_after_seconds') ? undefined : json['callback_offer_after_seconds'],
|
|
311
|
+
'callback_offer_interval_seconds': !exists(json, 'callback_offer_interval_seconds') ? undefined : json['callback_offer_interval_seconds'],
|
|
312
|
+
'callback_retry_delay_seconds': !exists(json, 'callback_retry_delay_seconds') ? undefined : json['callback_retry_delay_seconds'],
|
|
229
313
|
'conversation_pbx_queue_uuid': !exists(json, 'conversation_pbx_queue_uuid') ? undefined : json['conversation_pbx_queue_uuid'],
|
|
230
314
|
'conversation_voicemail_mailbox_uuid': !exists(json, 'conversation_voicemail_mailbox_uuid') ? undefined : json['conversation_voicemail_mailbox_uuid'],
|
|
231
315
|
'hold_conversation_pbx_audio_uuid': !exists(json, 'hold_conversation_pbx_audio_uuid') ? undefined : json['hold_conversation_pbx_audio_uuid'],
|
|
@@ -262,6 +346,18 @@ export function ConversationPbxQueueToJSON(value?: ConversationPbxQueue | null):
|
|
|
262
346
|
'ai_timeout_seconds': value.ai_timeout_seconds,
|
|
263
347
|
'announce_queue_position': value.announce_queue_position,
|
|
264
348
|
'automatic_coach_agent_uuid': value.automatic_coach_agent_uuid,
|
|
349
|
+
'callback_announce_audio_uuid': value.callback_announce_audio_uuid,
|
|
350
|
+
'callback_announce_say': value.callback_announce_say,
|
|
351
|
+
'callback_confirm_audio_uuid': value.callback_confirm_audio_uuid,
|
|
352
|
+
'callback_confirm_say': value.callback_confirm_say,
|
|
353
|
+
'callback_enabled': value.callback_enabled,
|
|
354
|
+
'callback_hours_only': value.callback_hours_only,
|
|
355
|
+
'callback_max_attempts': value.callback_max_attempts,
|
|
356
|
+
'callback_max_offers': value.callback_max_offers,
|
|
357
|
+
'callback_max_pending': value.callback_max_pending,
|
|
358
|
+
'callback_offer_after_seconds': value.callback_offer_after_seconds,
|
|
359
|
+
'callback_offer_interval_seconds': value.callback_offer_interval_seconds,
|
|
360
|
+
'callback_retry_delay_seconds': value.callback_retry_delay_seconds,
|
|
265
361
|
'conversation_pbx_queue_uuid': value.conversation_pbx_queue_uuid,
|
|
266
362
|
'conversation_voicemail_mailbox_uuid': value.conversation_voicemail_mailbox_uuid,
|
|
267
363
|
'hold_conversation_pbx_audio_uuid': value.hold_conversation_pbx_audio_uuid,
|