ultracart_rest_api_v2_typescript 4.1.23 → 4.1.25
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/apis/ConversationApi.js +1 -1
- package/dist/models/ConversationVirtualAgentCapabilities.d.ts +6 -0
- package/dist/models/ConversationVirtualAgentCapabilities.js +2 -0
- package/dist/models/CustomerLoyalty.d.ts +18 -0
- package/dist/models/CustomerLoyalty.js +6 -0
- package/package.json +1 -1
- package/src/apis/ConversationApi.ts +1 -1
- package/src/models/ConversationVirtualAgentCapabilities.ts +8 -0
- package/src/models/CustomerLoyalty.ts +24 -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.25
|
|
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.25 --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.25 | 10/20/2025 | conversation api bug fix for bad url on agent profile kb upload |
|
|
89
|
+
| 4.1.24 | 10/20/2025 | new perm flag on conversation virtual agent capabilities |
|
|
88
90
|
| 4.1.23 | 10/14/2025 | CustomerApi.deleteWishlistItem bug fix for bad response type |
|
|
89
91
|
| 4.1.22 | 10/06/2025 | added Customer.fax back into object model |
|
|
90
92
|
| 4.1.21 | 09/09/2025 | added OrderRestApi.replaceOrderItemMerchantItemId |
|
|
@@ -1496,7 +1496,7 @@ var ConversationApi = /** @class */ (function (_super) {
|
|
|
1496
1496
|
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
1497
1497
|
}
|
|
1498
1498
|
return [4 /*yield*/, this.request({
|
|
1499
|
-
path: "/conversation
|
|
1499
|
+
path: "/conversation/agent/profiles/{user_id}/knowledge_base/upload_url/{extension}".replace("{".concat("user_id", "}"), encodeURIComponent(String(requestParameters.userId))).replace("{".concat("extension", "}"), encodeURIComponent(String(requestParameters.extension))),
|
|
1500
1500
|
method: 'GET',
|
|
1501
1501
|
headers: headerParameters,
|
|
1502
1502
|
query: queryParameters,
|
|
@@ -16,6 +16,12 @@ import { ConversationVirtualAgentCapabilityZohoDeskDepartment } from './Conversa
|
|
|
16
16
|
* @interface ConversationVirtualAgentCapabilities
|
|
17
17
|
*/
|
|
18
18
|
export interface ConversationVirtualAgentCapabilities {
|
|
19
|
+
/**
|
|
20
|
+
* Permission flag to allow this Agent access to the storefront and item information.
|
|
21
|
+
* @type {boolean}
|
|
22
|
+
* @memberof ConversationVirtualAgentCapabilities
|
|
23
|
+
*/
|
|
24
|
+
access_storefront_and_item?: boolean;
|
|
19
25
|
/**
|
|
20
26
|
*
|
|
21
27
|
* @type {boolean}
|
|
@@ -42,6 +42,7 @@ function ConversationVirtualAgentCapabilitiesFromJSONTyped(json, ignoreDiscrimin
|
|
|
42
42
|
return json;
|
|
43
43
|
}
|
|
44
44
|
return {
|
|
45
|
+
'access_storefront_and_item': !(0, runtime_1.exists)(json, 'access_storefront_and_item') ? undefined : json['access_storefront_and_item'],
|
|
45
46
|
'cancel_subscription': !(0, runtime_1.exists)(json, 'cancel_subscription') ? undefined : json['cancel_subscription'],
|
|
46
47
|
'delay_subscription': !(0, runtime_1.exists)(json, 'delay_subscription') ? undefined : json['delay_subscription'],
|
|
47
48
|
'lookup_order_information': !(0, runtime_1.exists)(json, 'lookup_order_information') ? undefined : json['lookup_order_information'],
|
|
@@ -67,6 +68,7 @@ function ConversationVirtualAgentCapabilitiesToJSON(value) {
|
|
|
67
68
|
return null;
|
|
68
69
|
}
|
|
69
70
|
return {
|
|
71
|
+
'access_storefront_and_item': value.access_storefront_and_item,
|
|
70
72
|
'cancel_subscription': value.cancel_subscription,
|
|
71
73
|
'delay_subscription': value.delay_subscription,
|
|
72
74
|
'lookup_order_information': value.lookup_order_information,
|
|
@@ -48,6 +48,24 @@ export interface CustomerLoyalty {
|
|
|
48
48
|
* @memberof CustomerLoyalty
|
|
49
49
|
*/
|
|
50
50
|
ledger_entries?: Array<CustomerLoyaltyLedger>;
|
|
51
|
+
/**
|
|
52
|
+
* Loyalty tier expiration date (read only because of SDK addition)
|
|
53
|
+
* @type {string}
|
|
54
|
+
* @memberof CustomerLoyalty
|
|
55
|
+
*/
|
|
56
|
+
loyalty_tier_expiration_dts?: string;
|
|
57
|
+
/**
|
|
58
|
+
* Loyalty tier name
|
|
59
|
+
* @type {string}
|
|
60
|
+
* @memberof CustomerLoyalty
|
|
61
|
+
*/
|
|
62
|
+
loyalty_tier_name?: string;
|
|
63
|
+
/**
|
|
64
|
+
* Loyalty tier oid (set to zero to remove the tier)
|
|
65
|
+
* @type {number}
|
|
66
|
+
* @memberof CustomerLoyalty
|
|
67
|
+
*/
|
|
68
|
+
loyalty_tier_oid?: number;
|
|
51
69
|
/**
|
|
52
70
|
* Pending Points
|
|
53
71
|
* @type {number}
|
|
@@ -40,6 +40,9 @@ function CustomerLoyaltyFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
40
40
|
'internal_gift_certificate_balance': !(0, runtime_1.exists)(json, 'internal_gift_certificate_balance') ? undefined : json['internal_gift_certificate_balance'],
|
|
41
41
|
'internal_gift_certificate_oid': !(0, runtime_1.exists)(json, 'internal_gift_certificate_oid') ? undefined : json['internal_gift_certificate_oid'],
|
|
42
42
|
'ledger_entries': !(0, runtime_1.exists)(json, 'ledger_entries') ? undefined : (json['ledger_entries'].map(CustomerLoyaltyLedger_1.CustomerLoyaltyLedgerFromJSON)),
|
|
43
|
+
'loyalty_tier_expiration_dts': !(0, runtime_1.exists)(json, 'loyalty_tier_expiration_dts') ? undefined : json['loyalty_tier_expiration_dts'],
|
|
44
|
+
'loyalty_tier_name': !(0, runtime_1.exists)(json, 'loyalty_tier_name') ? undefined : json['loyalty_tier_name'],
|
|
45
|
+
'loyalty_tier_oid': !(0, runtime_1.exists)(json, 'loyalty_tier_oid') ? undefined : json['loyalty_tier_oid'],
|
|
43
46
|
'pending_points': !(0, runtime_1.exists)(json, 'pending_points') ? undefined : json['pending_points'],
|
|
44
47
|
'redemptions': !(0, runtime_1.exists)(json, 'redemptions') ? undefined : (json['redemptions'].map(CustomerLoyaltyRedemption_1.CustomerLoyaltyRedemptionFromJSON)),
|
|
45
48
|
};
|
|
@@ -58,6 +61,9 @@ function CustomerLoyaltyToJSON(value) {
|
|
|
58
61
|
'internal_gift_certificate_balance': value.internal_gift_certificate_balance,
|
|
59
62
|
'internal_gift_certificate_oid': value.internal_gift_certificate_oid,
|
|
60
63
|
'ledger_entries': value.ledger_entries === undefined ? undefined : (value.ledger_entries.map(CustomerLoyaltyLedger_1.CustomerLoyaltyLedgerToJSON)),
|
|
64
|
+
'loyalty_tier_expiration_dts': value.loyalty_tier_expiration_dts,
|
|
65
|
+
'loyalty_tier_name': value.loyalty_tier_name,
|
|
66
|
+
'loyalty_tier_oid': value.loyalty_tier_oid,
|
|
61
67
|
'pending_points': value.pending_points,
|
|
62
68
|
'redemptions': value.redemptions === undefined ? undefined : (value.redemptions.map(CustomerLoyaltyRedemption_1.CustomerLoyaltyRedemptionToJSON)),
|
|
63
69
|
};
|
package/package.json
CHANGED
|
@@ -3009,7 +3009,7 @@ export class ConversationApi extends runtime.BaseAPI implements ConversationApiI
|
|
|
3009
3009
|
}
|
|
3010
3010
|
|
|
3011
3011
|
const response = await this.request({
|
|
3012
|
-
path: `/conversation
|
|
3012
|
+
path: `/conversation/agent/profiles/{user_id}/knowledge_base/upload_url/{extension}`.replace(`{${"user_id"}}`, encodeURIComponent(String(requestParameters.userId))).replace(`{${"extension"}}`, encodeURIComponent(String(requestParameters.extension))),
|
|
3013
3013
|
method: 'GET',
|
|
3014
3014
|
headers: headerParameters,
|
|
3015
3015
|
query: queryParameters,
|
|
@@ -26,6 +26,12 @@ import {
|
|
|
26
26
|
* @interface ConversationVirtualAgentCapabilities
|
|
27
27
|
*/
|
|
28
28
|
export interface ConversationVirtualAgentCapabilities {
|
|
29
|
+
/**
|
|
30
|
+
* Permission flag to allow this Agent access to the storefront and item information.
|
|
31
|
+
* @type {boolean}
|
|
32
|
+
* @memberof ConversationVirtualAgentCapabilities
|
|
33
|
+
*/
|
|
34
|
+
access_storefront_and_item?: boolean;
|
|
29
35
|
/**
|
|
30
36
|
*
|
|
31
37
|
* @type {boolean}
|
|
@@ -145,6 +151,7 @@ export function ConversationVirtualAgentCapabilitiesFromJSONTyped(json: any, ign
|
|
|
145
151
|
}
|
|
146
152
|
return {
|
|
147
153
|
|
|
154
|
+
'access_storefront_and_item': !exists(json, 'access_storefront_and_item') ? undefined : json['access_storefront_and_item'],
|
|
148
155
|
'cancel_subscription': !exists(json, 'cancel_subscription') ? undefined : json['cancel_subscription'],
|
|
149
156
|
'delay_subscription': !exists(json, 'delay_subscription') ? undefined : json['delay_subscription'],
|
|
150
157
|
'lookup_order_information': !exists(json, 'lookup_order_information') ? undefined : json['lookup_order_information'],
|
|
@@ -171,6 +178,7 @@ export function ConversationVirtualAgentCapabilitiesToJSON(value?: ConversationV
|
|
|
171
178
|
}
|
|
172
179
|
return {
|
|
173
180
|
|
|
181
|
+
'access_storefront_and_item': value.access_storefront_and_item,
|
|
174
182
|
'cancel_subscription': value.cancel_subscription,
|
|
175
183
|
'delay_subscription': value.delay_subscription,
|
|
176
184
|
'lookup_order_information': value.lookup_order_information,
|
|
@@ -68,6 +68,24 @@ export interface CustomerLoyalty {
|
|
|
68
68
|
* @memberof CustomerLoyalty
|
|
69
69
|
*/
|
|
70
70
|
ledger_entries?: Array<CustomerLoyaltyLedger>;
|
|
71
|
+
/**
|
|
72
|
+
* Loyalty tier expiration date (read only because of SDK addition)
|
|
73
|
+
* @type {string}
|
|
74
|
+
* @memberof CustomerLoyalty
|
|
75
|
+
*/
|
|
76
|
+
loyalty_tier_expiration_dts?: string;
|
|
77
|
+
/**
|
|
78
|
+
* Loyalty tier name
|
|
79
|
+
* @type {string}
|
|
80
|
+
* @memberof CustomerLoyalty
|
|
81
|
+
*/
|
|
82
|
+
loyalty_tier_name?: string;
|
|
83
|
+
/**
|
|
84
|
+
* Loyalty tier oid (set to zero to remove the tier)
|
|
85
|
+
* @type {number}
|
|
86
|
+
* @memberof CustomerLoyalty
|
|
87
|
+
*/
|
|
88
|
+
loyalty_tier_oid?: number;
|
|
71
89
|
/**
|
|
72
90
|
* Pending Points
|
|
73
91
|
* @type {number}
|
|
@@ -108,6 +126,9 @@ export function CustomerLoyaltyFromJSONTyped(json: any, ignoreDiscriminator: boo
|
|
|
108
126
|
'internal_gift_certificate_balance': !exists(json, 'internal_gift_certificate_balance') ? undefined : json['internal_gift_certificate_balance'],
|
|
109
127
|
'internal_gift_certificate_oid': !exists(json, 'internal_gift_certificate_oid') ? undefined : json['internal_gift_certificate_oid'],
|
|
110
128
|
'ledger_entries': !exists(json, 'ledger_entries') ? undefined : ((json['ledger_entries'] as Array<any>).map(CustomerLoyaltyLedgerFromJSON)),
|
|
129
|
+
'loyalty_tier_expiration_dts': !exists(json, 'loyalty_tier_expiration_dts') ? undefined : json['loyalty_tier_expiration_dts'],
|
|
130
|
+
'loyalty_tier_name': !exists(json, 'loyalty_tier_name') ? undefined : json['loyalty_tier_name'],
|
|
131
|
+
'loyalty_tier_oid': !exists(json, 'loyalty_tier_oid') ? undefined : json['loyalty_tier_oid'],
|
|
111
132
|
'pending_points': !exists(json, 'pending_points') ? undefined : json['pending_points'],
|
|
112
133
|
'redemptions': !exists(json, 'redemptions') ? undefined : ((json['redemptions'] as Array<any>).map(CustomerLoyaltyRedemptionFromJSON)),
|
|
113
134
|
};
|
|
@@ -127,6 +148,9 @@ export function CustomerLoyaltyToJSON(value?: CustomerLoyalty | null): any {
|
|
|
127
148
|
'internal_gift_certificate_balance': value.internal_gift_certificate_balance,
|
|
128
149
|
'internal_gift_certificate_oid': value.internal_gift_certificate_oid,
|
|
129
150
|
'ledger_entries': value.ledger_entries === undefined ? undefined : ((value.ledger_entries as Array<any>).map(CustomerLoyaltyLedgerToJSON)),
|
|
151
|
+
'loyalty_tier_expiration_dts': value.loyalty_tier_expiration_dts,
|
|
152
|
+
'loyalty_tier_name': value.loyalty_tier_name,
|
|
153
|
+
'loyalty_tier_oid': value.loyalty_tier_oid,
|
|
130
154
|
'pending_points': value.pending_points,
|
|
131
155
|
'redemptions': value.redemptions === undefined ? undefined : ((value.redemptions as Array<any>).map(CustomerLoyaltyRedemptionToJSON)),
|
|
132
156
|
};
|