ultracart_rest_api_v2_typescript 3.10.213 → 3.10.214
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 +62 -8
- package/dist/api.d.ts +54 -5
- package/dist/api.js +33 -10
- 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.214
|
|
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.214 --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.214 | 08/08/2024 | added query_target to OrderApi.getOrdersBatch to allow cache usage |
|
|
57
58
|
| 3.10.213 | 06/24/2024 | conversation object cleanup |
|
|
58
59
|
| 3.10.212 | 06/14/2024 | pbx menu - add say voice property |
|
|
59
60
|
| 3.10.211 | 06/07/2024 | conversation pbx - adjust agent voicemail box uuid fields |
|
package/api.ts
CHANGED
|
@@ -35106,6 +35106,27 @@ export interface OrderQueryBatch {
|
|
|
35106
35106
|
* @memberof OrderQueryBatch
|
|
35107
35107
|
*/
|
|
35108
35108
|
order_ids?: Array<string>;
|
|
35109
|
+
/**
|
|
35110
|
+
* Query Target
|
|
35111
|
+
* @type {string}
|
|
35112
|
+
* @memberof OrderQueryBatch
|
|
35113
|
+
*/
|
|
35114
|
+
query_target?: OrderQueryBatch.QueryTargetEnum;
|
|
35115
|
+
}
|
|
35116
|
+
|
|
35117
|
+
/**
|
|
35118
|
+
* @export
|
|
35119
|
+
* @namespace OrderQueryBatch
|
|
35120
|
+
*/
|
|
35121
|
+
export namespace OrderQueryBatch {
|
|
35122
|
+
/**
|
|
35123
|
+
* @export
|
|
35124
|
+
* @enum {string}
|
|
35125
|
+
*/
|
|
35126
|
+
export enum QueryTargetEnum {
|
|
35127
|
+
Origin = <any> 'origin',
|
|
35128
|
+
Cache = <any> 'cache'
|
|
35129
|
+
}
|
|
35109
35130
|
}
|
|
35110
35131
|
|
|
35111
35132
|
/**
|
|
@@ -41129,6 +41150,18 @@ export interface ScreenshotsResponse {
|
|
|
41129
41150
|
* @interface SelfConfig
|
|
41130
41151
|
*/
|
|
41131
41152
|
export interface SelfConfig {
|
|
41153
|
+
/**
|
|
41154
|
+
* True if the Colorado Retail Delivery Fee should not be collected
|
|
41155
|
+
* @type {boolean}
|
|
41156
|
+
* @memberof SelfConfig
|
|
41157
|
+
*/
|
|
41158
|
+
exempt_from_colorado_retail_delivery_fee?: boolean;
|
|
41159
|
+
/**
|
|
41160
|
+
* True if the Minnesota Retail Delivery Fee should not be collected
|
|
41161
|
+
* @type {boolean}
|
|
41162
|
+
* @memberof SelfConfig
|
|
41163
|
+
*/
|
|
41164
|
+
exempt_from_minnesota_retail_delivery_fee?: boolean;
|
|
41132
41165
|
/**
|
|
41133
41166
|
* True if sales tax should be collected based on billing address instead of shipping address
|
|
41134
41167
|
* @type {boolean}
|
|
@@ -42942,6 +42975,18 @@ export interface TwiliosResponse {
|
|
|
42942
42975
|
* @interface UltraCartConfig
|
|
42943
42976
|
*/
|
|
42944
42977
|
export interface UltraCartConfig {
|
|
42978
|
+
/**
|
|
42979
|
+
* True if the Colorado Retail Delivery Fee should not be collected
|
|
42980
|
+
* @type {boolean}
|
|
42981
|
+
* @memberof UltraCartConfig
|
|
42982
|
+
*/
|
|
42983
|
+
exempt_from_colorado_retail_delivery_fee?: boolean;
|
|
42984
|
+
/**
|
|
42985
|
+
* True if the Minnesota Retail Delivery Fee should not be collected
|
|
42986
|
+
* @type {boolean}
|
|
42987
|
+
* @memberof UltraCartConfig
|
|
42988
|
+
*/
|
|
42989
|
+
exempt_from_minnesota_retail_delivery_fee?: boolean;
|
|
42945
42990
|
/**
|
|
42946
42991
|
* True if sales tax should be collected based on billing address instead of shipping address
|
|
42947
42992
|
* @type {boolean}
|
|
@@ -73122,11 +73167,12 @@ export const OrderApiFetchParamCreator = function (configuration?: Configuration
|
|
|
73122
73167
|
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
73123
73168
|
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
73124
73169
|
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
73170
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
73125
73171
|
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
73126
73172
|
* @param {*} [options] Override http request option.
|
|
73127
73173
|
* @throws {RequiredError}
|
|
73128
73174
|
*/
|
|
73129
|
-
refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, _expand?: string, options: any = {}): FetchArgs {
|
|
73175
|
+
refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, auto_order_cancel_reason?: string, _expand?: string, options: any = {}): FetchArgs {
|
|
73130
73176
|
// verify required parameter 'order' is not null or undefined
|
|
73131
73177
|
if (order === null || order === undefined) {
|
|
73132
73178
|
throw new RequiredError('order','Required parameter order was null or undefined when calling refundOrder.');
|
|
@@ -73189,6 +73235,10 @@ export const OrderApiFetchParamCreator = function (configuration?: Configuration
|
|
|
73189
73235
|
localVarQueryParameter['issue_store_credit'] = issue_store_credit;
|
|
73190
73236
|
}
|
|
73191
73237
|
|
|
73238
|
+
if (auto_order_cancel_reason !== undefined) {
|
|
73239
|
+
localVarQueryParameter['auto_order_cancel_reason'] = auto_order_cancel_reason;
|
|
73240
|
+
}
|
|
73241
|
+
|
|
73192
73242
|
if (_expand !== undefined) {
|
|
73193
73243
|
localVarQueryParameter['_expand'] = _expand;
|
|
73194
73244
|
}
|
|
@@ -74033,12 +74083,13 @@ export const OrderApiFp = function(configuration?: Configuration) {
|
|
|
74033
74083
|
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
74034
74084
|
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
74035
74085
|
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
74086
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
74036
74087
|
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
74037
74088
|
* @param {*} [options] Override http request option.
|
|
74038
74089
|
* @throws {RequiredError}
|
|
74039
74090
|
*/
|
|
74040
|
-
refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, _expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrderResponse> {
|
|
74041
|
-
const localVarFetchArgs = OrderApiFetchParamCreator(configuration).refundOrder(order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, _expand, options);
|
|
74091
|
+
refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, auto_order_cancel_reason?: string, _expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrderResponse> {
|
|
74092
|
+
const localVarFetchArgs = OrderApiFetchParamCreator(configuration).refundOrder(order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, auto_order_cancel_reason, _expand, options);
|
|
74042
74093
|
return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
|
|
74043
74094
|
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
|
|
74044
74095
|
|
|
@@ -74445,12 +74496,13 @@ export const OrderApiFactory = function (configuration?: Configuration, fetch?:
|
|
|
74445
74496
|
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
74446
74497
|
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
74447
74498
|
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
74499
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
74448
74500
|
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
74449
74501
|
* @param {*} [options] Override http request option.
|
|
74450
74502
|
* @throws {RequiredError}
|
|
74451
74503
|
*/
|
|
74452
|
-
refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, _expand?: string, options?: any) {
|
|
74453
|
-
return OrderApiFp(configuration).refundOrder(order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, _expand, options)(fetch, basePath);
|
|
74504
|
+
refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, auto_order_cancel_reason?: string, _expand?: string, options?: any) {
|
|
74505
|
+
return OrderApiFp(configuration).refundOrder(order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, auto_order_cancel_reason, _expand, options)(fetch, basePath);
|
|
74454
74506
|
},
|
|
74455
74507
|
/**
|
|
74456
74508
|
* Create a replacement order based upon a previous order
|
|
@@ -74780,12 +74832,13 @@ export interface OrderApiInterface {
|
|
|
74780
74832
|
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
74781
74833
|
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
74782
74834
|
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
74835
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
74783
74836
|
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
74784
74837
|
* @param {*} [options] Override http request option.
|
|
74785
74838
|
* @throws {RequiredError}
|
|
74786
74839
|
* @memberof OrderApiInterface
|
|
74787
74840
|
*/
|
|
74788
|
-
refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, _expand?: string, options?: any): Promise<OrderResponse>;
|
|
74841
|
+
refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, auto_order_cancel_reason?: string, _expand?: string, options?: any): Promise<OrderResponse>;
|
|
74789
74842
|
|
|
74790
74843
|
/**
|
|
74791
74844
|
* Create a replacement order based upon a previous order
|
|
@@ -75155,13 +75208,14 @@ export class OrderApi extends BaseAPI implements OrderApiInterface {
|
|
|
75155
75208
|
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
75156
75209
|
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
75157
75210
|
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
75211
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
75158
75212
|
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
75159
75213
|
* @param {*} [options] Override http request option.
|
|
75160
75214
|
* @throws {RequiredError}
|
|
75161
75215
|
* @memberof OrderApi
|
|
75162
75216
|
*/
|
|
75163
|
-
public refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, _expand?: string, options?: any) {
|
|
75164
|
-
return OrderApiFp(this.configuration).refundOrder(order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, _expand, options)(this.fetch, this.basePath);
|
|
75217
|
+
public refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, auto_order_cancel_reason?: string, _expand?: string, options?: any) {
|
|
75218
|
+
return OrderApiFp(this.configuration).refundOrder(order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, auto_order_cancel_reason, _expand, options)(this.fetch, this.basePath);
|
|
75165
75219
|
}
|
|
75166
75220
|
|
|
75167
75221
|
/**
|
package/dist/api.d.ts
CHANGED
|
@@ -34370,6 +34370,26 @@ export interface OrderQueryBatch {
|
|
|
34370
34370
|
* @memberof OrderQueryBatch
|
|
34371
34371
|
*/
|
|
34372
34372
|
order_ids?: Array<string>;
|
|
34373
|
+
/**
|
|
34374
|
+
* Query Target
|
|
34375
|
+
* @type {string}
|
|
34376
|
+
* @memberof OrderQueryBatch
|
|
34377
|
+
*/
|
|
34378
|
+
query_target?: OrderQueryBatch.QueryTargetEnum;
|
|
34379
|
+
}
|
|
34380
|
+
/**
|
|
34381
|
+
* @export
|
|
34382
|
+
* @namespace OrderQueryBatch
|
|
34383
|
+
*/
|
|
34384
|
+
export declare namespace OrderQueryBatch {
|
|
34385
|
+
/**
|
|
34386
|
+
* @export
|
|
34387
|
+
* @enum {string}
|
|
34388
|
+
*/
|
|
34389
|
+
enum QueryTargetEnum {
|
|
34390
|
+
Origin,
|
|
34391
|
+
Cache
|
|
34392
|
+
}
|
|
34373
34393
|
}
|
|
34374
34394
|
/**
|
|
34375
34395
|
*
|
|
@@ -40269,6 +40289,18 @@ export interface ScreenshotsResponse {
|
|
|
40269
40289
|
* @interface SelfConfig
|
|
40270
40290
|
*/
|
|
40271
40291
|
export interface SelfConfig {
|
|
40292
|
+
/**
|
|
40293
|
+
* True if the Colorado Retail Delivery Fee should not be collected
|
|
40294
|
+
* @type {boolean}
|
|
40295
|
+
* @memberof SelfConfig
|
|
40296
|
+
*/
|
|
40297
|
+
exempt_from_colorado_retail_delivery_fee?: boolean;
|
|
40298
|
+
/**
|
|
40299
|
+
* True if the Minnesota Retail Delivery Fee should not be collected
|
|
40300
|
+
* @type {boolean}
|
|
40301
|
+
* @memberof SelfConfig
|
|
40302
|
+
*/
|
|
40303
|
+
exempt_from_minnesota_retail_delivery_fee?: boolean;
|
|
40272
40304
|
/**
|
|
40273
40305
|
* True if sales tax should be collected based on billing address instead of shipping address
|
|
40274
40306
|
* @type {boolean}
|
|
@@ -42038,6 +42070,18 @@ export interface TwiliosResponse {
|
|
|
42038
42070
|
* @interface UltraCartConfig
|
|
42039
42071
|
*/
|
|
42040
42072
|
export interface UltraCartConfig {
|
|
42073
|
+
/**
|
|
42074
|
+
* True if the Colorado Retail Delivery Fee should not be collected
|
|
42075
|
+
* @type {boolean}
|
|
42076
|
+
* @memberof UltraCartConfig
|
|
42077
|
+
*/
|
|
42078
|
+
exempt_from_colorado_retail_delivery_fee?: boolean;
|
|
42079
|
+
/**
|
|
42080
|
+
* True if the Minnesota Retail Delivery Fee should not be collected
|
|
42081
|
+
* @type {boolean}
|
|
42082
|
+
* @memberof UltraCartConfig
|
|
42083
|
+
*/
|
|
42084
|
+
exempt_from_minnesota_retail_delivery_fee?: boolean;
|
|
42041
42085
|
/**
|
|
42042
42086
|
* True if sales tax should be collected based on billing address instead of shipping address
|
|
42043
42087
|
* @type {boolean}
|
|
@@ -55278,11 +55322,12 @@ export declare const OrderApiFetchParamCreator: (configuration?: Configuration)
|
|
|
55278
55322
|
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
55279
55323
|
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
55280
55324
|
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
55325
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
55281
55326
|
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
55282
55327
|
* @param {*} [options] Override http request option.
|
|
55283
55328
|
* @throws {RequiredError}
|
|
55284
55329
|
*/
|
|
55285
|
-
refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, _expand?: string, options?: any): FetchArgs;
|
|
55330
|
+
refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, auto_order_cancel_reason?: string, _expand?: string, options?: any): FetchArgs;
|
|
55286
55331
|
/**
|
|
55287
55332
|
* Create a replacement order based upon a previous order
|
|
55288
55333
|
* @summary Replacement order
|
|
@@ -55556,11 +55601,12 @@ export declare const OrderApiFp: (configuration?: Configuration) => {
|
|
|
55556
55601
|
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
55557
55602
|
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
55558
55603
|
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
55604
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
55559
55605
|
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
55560
55606
|
* @param {*} [options] Override http request option.
|
|
55561
55607
|
* @throws {RequiredError}
|
|
55562
55608
|
*/
|
|
55563
|
-
refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, _expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrderResponse>;
|
|
55609
|
+
refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, auto_order_cancel_reason?: string, _expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrderResponse>;
|
|
55564
55610
|
/**
|
|
55565
55611
|
* Create a replacement order based upon a previous order
|
|
55566
55612
|
* @summary Replacement order
|
|
@@ -55834,11 +55880,12 @@ export declare const OrderApiFactory: (configuration?: Configuration, fetch?: Fe
|
|
|
55834
55880
|
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
55835
55881
|
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
55836
55882
|
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
55883
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
55837
55884
|
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
55838
55885
|
* @param {*} [options] Override http request option.
|
|
55839
55886
|
* @throws {RequiredError}
|
|
55840
55887
|
*/
|
|
55841
|
-
refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, _expand?: string, options?: any): Promise<OrderResponse>;
|
|
55888
|
+
refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, auto_order_cancel_reason?: string, _expand?: string, options?: any): Promise<OrderResponse>;
|
|
55842
55889
|
/**
|
|
55843
55890
|
* Create a replacement order based upon a previous order
|
|
55844
55891
|
* @summary Replacement order
|
|
@@ -56133,12 +56180,13 @@ export interface OrderApiInterface {
|
|
|
56133
56180
|
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
56134
56181
|
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
56135
56182
|
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
56183
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
56136
56184
|
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
56137
56185
|
* @param {*} [options] Override http request option.
|
|
56138
56186
|
* @throws {RequiredError}
|
|
56139
56187
|
* @memberof OrderApiInterface
|
|
56140
56188
|
*/
|
|
56141
|
-
refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, _expand?: string, options?: any): Promise<OrderResponse>;
|
|
56189
|
+
refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, auto_order_cancel_reason?: string, _expand?: string, options?: any): Promise<OrderResponse>;
|
|
56142
56190
|
/**
|
|
56143
56191
|
* Create a replacement order based upon a previous order
|
|
56144
56192
|
* @summary Replacement order
|
|
@@ -56440,12 +56488,13 @@ export declare class OrderApi extends BaseAPI implements OrderApiInterface {
|
|
|
56440
56488
|
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
56441
56489
|
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
56442
56490
|
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
56491
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
56443
56492
|
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
56444
56493
|
* @param {*} [options] Override http request option.
|
|
56445
56494
|
* @throws {RequiredError}
|
|
56446
56495
|
* @memberof OrderApi
|
|
56447
56496
|
*/
|
|
56448
|
-
refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, _expand?: string, options?: any): Promise<OrderResponse>;
|
|
56497
|
+
refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, auto_order_cancel_reason?: string, _expand?: string, options?: any): Promise<OrderResponse>;
|
|
56449
56498
|
/**
|
|
56450
56499
|
* Create a replacement order based upon a previous order
|
|
56451
56500
|
* @summary Replacement order
|
package/dist/api.js
CHANGED
|
@@ -29,9 +29,9 @@ var __extends = (this && this.__extends) || (function () {
|
|
|
29
29
|
})();
|
|
30
30
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
31
31
|
exports.ItemTax = exports.ItemTag = exports.ItemShippingMethod = exports.ItemShippingDestinationRestriction = exports.ItemReview = exports.ItemRestrictionItem = exports.ItemRelatedItem = exports.ItemOptionValue = exports.ItemOption = exports.ItemContentMultimedia = exports.ItemAutoOrderStep = exports.Experiment = exports.EmailPerformance = exports.EmailCommseqStep = exports.Distance = exports.Coupon = exports.ConversationWebsocketMessage = exports.ConversationWebchatQueueStatusUpdateRequest = exports.ConversationWebchatQueueStatusAgent = exports.ConversationSummary = exports.ConversationSentiment = exports.ConversationPbxVoicemailMessageSummary = exports.ConversationPbxVoicemailMessage = exports.ConversationPbxVoicemailMailbox = exports.ConversationPbxTimeBasedMapping = exports.ConversationPbxPhoneNumber = exports.ConversationPbxMenuMapping = exports.ConversationPbxMenu = exports.ConversationMessageTransportStatus = exports.ConversationMessage = exports.ConversationEventRRWeb = exports.ConversationEngagementEquationFunction = exports.ConversationEngagement = exports.ConversationAgentProfile = exports.Conversation = exports.CheckoutHandoffRequest = exports.ChannelPartnerOrderItem = exports.ChannelPartnerOrder = exports.CartKitComponentOption = exports.CartItemOption = exports.CartItemMultimedia = exports.CartCustomerProfileCreditCard = exports.AutoOrderItemSimpleSchedule = exports.AutoOrderItem = exports.AutoOrder = exports.AffiliateLink = exports.AffiliateLedger = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = void 0;
|
|
32
|
-
exports.
|
|
33
|
-
exports.
|
|
34
|
-
exports.WorkflowApi = exports.WorkflowApiFactory = exports.WorkflowApiFp = exports.WorkflowApiFetchParamCreator = exports.WebhookApi = exports.WebhookApiFactory = exports.WebhookApiFp = exports.WebhookApiFetchParamCreator = exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiFetchParamCreator = exports.TaxApi = exports.TaxApiFactory = void 0;
|
|
32
|
+
exports.CheckoutApiFactory = exports.CheckoutApiFp = exports.CheckoutApiFetchParamCreator = exports.ChargebackApi = exports.ChargebackApiFactory = exports.ChargebackApiFp = exports.ChargebackApiFetchParamCreator = exports.ChannelPartnerApi = exports.ChannelPartnerApiFactory = exports.ChannelPartnerApiFp = exports.ChannelPartnerApiFetchParamCreator = exports.AutoOrderApi = exports.AutoOrderApiFactory = exports.AutoOrderApiFp = exports.AutoOrderApiFetchParamCreator = exports.AffiliateApi = exports.AffiliateApiFactory = exports.AffiliateApiFp = exports.AffiliateApiFetchParamCreator = exports.WorkflowTasksRequest = exports.WorkflowTask = exports.Weight = exports.Webhook = exports.TempMultimedia = exports.ReportWebsocketEvent = exports.ReportPageVisualizationMetric = exports.ReportPageVisualization = exports.ReportFilter = exports.ReportExecuteQueriesRequest = exports.ReportDataSourceSchema = exports.ReportDataSetSchema = exports.ReportDataSetQuery = exports.ReportDataSet = exports.Report = exports.PointOfSaleReader = exports.OrderQueryBatch = exports.OrderQuery = exports.OrderPaymentECheck = exports.OrderPaymentCreditCard = exports.OrderPayment = exports.OrderItemOption = exports.OrderItem = exports.OrderFraudScore = exports.OrderFormat = exports.OrderEdiDocument = exports.OrderAutoOrder = exports.OrderAffiliateLedger = exports.Order = exports.OauthTokenResponse = exports.ItemThirdPartyEmailMarketing = void 0;
|
|
33
|
+
exports.TaxApiFetchParamCreator = exports.StorefrontApi = exports.StorefrontApiFactory = exports.StorefrontApiFp = exports.StorefrontApiFetchParamCreator = exports.SsoApi = exports.SsoApiFactory = exports.SsoApiFp = exports.SsoApiFetchParamCreator = exports.OrderApi = exports.OrderApiFactory = exports.OrderApiFp = exports.OrderApiFetchParamCreator = exports.OauthApi = exports.OauthApiFactory = exports.OauthApiFp = exports.OauthApiFetchParamCreator = exports.ItemApi = exports.ItemApiFactory = exports.ItemApiFp = exports.ItemApiFetchParamCreator = exports.IntegrationLogApi = exports.IntegrationLogApiFactory = exports.IntegrationLogApiFp = exports.IntegrationLogApiFetchParamCreator = exports.GiftCertificateApi = exports.GiftCertificateApiFactory = exports.GiftCertificateApiFp = exports.GiftCertificateApiFetchParamCreator = exports.FulfillmentApi = exports.FulfillmentApiFactory = exports.FulfillmentApiFp = exports.FulfillmentApiFetchParamCreator = exports.DatawarehouseApi = exports.DatawarehouseApiFactory = exports.DatawarehouseApiFp = exports.DatawarehouseApiFetchParamCreator = exports.CustomerApi = exports.CustomerApiFactory = exports.CustomerApiFp = exports.CustomerApiFetchParamCreator = exports.CouponApi = exports.CouponApiFactory = exports.CouponApiFp = exports.CouponApiFetchParamCreator = exports.ConversationApi = exports.ConversationApiFactory = exports.ConversationApiFp = exports.ConversationApiFetchParamCreator = exports.CheckoutApi = void 0;
|
|
34
|
+
exports.WorkflowApi = exports.WorkflowApiFactory = exports.WorkflowApiFp = exports.WorkflowApiFetchParamCreator = exports.WebhookApi = exports.WebhookApiFactory = exports.WebhookApiFp = exports.WebhookApiFetchParamCreator = exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiFetchParamCreator = exports.TaxApi = exports.TaxApiFactory = exports.TaxApiFp = void 0;
|
|
35
35
|
var url = require("url");
|
|
36
36
|
var portableFetch = require("portable-fetch");
|
|
37
37
|
var BASE_PATH = "https://secure.ultracart.com/rest/v2".replace(/\/+$/, "");
|
|
@@ -1474,6 +1474,22 @@ var OrderQuery;
|
|
|
1474
1474
|
QueryTargetEnum[QueryTargetEnum["Cache"] = 'cache'] = "Cache";
|
|
1475
1475
|
})(QueryTargetEnum = OrderQuery.QueryTargetEnum || (OrderQuery.QueryTargetEnum = {}));
|
|
1476
1476
|
})(OrderQuery = exports.OrderQuery || (exports.OrderQuery = {}));
|
|
1477
|
+
/**
|
|
1478
|
+
* @export
|
|
1479
|
+
* @namespace OrderQueryBatch
|
|
1480
|
+
*/
|
|
1481
|
+
var OrderQueryBatch;
|
|
1482
|
+
(function (OrderQueryBatch) {
|
|
1483
|
+
/**
|
|
1484
|
+
* @export
|
|
1485
|
+
* @enum {string}
|
|
1486
|
+
*/
|
|
1487
|
+
var QueryTargetEnum;
|
|
1488
|
+
(function (QueryTargetEnum) {
|
|
1489
|
+
QueryTargetEnum[QueryTargetEnum["Origin"] = 'origin'] = "Origin";
|
|
1490
|
+
QueryTargetEnum[QueryTargetEnum["Cache"] = 'cache'] = "Cache";
|
|
1491
|
+
})(QueryTargetEnum = OrderQueryBatch.QueryTargetEnum || (OrderQueryBatch.QueryTargetEnum = {}));
|
|
1492
|
+
})(OrderQueryBatch = exports.OrderQueryBatch || (exports.OrderQueryBatch = {}));
|
|
1477
1493
|
/**
|
|
1478
1494
|
* @export
|
|
1479
1495
|
* @namespace PointOfSaleReader
|
|
@@ -25649,11 +25665,12 @@ var OrderApiFetchParamCreator = function (configuration) {
|
|
|
25649
25665
|
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
25650
25666
|
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
25651
25667
|
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
25668
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
25652
25669
|
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
25653
25670
|
* @param {*} [options] Override http request option.
|
|
25654
25671
|
* @throws {RequiredError}
|
|
25655
25672
|
*/
|
|
25656
|
-
refundOrder: function (order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, _expand, options) {
|
|
25673
|
+
refundOrder: function (order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, auto_order_cancel_reason, _expand, options) {
|
|
25657
25674
|
if (options === void 0) { options = {}; }
|
|
25658
25675
|
// verify required parameter 'order' is not null or undefined
|
|
25659
25676
|
if (order === null || order === undefined) {
|
|
@@ -25705,6 +25722,9 @@ var OrderApiFetchParamCreator = function (configuration) {
|
|
|
25705
25722
|
if (issue_store_credit !== undefined) {
|
|
25706
25723
|
localVarQueryParameter['issue_store_credit'] = issue_store_credit;
|
|
25707
25724
|
}
|
|
25725
|
+
if (auto_order_cancel_reason !== undefined) {
|
|
25726
|
+
localVarQueryParameter['auto_order_cancel_reason'] = auto_order_cancel_reason;
|
|
25727
|
+
}
|
|
25708
25728
|
if (_expand !== undefined) {
|
|
25709
25729
|
localVarQueryParameter['_expand'] = _expand;
|
|
25710
25730
|
}
|
|
@@ -26525,12 +26545,13 @@ var OrderApiFp = function (configuration) {
|
|
|
26525
26545
|
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
26526
26546
|
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
26527
26547
|
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
26548
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
26528
26549
|
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
26529
26550
|
* @param {*} [options] Override http request option.
|
|
26530
26551
|
* @throws {RequiredError}
|
|
26531
26552
|
*/
|
|
26532
|
-
refundOrder: function (order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, _expand, options) {
|
|
26533
|
-
var localVarFetchArgs = (0, exports.OrderApiFetchParamCreator)(configuration).refundOrder(order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, _expand, options);
|
|
26553
|
+
refundOrder: function (order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, auto_order_cancel_reason, _expand, options) {
|
|
26554
|
+
var localVarFetchArgs = (0, exports.OrderApiFetchParamCreator)(configuration).refundOrder(order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, auto_order_cancel_reason, _expand, options);
|
|
26534
26555
|
return function (fetch, basePath) {
|
|
26535
26556
|
if (fetch === void 0) { fetch = portableFetch; }
|
|
26536
26557
|
if (basePath === void 0) { basePath = BASE_PATH; }
|
|
@@ -26944,12 +26965,13 @@ var OrderApiFactory = function (configuration, fetch, basePath) {
|
|
|
26944
26965
|
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
26945
26966
|
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
26946
26967
|
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
26968
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
26947
26969
|
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
26948
26970
|
* @param {*} [options] Override http request option.
|
|
26949
26971
|
* @throws {RequiredError}
|
|
26950
26972
|
*/
|
|
26951
|
-
refundOrder: function (order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, _expand, options) {
|
|
26952
|
-
return (0, exports.OrderApiFp)(configuration).refundOrder(order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, _expand, options)(fetch, basePath);
|
|
26973
|
+
refundOrder: function (order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, auto_order_cancel_reason, _expand, options) {
|
|
26974
|
+
return (0, exports.OrderApiFp)(configuration).refundOrder(order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, auto_order_cancel_reason, _expand, options)(fetch, basePath);
|
|
26953
26975
|
},
|
|
26954
26976
|
/**
|
|
26955
26977
|
* Create a replacement order based upon a previous order
|
|
@@ -27304,13 +27326,14 @@ var OrderApi = /** @class */ (function (_super) {
|
|
|
27304
27326
|
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
27305
27327
|
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
27306
27328
|
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
27329
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
27307
27330
|
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
27308
27331
|
* @param {*} [options] Override http request option.
|
|
27309
27332
|
* @throws {RequiredError}
|
|
27310
27333
|
* @memberof OrderApi
|
|
27311
27334
|
*/
|
|
27312
|
-
OrderApi.prototype.refundOrder = function (order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, _expand, options) {
|
|
27313
|
-
return (0, exports.OrderApiFp)(this.configuration).refundOrder(order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, _expand, options)(this.fetch, this.basePath);
|
|
27335
|
+
OrderApi.prototype.refundOrder = function (order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, auto_order_cancel_reason, _expand, options) {
|
|
27336
|
+
return (0, exports.OrderApiFp)(this.configuration).refundOrder(order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, auto_order_cancel_reason, _expand, options)(this.fetch, this.basePath);
|
|
27314
27337
|
};
|
|
27315
27338
|
/**
|
|
27316
27339
|
* Create a replacement order based upon a previous order
|