ultracart_rest_api_v2_typescript 4.1.131 → 4.1.133
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 -2
- package/dist/models/ConversationPbxAgent.d.ts +12 -0
- package/dist/models/ConversationPbxAgent.js +4 -0
- package/dist/models/CustomerActivity.d.ts +12 -0
- package/dist/models/CustomerActivity.js +4 -0
- package/dist/models/Metric.d.ts +0 -12
- package/dist/models/Metric.js +0 -4
- package/dist/models/Order.d.ts +1 -1
- package/dist/models/OrderPayment.d.ts +1 -1
- package/package.json +1 -1
- package/src/models/ConversationPbxAgent.ts +16 -0
- package/src/models/CustomerActivity.ts +16 -0
- package/src/models/Metric.ts +0 -16
- package/src/models/Order.ts +1 -1
- package/src/models/OrderPayment.ts +1 -1
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.133
|
|
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.133 --save
|
|
10
10
|
```
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
@@ -85,6 +85,8 @@ Not every change is committed to every SDK.
|
|
|
85
85
|
|
|
86
86
|
| Version | Date | Comments |
|
|
87
87
|
| --: | :-: | --- |
|
|
88
|
+
| 4.1.133 | 08/20/2026 | conversations - pbx agent setting for creating tickets in zoho desk for outgoing calls |
|
|
89
|
+
| 4.1.132 | 08/18/2026 | customer activity bug fix |
|
|
88
90
|
| 4.1.131 | 08/18/2026 | customer activity now returns the SF communications active flag and last_activity_dts |
|
|
89
91
|
| 4.1.130 | 08/17/2026 | order api - new method to obtain customer activity similar to the customer endpoint for a profile |
|
|
90
92
|
| 4.1.129 | 08/13/2026 | ChannelPartnerOrder and OrderChannelPartner were missing a property |
|
|
@@ -141,6 +141,18 @@ export interface ConversationPbxAgent {
|
|
|
141
141
|
* @memberof ConversationPbxAgent
|
|
142
142
|
*/
|
|
143
143
|
voicemail?: boolean;
|
|
144
|
+
/**
|
|
145
|
+
* Zoho Desk department ID to create outbound-call tickets in for this agent
|
|
146
|
+
* @type {string}
|
|
147
|
+
* @memberof ConversationPbxAgent
|
|
148
|
+
*/
|
|
149
|
+
zoho_desk_outbound_department_id?: string;
|
|
150
|
+
/**
|
|
151
|
+
* If true, a Zoho Desk ticket is automatically created for outbound calls placed by this agent
|
|
152
|
+
* @type {boolean}
|
|
153
|
+
* @memberof ConversationPbxAgent
|
|
154
|
+
*/
|
|
155
|
+
zoho_desk_outbound_ticket_enabled?: boolean;
|
|
144
156
|
}
|
|
145
157
|
/**
|
|
146
158
|
* @export
|
|
@@ -68,6 +68,8 @@ function ConversationPbxAgentFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
68
68
|
'unavailable_say_voice': !(0, runtime_1.exists)(json, 'unavailable_say_voice') ? undefined : json['unavailable_say_voice'],
|
|
69
69
|
'user_id': !(0, runtime_1.exists)(json, 'user_id') ? undefined : json['user_id'],
|
|
70
70
|
'voicemail': !(0, runtime_1.exists)(json, 'voicemail') ? undefined : json['voicemail'],
|
|
71
|
+
'zoho_desk_outbound_department_id': !(0, runtime_1.exists)(json, 'zoho_desk_outbound_department_id') ? undefined : json['zoho_desk_outbound_department_id'],
|
|
72
|
+
'zoho_desk_outbound_ticket_enabled': !(0, runtime_1.exists)(json, 'zoho_desk_outbound_ticket_enabled') ? undefined : json['zoho_desk_outbound_ticket_enabled'],
|
|
71
73
|
};
|
|
72
74
|
}
|
|
73
75
|
exports.ConversationPbxAgentFromJSONTyped = ConversationPbxAgentFromJSONTyped;
|
|
@@ -100,6 +102,8 @@ function ConversationPbxAgentToJSON(value) {
|
|
|
100
102
|
'unavailable_say_voice': value.unavailable_say_voice,
|
|
101
103
|
'user_id': value.user_id,
|
|
102
104
|
'voicemail': value.voicemail,
|
|
105
|
+
'zoho_desk_outbound_department_id': value.zoho_desk_outbound_department_id,
|
|
106
|
+
'zoho_desk_outbound_ticket_enabled': value.zoho_desk_outbound_ticket_enabled,
|
|
103
107
|
};
|
|
104
108
|
}
|
|
105
109
|
exports.ConversationPbxAgentToJSON = ConversationPbxAgentToJSON;
|
|
@@ -19,6 +19,12 @@ import { Property } from './Property';
|
|
|
19
19
|
* @interface CustomerActivity
|
|
20
20
|
*/
|
|
21
21
|
export interface CustomerActivity {
|
|
22
|
+
/**
|
|
23
|
+
*
|
|
24
|
+
* @type {boolean}
|
|
25
|
+
* @memberof CustomerActivity
|
|
26
|
+
*/
|
|
27
|
+
active?: boolean;
|
|
22
28
|
/**
|
|
23
29
|
*
|
|
24
30
|
* @type {Array<Activity>}
|
|
@@ -37,6 +43,12 @@ export interface CustomerActivity {
|
|
|
37
43
|
* @memberof CustomerActivity
|
|
38
44
|
*/
|
|
39
45
|
global_unsubscribed_dts?: string;
|
|
46
|
+
/**
|
|
47
|
+
*
|
|
48
|
+
* @type {string}
|
|
49
|
+
* @memberof CustomerActivity
|
|
50
|
+
*/
|
|
51
|
+
last_activity_dts?: string;
|
|
40
52
|
/**
|
|
41
53
|
*
|
|
42
54
|
* @type {Array<ListSegmentMembership>}
|
|
@@ -36,9 +36,11 @@ function CustomerActivityFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
36
36
|
return json;
|
|
37
37
|
}
|
|
38
38
|
return {
|
|
39
|
+
'active': !(0, runtime_1.exists)(json, 'active') ? undefined : json['active'],
|
|
39
40
|
'activities': !(0, runtime_1.exists)(json, 'activities') ? undefined : (json['activities'].map(Activity_1.ActivityFromJSON)),
|
|
40
41
|
'global_unsubscribed': !(0, runtime_1.exists)(json, 'global_unsubscribed') ? undefined : json['global_unsubscribed'],
|
|
41
42
|
'global_unsubscribed_dts': !(0, runtime_1.exists)(json, 'global_unsubscribed_dts') ? undefined : json['global_unsubscribed_dts'],
|
|
43
|
+
'last_activity_dts': !(0, runtime_1.exists)(json, 'last_activity_dts') ? undefined : json['last_activity_dts'],
|
|
42
44
|
'memberships': !(0, runtime_1.exists)(json, 'memberships') ? undefined : (json['memberships'].map(ListSegmentMembership_1.ListSegmentMembershipFromJSON)),
|
|
43
45
|
'metrics': !(0, runtime_1.exists)(json, 'metrics') ? undefined : (json['metrics'].map(Metric_1.MetricFromJSON)),
|
|
44
46
|
'properties_list': !(0, runtime_1.exists)(json, 'properties_list') ? undefined : (json['properties_list'].map(Property_1.PropertyFromJSON)),
|
|
@@ -57,9 +59,11 @@ function CustomerActivityToJSON(value) {
|
|
|
57
59
|
return null;
|
|
58
60
|
}
|
|
59
61
|
return {
|
|
62
|
+
'active': value.active,
|
|
60
63
|
'activities': value.activities === undefined ? undefined : (value.activities.map(Activity_1.ActivityToJSON)),
|
|
61
64
|
'global_unsubscribed': value.global_unsubscribed,
|
|
62
65
|
'global_unsubscribed_dts': value.global_unsubscribed_dts,
|
|
66
|
+
'last_activity_dts': value.last_activity_dts,
|
|
63
67
|
'memberships': value.memberships === undefined ? undefined : (value.memberships.map(ListSegmentMembership_1.ListSegmentMembershipToJSON)),
|
|
64
68
|
'metrics': value.metrics === undefined ? undefined : (value.metrics.map(Metric_1.MetricToJSON)),
|
|
65
69
|
'properties_list': value.properties_list === undefined ? undefined : (value.properties_list.map(Property_1.PropertyToJSON)),
|
package/dist/models/Metric.d.ts
CHANGED
|
@@ -15,12 +15,6 @@
|
|
|
15
15
|
* @interface Metric
|
|
16
16
|
*/
|
|
17
17
|
export interface Metric {
|
|
18
|
-
/**
|
|
19
|
-
*
|
|
20
|
-
* @type {boolean}
|
|
21
|
-
* @memberof Metric
|
|
22
|
-
*/
|
|
23
|
-
active?: boolean;
|
|
24
18
|
/**
|
|
25
19
|
*
|
|
26
20
|
* @type {number}
|
|
@@ -45,12 +39,6 @@ export interface Metric {
|
|
|
45
39
|
* @memberof Metric
|
|
46
40
|
*/
|
|
47
41
|
last_30_formatted?: string;
|
|
48
|
-
/**
|
|
49
|
-
*
|
|
50
|
-
* @type {string}
|
|
51
|
-
* @memberof Metric
|
|
52
|
-
*/
|
|
53
|
-
last_activity_dts?: string;
|
|
54
42
|
/**
|
|
55
43
|
*
|
|
56
44
|
* @type {string}
|
package/dist/models/Metric.js
CHANGED
|
@@ -32,12 +32,10 @@ function MetricFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
32
32
|
return json;
|
|
33
33
|
}
|
|
34
34
|
return {
|
|
35
|
-
'active': !(0, runtime_1.exists)(json, 'active') ? undefined : json['active'],
|
|
36
35
|
'all_time': !(0, runtime_1.exists)(json, 'all_time') ? undefined : json['all_time'],
|
|
37
36
|
'all_time_formatted': !(0, runtime_1.exists)(json, 'all_time_formatted') ? undefined : json['all_time_formatted'],
|
|
38
37
|
'last_30': !(0, runtime_1.exists)(json, 'last_30') ? undefined : json['last_30'],
|
|
39
38
|
'last_30_formatted': !(0, runtime_1.exists)(json, 'last_30_formatted') ? undefined : json['last_30_formatted'],
|
|
40
|
-
'last_activity_dts': !(0, runtime_1.exists)(json, 'last_activity_dts') ? undefined : json['last_activity_dts'],
|
|
41
39
|
'name': !(0, runtime_1.exists)(json, 'name') ? undefined : json['name'],
|
|
42
40
|
'prior_30': !(0, runtime_1.exists)(json, 'prior_30') ? undefined : json['prior_30'],
|
|
43
41
|
'prior_30_formatted': !(0, runtime_1.exists)(json, 'prior_30_formatted') ? undefined : json['prior_30_formatted'],
|
|
@@ -53,12 +51,10 @@ function MetricToJSON(value) {
|
|
|
53
51
|
return null;
|
|
54
52
|
}
|
|
55
53
|
return {
|
|
56
|
-
'active': value.active,
|
|
57
54
|
'all_time': value.all_time,
|
|
58
55
|
'all_time_formatted': value.all_time_formatted,
|
|
59
56
|
'last_30': value.last_30,
|
|
60
57
|
'last_30_formatted': value.last_30_formatted,
|
|
61
|
-
'last_activity_dts': value.last_activity_dts,
|
|
62
58
|
'name': value.name,
|
|
63
59
|
'prior_30': value.prior_30,
|
|
64
60
|
'prior_30_formatted': value.prior_30_formatted,
|
package/dist/models/Order.d.ts
CHANGED
|
@@ -213,7 +213,7 @@ export interface Order {
|
|
|
213
213
|
*/
|
|
214
214
|
point_of_sale?: OrderPointOfSale;
|
|
215
215
|
/**
|
|
216
|
-
* Properties
|
|
216
|
+
* Properties associated with the order
|
|
217
217
|
* @type {Array<OrderProperty>}
|
|
218
218
|
* @memberof Order
|
|
219
219
|
*/
|
|
@@ -139,7 +139,7 @@ export interface OrderPayment {
|
|
|
139
139
|
*/
|
|
140
140
|
test_order?: boolean;
|
|
141
141
|
/**
|
|
142
|
-
* Transactions associated with processing this payment
|
|
142
|
+
* Transactions associated with processing this payment. Accepted on insert to carry the payment history of an order captured outside the system.
|
|
143
143
|
* @type {Array<OrderPaymentTransaction>}
|
|
144
144
|
* @memberof OrderPayment
|
|
145
145
|
*/
|
package/package.json
CHANGED
|
@@ -145,6 +145,18 @@ export interface ConversationPbxAgent {
|
|
|
145
145
|
* @memberof ConversationPbxAgent
|
|
146
146
|
*/
|
|
147
147
|
voicemail?: boolean;
|
|
148
|
+
/**
|
|
149
|
+
* Zoho Desk department ID to create outbound-call tickets in for this agent
|
|
150
|
+
* @type {string}
|
|
151
|
+
* @memberof ConversationPbxAgent
|
|
152
|
+
*/
|
|
153
|
+
zoho_desk_outbound_department_id?: string;
|
|
154
|
+
/**
|
|
155
|
+
* If true, a Zoho Desk ticket is automatically created for outbound calls placed by this agent
|
|
156
|
+
* @type {boolean}
|
|
157
|
+
* @memberof ConversationPbxAgent
|
|
158
|
+
*/
|
|
159
|
+
zoho_desk_outbound_ticket_enabled?: boolean;
|
|
148
160
|
}
|
|
149
161
|
|
|
150
162
|
|
|
@@ -209,6 +221,8 @@ export function ConversationPbxAgentFromJSONTyped(json: any, ignoreDiscriminator
|
|
|
209
221
|
'unavailable_say_voice': !exists(json, 'unavailable_say_voice') ? undefined : json['unavailable_say_voice'],
|
|
210
222
|
'user_id': !exists(json, 'user_id') ? undefined : json['user_id'],
|
|
211
223
|
'voicemail': !exists(json, 'voicemail') ? undefined : json['voicemail'],
|
|
224
|
+
'zoho_desk_outbound_department_id': !exists(json, 'zoho_desk_outbound_department_id') ? undefined : json['zoho_desk_outbound_department_id'],
|
|
225
|
+
'zoho_desk_outbound_ticket_enabled': !exists(json, 'zoho_desk_outbound_ticket_enabled') ? undefined : json['zoho_desk_outbound_ticket_enabled'],
|
|
212
226
|
};
|
|
213
227
|
}
|
|
214
228
|
|
|
@@ -242,6 +256,8 @@ export function ConversationPbxAgentToJSON(value?: ConversationPbxAgent | null):
|
|
|
242
256
|
'unavailable_say_voice': value.unavailable_say_voice,
|
|
243
257
|
'user_id': value.user_id,
|
|
244
258
|
'voicemail': value.voicemail,
|
|
259
|
+
'zoho_desk_outbound_department_id': value.zoho_desk_outbound_department_id,
|
|
260
|
+
'zoho_desk_outbound_ticket_enabled': value.zoho_desk_outbound_ticket_enabled,
|
|
245
261
|
};
|
|
246
262
|
}
|
|
247
263
|
|
|
@@ -44,6 +44,12 @@ import {
|
|
|
44
44
|
* @interface CustomerActivity
|
|
45
45
|
*/
|
|
46
46
|
export interface CustomerActivity {
|
|
47
|
+
/**
|
|
48
|
+
*
|
|
49
|
+
* @type {boolean}
|
|
50
|
+
* @memberof CustomerActivity
|
|
51
|
+
*/
|
|
52
|
+
active?: boolean;
|
|
47
53
|
/**
|
|
48
54
|
*
|
|
49
55
|
* @type {Array<Activity>}
|
|
@@ -62,6 +68,12 @@ export interface CustomerActivity {
|
|
|
62
68
|
* @memberof CustomerActivity
|
|
63
69
|
*/
|
|
64
70
|
global_unsubscribed_dts?: string;
|
|
71
|
+
/**
|
|
72
|
+
*
|
|
73
|
+
* @type {string}
|
|
74
|
+
* @memberof CustomerActivity
|
|
75
|
+
*/
|
|
76
|
+
last_activity_dts?: string;
|
|
65
77
|
/**
|
|
66
78
|
*
|
|
67
79
|
* @type {Array<ListSegmentMembership>}
|
|
@@ -127,9 +139,11 @@ export function CustomerActivityFromJSONTyped(json: any, ignoreDiscriminator: bo
|
|
|
127
139
|
}
|
|
128
140
|
return {
|
|
129
141
|
|
|
142
|
+
'active': !exists(json, 'active') ? undefined : json['active'],
|
|
130
143
|
'activities': !exists(json, 'activities') ? undefined : ((json['activities'] as Array<any>).map(ActivityFromJSON)),
|
|
131
144
|
'global_unsubscribed': !exists(json, 'global_unsubscribed') ? undefined : json['global_unsubscribed'],
|
|
132
145
|
'global_unsubscribed_dts': !exists(json, 'global_unsubscribed_dts') ? undefined : json['global_unsubscribed_dts'],
|
|
146
|
+
'last_activity_dts': !exists(json, 'last_activity_dts') ? undefined : json['last_activity_dts'],
|
|
133
147
|
'memberships': !exists(json, 'memberships') ? undefined : ((json['memberships'] as Array<any>).map(ListSegmentMembershipFromJSON)),
|
|
134
148
|
'metrics': !exists(json, 'metrics') ? undefined : ((json['metrics'] as Array<any>).map(MetricFromJSON)),
|
|
135
149
|
'properties_list': !exists(json, 'properties_list') ? undefined : ((json['properties_list'] as Array<any>).map(PropertyFromJSON)),
|
|
@@ -149,9 +163,11 @@ export function CustomerActivityToJSON(value?: CustomerActivity | null): any {
|
|
|
149
163
|
}
|
|
150
164
|
return {
|
|
151
165
|
|
|
166
|
+
'active': value.active,
|
|
152
167
|
'activities': value.activities === undefined ? undefined : ((value.activities as Array<any>).map(ActivityToJSON)),
|
|
153
168
|
'global_unsubscribed': value.global_unsubscribed,
|
|
154
169
|
'global_unsubscribed_dts': value.global_unsubscribed_dts,
|
|
170
|
+
'last_activity_dts': value.last_activity_dts,
|
|
155
171
|
'memberships': value.memberships === undefined ? undefined : ((value.memberships as Array<any>).map(ListSegmentMembershipToJSON)),
|
|
156
172
|
'metrics': value.metrics === undefined ? undefined : ((value.metrics as Array<any>).map(MetricToJSON)),
|
|
157
173
|
'properties_list': value.properties_list === undefined ? undefined : ((value.properties_list as Array<any>).map(PropertyToJSON)),
|
package/src/models/Metric.ts
CHANGED
|
@@ -19,12 +19,6 @@ import { exists, mapValues } from '../runtime';
|
|
|
19
19
|
* @interface Metric
|
|
20
20
|
*/
|
|
21
21
|
export interface Metric {
|
|
22
|
-
/**
|
|
23
|
-
*
|
|
24
|
-
* @type {boolean}
|
|
25
|
-
* @memberof Metric
|
|
26
|
-
*/
|
|
27
|
-
active?: boolean;
|
|
28
22
|
/**
|
|
29
23
|
*
|
|
30
24
|
* @type {number}
|
|
@@ -49,12 +43,6 @@ export interface Metric {
|
|
|
49
43
|
* @memberof Metric
|
|
50
44
|
*/
|
|
51
45
|
last_30_formatted?: string;
|
|
52
|
-
/**
|
|
53
|
-
*
|
|
54
|
-
* @type {string}
|
|
55
|
-
* @memberof Metric
|
|
56
|
-
*/
|
|
57
|
-
last_activity_dts?: string;
|
|
58
46
|
/**
|
|
59
47
|
*
|
|
60
48
|
* @type {string}
|
|
@@ -102,12 +90,10 @@ export function MetricFromJSONTyped(json: any, ignoreDiscriminator: boolean): Me
|
|
|
102
90
|
}
|
|
103
91
|
return {
|
|
104
92
|
|
|
105
|
-
'active': !exists(json, 'active') ? undefined : json['active'],
|
|
106
93
|
'all_time': !exists(json, 'all_time') ? undefined : json['all_time'],
|
|
107
94
|
'all_time_formatted': !exists(json, 'all_time_formatted') ? undefined : json['all_time_formatted'],
|
|
108
95
|
'last_30': !exists(json, 'last_30') ? undefined : json['last_30'],
|
|
109
96
|
'last_30_formatted': !exists(json, 'last_30_formatted') ? undefined : json['last_30_formatted'],
|
|
110
|
-
'last_activity_dts': !exists(json, 'last_activity_dts') ? undefined : json['last_activity_dts'],
|
|
111
97
|
'name': !exists(json, 'name') ? undefined : json['name'],
|
|
112
98
|
'prior_30': !exists(json, 'prior_30') ? undefined : json['prior_30'],
|
|
113
99
|
'prior_30_formatted': !exists(json, 'prior_30_formatted') ? undefined : json['prior_30_formatted'],
|
|
@@ -124,12 +110,10 @@ export function MetricToJSON(value?: Metric | null): any {
|
|
|
124
110
|
}
|
|
125
111
|
return {
|
|
126
112
|
|
|
127
|
-
'active': value.active,
|
|
128
113
|
'all_time': value.all_time,
|
|
129
114
|
'all_time_formatted': value.all_time_formatted,
|
|
130
115
|
'last_30': value.last_30,
|
|
131
116
|
'last_30_formatted': value.last_30_formatted,
|
|
132
|
-
'last_activity_dts': value.last_activity_dts,
|
|
133
117
|
'name': value.name,
|
|
134
118
|
'prior_30': value.prior_30,
|
|
135
119
|
'prior_30_formatted': value.prior_30_formatted,
|
package/src/models/Order.ts
CHANGED
|
@@ -363,7 +363,7 @@ export interface Order {
|
|
|
363
363
|
*/
|
|
364
364
|
point_of_sale?: OrderPointOfSale;
|
|
365
365
|
/**
|
|
366
|
-
* Properties
|
|
366
|
+
* Properties associated with the order
|
|
367
367
|
* @type {Array<OrderProperty>}
|
|
368
368
|
* @memberof Order
|
|
369
369
|
*/
|
|
@@ -189,7 +189,7 @@ export interface OrderPayment {
|
|
|
189
189
|
*/
|
|
190
190
|
test_order?: boolean;
|
|
191
191
|
/**
|
|
192
|
-
* Transactions associated with processing this payment
|
|
192
|
+
* Transactions associated with processing this payment. Accepted on insert to carry the payment history of an order captured outside the system.
|
|
193
193
|
* @type {Array<OrderPaymentTransaction>}
|
|
194
194
|
* @memberof OrderPayment
|
|
195
195
|
*/
|