ultracart_rest_api_v2_typescript 4.1.82 → 4.1.83
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 +3 -2
- package/dist/models/AutoOrderItemCancelRequest.d.ts +8 -1
- package/dist/models/AutoOrderItemCancelRequest.js +3 -0
- package/dist/models/ConversationAgentStatusEvent.d.ts +6 -0
- package/dist/models/ConversationAgentStatusEvent.js +2 -0
- package/dist/models/ConversationPbxCallAgent.d.ts +6 -0
- package/dist/models/ConversationPbxCallAgent.js +2 -0
- package/package.json +1 -1
- package/src/models/AutoOrderItemCancelRequest.ts +16 -1
- package/src/models/ConversationAgentStatusEvent.ts +8 -0
- package/src/models/ConversationPbxCallAgent.ts +8 -0
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.83
|
|
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.83 --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.83 | 04/29/2026 | AO support for item appending on cancel request, order payment method test routing on hold release |
|
|
88
89
|
| 4.1.82 | 04/27/2026 | converation - agent status and availability |
|
|
89
90
|
| 4.1.81 | 04/27/2026 | conversations - agent status and availability |
|
|
90
91
|
| 4.1.80 | 04/22/2026 | customer - e.164 read only fields on billing/shipping child objects |
|
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import { AutoOrderItem } from './AutoOrderItem';
|
|
12
13
|
/**
|
|
13
14
|
*
|
|
14
15
|
* @export
|
|
@@ -16,7 +17,13 @@
|
|
|
16
17
|
*/
|
|
17
18
|
export interface AutoOrderItemCancelRequest {
|
|
18
19
|
/**
|
|
19
|
-
*
|
|
20
|
+
* Specifying these items allows for an easier immutable item contact. Validation will occur before any operations take place. After the end/remove operation is successful, append these additional item(s) to the auto order. The changes will be available in the response if the expansion includes items.
|
|
21
|
+
* @type {Array<AutoOrderItem>}
|
|
22
|
+
* @memberof AutoOrderItemCancelRequest
|
|
23
|
+
*/
|
|
24
|
+
append_items?: Array<AutoOrderItem>;
|
|
25
|
+
/**
|
|
26
|
+
* Optional tiebreaker when more than one item on the auto order shares the same original_item_id. When present, the item with this oid is targeted and its original_item_id must match the URL path parameter (safety check). Leave unset for the common case of a unique original_item_id. For reference the order_item.item_reference_oid is the same value as auto_order_item.auto_order_item_oid UNLESS the a manual edit took place AFTER the original order was placed.
|
|
20
27
|
* @type {number}
|
|
21
28
|
* @memberof AutoOrderItemCancelRequest
|
|
22
29
|
*/
|
|
@@ -15,6 +15,7 @@
|
|
|
15
15
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
16
|
exports.AutoOrderItemCancelRequestToJSON = exports.AutoOrderItemCancelRequestFromJSONTyped = exports.AutoOrderItemCancelRequestFromJSON = exports.instanceOfAutoOrderItemCancelRequest = exports.AutoOrderItemCancelRequestModeEnum = void 0;
|
|
17
17
|
var runtime_1 = require("../runtime");
|
|
18
|
+
var AutoOrderItem_1 = require("./AutoOrderItem");
|
|
18
19
|
/**
|
|
19
20
|
* @export
|
|
20
21
|
*/
|
|
@@ -39,6 +40,7 @@ function AutoOrderItemCancelRequestFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
39
40
|
return json;
|
|
40
41
|
}
|
|
41
42
|
return {
|
|
43
|
+
'append_items': !(0, runtime_1.exists)(json, 'append_items') ? undefined : (json['append_items'].map(AutoOrderItem_1.AutoOrderItemFromJSON)),
|
|
42
44
|
'auto_order_item_oid': !(0, runtime_1.exists)(json, 'auto_order_item_oid') ? undefined : json['auto_order_item_oid'],
|
|
43
45
|
'mode': !(0, runtime_1.exists)(json, 'mode') ? undefined : json['mode'],
|
|
44
46
|
};
|
|
@@ -52,6 +54,7 @@ function AutoOrderItemCancelRequestToJSON(value) {
|
|
|
52
54
|
return null;
|
|
53
55
|
}
|
|
54
56
|
return {
|
|
57
|
+
'append_items': value.append_items === undefined ? undefined : (value.append_items.map(AutoOrderItem_1.AutoOrderItemToJSON)),
|
|
55
58
|
'auto_order_item_oid': value.auto_order_item_oid,
|
|
56
59
|
'mode': value.mode,
|
|
57
60
|
};
|
|
@@ -15,6 +15,12 @@
|
|
|
15
15
|
* @interface ConversationAgentStatusEvent
|
|
16
16
|
*/
|
|
17
17
|
export interface ConversationAgentStatusEvent {
|
|
18
|
+
/**
|
|
19
|
+
* Agent identifier — voice_identity for PBX (e.g. 'client:login'), participant_arn for chat, synthetic 'ai:<user_id>' for AI flag events. Stable across an agent's events; participates in DDB pk and GSI1 sk.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof ConversationAgentStatusEvent
|
|
22
|
+
*/
|
|
23
|
+
agent_identifier?: string;
|
|
18
24
|
/**
|
|
19
25
|
* Agent display name at the time of the event
|
|
20
26
|
* @type {string}
|
|
@@ -70,6 +70,7 @@ function ConversationAgentStatusEventFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
70
70
|
return json;
|
|
71
71
|
}
|
|
72
72
|
return {
|
|
73
|
+
'agent_identifier': !(0, runtime_1.exists)(json, 'agent_identifier') ? undefined : json['agent_identifier'],
|
|
73
74
|
'agent_name': !(0, runtime_1.exists)(json, 'agent_name') ? undefined : json['agent_name'],
|
|
74
75
|
'agent_type': !(0, runtime_1.exists)(json, 'agent_type') ? undefined : json['agent_type'],
|
|
75
76
|
'agent_user_id': !(0, runtime_1.exists)(json, 'agent_user_id') ? undefined : json['agent_user_id'],
|
|
@@ -97,6 +98,7 @@ function ConversationAgentStatusEventToJSON(value) {
|
|
|
97
98
|
return null;
|
|
98
99
|
}
|
|
99
100
|
return {
|
|
101
|
+
'agent_identifier': value.agent_identifier,
|
|
100
102
|
'agent_name': value.agent_name,
|
|
101
103
|
'agent_type': value.agent_type,
|
|
102
104
|
'agent_user_id': value.agent_user_id,
|
|
@@ -33,6 +33,12 @@ export interface ConversationPbxCallAgent {
|
|
|
33
33
|
* @memberof ConversationPbxCallAgent
|
|
34
34
|
*/
|
|
35
35
|
agent_name?: string;
|
|
36
|
+
/**
|
|
37
|
+
* UltraCart user id for the agent (denormalized at index time so reporting endpoints can join on agent_user_id without translating from the agent_id login).
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof ConversationPbxCallAgent
|
|
40
|
+
*/
|
|
41
|
+
agent_user_id?: string;
|
|
36
42
|
/**
|
|
37
43
|
* Whether the agent answered the call
|
|
38
44
|
* @type {boolean}
|
|
@@ -35,6 +35,7 @@ function ConversationPbxCallAgentFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
35
35
|
'agent_extension': !(0, runtime_1.exists)(json, 'agent_extension') ? undefined : json['agent_extension'],
|
|
36
36
|
'agent_id': !(0, runtime_1.exists)(json, 'agent_id') ? undefined : json['agent_id'],
|
|
37
37
|
'agent_name': !(0, runtime_1.exists)(json, 'agent_name') ? undefined : json['agent_name'],
|
|
38
|
+
'agent_user_id': !(0, runtime_1.exists)(json, 'agent_user_id') ? undefined : json['agent_user_id'],
|
|
38
39
|
'answered': !(0, runtime_1.exists)(json, 'answered') ? undefined : json['answered'],
|
|
39
40
|
'call_sid': !(0, runtime_1.exists)(json, 'call_sid') ? undefined : json['call_sid'],
|
|
40
41
|
'joined_at_dts': !(0, runtime_1.exists)(json, 'joined_at_dts') ? undefined : json['joined_at_dts'],
|
|
@@ -55,6 +56,7 @@ function ConversationPbxCallAgentToJSON(value) {
|
|
|
55
56
|
'agent_extension': value.agent_extension,
|
|
56
57
|
'agent_id': value.agent_id,
|
|
57
58
|
'agent_name': value.agent_name,
|
|
59
|
+
'agent_user_id': value.agent_user_id,
|
|
58
60
|
'answered': value.answered,
|
|
59
61
|
'call_sid': value.call_sid,
|
|
60
62
|
'joined_at_dts': value.joined_at_dts,
|
package/package.json
CHANGED
|
@@ -13,6 +13,13 @@
|
|
|
13
13
|
*/
|
|
14
14
|
|
|
15
15
|
import { exists, mapValues } from '../runtime';
|
|
16
|
+
import {
|
|
17
|
+
AutoOrderItem,
|
|
18
|
+
AutoOrderItemFromJSON,
|
|
19
|
+
AutoOrderItemFromJSONTyped,
|
|
20
|
+
AutoOrderItemToJSON,
|
|
21
|
+
} from './AutoOrderItem';
|
|
22
|
+
|
|
16
23
|
/**
|
|
17
24
|
*
|
|
18
25
|
* @export
|
|
@@ -20,7 +27,13 @@ import { exists, mapValues } from '../runtime';
|
|
|
20
27
|
*/
|
|
21
28
|
export interface AutoOrderItemCancelRequest {
|
|
22
29
|
/**
|
|
23
|
-
*
|
|
30
|
+
* Specifying these items allows for an easier immutable item contact. Validation will occur before any operations take place. After the end/remove operation is successful, append these additional item(s) to the auto order. The changes will be available in the response if the expansion includes items.
|
|
31
|
+
* @type {Array<AutoOrderItem>}
|
|
32
|
+
* @memberof AutoOrderItemCancelRequest
|
|
33
|
+
*/
|
|
34
|
+
append_items?: Array<AutoOrderItem>;
|
|
35
|
+
/**
|
|
36
|
+
* Optional tiebreaker when more than one item on the auto order shares the same original_item_id. When present, the item with this oid is targeted and its original_item_id must match the URL path parameter (safety check). Leave unset for the common case of a unique original_item_id. For reference the order_item.item_reference_oid is the same value as auto_order_item.auto_order_item_oid UNLESS the a manual edit took place AFTER the original order was placed.
|
|
24
37
|
* @type {number}
|
|
25
38
|
* @memberof AutoOrderItemCancelRequest
|
|
26
39
|
*/
|
|
@@ -64,6 +77,7 @@ export function AutoOrderItemCancelRequestFromJSONTyped(json: any, ignoreDiscrim
|
|
|
64
77
|
}
|
|
65
78
|
return {
|
|
66
79
|
|
|
80
|
+
'append_items': !exists(json, 'append_items') ? undefined : ((json['append_items'] as Array<any>).map(AutoOrderItemFromJSON)),
|
|
67
81
|
'auto_order_item_oid': !exists(json, 'auto_order_item_oid') ? undefined : json['auto_order_item_oid'],
|
|
68
82
|
'mode': !exists(json, 'mode') ? undefined : json['mode'],
|
|
69
83
|
};
|
|
@@ -78,6 +92,7 @@ export function AutoOrderItemCancelRequestToJSON(value?: AutoOrderItemCancelRequ
|
|
|
78
92
|
}
|
|
79
93
|
return {
|
|
80
94
|
|
|
95
|
+
'append_items': value.append_items === undefined ? undefined : ((value.append_items as Array<any>).map(AutoOrderItemToJSON)),
|
|
81
96
|
'auto_order_item_oid': value.auto_order_item_oid,
|
|
82
97
|
'mode': value.mode,
|
|
83
98
|
};
|
|
@@ -19,6 +19,12 @@ import { exists, mapValues } from '../runtime';
|
|
|
19
19
|
* @interface ConversationAgentStatusEvent
|
|
20
20
|
*/
|
|
21
21
|
export interface ConversationAgentStatusEvent {
|
|
22
|
+
/**
|
|
23
|
+
* Agent identifier — voice_identity for PBX (e.g. 'client:login'), participant_arn for chat, synthetic 'ai:<user_id>' for AI flag events. Stable across an agent's events; participates in DDB pk and GSI1 sk.
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof ConversationAgentStatusEvent
|
|
26
|
+
*/
|
|
27
|
+
agent_identifier?: string;
|
|
22
28
|
/**
|
|
23
29
|
* Agent display name at the time of the event
|
|
24
30
|
* @type {string}
|
|
@@ -187,6 +193,7 @@ export function ConversationAgentStatusEventFromJSONTyped(json: any, ignoreDiscr
|
|
|
187
193
|
}
|
|
188
194
|
return {
|
|
189
195
|
|
|
196
|
+
'agent_identifier': !exists(json, 'agent_identifier') ? undefined : json['agent_identifier'],
|
|
190
197
|
'agent_name': !exists(json, 'agent_name') ? undefined : json['agent_name'],
|
|
191
198
|
'agent_type': !exists(json, 'agent_type') ? undefined : json['agent_type'],
|
|
192
199
|
'agent_user_id': !exists(json, 'agent_user_id') ? undefined : json['agent_user_id'],
|
|
@@ -215,6 +222,7 @@ export function ConversationAgentStatusEventToJSON(value?: ConversationAgentStat
|
|
|
215
222
|
}
|
|
216
223
|
return {
|
|
217
224
|
|
|
225
|
+
'agent_identifier': value.agent_identifier,
|
|
218
226
|
'agent_name': value.agent_name,
|
|
219
227
|
'agent_type': value.agent_type,
|
|
220
228
|
'agent_user_id': value.agent_user_id,
|
|
@@ -37,6 +37,12 @@ export interface ConversationPbxCallAgent {
|
|
|
37
37
|
* @memberof ConversationPbxCallAgent
|
|
38
38
|
*/
|
|
39
39
|
agent_name?: string;
|
|
40
|
+
/**
|
|
41
|
+
* UltraCart user id for the agent (denormalized at index time so reporting endpoints can join on agent_user_id without translating from the agent_id login).
|
|
42
|
+
* @type {string}
|
|
43
|
+
* @memberof ConversationPbxCallAgent
|
|
44
|
+
*/
|
|
45
|
+
agent_user_id?: string;
|
|
40
46
|
/**
|
|
41
47
|
* Whether the agent answered the call
|
|
42
48
|
* @type {boolean}
|
|
@@ -99,6 +105,7 @@ export function ConversationPbxCallAgentFromJSONTyped(json: any, ignoreDiscrimin
|
|
|
99
105
|
'agent_extension': !exists(json, 'agent_extension') ? undefined : json['agent_extension'],
|
|
100
106
|
'agent_id': !exists(json, 'agent_id') ? undefined : json['agent_id'],
|
|
101
107
|
'agent_name': !exists(json, 'agent_name') ? undefined : json['agent_name'],
|
|
108
|
+
'agent_user_id': !exists(json, 'agent_user_id') ? undefined : json['agent_user_id'],
|
|
102
109
|
'answered': !exists(json, 'answered') ? undefined : json['answered'],
|
|
103
110
|
'call_sid': !exists(json, 'call_sid') ? undefined : json['call_sid'],
|
|
104
111
|
'joined_at_dts': !exists(json, 'joined_at_dts') ? undefined : json['joined_at_dts'],
|
|
@@ -120,6 +127,7 @@ export function ConversationPbxCallAgentToJSON(value?: ConversationPbxCallAgent
|
|
|
120
127
|
'agent_extension': value.agent_extension,
|
|
121
128
|
'agent_id': value.agent_id,
|
|
122
129
|
'agent_name': value.agent_name,
|
|
130
|
+
'agent_user_id': value.agent_user_id,
|
|
123
131
|
'answered': value.answered,
|
|
124
132
|
'call_sid': value.call_sid,
|
|
125
133
|
'joined_at_dts': value.joined_at_dts,
|