ultracart_rest_api_v2_typescript 4.1.124 → 4.1.125
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/ItemThirdPartyEmailMarketing.d.ts +0 -1
- package/dist/models/ItemThirdPartyEmailMarketing.js +1 -2
- package/dist/models/OrderQuery.d.ts +13 -1
- package/dist/models/OrderQuery.js +4 -0
- package/package.json +1 -1
- package/src/models/ItemThirdPartyEmailMarketing.ts +1 -2
- package/src/models/OrderQuery.ts +17 -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.125
|
|
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.125 --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.125 | 08/06/2026 | order api - ability to query by bin and last 4 in unlimited scenarios for chargeback order association |
|
|
88
89
|
| 4.1.124 | 08/04/2026 | customer - method to remove customer profile from email suppression |
|
|
89
90
|
| 4.1.123 | 08/04/2026 | customer - method to remove customer profile from email suppression |
|
|
90
91
|
| 4.1.122 | 07/29/2026 | auto order api - new methods for payment information and rebill |
|
|
@@ -61,7 +61,6 @@ export declare const ItemThirdPartyEmailMarketingProviderNameEnum: {
|
|
|
61
61
|
readonly Lyris: "Lyris";
|
|
62
62
|
readonly LyrisHq: "LyrisHQ";
|
|
63
63
|
readonly MailChimp: "MailChimp";
|
|
64
|
-
readonly SilverPop: "SilverPop";
|
|
65
64
|
};
|
|
66
65
|
export type ItemThirdPartyEmailMarketingProviderNameEnum = typeof ItemThirdPartyEmailMarketingProviderNameEnum[keyof typeof ItemThirdPartyEmailMarketingProviderNameEnum];
|
|
67
66
|
/**
|
|
@@ -29,8 +29,7 @@ exports.ItemThirdPartyEmailMarketingProviderNameEnum = {
|
|
|
29
29
|
Klaviyo: 'Klaviyo',
|
|
30
30
|
Lyris: 'Lyris',
|
|
31
31
|
LyrisHq: 'LyrisHQ',
|
|
32
|
-
MailChimp: 'MailChimp'
|
|
33
|
-
SilverPop: 'SilverPop'
|
|
32
|
+
MailChimp: 'MailChimp'
|
|
34
33
|
};
|
|
35
34
|
/**
|
|
36
35
|
* Check if a given object implements the ItemThirdPartyEmailMarketing interface.
|
|
@@ -16,6 +16,18 @@ import { OrderQueryPaymentTransactionFilter } from './OrderQueryPaymentTransacti
|
|
|
16
16
|
* @interface OrderQuery
|
|
17
17
|
*/
|
|
18
18
|
export interface OrderQuery {
|
|
19
|
+
/**
|
|
20
|
+
* First six digits (BIN) of the credit card number. Must be specified together with card_last4 and a payment_date_begin/payment_date_end range. Requires query_target=cache.
|
|
21
|
+
* @type {string}
|
|
22
|
+
* @memberof OrderQuery
|
|
23
|
+
*/
|
|
24
|
+
card_bin?: string;
|
|
25
|
+
/**
|
|
26
|
+
* Last four digits of the credit card number. Must be specified together with card_bin and a payment_date_begin/payment_date_end range. Always supply four digits, including for American Express. Requires query_target=cache.
|
|
27
|
+
* @type {string}
|
|
28
|
+
* @memberof OrderQuery
|
|
29
|
+
*/
|
|
30
|
+
card_last4?: string;
|
|
19
31
|
/**
|
|
20
32
|
* CC Email
|
|
21
33
|
* @type {string}
|
|
@@ -185,7 +197,7 @@ export interface OrderQuery {
|
|
|
185
197
|
*/
|
|
186
198
|
payment_method?: OrderQueryPaymentMethodEnum;
|
|
187
199
|
/**
|
|
188
|
-
* Exact-match filters on the detail name/value pairs of a single payment transaction, AND-ed against the same transaction. Requires query_target=cache
|
|
200
|
+
* Exact-match filters on the detail name/value pairs of a single payment transaction, AND-ed against the same transaction. Requires query_target=cache. The origin or database path cannot search transaction details. The rotating gateway is just another pair, name equals rotatingTransactionGatewayCode or rotatingTransactionGatewayName.
|
|
189
201
|
* @type {Array<OrderQueryPaymentTransactionFilter>}
|
|
190
202
|
* @memberof OrderQuery
|
|
191
203
|
*/
|
|
@@ -80,6 +80,8 @@ function OrderQueryFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
80
80
|
return json;
|
|
81
81
|
}
|
|
82
82
|
return {
|
|
83
|
+
'card_bin': !(0, runtime_1.exists)(json, 'card_bin') ? undefined : json['card_bin'],
|
|
84
|
+
'card_last4': !(0, runtime_1.exists)(json, 'card_last4') ? undefined : json['card_last4'],
|
|
83
85
|
'cc_email': !(0, runtime_1.exists)(json, 'cc_email') ? undefined : json['cc_email'],
|
|
84
86
|
'channel_partner_code': !(0, runtime_1.exists)(json, 'channel_partner_code') ? undefined : json['channel_partner_code'],
|
|
85
87
|
'channel_partner_order_id': !(0, runtime_1.exists)(json, 'channel_partner_order_id') ? undefined : json['channel_partner_order_id'],
|
|
@@ -135,6 +137,8 @@ function OrderQueryToJSON(value) {
|
|
|
135
137
|
return null;
|
|
136
138
|
}
|
|
137
139
|
return {
|
|
140
|
+
'card_bin': value.card_bin,
|
|
141
|
+
'card_last4': value.card_last4,
|
|
138
142
|
'cc_email': value.cc_email,
|
|
139
143
|
'channel_partner_code': value.channel_partner_code,
|
|
140
144
|
'channel_partner_order_id': value.channel_partner_order_id,
|
package/package.json
CHANGED
|
@@ -67,8 +67,7 @@ export const ItemThirdPartyEmailMarketingProviderNameEnum = {
|
|
|
67
67
|
Klaviyo: 'Klaviyo',
|
|
68
68
|
Lyris: 'Lyris',
|
|
69
69
|
LyrisHq: 'LyrisHQ',
|
|
70
|
-
MailChimp: 'MailChimp'
|
|
71
|
-
SilverPop: 'SilverPop'
|
|
70
|
+
MailChimp: 'MailChimp'
|
|
72
71
|
} as const;
|
|
73
72
|
export type ItemThirdPartyEmailMarketingProviderNameEnum = typeof ItemThirdPartyEmailMarketingProviderNameEnum[keyof typeof ItemThirdPartyEmailMarketingProviderNameEnum];
|
|
74
73
|
|
package/src/models/OrderQuery.ts
CHANGED
|
@@ -26,6 +26,18 @@ import {
|
|
|
26
26
|
* @interface OrderQuery
|
|
27
27
|
*/
|
|
28
28
|
export interface OrderQuery {
|
|
29
|
+
/**
|
|
30
|
+
* First six digits (BIN) of the credit card number. Must be specified together with card_last4 and a payment_date_begin/payment_date_end range. Requires query_target=cache.
|
|
31
|
+
* @type {string}
|
|
32
|
+
* @memberof OrderQuery
|
|
33
|
+
*/
|
|
34
|
+
card_bin?: string;
|
|
35
|
+
/**
|
|
36
|
+
* Last four digits of the credit card number. Must be specified together with card_bin and a payment_date_begin/payment_date_end range. Always supply four digits, including for American Express. Requires query_target=cache.
|
|
37
|
+
* @type {string}
|
|
38
|
+
* @memberof OrderQuery
|
|
39
|
+
*/
|
|
40
|
+
card_last4?: string;
|
|
29
41
|
/**
|
|
30
42
|
* CC Email
|
|
31
43
|
* @type {string}
|
|
@@ -195,7 +207,7 @@ export interface OrderQuery {
|
|
|
195
207
|
*/
|
|
196
208
|
payment_method?: OrderQueryPaymentMethodEnum;
|
|
197
209
|
/**
|
|
198
|
-
* Exact-match filters on the detail name/value pairs of a single payment transaction, AND-ed against the same transaction. Requires query_target=cache
|
|
210
|
+
* Exact-match filters on the detail name/value pairs of a single payment transaction, AND-ed against the same transaction. Requires query_target=cache. The origin or database path cannot search transaction details. The rotating gateway is just another pair, name equals rotatingTransactionGatewayCode or rotatingTransactionGatewayName.
|
|
199
211
|
* @type {Array<OrderQueryPaymentTransactionFilter>}
|
|
200
212
|
* @memberof OrderQuery
|
|
201
213
|
*/
|
|
@@ -367,6 +379,8 @@ export function OrderQueryFromJSONTyped(json: any, ignoreDiscriminator: boolean)
|
|
|
367
379
|
}
|
|
368
380
|
return {
|
|
369
381
|
|
|
382
|
+
'card_bin': !exists(json, 'card_bin') ? undefined : json['card_bin'],
|
|
383
|
+
'card_last4': !exists(json, 'card_last4') ? undefined : json['card_last4'],
|
|
370
384
|
'cc_email': !exists(json, 'cc_email') ? undefined : json['cc_email'],
|
|
371
385
|
'channel_partner_code': !exists(json, 'channel_partner_code') ? undefined : json['channel_partner_code'],
|
|
372
386
|
'channel_partner_order_id': !exists(json, 'channel_partner_order_id') ? undefined : json['channel_partner_order_id'],
|
|
@@ -423,6 +437,8 @@ export function OrderQueryToJSON(value?: OrderQuery | null): any {
|
|
|
423
437
|
}
|
|
424
438
|
return {
|
|
425
439
|
|
|
440
|
+
'card_bin': value.card_bin,
|
|
441
|
+
'card_last4': value.card_last4,
|
|
426
442
|
'cc_email': value.cc_email,
|
|
427
443
|
'channel_partner_code': value.channel_partner_code,
|
|
428
444
|
'channel_partner_order_id': value.channel_partner_order_id,
|