ultracart_rest_api_v2_typescript 3.10.137 → 3.10.138
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/api.ts +34 -10
- package/dist/api.d.ts +34 -10
- package/dist/api.js +8 -8
- 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.138
|
|
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.138 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
|
|
|
54
54
|
|
|
55
55
|
| Version | Date | Comments |
|
|
56
56
|
| --: | :-: | --- |
|
|
57
|
+
| 3.10.138 | 05/18/2023 | dw bi - send back the executed SQL |
|
|
57
58
|
| 3.10.137 | 05/04/2023 | item api added methods for items reviews |
|
|
58
59
|
| 3.10.136 | 04/28/2023 | item - pricing tier level flag for exempt from min item count |
|
|
59
60
|
| 3.10.135 | 04/27/2023 | order - expose dual vaulted identifiers |
|
package/api.ts
CHANGED
|
@@ -1544,6 +1544,12 @@ export interface AutoOrderItem {
|
|
|
1544
1544
|
* @memberof AutoOrderItem
|
|
1545
1545
|
*/
|
|
1546
1546
|
auto_order_item_oid?: number;
|
|
1547
|
+
/**
|
|
1548
|
+
* Date/time of the first order of this item. Null if item added to auto order and has not been rebilled yet.
|
|
1549
|
+
* @type {string}
|
|
1550
|
+
* @memberof AutoOrderItem
|
|
1551
|
+
*/
|
|
1552
|
+
first_order_dts?: string;
|
|
1547
1553
|
/**
|
|
1548
1554
|
* Frequency of the rebill if not a fixed schedule
|
|
1549
1555
|
* @type {string}
|
|
@@ -1610,6 +1616,12 @@ export interface AutoOrderItem {
|
|
|
1610
1616
|
* @memberof AutoOrderItem
|
|
1611
1617
|
*/
|
|
1612
1618
|
original_quantity?: number;
|
|
1619
|
+
/**
|
|
1620
|
+
* True if paused. This field is an object instead of a primitive for backwards compatibility.
|
|
1621
|
+
* @type {boolean}
|
|
1622
|
+
* @memberof AutoOrderItem
|
|
1623
|
+
*/
|
|
1624
|
+
paused?: boolean;
|
|
1613
1625
|
/**
|
|
1614
1626
|
* The PayPal Payer ID tied to this item
|
|
1615
1627
|
* @type {string}
|
|
@@ -25509,6 +25521,12 @@ export interface ItemPricingTierLimit {
|
|
|
25509
25521
|
* @memberof ItemPricingTierLimit
|
|
25510
25522
|
*/
|
|
25511
25523
|
multiple_quantity?: number;
|
|
25524
|
+
/**
|
|
25525
|
+
* Payment method validity
|
|
25526
|
+
* @type {Array<string>}
|
|
25527
|
+
* @memberof ItemPricingTierLimit
|
|
25528
|
+
*/
|
|
25529
|
+
payment_method_validity?: Array<string>;
|
|
25512
25530
|
}
|
|
25513
25531
|
|
|
25514
25532
|
/**
|
|
@@ -33708,6 +33726,12 @@ export interface ReportDataSet {
|
|
|
33708
33726
|
* @memberof ReportDataSet
|
|
33709
33727
|
*/
|
|
33710
33728
|
error_message?: string;
|
|
33729
|
+
/**
|
|
33730
|
+
*
|
|
33731
|
+
* @type {string}
|
|
33732
|
+
* @memberof ReportDataSet
|
|
33733
|
+
*/
|
|
33734
|
+
executed_sql?: string;
|
|
33711
33735
|
/**
|
|
33712
33736
|
* An identifier that can be used to help match up the returned data set
|
|
33713
33737
|
* @type {string}
|
|
@@ -58733,7 +58757,7 @@ export const ItemApiFetchParamCreator = function (configuration?: Configuration)
|
|
|
58733
58757
|
},
|
|
58734
58758
|
/**
|
|
58735
58759
|
* Retrieve an item review.
|
|
58736
|
-
* @summary
|
|
58760
|
+
* @summary Get a review
|
|
58737
58761
|
* @param {number} review_oid The review oid to retrieve.
|
|
58738
58762
|
* @param {number} merchant_item_oid The item oid the review is associated with.
|
|
58739
58763
|
* @param {*} [options] Override http request option.
|
|
@@ -58791,7 +58815,7 @@ export const ItemApiFetchParamCreator = function (configuration?: Configuration)
|
|
|
58791
58815
|
},
|
|
58792
58816
|
/**
|
|
58793
58817
|
* Retrieve item reviews.
|
|
58794
|
-
* @summary
|
|
58818
|
+
* @summary Get reviews for an item
|
|
58795
58819
|
* @param {number} merchant_item_oid The item oid the review is associated with.
|
|
58796
58820
|
* @param {*} [options] Override http request option.
|
|
58797
58821
|
* @throws {RequiredError}
|
|
@@ -59664,7 +59688,7 @@ export const ItemApiFp = function(configuration?: Configuration) {
|
|
|
59664
59688
|
},
|
|
59665
59689
|
/**
|
|
59666
59690
|
* Retrieve an item review.
|
|
59667
|
-
* @summary
|
|
59691
|
+
* @summary Get a review
|
|
59668
59692
|
* @param {number} review_oid The review oid to retrieve.
|
|
59669
59693
|
* @param {number} merchant_item_oid The item oid the review is associated with.
|
|
59670
59694
|
* @param {*} [options] Override http request option.
|
|
@@ -59686,7 +59710,7 @@ export const ItemApiFp = function(configuration?: Configuration) {
|
|
|
59686
59710
|
},
|
|
59687
59711
|
/**
|
|
59688
59712
|
* Retrieve item reviews.
|
|
59689
|
-
* @summary
|
|
59713
|
+
* @summary Get reviews for an item
|
|
59690
59714
|
* @param {number} merchant_item_oid The item oid the review is associated with.
|
|
59691
59715
|
* @param {*} [options] Override http request option.
|
|
59692
59716
|
* @throws {RequiredError}
|
|
@@ -60039,7 +60063,7 @@ export const ItemApiFactory = function (configuration?: Configuration, fetch?: F
|
|
|
60039
60063
|
},
|
|
60040
60064
|
/**
|
|
60041
60065
|
* Retrieve an item review.
|
|
60042
|
-
* @summary
|
|
60066
|
+
* @summary Get a review
|
|
60043
60067
|
* @param {number} review_oid The review oid to retrieve.
|
|
60044
60068
|
* @param {number} merchant_item_oid The item oid the review is associated with.
|
|
60045
60069
|
* @param {*} [options] Override http request option.
|
|
@@ -60050,7 +60074,7 @@ export const ItemApiFactory = function (configuration?: Configuration, fetch?: F
|
|
|
60050
60074
|
},
|
|
60051
60075
|
/**
|
|
60052
60076
|
* Retrieve item reviews.
|
|
60053
|
-
* @summary
|
|
60077
|
+
* @summary Get reviews for an item
|
|
60054
60078
|
* @param {number} merchant_item_oid The item oid the review is associated with.
|
|
60055
60079
|
* @param {*} [options] Override http request option.
|
|
60056
60080
|
* @throws {RequiredError}
|
|
@@ -60293,7 +60317,7 @@ export interface ItemApiInterface {
|
|
|
60293
60317
|
|
|
60294
60318
|
/**
|
|
60295
60319
|
* Retrieve an item review.
|
|
60296
|
-
* @summary
|
|
60320
|
+
* @summary Get a review
|
|
60297
60321
|
* @param {number} review_oid The review oid to retrieve.
|
|
60298
60322
|
* @param {number} merchant_item_oid The item oid the review is associated with.
|
|
60299
60323
|
* @param {*} [options] Override http request option.
|
|
@@ -60304,7 +60328,7 @@ export interface ItemApiInterface {
|
|
|
60304
60328
|
|
|
60305
60329
|
/**
|
|
60306
60330
|
* Retrieve item reviews.
|
|
60307
|
-
* @summary
|
|
60331
|
+
* @summary Get reviews for an item
|
|
60308
60332
|
* @param {number} merchant_item_oid The item oid the review is associated with.
|
|
60309
60333
|
* @param {*} [options] Override http request option.
|
|
60310
60334
|
* @throws {RequiredError}
|
|
@@ -60567,7 +60591,7 @@ export class ItemApi extends BaseAPI implements ItemApiInterface {
|
|
|
60567
60591
|
|
|
60568
60592
|
/**
|
|
60569
60593
|
* Retrieve an item review.
|
|
60570
|
-
* @summary
|
|
60594
|
+
* @summary Get a review
|
|
60571
60595
|
* @param {number} review_oid The review oid to retrieve.
|
|
60572
60596
|
* @param {number} merchant_item_oid The item oid the review is associated with.
|
|
60573
60597
|
* @param {*} [options] Override http request option.
|
|
@@ -60580,7 +60604,7 @@ export class ItemApi extends BaseAPI implements ItemApiInterface {
|
|
|
60580
60604
|
|
|
60581
60605
|
/**
|
|
60582
60606
|
* Retrieve item reviews.
|
|
60583
|
-
* @summary
|
|
60607
|
+
* @summary Get reviews for an item
|
|
60584
60608
|
* @param {number} merchant_item_oid The item oid the review is associated with.
|
|
60585
60609
|
* @param {*} [options] Override http request option.
|
|
60586
60610
|
* @throws {RequiredError}
|
package/dist/api.d.ts
CHANGED
|
@@ -1500,6 +1500,12 @@ export interface AutoOrderItem {
|
|
|
1500
1500
|
* @memberof AutoOrderItem
|
|
1501
1501
|
*/
|
|
1502
1502
|
auto_order_item_oid?: number;
|
|
1503
|
+
/**
|
|
1504
|
+
* Date/time of the first order of this item. Null if item added to auto order and has not been rebilled yet.
|
|
1505
|
+
* @type {string}
|
|
1506
|
+
* @memberof AutoOrderItem
|
|
1507
|
+
*/
|
|
1508
|
+
first_order_dts?: string;
|
|
1503
1509
|
/**
|
|
1504
1510
|
* Frequency of the rebill if not a fixed schedule
|
|
1505
1511
|
* @type {string}
|
|
@@ -1566,6 +1572,12 @@ export interface AutoOrderItem {
|
|
|
1566
1572
|
* @memberof AutoOrderItem
|
|
1567
1573
|
*/
|
|
1568
1574
|
original_quantity?: number;
|
|
1575
|
+
/**
|
|
1576
|
+
* True if paused. This field is an object instead of a primitive for backwards compatibility.
|
|
1577
|
+
* @type {boolean}
|
|
1578
|
+
* @memberof AutoOrderItem
|
|
1579
|
+
*/
|
|
1580
|
+
paused?: boolean;
|
|
1569
1581
|
/**
|
|
1570
1582
|
* The PayPal Payer ID tied to this item
|
|
1571
1583
|
* @type {string}
|
|
@@ -24965,6 +24977,12 @@ export interface ItemPricingTierLimit {
|
|
|
24965
24977
|
* @memberof ItemPricingTierLimit
|
|
24966
24978
|
*/
|
|
24967
24979
|
multiple_quantity?: number;
|
|
24980
|
+
/**
|
|
24981
|
+
* Payment method validity
|
|
24982
|
+
* @type {Array<string>}
|
|
24983
|
+
* @memberof ItemPricingTierLimit
|
|
24984
|
+
*/
|
|
24985
|
+
payment_method_validity?: Array<string>;
|
|
24968
24986
|
}
|
|
24969
24987
|
/**
|
|
24970
24988
|
*
|
|
@@ -33003,6 +33021,12 @@ export interface ReportDataSet {
|
|
|
33003
33021
|
* @memberof ReportDataSet
|
|
33004
33022
|
*/
|
|
33005
33023
|
error_message?: string;
|
|
33024
|
+
/**
|
|
33025
|
+
*
|
|
33026
|
+
* @type {string}
|
|
33027
|
+
* @memberof ReportDataSet
|
|
33028
|
+
*/
|
|
33029
|
+
executed_sql?: string;
|
|
33006
33030
|
/**
|
|
33007
33031
|
* An identifier that can be used to help match up the returned data set
|
|
33008
33032
|
* @type {string}
|
|
@@ -46951,7 +46975,7 @@ export declare const ItemApiFetchParamCreator: (configuration?: Configuration) =
|
|
|
46951
46975
|
getPricingTiers(_expand?: string, options?: any): FetchArgs;
|
|
46952
46976
|
/**
|
|
46953
46977
|
* Retrieve an item review.
|
|
46954
|
-
* @summary
|
|
46978
|
+
* @summary Get a review
|
|
46955
46979
|
* @param {number} review_oid The review oid to retrieve.
|
|
46956
46980
|
* @param {number} merchant_item_oid The item oid the review is associated with.
|
|
46957
46981
|
* @param {*} [options] Override http request option.
|
|
@@ -46960,7 +46984,7 @@ export declare const ItemApiFetchParamCreator: (configuration?: Configuration) =
|
|
|
46960
46984
|
getReview(review_oid: number, merchant_item_oid: number, options?: any): FetchArgs;
|
|
46961
46985
|
/**
|
|
46962
46986
|
* Retrieve item reviews.
|
|
46963
|
-
* @summary
|
|
46987
|
+
* @summary Get reviews for an item
|
|
46964
46988
|
* @param {number} merchant_item_oid The item oid the review is associated with.
|
|
46965
46989
|
* @param {*} [options] Override http request option.
|
|
46966
46990
|
* @throws {RequiredError}
|
|
@@ -47160,7 +47184,7 @@ export declare const ItemApiFp: (configuration?: Configuration) => {
|
|
|
47160
47184
|
getPricingTiers(_expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<PricingTiersResponse>;
|
|
47161
47185
|
/**
|
|
47162
47186
|
* Retrieve an item review.
|
|
47163
|
-
* @summary
|
|
47187
|
+
* @summary Get a review
|
|
47164
47188
|
* @param {number} review_oid The review oid to retrieve.
|
|
47165
47189
|
* @param {number} merchant_item_oid The item oid the review is associated with.
|
|
47166
47190
|
* @param {*} [options] Override http request option.
|
|
@@ -47169,7 +47193,7 @@ export declare const ItemApiFp: (configuration?: Configuration) => {
|
|
|
47169
47193
|
getReview(review_oid: number, merchant_item_oid: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ItemReviewResponse>;
|
|
47170
47194
|
/**
|
|
47171
47195
|
* Retrieve item reviews.
|
|
47172
|
-
* @summary
|
|
47196
|
+
* @summary Get reviews for an item
|
|
47173
47197
|
* @param {number} merchant_item_oid The item oid the review is associated with.
|
|
47174
47198
|
* @param {*} [options] Override http request option.
|
|
47175
47199
|
* @throws {RequiredError}
|
|
@@ -47369,7 +47393,7 @@ export declare const ItemApiFactory: (configuration?: Configuration, fetch?: Fet
|
|
|
47369
47393
|
getPricingTiers(_expand?: string, options?: any): Promise<PricingTiersResponse>;
|
|
47370
47394
|
/**
|
|
47371
47395
|
* Retrieve an item review.
|
|
47372
|
-
* @summary
|
|
47396
|
+
* @summary Get a review
|
|
47373
47397
|
* @param {number} review_oid The review oid to retrieve.
|
|
47374
47398
|
* @param {number} merchant_item_oid The item oid the review is associated with.
|
|
47375
47399
|
* @param {*} [options] Override http request option.
|
|
@@ -47378,7 +47402,7 @@ export declare const ItemApiFactory: (configuration?: Configuration, fetch?: Fet
|
|
|
47378
47402
|
getReview(review_oid: number, merchant_item_oid: number, options?: any): Promise<ItemReviewResponse>;
|
|
47379
47403
|
/**
|
|
47380
47404
|
* Retrieve item reviews.
|
|
47381
|
-
* @summary
|
|
47405
|
+
* @summary Get reviews for an item
|
|
47382
47406
|
* @param {number} merchant_item_oid The item oid the review is associated with.
|
|
47383
47407
|
* @param {*} [options] Override http request option.
|
|
47384
47408
|
* @throws {RequiredError}
|
|
@@ -47589,7 +47613,7 @@ export interface ItemApiInterface {
|
|
|
47589
47613
|
getPricingTiers(_expand?: string, options?: any): Promise<PricingTiersResponse>;
|
|
47590
47614
|
/**
|
|
47591
47615
|
* Retrieve an item review.
|
|
47592
|
-
* @summary
|
|
47616
|
+
* @summary Get a review
|
|
47593
47617
|
* @param {number} review_oid The review oid to retrieve.
|
|
47594
47618
|
* @param {number} merchant_item_oid The item oid the review is associated with.
|
|
47595
47619
|
* @param {*} [options] Override http request option.
|
|
@@ -47599,7 +47623,7 @@ export interface ItemApiInterface {
|
|
|
47599
47623
|
getReview(review_oid: number, merchant_item_oid: number, options?: any): Promise<ItemReviewResponse>;
|
|
47600
47624
|
/**
|
|
47601
47625
|
* Retrieve item reviews.
|
|
47602
|
-
* @summary
|
|
47626
|
+
* @summary Get reviews for an item
|
|
47603
47627
|
* @param {number} merchant_item_oid The item oid the review is associated with.
|
|
47604
47628
|
* @param {*} [options] Override http request option.
|
|
47605
47629
|
* @throws {RequiredError}
|
|
@@ -47821,7 +47845,7 @@ export declare class ItemApi extends BaseAPI implements ItemApiInterface {
|
|
|
47821
47845
|
getPricingTiers(_expand?: string, options?: any): Promise<PricingTiersResponse>;
|
|
47822
47846
|
/**
|
|
47823
47847
|
* Retrieve an item review.
|
|
47824
|
-
* @summary
|
|
47848
|
+
* @summary Get a review
|
|
47825
47849
|
* @param {number} review_oid The review oid to retrieve.
|
|
47826
47850
|
* @param {number} merchant_item_oid The item oid the review is associated with.
|
|
47827
47851
|
* @param {*} [options] Override http request option.
|
|
@@ -47831,7 +47855,7 @@ export declare class ItemApi extends BaseAPI implements ItemApiInterface {
|
|
|
47831
47855
|
getReview(review_oid: number, merchant_item_oid: number, options?: any): Promise<ItemReviewResponse>;
|
|
47832
47856
|
/**
|
|
47833
47857
|
* Retrieve item reviews.
|
|
47834
|
-
* @summary
|
|
47858
|
+
* @summary Get reviews for an item
|
|
47835
47859
|
* @param {number} merchant_item_oid The item oid the review is associated with.
|
|
47836
47860
|
* @param {*} [options] Override http request option.
|
|
47837
47861
|
* @throws {RequiredError}
|
package/dist/api.js
CHANGED
|
@@ -17075,7 +17075,7 @@ var ItemApiFetchParamCreator = function (configuration) {
|
|
|
17075
17075
|
},
|
|
17076
17076
|
/**
|
|
17077
17077
|
* Retrieve an item review.
|
|
17078
|
-
* @summary
|
|
17078
|
+
* @summary Get a review
|
|
17079
17079
|
* @param {number} review_oid The review oid to retrieve.
|
|
17080
17080
|
* @param {number} merchant_item_oid The item oid the review is associated with.
|
|
17081
17081
|
* @param {*} [options] Override http request option.
|
|
@@ -17127,7 +17127,7 @@ var ItemApiFetchParamCreator = function (configuration) {
|
|
|
17127
17127
|
},
|
|
17128
17128
|
/**
|
|
17129
17129
|
* Retrieve item reviews.
|
|
17130
|
-
* @summary
|
|
17130
|
+
* @summary Get reviews for an item
|
|
17131
17131
|
* @param {number} merchant_item_oid The item oid the review is associated with.
|
|
17132
17132
|
* @param {*} [options] Override http request option.
|
|
17133
17133
|
* @throws {RequiredError}
|
|
@@ -17928,7 +17928,7 @@ var ItemApiFp = function (configuration) {
|
|
|
17928
17928
|
},
|
|
17929
17929
|
/**
|
|
17930
17930
|
* Retrieve an item review.
|
|
17931
|
-
* @summary
|
|
17931
|
+
* @summary Get a review
|
|
17932
17932
|
* @param {number} review_oid The review oid to retrieve.
|
|
17933
17933
|
* @param {number} merchant_item_oid The item oid the review is associated with.
|
|
17934
17934
|
* @param {*} [options] Override http request option.
|
|
@@ -17951,7 +17951,7 @@ var ItemApiFp = function (configuration) {
|
|
|
17951
17951
|
},
|
|
17952
17952
|
/**
|
|
17953
17953
|
* Retrieve item reviews.
|
|
17954
|
-
* @summary
|
|
17954
|
+
* @summary Get reviews for an item
|
|
17955
17955
|
* @param {number} merchant_item_oid The item oid the review is associated with.
|
|
17956
17956
|
* @param {*} [options] Override http request option.
|
|
17957
17957
|
* @throws {RequiredError}
|
|
@@ -18314,7 +18314,7 @@ var ItemApiFactory = function (configuration, fetch, basePath) {
|
|
|
18314
18314
|
},
|
|
18315
18315
|
/**
|
|
18316
18316
|
* Retrieve an item review.
|
|
18317
|
-
* @summary
|
|
18317
|
+
* @summary Get a review
|
|
18318
18318
|
* @param {number} review_oid The review oid to retrieve.
|
|
18319
18319
|
* @param {number} merchant_item_oid The item oid the review is associated with.
|
|
18320
18320
|
* @param {*} [options] Override http request option.
|
|
@@ -18325,7 +18325,7 @@ var ItemApiFactory = function (configuration, fetch, basePath) {
|
|
|
18325
18325
|
},
|
|
18326
18326
|
/**
|
|
18327
18327
|
* Retrieve item reviews.
|
|
18328
|
-
* @summary
|
|
18328
|
+
* @summary Get reviews for an item
|
|
18329
18329
|
* @param {number} merchant_item_oid The item oid the review is associated with.
|
|
18330
18330
|
* @param {*} [options] Override http request option.
|
|
18331
18331
|
* @throws {RequiredError}
|
|
@@ -18583,7 +18583,7 @@ var ItemApi = /** @class */ (function (_super) {
|
|
|
18583
18583
|
};
|
|
18584
18584
|
/**
|
|
18585
18585
|
* Retrieve an item review.
|
|
18586
|
-
* @summary
|
|
18586
|
+
* @summary Get a review
|
|
18587
18587
|
* @param {number} review_oid The review oid to retrieve.
|
|
18588
18588
|
* @param {number} merchant_item_oid The item oid the review is associated with.
|
|
18589
18589
|
* @param {*} [options] Override http request option.
|
|
@@ -18595,7 +18595,7 @@ var ItemApi = /** @class */ (function (_super) {
|
|
|
18595
18595
|
};
|
|
18596
18596
|
/**
|
|
18597
18597
|
* Retrieve item reviews.
|
|
18598
|
-
* @summary
|
|
18598
|
+
* @summary Get reviews for an item
|
|
18599
18599
|
* @param {number} merchant_item_oid The item oid the review is associated with.
|
|
18600
18600
|
* @param {*} [options] Override http request option.
|
|
18601
18601
|
* @throws {RequiredError}
|