ultracart_rest_api_v2_typescript 3.10.155 → 3.10.157
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/api.ts +82 -3
- package/dist/api.d.ts +80 -3
- package/dist/api.js +9 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## ultracart_rest_api_v2_typescript@3.10.
|
|
1
|
+
## ultracart_rest_api_v2_typescript@3.10.157
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install ultracart_rest_api_v2_typescript@3.10.
|
|
39
|
+
npm install ultracart_rest_api_v2_typescript@3.10.157 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
|
|
|
54
54
|
|
|
55
55
|
| Version | Date | Comments |
|
|
56
56
|
| --: | :-: | --- |
|
|
57
|
+
| 3.10.157 | 09/05/2023 | auto order schedule - add intervals for 4 6 and 8 weeks |
|
|
58
|
+
| 3.10.156 | 08/31/2023 | new coupon - free item and free shipping with purchase |
|
|
57
59
|
| 3.10.155 | 08/16/2023 | added validate_original_order query param to auto order update method |
|
|
58
60
|
| 3.10.154 | 08/14/2023 | esp - add require_order_within_last to the settings object |
|
|
59
61
|
| 3.10.153 | 08/14/2023 | esp - expose rate limiter values in settings object |
|
package/api.ts
CHANGED
|
@@ -1752,7 +1752,10 @@ export namespace AutoOrderItem {
|
|
|
1752
1752
|
Every3Months = <any> 'Every 3 Months',
|
|
1753
1753
|
Every4Months = <any> 'Every 4 Months',
|
|
1754
1754
|
Every6Months = <any> 'Every 6 Months',
|
|
1755
|
-
Yearly = <any> 'Yearly'
|
|
1755
|
+
Yearly = <any> 'Yearly',
|
|
1756
|
+
Every4Weeks = <any> 'Every 4 Weeks',
|
|
1757
|
+
Every6Weeks = <any> 'Every 6 Weeks',
|
|
1758
|
+
Every8Weeks = <any> 'Every 8 Weeks'
|
|
1756
1759
|
}
|
|
1757
1760
|
}
|
|
1758
1761
|
|
|
@@ -1856,7 +1859,10 @@ export namespace AutoOrderItemSimpleSchedule {
|
|
|
1856
1859
|
Every3Months = <any> 'Every 3 Months',
|
|
1857
1860
|
Every4Months = <any> 'Every 4 Months',
|
|
1858
1861
|
Every6Months = <any> 'Every 6 Months',
|
|
1859
|
-
Yearly = <any> 'Yearly'
|
|
1862
|
+
Yearly = <any> 'Yearly',
|
|
1863
|
+
Every4Weeks = <any> 'Every 4 Weeks',
|
|
1864
|
+
Every6Weeks = <any> 'Every 6 Weeks',
|
|
1865
|
+
Every8Weeks = <any> 'Every 8 Weeks'
|
|
1860
1866
|
}
|
|
1861
1867
|
}
|
|
1862
1868
|
|
|
@@ -6008,7 +6014,10 @@ export namespace ChannelPartnerOrderItem {
|
|
|
6008
6014
|
Every3Months = <any> 'Every 3 Months',
|
|
6009
6015
|
Every4Months = <any> 'Every 4 Months',
|
|
6010
6016
|
Every6Months = <any> 'Every 6 Months',
|
|
6011
|
-
Yearly = <any> 'Yearly'
|
|
6017
|
+
Yearly = <any> 'Yearly',
|
|
6018
|
+
Every4Weeks = <any> 'Every 4 Weeks',
|
|
6019
|
+
Every6Weeks = <any> 'Every 6 Weeks',
|
|
6020
|
+
Every8Weeks = <any> 'Every 8 Weeks'
|
|
6012
6021
|
}
|
|
6013
6022
|
}
|
|
6014
6023
|
|
|
@@ -9625,6 +9634,12 @@ export interface Coupon {
|
|
|
9625
9634
|
* @memberof Coupon
|
|
9626
9635
|
*/
|
|
9627
9636
|
free_item_with_item_purchase?: CouponFreeItemWithItemPurchase;
|
|
9637
|
+
/**
|
|
9638
|
+
*
|
|
9639
|
+
* @type {CouponFreeItemWithItemPurchaseAndFreeShipping}
|
|
9640
|
+
* @memberof Coupon
|
|
9641
|
+
*/
|
|
9642
|
+
free_item_with_item_purchase_and_free_shipping?: CouponFreeItemWithItemPurchaseAndFreeShipping;
|
|
9628
9643
|
/**
|
|
9629
9644
|
*
|
|
9630
9645
|
* @type {CouponFreeItemWithSubtotal}
|
|
@@ -10651,6 +10666,38 @@ export interface CouponFreeItemWithItemPurchase {
|
|
|
10651
10666
|
required_purchase_items?: Array<string>;
|
|
10652
10667
|
}
|
|
10653
10668
|
|
|
10669
|
+
/**
|
|
10670
|
+
*
|
|
10671
|
+
* @export
|
|
10672
|
+
* @interface CouponFreeItemWithItemPurchaseAndFreeShipping
|
|
10673
|
+
*/
|
|
10674
|
+
export interface CouponFreeItemWithItemPurchaseAndFreeShipping {
|
|
10675
|
+
/**
|
|
10676
|
+
* A list of free items which will receive a discount if one of the required purchase items is purchased.
|
|
10677
|
+
* @type {Array<string>}
|
|
10678
|
+
* @memberof CouponFreeItemWithItemPurchaseAndFreeShipping
|
|
10679
|
+
*/
|
|
10680
|
+
items?: Array<string>;
|
|
10681
|
+
/**
|
|
10682
|
+
* The (optional) maximum quantity of discounted items. Free shipping will apply to all units of the free item ids though.
|
|
10683
|
+
* @type {number}
|
|
10684
|
+
* @memberof CouponFreeItemWithItemPurchaseAndFreeShipping
|
|
10685
|
+
*/
|
|
10686
|
+
limit?: number;
|
|
10687
|
+
/**
|
|
10688
|
+
* If true then the free item is matched 1:1 with the free item in the list.
|
|
10689
|
+
* @type {boolean}
|
|
10690
|
+
* @memberof CouponFreeItemWithItemPurchaseAndFreeShipping
|
|
10691
|
+
*/
|
|
10692
|
+
match_required_purchase_item_to_free_item?: boolean;
|
|
10693
|
+
/**
|
|
10694
|
+
* Required items (at least one from the list) that must be purchased for coupon to be valid
|
|
10695
|
+
* @type {Array<string>}
|
|
10696
|
+
* @memberof CouponFreeItemWithItemPurchaseAndFreeShipping
|
|
10697
|
+
*/
|
|
10698
|
+
required_purchase_items?: Array<string>;
|
|
10699
|
+
}
|
|
10700
|
+
|
|
10654
10701
|
/**
|
|
10655
10702
|
*
|
|
10656
10703
|
* @export
|
|
@@ -12109,6 +12156,12 @@ export interface Customer {
|
|
|
12109
12156
|
* @memberof Customer
|
|
12110
12157
|
*/
|
|
12111
12158
|
privacy?: CustomerPrivacy;
|
|
12159
|
+
/**
|
|
12160
|
+
* Properties for this customer
|
|
12161
|
+
* @type {Array<CustomerProperty>}
|
|
12162
|
+
* @memberof Customer
|
|
12163
|
+
*/
|
|
12164
|
+
properties?: Array<CustomerProperty>;
|
|
12112
12165
|
/**
|
|
12113
12166
|
* QuickBooks class to import this customer as
|
|
12114
12167
|
* @type {string}
|
|
@@ -13081,6 +13134,32 @@ export interface CustomerPrivacy {
|
|
|
13081
13134
|
statistics?: boolean;
|
|
13082
13135
|
}
|
|
13083
13136
|
|
|
13137
|
+
/**
|
|
13138
|
+
*
|
|
13139
|
+
* @export
|
|
13140
|
+
* @interface CustomerProperty
|
|
13141
|
+
*/
|
|
13142
|
+
export interface CustomerProperty {
|
|
13143
|
+
/**
|
|
13144
|
+
* The date/time that the property expires and is deleted
|
|
13145
|
+
* @type {string}
|
|
13146
|
+
* @memberof CustomerProperty
|
|
13147
|
+
*/
|
|
13148
|
+
expiration_dts?: string;
|
|
13149
|
+
/**
|
|
13150
|
+
* Name
|
|
13151
|
+
* @type {string}
|
|
13152
|
+
* @memberof CustomerProperty
|
|
13153
|
+
*/
|
|
13154
|
+
name?: string;
|
|
13155
|
+
/**
|
|
13156
|
+
* Value
|
|
13157
|
+
* @type {string}
|
|
13158
|
+
* @memberof CustomerProperty
|
|
13159
|
+
*/
|
|
13160
|
+
value?: string;
|
|
13161
|
+
}
|
|
13162
|
+
|
|
13084
13163
|
/**
|
|
13085
13164
|
*
|
|
13086
13165
|
* @export
|
package/dist/api.d.ts
CHANGED
|
@@ -1705,7 +1705,10 @@ export declare namespace AutoOrderItem {
|
|
|
1705
1705
|
Every3Months,
|
|
1706
1706
|
Every4Months,
|
|
1707
1707
|
Every6Months,
|
|
1708
|
-
Yearly
|
|
1708
|
+
Yearly,
|
|
1709
|
+
Every4Weeks,
|
|
1710
|
+
Every6Weeks,
|
|
1711
|
+
Every8Weeks
|
|
1709
1712
|
}
|
|
1710
1713
|
}
|
|
1711
1714
|
/**
|
|
@@ -1805,7 +1808,10 @@ export declare namespace AutoOrderItemSimpleSchedule {
|
|
|
1805
1808
|
Every3Months,
|
|
1806
1809
|
Every4Months,
|
|
1807
1810
|
Every6Months,
|
|
1808
|
-
Yearly
|
|
1811
|
+
Yearly,
|
|
1812
|
+
Every4Weeks,
|
|
1813
|
+
Every6Weeks,
|
|
1814
|
+
Every8Weeks
|
|
1809
1815
|
}
|
|
1810
1816
|
}
|
|
1811
1817
|
/**
|
|
@@ -5872,7 +5878,10 @@ export declare namespace ChannelPartnerOrderItem {
|
|
|
5872
5878
|
Every3Months,
|
|
5873
5879
|
Every4Months,
|
|
5874
5880
|
Every6Months,
|
|
5875
|
-
Yearly
|
|
5881
|
+
Yearly,
|
|
5882
|
+
Every4Weeks,
|
|
5883
|
+
Every6Weeks,
|
|
5884
|
+
Every8Weeks
|
|
5876
5885
|
}
|
|
5877
5886
|
}
|
|
5878
5887
|
/**
|
|
@@ -9395,6 +9404,12 @@ export interface Coupon {
|
|
|
9395
9404
|
* @memberof Coupon
|
|
9396
9405
|
*/
|
|
9397
9406
|
free_item_with_item_purchase?: CouponFreeItemWithItemPurchase;
|
|
9407
|
+
/**
|
|
9408
|
+
*
|
|
9409
|
+
* @type {CouponFreeItemWithItemPurchaseAndFreeShipping}
|
|
9410
|
+
* @memberof Coupon
|
|
9411
|
+
*/
|
|
9412
|
+
free_item_with_item_purchase_and_free_shipping?: CouponFreeItemWithItemPurchaseAndFreeShipping;
|
|
9398
9413
|
/**
|
|
9399
9414
|
*
|
|
9400
9415
|
* @type {CouponFreeItemWithSubtotal}
|
|
@@ -10396,6 +10411,37 @@ export interface CouponFreeItemWithItemPurchase {
|
|
|
10396
10411
|
*/
|
|
10397
10412
|
required_purchase_items?: Array<string>;
|
|
10398
10413
|
}
|
|
10414
|
+
/**
|
|
10415
|
+
*
|
|
10416
|
+
* @export
|
|
10417
|
+
* @interface CouponFreeItemWithItemPurchaseAndFreeShipping
|
|
10418
|
+
*/
|
|
10419
|
+
export interface CouponFreeItemWithItemPurchaseAndFreeShipping {
|
|
10420
|
+
/**
|
|
10421
|
+
* A list of free items which will receive a discount if one of the required purchase items is purchased.
|
|
10422
|
+
* @type {Array<string>}
|
|
10423
|
+
* @memberof CouponFreeItemWithItemPurchaseAndFreeShipping
|
|
10424
|
+
*/
|
|
10425
|
+
items?: Array<string>;
|
|
10426
|
+
/**
|
|
10427
|
+
* The (optional) maximum quantity of discounted items. Free shipping will apply to all units of the free item ids though.
|
|
10428
|
+
* @type {number}
|
|
10429
|
+
* @memberof CouponFreeItemWithItemPurchaseAndFreeShipping
|
|
10430
|
+
*/
|
|
10431
|
+
limit?: number;
|
|
10432
|
+
/**
|
|
10433
|
+
* If true then the free item is matched 1:1 with the free item in the list.
|
|
10434
|
+
* @type {boolean}
|
|
10435
|
+
* @memberof CouponFreeItemWithItemPurchaseAndFreeShipping
|
|
10436
|
+
*/
|
|
10437
|
+
match_required_purchase_item_to_free_item?: boolean;
|
|
10438
|
+
/**
|
|
10439
|
+
* Required items (at least one from the list) that must be purchased for coupon to be valid
|
|
10440
|
+
* @type {Array<string>}
|
|
10441
|
+
* @memberof CouponFreeItemWithItemPurchaseAndFreeShipping
|
|
10442
|
+
*/
|
|
10443
|
+
required_purchase_items?: Array<string>;
|
|
10444
|
+
}
|
|
10399
10445
|
/**
|
|
10400
10446
|
*
|
|
10401
10447
|
* @export
|
|
@@ -11809,6 +11855,12 @@ export interface Customer {
|
|
|
11809
11855
|
* @memberof Customer
|
|
11810
11856
|
*/
|
|
11811
11857
|
privacy?: CustomerPrivacy;
|
|
11858
|
+
/**
|
|
11859
|
+
* Properties for this customer
|
|
11860
|
+
* @type {Array<CustomerProperty>}
|
|
11861
|
+
* @memberof Customer
|
|
11862
|
+
*/
|
|
11863
|
+
properties?: Array<CustomerProperty>;
|
|
11812
11864
|
/**
|
|
11813
11865
|
* QuickBooks class to import this customer as
|
|
11814
11866
|
* @type {string}
|
|
@@ -12763,6 +12815,31 @@ export interface CustomerPrivacy {
|
|
|
12763
12815
|
*/
|
|
12764
12816
|
statistics?: boolean;
|
|
12765
12817
|
}
|
|
12818
|
+
/**
|
|
12819
|
+
*
|
|
12820
|
+
* @export
|
|
12821
|
+
* @interface CustomerProperty
|
|
12822
|
+
*/
|
|
12823
|
+
export interface CustomerProperty {
|
|
12824
|
+
/**
|
|
12825
|
+
* The date/time that the property expires and is deleted
|
|
12826
|
+
* @type {string}
|
|
12827
|
+
* @memberof CustomerProperty
|
|
12828
|
+
*/
|
|
12829
|
+
expiration_dts?: string;
|
|
12830
|
+
/**
|
|
12831
|
+
* Name
|
|
12832
|
+
* @type {string}
|
|
12833
|
+
* @memberof CustomerProperty
|
|
12834
|
+
*/
|
|
12835
|
+
name?: string;
|
|
12836
|
+
/**
|
|
12837
|
+
* Value
|
|
12838
|
+
* @type {string}
|
|
12839
|
+
* @memberof CustomerProperty
|
|
12840
|
+
*/
|
|
12841
|
+
value?: string;
|
|
12842
|
+
}
|
|
12766
12843
|
/**
|
|
12767
12844
|
*
|
|
12768
12845
|
* @export
|
package/dist/api.js
CHANGED
|
@@ -181,6 +181,9 @@ var AutoOrderItem;
|
|
|
181
181
|
FrequencyEnum[FrequencyEnum["Every4Months"] = 'Every 4 Months'] = "Every4Months";
|
|
182
182
|
FrequencyEnum[FrequencyEnum["Every6Months"] = 'Every 6 Months'] = "Every6Months";
|
|
183
183
|
FrequencyEnum[FrequencyEnum["Yearly"] = 'Yearly'] = "Yearly";
|
|
184
|
+
FrequencyEnum[FrequencyEnum["Every4Weeks"] = 'Every 4 Weeks'] = "Every4Weeks";
|
|
185
|
+
FrequencyEnum[FrequencyEnum["Every6Weeks"] = 'Every 6 Weeks'] = "Every6Weeks";
|
|
186
|
+
FrequencyEnum[FrequencyEnum["Every8Weeks"] = 'Every 8 Weeks'] = "Every8Weeks";
|
|
184
187
|
})(FrequencyEnum = AutoOrderItem.FrequencyEnum || (AutoOrderItem.FrequencyEnum = {}));
|
|
185
188
|
})(AutoOrderItem = exports.AutoOrderItem || (exports.AutoOrderItem = {}));
|
|
186
189
|
/**
|
|
@@ -208,6 +211,9 @@ var AutoOrderItemSimpleSchedule;
|
|
|
208
211
|
FrequencyEnum[FrequencyEnum["Every4Months"] = 'Every 4 Months'] = "Every4Months";
|
|
209
212
|
FrequencyEnum[FrequencyEnum["Every6Months"] = 'Every 6 Months'] = "Every6Months";
|
|
210
213
|
FrequencyEnum[FrequencyEnum["Yearly"] = 'Yearly'] = "Yearly";
|
|
214
|
+
FrequencyEnum[FrequencyEnum["Every4Weeks"] = 'Every 4 Weeks'] = "Every4Weeks";
|
|
215
|
+
FrequencyEnum[FrequencyEnum["Every6Weeks"] = 'Every 6 Weeks'] = "Every6Weeks";
|
|
216
|
+
FrequencyEnum[FrequencyEnum["Every8Weeks"] = 'Every 8 Weeks'] = "Every8Weeks";
|
|
211
217
|
})(FrequencyEnum = AutoOrderItemSimpleSchedule.FrequencyEnum || (AutoOrderItemSimpleSchedule.FrequencyEnum = {}));
|
|
212
218
|
})(AutoOrderItemSimpleSchedule = exports.AutoOrderItemSimpleSchedule || (exports.AutoOrderItemSimpleSchedule = {}));
|
|
213
219
|
/**
|
|
@@ -338,6 +344,9 @@ var ChannelPartnerOrderItem;
|
|
|
338
344
|
AutoOrderScheduleEnum[AutoOrderScheduleEnum["Every4Months"] = 'Every 4 Months'] = "Every4Months";
|
|
339
345
|
AutoOrderScheduleEnum[AutoOrderScheduleEnum["Every6Months"] = 'Every 6 Months'] = "Every6Months";
|
|
340
346
|
AutoOrderScheduleEnum[AutoOrderScheduleEnum["Yearly"] = 'Yearly'] = "Yearly";
|
|
347
|
+
AutoOrderScheduleEnum[AutoOrderScheduleEnum["Every4Weeks"] = 'Every 4 Weeks'] = "Every4Weeks";
|
|
348
|
+
AutoOrderScheduleEnum[AutoOrderScheduleEnum["Every6Weeks"] = 'Every 6 Weeks'] = "Every6Weeks";
|
|
349
|
+
AutoOrderScheduleEnum[AutoOrderScheduleEnum["Every8Weeks"] = 'Every 8 Weeks'] = "Every8Weeks";
|
|
341
350
|
})(AutoOrderScheduleEnum = ChannelPartnerOrderItem.AutoOrderScheduleEnum || (ChannelPartnerOrderItem.AutoOrderScheduleEnum = {}));
|
|
342
351
|
})(ChannelPartnerOrderItem = exports.ChannelPartnerOrderItem || (exports.ChannelPartnerOrderItem = {}));
|
|
343
352
|
/**
|