ultracart_rest_api_v2_typescript 3.11.15 → 3.11.16
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 +143 -268
- package/dist/api.d.ts +79 -132
- package/dist/api.js +89 -217
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## ultracart_rest_api_v2_typescript@3.11.
|
|
1
|
+
## ultracart_rest_api_v2_typescript@3.11.16
|
|
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.11.
|
|
39
|
+
npm install ultracart_rest_api_v2_typescript@3.11.16 --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.11.16 | 07/28/2025 | updated doc samples |
|
|
57
58
|
| 3.11.15 | 07/28/2025 | new order methods for blocking and unblocking refunds |
|
|
58
59
|
| 3.11.14 | 07/10/2025 | automation test |
|
|
59
60
|
| 3.11.13 | 05/20/2025 | conversation - virtual agent flag and virtual agent cost |
|
package/api.ts
CHANGED
|
@@ -14969,6 +14969,44 @@ export interface CustomReportTooltip {
|
|
|
14969
14969
|
tooltip?: string;
|
|
14970
14970
|
}
|
|
14971
14971
|
|
|
14972
|
+
/**
|
|
14973
|
+
*
|
|
14974
|
+
* @export
|
|
14975
|
+
* @interface CustomReportsResponse
|
|
14976
|
+
*/
|
|
14977
|
+
export interface CustomReportsResponse {
|
|
14978
|
+
/**
|
|
14979
|
+
*
|
|
14980
|
+
* @type {ModelError}
|
|
14981
|
+
* @memberof CustomReportsResponse
|
|
14982
|
+
*/
|
|
14983
|
+
error?: ModelError;
|
|
14984
|
+
/**
|
|
14985
|
+
*
|
|
14986
|
+
* @type {ResponseMetadata}
|
|
14987
|
+
* @memberof CustomReportsResponse
|
|
14988
|
+
*/
|
|
14989
|
+
metadata?: ResponseMetadata;
|
|
14990
|
+
/**
|
|
14991
|
+
* reports
|
|
14992
|
+
* @type {Array<CustomReport>}
|
|
14993
|
+
* @memberof CustomReportsResponse
|
|
14994
|
+
*/
|
|
14995
|
+
reports?: Array<CustomReport>;
|
|
14996
|
+
/**
|
|
14997
|
+
* Indicates if API call was successful
|
|
14998
|
+
* @type {boolean}
|
|
14999
|
+
* @memberof CustomReportsResponse
|
|
15000
|
+
*/
|
|
15001
|
+
success?: boolean;
|
|
15002
|
+
/**
|
|
15003
|
+
*
|
|
15004
|
+
* @type {Warning}
|
|
15005
|
+
* @memberof CustomReportsResponse
|
|
15006
|
+
*/
|
|
15007
|
+
warning?: Warning;
|
|
15008
|
+
}
|
|
15009
|
+
|
|
14972
15010
|
/**
|
|
14973
15011
|
*
|
|
14974
15012
|
* @export
|
|
@@ -67844,6 +67882,52 @@ export const DatawarehouseApiFetchParamCreator = function (configuration?: Confi
|
|
|
67844
67882
|
|
|
67845
67883
|
|
|
67846
67884
|
|
|
67885
|
+
// authentication ultraCartOauth required
|
|
67886
|
+
// oauth required
|
|
67887
|
+
if (configuration && configuration.accessToken) {
|
|
67888
|
+
const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
67889
|
+
? configuration.accessToken("ultraCartOauth", [])
|
|
67890
|
+
: configuration.accessToken;
|
|
67891
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
67892
|
+
}
|
|
67893
|
+
|
|
67894
|
+
// authentication ultraCartSimpleApiKey required
|
|
67895
|
+
if (configuration && configuration.apiKey) {
|
|
67896
|
+
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
67897
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
67898
|
+
: configuration.apiKey;
|
|
67899
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
67900
|
+
}
|
|
67901
|
+
|
|
67902
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
67903
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
67904
|
+
delete localVarUrlObj.search;
|
|
67905
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
67906
|
+
|
|
67907
|
+
return {
|
|
67908
|
+
url: url.format(localVarUrlObj),
|
|
67909
|
+
options: localVarRequestOptions,
|
|
67910
|
+
};
|
|
67911
|
+
},
|
|
67912
|
+
/**
|
|
67913
|
+
* Retrieve a custom reports
|
|
67914
|
+
* @summary Get custom reports
|
|
67915
|
+
* @param {*} [options] Override http request option.
|
|
67916
|
+
* @throws {RequiredError}
|
|
67917
|
+
*/
|
|
67918
|
+
getCustomReports(options: any = {}): FetchArgs {
|
|
67919
|
+
const localVarPath = `/datawarehouse/custom_reports`;
|
|
67920
|
+
const localVarUrlObj = url.parse(localVarPath, true);
|
|
67921
|
+
const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
|
|
67922
|
+
const localVarHeaderParameter = {} as any;
|
|
67923
|
+
const localVarQueryParameter = {} as any;
|
|
67924
|
+
|
|
67925
|
+
if(configuration && configuration.apiVersion) {
|
|
67926
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
67927
|
+
}
|
|
67928
|
+
|
|
67929
|
+
|
|
67930
|
+
|
|
67847
67931
|
// authentication ultraCartOauth required
|
|
67848
67932
|
// oauth required
|
|
67849
67933
|
if (configuration && configuration.accessToken) {
|
|
@@ -68568,6 +68652,26 @@ export const DatawarehouseApiFp = function(configuration?: Configuration) {
|
|
|
68568
68652
|
});
|
|
68569
68653
|
};
|
|
68570
68654
|
},
|
|
68655
|
+
/**
|
|
68656
|
+
* Retrieve a custom reports
|
|
68657
|
+
* @summary Get custom reports
|
|
68658
|
+
* @param {*} [options] Override http request option.
|
|
68659
|
+
* @throws {RequiredError}
|
|
68660
|
+
*/
|
|
68661
|
+
getCustomReports(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<CustomReportsResponse> {
|
|
68662
|
+
const localVarFetchArgs = DatawarehouseApiFetchParamCreator(configuration).getCustomReports(options);
|
|
68663
|
+
return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
|
|
68664
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
|
|
68665
|
+
|
|
68666
|
+
if (response.status >= 200 && response.status < 300) {
|
|
68667
|
+
return response.json();
|
|
68668
|
+
|
|
68669
|
+
} else {
|
|
68670
|
+
throw response;
|
|
68671
|
+
}
|
|
68672
|
+
});
|
|
68673
|
+
};
|
|
68674
|
+
},
|
|
68571
68675
|
/**
|
|
68572
68676
|
* Retrieve a report
|
|
68573
68677
|
* @summary Get a report
|
|
@@ -68858,6 +68962,15 @@ export const DatawarehouseApiFactory = function (configuration?: Configuration,
|
|
|
68858
68962
|
getCustomReportAccountConfig(options?: any) {
|
|
68859
68963
|
return DatawarehouseApiFp(configuration).getCustomReportAccountConfig(options)(fetch, basePath);
|
|
68860
68964
|
},
|
|
68965
|
+
/**
|
|
68966
|
+
* Retrieve a custom reports
|
|
68967
|
+
* @summary Get custom reports
|
|
68968
|
+
* @param {*} [options] Override http request option.
|
|
68969
|
+
* @throws {RequiredError}
|
|
68970
|
+
*/
|
|
68971
|
+
getCustomReports(options?: any) {
|
|
68972
|
+
return DatawarehouseApiFp(configuration).getCustomReports(options)(fetch, basePath);
|
|
68973
|
+
},
|
|
68861
68974
|
/**
|
|
68862
68975
|
* Retrieve a report
|
|
68863
68976
|
* @summary Get a report
|
|
@@ -69038,6 +69151,15 @@ export interface DatawarehouseApiInterface {
|
|
|
69038
69151
|
*/
|
|
69039
69152
|
getCustomReportAccountConfig(options?: any): Promise<CustomReportAccountConfigResponse>;
|
|
69040
69153
|
|
|
69154
|
+
/**
|
|
69155
|
+
* Retrieve a custom reports
|
|
69156
|
+
* @summary Get custom reports
|
|
69157
|
+
* @param {*} [options] Override http request option.
|
|
69158
|
+
* @throws {RequiredError}
|
|
69159
|
+
* @memberof DatawarehouseApiInterface
|
|
69160
|
+
*/
|
|
69161
|
+
getCustomReports(options?: any): Promise<CustomReportsResponse>;
|
|
69162
|
+
|
|
69041
69163
|
/**
|
|
69042
69164
|
* Retrieve a report
|
|
69043
69165
|
* @summary Get a report
|
|
@@ -69232,6 +69354,17 @@ export class DatawarehouseApi extends BaseAPI implements DatawarehouseApiInterfa
|
|
|
69232
69354
|
return DatawarehouseApiFp(this.configuration).getCustomReportAccountConfig(options)(this.fetch, this.basePath);
|
|
69233
69355
|
}
|
|
69234
69356
|
|
|
69357
|
+
/**
|
|
69358
|
+
* Retrieve a custom reports
|
|
69359
|
+
* @summary Get custom reports
|
|
69360
|
+
* @param {*} [options] Override http request option.
|
|
69361
|
+
* @throws {RequiredError}
|
|
69362
|
+
* @memberof DatawarehouseApi
|
|
69363
|
+
*/
|
|
69364
|
+
public getCustomReports(options?: any) {
|
|
69365
|
+
return DatawarehouseApiFp(this.configuration).getCustomReports(options)(this.fetch, this.basePath);
|
|
69366
|
+
}
|
|
69367
|
+
|
|
69235
69368
|
/**
|
|
69236
69369
|
* Retrieve a report
|
|
69237
69370
|
* @summary Get a report
|
|
@@ -74906,7 +75039,7 @@ export const OrderApiFetchParamCreator = function (configuration?: Configuration
|
|
|
74906
75039
|
const localVarPath = `/order/orders/{order_id}/refund_block`
|
|
74907
75040
|
.replace(`{${"order_id"}}`, encodeURIComponent(String(order_id)));
|
|
74908
75041
|
const localVarUrlObj = url.parse(localVarPath, true);
|
|
74909
|
-
const localVarRequestOptions = Object.assign({ method: '
|
|
75042
|
+
const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
|
|
74910
75043
|
const localVarHeaderParameter = {} as any;
|
|
74911
75044
|
const localVarQueryParameter = {} as any;
|
|
74912
75045
|
|
|
@@ -76274,103 +76407,6 @@ export const OrderApiFetchParamCreator = function (configuration?: Configuration
|
|
|
76274
76407
|
options: localVarRequestOptions,
|
|
76275
76408
|
};
|
|
76276
76409
|
},
|
|
76277
|
-
/**
|
|
76278
|
-
* Perform a refund operation on an order and then update the order if successful.
|
|
76279
|
-
* @summary Refund an order completely
|
|
76280
|
-
* @param {string} order_id The order id to refund.
|
|
76281
|
-
* @param {boolean} [reject_after_refund] Reject order after refund
|
|
76282
|
-
* @param {boolean} [skip_customer_notification] Skip customer email notification
|
|
76283
|
-
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
76284
|
-
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
76285
|
-
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
76286
|
-
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
76287
|
-
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
76288
|
-
* @param {string} [refund_reason] Reason for refund
|
|
76289
|
-
* @param {string} [reject_reason] Reason for reject
|
|
76290
|
-
* @param {*} [options] Override http request option.
|
|
76291
|
-
* @throws {RequiredError}
|
|
76292
|
-
*/
|
|
76293
|
-
refundOrderCompletely(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, refund_reason?: string, reject_reason?: string, options: any = {}): FetchArgs {
|
|
76294
|
-
// verify required parameter 'order_id' is not null or undefined
|
|
76295
|
-
if (order_id === null || order_id === undefined) {
|
|
76296
|
-
throw new RequiredError('order_id','Required parameter order_id was null or undefined when calling refundOrderCompletely.');
|
|
76297
|
-
}
|
|
76298
|
-
const localVarPath = `/order/orders/{order_id}/refund_completely`
|
|
76299
|
-
.replace(`{${"order_id"}}`, encodeURIComponent(String(order_id)));
|
|
76300
|
-
const localVarUrlObj = url.parse(localVarPath, true);
|
|
76301
|
-
const localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
|
|
76302
|
-
const localVarHeaderParameter = {} as any;
|
|
76303
|
-
const localVarQueryParameter = {} as any;
|
|
76304
|
-
|
|
76305
|
-
if(configuration && configuration.apiVersion) {
|
|
76306
|
-
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
76307
|
-
}
|
|
76308
|
-
|
|
76309
|
-
|
|
76310
|
-
|
|
76311
|
-
// authentication ultraCartOauth required
|
|
76312
|
-
// oauth required
|
|
76313
|
-
if (configuration && configuration.accessToken) {
|
|
76314
|
-
const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
76315
|
-
? configuration.accessToken("ultraCartOauth", ["order_write"])
|
|
76316
|
-
: configuration.accessToken;
|
|
76317
|
-
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
76318
|
-
}
|
|
76319
|
-
|
|
76320
|
-
// authentication ultraCartSimpleApiKey required
|
|
76321
|
-
if (configuration && configuration.apiKey) {
|
|
76322
|
-
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
76323
|
-
? configuration.apiKey("x-ultracart-simple-key")
|
|
76324
|
-
: configuration.apiKey;
|
|
76325
|
-
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
76326
|
-
}
|
|
76327
|
-
|
|
76328
|
-
if (reject_after_refund !== undefined) {
|
|
76329
|
-
localVarQueryParameter['reject_after_refund'] = reject_after_refund;
|
|
76330
|
-
}
|
|
76331
|
-
|
|
76332
|
-
if (skip_customer_notification !== undefined) {
|
|
76333
|
-
localVarQueryParameter['skip_customer_notification'] = skip_customer_notification;
|
|
76334
|
-
}
|
|
76335
|
-
|
|
76336
|
-
if (auto_order_cancel !== undefined) {
|
|
76337
|
-
localVarQueryParameter['auto_order_cancel'] = auto_order_cancel;
|
|
76338
|
-
}
|
|
76339
|
-
|
|
76340
|
-
if (manual_refund !== undefined) {
|
|
76341
|
-
localVarQueryParameter['manual_refund'] = manual_refund;
|
|
76342
|
-
}
|
|
76343
|
-
|
|
76344
|
-
if (reverse_affiliate_transactions !== undefined) {
|
|
76345
|
-
localVarQueryParameter['reverse_affiliate_transactions'] = reverse_affiliate_transactions;
|
|
76346
|
-
}
|
|
76347
|
-
|
|
76348
|
-
if (issue_store_credit !== undefined) {
|
|
76349
|
-
localVarQueryParameter['issue_store_credit'] = issue_store_credit;
|
|
76350
|
-
}
|
|
76351
|
-
|
|
76352
|
-
if (auto_order_cancel_reason !== undefined) {
|
|
76353
|
-
localVarQueryParameter['auto_order_cancel_reason'] = auto_order_cancel_reason;
|
|
76354
|
-
}
|
|
76355
|
-
|
|
76356
|
-
if (refund_reason !== undefined) {
|
|
76357
|
-
localVarQueryParameter['refund_reason'] = refund_reason;
|
|
76358
|
-
}
|
|
76359
|
-
|
|
76360
|
-
if (reject_reason !== undefined) {
|
|
76361
|
-
localVarQueryParameter['reject_reason'] = reject_reason;
|
|
76362
|
-
}
|
|
76363
|
-
|
|
76364
|
-
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
76365
|
-
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
76366
|
-
delete localVarUrlObj.search;
|
|
76367
|
-
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
76368
|
-
|
|
76369
|
-
return {
|
|
76370
|
-
url: url.format(localVarUrlObj),
|
|
76371
|
-
options: localVarRequestOptions,
|
|
76372
|
-
};
|
|
76373
|
-
},
|
|
76374
76410
|
/**
|
|
76375
76411
|
* Create a replacement order based upon a previous order
|
|
76376
76412
|
* @summary Replacement order
|
|
@@ -76551,7 +76587,7 @@ export const OrderApiFetchParamCreator = function (configuration?: Configuration
|
|
|
76551
76587
|
const localVarPath = `/order/orders/{order_id}/refund_unblock`
|
|
76552
76588
|
.replace(`{${"order_id"}}`, encodeURIComponent(String(order_id)));
|
|
76553
76589
|
const localVarUrlObj = url.parse(localVarPath, true);
|
|
76554
|
-
const localVarRequestOptions = Object.assign({ method: '
|
|
76590
|
+
const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
|
|
76555
76591
|
const localVarHeaderParameter = {} as any;
|
|
76556
76592
|
const localVarQueryParameter = {} as any;
|
|
76557
76593
|
|
|
@@ -77290,36 +77326,6 @@ export const OrderApiFp = function(configuration?: Configuration) {
|
|
|
77290
77326
|
});
|
|
77291
77327
|
};
|
|
77292
77328
|
},
|
|
77293
|
-
/**
|
|
77294
|
-
* Perform a refund operation on an order and then update the order if successful.
|
|
77295
|
-
* @summary Refund an order completely
|
|
77296
|
-
* @param {string} order_id The order id to refund.
|
|
77297
|
-
* @param {boolean} [reject_after_refund] Reject order after refund
|
|
77298
|
-
* @param {boolean} [skip_customer_notification] Skip customer email notification
|
|
77299
|
-
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
77300
|
-
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
77301
|
-
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
77302
|
-
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
77303
|
-
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
77304
|
-
* @param {string} [refund_reason] Reason for refund
|
|
77305
|
-
* @param {string} [reject_reason] Reason for reject
|
|
77306
|
-
* @param {*} [options] Override http request option.
|
|
77307
|
-
* @throws {RequiredError}
|
|
77308
|
-
*/
|
|
77309
|
-
refundOrderCompletely(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, refund_reason?: string, reject_reason?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrderResponse> {
|
|
77310
|
-
const localVarFetchArgs = OrderApiFetchParamCreator(configuration).refundOrderCompletely(order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, auto_order_cancel_reason, refund_reason, reject_reason, options);
|
|
77311
|
-
return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
|
|
77312
|
-
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
|
|
77313
|
-
|
|
77314
|
-
if (response.status >= 200 && response.status < 300) {
|
|
77315
|
-
return response.json();
|
|
77316
|
-
|
|
77317
|
-
} else {
|
|
77318
|
-
throw response;
|
|
77319
|
-
}
|
|
77320
|
-
});
|
|
77321
|
-
};
|
|
77322
|
-
},
|
|
77323
77329
|
/**
|
|
77324
77330
|
* Create a replacement order based upon a previous order
|
|
77325
77331
|
* @summary Replacement order
|
|
@@ -77754,25 +77760,6 @@ export const OrderApiFactory = function (configuration?: Configuration, fetch?:
|
|
|
77754
77760
|
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) {
|
|
77755
77761
|
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);
|
|
77756
77762
|
},
|
|
77757
|
-
/**
|
|
77758
|
-
* Perform a refund operation on an order and then update the order if successful.
|
|
77759
|
-
* @summary Refund an order completely
|
|
77760
|
-
* @param {string} order_id The order id to refund.
|
|
77761
|
-
* @param {boolean} [reject_after_refund] Reject order after refund
|
|
77762
|
-
* @param {boolean} [skip_customer_notification] Skip customer email notification
|
|
77763
|
-
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
77764
|
-
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
77765
|
-
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
77766
|
-
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
77767
|
-
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
77768
|
-
* @param {string} [refund_reason] Reason for refund
|
|
77769
|
-
* @param {string} [reject_reason] Reason for reject
|
|
77770
|
-
* @param {*} [options] Override http request option.
|
|
77771
|
-
* @throws {RequiredError}
|
|
77772
|
-
*/
|
|
77773
|
-
refundOrderCompletely(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, refund_reason?: string, reject_reason?: string, options?: any) {
|
|
77774
|
-
return OrderApiFp(configuration).refundOrderCompletely(order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, auto_order_cancel_reason, refund_reason, reject_reason, options)(fetch, basePath);
|
|
77775
|
-
},
|
|
77776
77763
|
/**
|
|
77777
77764
|
* Create a replacement order based upon a previous order
|
|
77778
77765
|
* @summary Replacement order
|
|
@@ -78130,25 +78117,6 @@ export interface OrderApiInterface {
|
|
|
78130
78117
|
*/
|
|
78131
78118
|
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>;
|
|
78132
78119
|
|
|
78133
|
-
/**
|
|
78134
|
-
* Perform a refund operation on an order and then update the order if successful.
|
|
78135
|
-
* @summary Refund an order completely
|
|
78136
|
-
* @param {string} order_id The order id to refund.
|
|
78137
|
-
* @param {boolean} [reject_after_refund] Reject order after refund
|
|
78138
|
-
* @param {boolean} [skip_customer_notification] Skip customer email notification
|
|
78139
|
-
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
78140
|
-
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
78141
|
-
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
78142
|
-
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
78143
|
-
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
78144
|
-
* @param {string} [refund_reason] Reason for refund
|
|
78145
|
-
* @param {string} [reject_reason] Reason for reject
|
|
78146
|
-
* @param {*} [options] Override http request option.
|
|
78147
|
-
* @throws {RequiredError}
|
|
78148
|
-
* @memberof OrderApiInterface
|
|
78149
|
-
*/
|
|
78150
|
-
refundOrderCompletely(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, refund_reason?: string, reject_reason?: string, options?: any): Promise<OrderResponse>;
|
|
78151
|
-
|
|
78152
78120
|
/**
|
|
78153
78121
|
* Create a replacement order based upon a previous order
|
|
78154
78122
|
* @summary Replacement order
|
|
@@ -78550,27 +78518,6 @@ export class OrderApi extends BaseAPI implements OrderApiInterface {
|
|
|
78550
78518
|
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);
|
|
78551
78519
|
}
|
|
78552
78520
|
|
|
78553
|
-
/**
|
|
78554
|
-
* Perform a refund operation on an order and then update the order if successful.
|
|
78555
|
-
* @summary Refund an order completely
|
|
78556
|
-
* @param {string} order_id The order id to refund.
|
|
78557
|
-
* @param {boolean} [reject_after_refund] Reject order after refund
|
|
78558
|
-
* @param {boolean} [skip_customer_notification] Skip customer email notification
|
|
78559
|
-
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
78560
|
-
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
78561
|
-
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
78562
|
-
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
78563
|
-
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
78564
|
-
* @param {string} [refund_reason] Reason for refund
|
|
78565
|
-
* @param {string} [reject_reason] Reason for reject
|
|
78566
|
-
* @param {*} [options] Override http request option.
|
|
78567
|
-
* @throws {RequiredError}
|
|
78568
|
-
* @memberof OrderApi
|
|
78569
|
-
*/
|
|
78570
|
-
public refundOrderCompletely(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, refund_reason?: string, reject_reason?: string, options?: any) {
|
|
78571
|
-
return OrderApiFp(this.configuration).refundOrderCompletely(order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, auto_order_cancel_reason, refund_reason, reject_reason, options)(this.fetch, this.basePath);
|
|
78572
|
-
}
|
|
78573
|
-
|
|
78574
78521
|
/**
|
|
78575
78522
|
* Create a replacement order based upon a previous order
|
|
78576
78523
|
* @summary Replacement order
|
|
@@ -105803,21 +105750,13 @@ export const WebhookApiFetchParamCreator = function (configuration?: Configurati
|
|
|
105803
105750
|
* Retrieves the log summary information for a given webhook. This is useful for displaying all the various logs that can be viewed.
|
|
105804
105751
|
* @summary Retrieve the log summaries
|
|
105805
105752
|
* @param {number} webhookOid The webhook oid to retrieve log summaries for.
|
|
105806
|
-
* @param {string} [requestId]
|
|
105807
|
-
* @param {string} [beginDate]
|
|
105808
|
-
* @param {string} [endDate]
|
|
105809
|
-
* @param {string} [status]
|
|
105810
|
-
* @param {string} [event]
|
|
105811
|
-
* @param {string} [orderId]
|
|
105812
|
-
* @param {string} [request]
|
|
105813
|
-
* @param {number} [duration]
|
|
105814
105753
|
* @param {number} [_limit] The maximum number of records to return on this one API call.
|
|
105815
105754
|
* @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
|
|
105816
105755
|
* @param {string} [_since] Fetch log summaries that have been delivered since this date/time.
|
|
105817
105756
|
* @param {*} [options] Override http request option.
|
|
105818
105757
|
* @throws {RequiredError}
|
|
105819
105758
|
*/
|
|
105820
|
-
getWebhookLogSummaries(webhookOid: number,
|
|
105759
|
+
getWebhookLogSummaries(webhookOid: number, _limit?: number, _offset?: number, _since?: string, options: any = {}): FetchArgs {
|
|
105821
105760
|
// verify required parameter 'webhookOid' is not null or undefined
|
|
105822
105761
|
if (webhookOid === null || webhookOid === undefined) {
|
|
105823
105762
|
throw new RequiredError('webhookOid','Required parameter webhookOid was null or undefined when calling getWebhookLogSummaries.');
|
|
@@ -105852,38 +105791,6 @@ export const WebhookApiFetchParamCreator = function (configuration?: Configurati
|
|
|
105852
105791
|
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
105853
105792
|
}
|
|
105854
105793
|
|
|
105855
|
-
if (requestId !== undefined) {
|
|
105856
|
-
localVarQueryParameter['requestId'] = requestId;
|
|
105857
|
-
}
|
|
105858
|
-
|
|
105859
|
-
if (beginDate !== undefined) {
|
|
105860
|
-
localVarQueryParameter['beginDate'] = beginDate;
|
|
105861
|
-
}
|
|
105862
|
-
|
|
105863
|
-
if (endDate !== undefined) {
|
|
105864
|
-
localVarQueryParameter['endDate'] = endDate;
|
|
105865
|
-
}
|
|
105866
|
-
|
|
105867
|
-
if (status !== undefined) {
|
|
105868
|
-
localVarQueryParameter['status'] = status;
|
|
105869
|
-
}
|
|
105870
|
-
|
|
105871
|
-
if (event !== undefined) {
|
|
105872
|
-
localVarQueryParameter['event'] = event;
|
|
105873
|
-
}
|
|
105874
|
-
|
|
105875
|
-
if (orderId !== undefined) {
|
|
105876
|
-
localVarQueryParameter['orderId'] = orderId;
|
|
105877
|
-
}
|
|
105878
|
-
|
|
105879
|
-
if (request !== undefined) {
|
|
105880
|
-
localVarQueryParameter['request'] = request;
|
|
105881
|
-
}
|
|
105882
|
-
|
|
105883
|
-
if (duration !== undefined) {
|
|
105884
|
-
localVarQueryParameter['duration'] = duration;
|
|
105885
|
-
}
|
|
105886
|
-
|
|
105887
105794
|
if (_limit !== undefined) {
|
|
105888
105795
|
localVarQueryParameter['_limit'] = _limit;
|
|
105889
105796
|
}
|
|
@@ -106233,22 +106140,14 @@ export const WebhookApiFp = function(configuration?: Configuration) {
|
|
|
106233
106140
|
* Retrieves the log summary information for a given webhook. This is useful for displaying all the various logs that can be viewed.
|
|
106234
106141
|
* @summary Retrieve the log summaries
|
|
106235
106142
|
* @param {number} webhookOid The webhook oid to retrieve log summaries for.
|
|
106236
|
-
* @param {string} [requestId]
|
|
106237
|
-
* @param {string} [beginDate]
|
|
106238
|
-
* @param {string} [endDate]
|
|
106239
|
-
* @param {string} [status]
|
|
106240
|
-
* @param {string} [event]
|
|
106241
|
-
* @param {string} [orderId]
|
|
106242
|
-
* @param {string} [request]
|
|
106243
|
-
* @param {number} [duration]
|
|
106244
106143
|
* @param {number} [_limit] The maximum number of records to return on this one API call.
|
|
106245
106144
|
* @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
|
|
106246
106145
|
* @param {string} [_since] Fetch log summaries that have been delivered since this date/time.
|
|
106247
106146
|
* @param {*} [options] Override http request option.
|
|
106248
106147
|
* @throws {RequiredError}
|
|
106249
106148
|
*/
|
|
106250
|
-
getWebhookLogSummaries(webhookOid: number,
|
|
106251
|
-
const localVarFetchArgs = WebhookApiFetchParamCreator(configuration).getWebhookLogSummaries(webhookOid,
|
|
106149
|
+
getWebhookLogSummaries(webhookOid: number, _limit?: number, _offset?: number, _since?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<WebhookLogSummariesResponse> {
|
|
106150
|
+
const localVarFetchArgs = WebhookApiFetchParamCreator(configuration).getWebhookLogSummaries(webhookOid, _limit, _offset, _since, options);
|
|
106252
106151
|
return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
|
|
106253
106152
|
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
|
|
106254
106153
|
|
|
@@ -106396,22 +106295,14 @@ export const WebhookApiFactory = function (configuration?: Configuration, fetch?
|
|
|
106396
106295
|
* Retrieves the log summary information for a given webhook. This is useful for displaying all the various logs that can be viewed.
|
|
106397
106296
|
* @summary Retrieve the log summaries
|
|
106398
106297
|
* @param {number} webhookOid The webhook oid to retrieve log summaries for.
|
|
106399
|
-
* @param {string} [requestId]
|
|
106400
|
-
* @param {string} [beginDate]
|
|
106401
|
-
* @param {string} [endDate]
|
|
106402
|
-
* @param {string} [status]
|
|
106403
|
-
* @param {string} [event]
|
|
106404
|
-
* @param {string} [orderId]
|
|
106405
|
-
* @param {string} [request]
|
|
106406
|
-
* @param {number} [duration]
|
|
106407
106298
|
* @param {number} [_limit] The maximum number of records to return on this one API call.
|
|
106408
106299
|
* @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
|
|
106409
106300
|
* @param {string} [_since] Fetch log summaries that have been delivered since this date/time.
|
|
106410
106301
|
* @param {*} [options] Override http request option.
|
|
106411
106302
|
* @throws {RequiredError}
|
|
106412
106303
|
*/
|
|
106413
|
-
getWebhookLogSummaries(webhookOid: number,
|
|
106414
|
-
return WebhookApiFp(configuration).getWebhookLogSummaries(webhookOid,
|
|
106304
|
+
getWebhookLogSummaries(webhookOid: number, _limit?: number, _offset?: number, _since?: string, options?: any) {
|
|
106305
|
+
return WebhookApiFp(configuration).getWebhookLogSummaries(webhookOid, _limit, _offset, _since, options)(fetch, basePath);
|
|
106415
106306
|
},
|
|
106416
106307
|
/**
|
|
106417
106308
|
* Retrieves the webhooks associated with this application.
|
|
@@ -106504,14 +106395,6 @@ export interface WebhookApiInterface {
|
|
|
106504
106395
|
* Retrieves the log summary information for a given webhook. This is useful for displaying all the various logs that can be viewed.
|
|
106505
106396
|
* @summary Retrieve the log summaries
|
|
106506
106397
|
* @param {number} webhookOid The webhook oid to retrieve log summaries for.
|
|
106507
|
-
* @param {string} [requestId]
|
|
106508
|
-
* @param {string} [beginDate]
|
|
106509
|
-
* @param {string} [endDate]
|
|
106510
|
-
* @param {string} [status]
|
|
106511
|
-
* @param {string} [event]
|
|
106512
|
-
* @param {string} [orderId]
|
|
106513
|
-
* @param {string} [request]
|
|
106514
|
-
* @param {number} [duration]
|
|
106515
106398
|
* @param {number} [_limit] The maximum number of records to return on this one API call.
|
|
106516
106399
|
* @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
|
|
106517
106400
|
* @param {string} [_since] Fetch log summaries that have been delivered since this date/time.
|
|
@@ -106519,7 +106402,7 @@ export interface WebhookApiInterface {
|
|
|
106519
106402
|
* @throws {RequiredError}
|
|
106520
106403
|
* @memberof WebhookApiInterface
|
|
106521
106404
|
*/
|
|
106522
|
-
getWebhookLogSummaries(webhookOid: number,
|
|
106405
|
+
getWebhookLogSummaries(webhookOid: number, _limit?: number, _offset?: number, _since?: string, options?: any): Promise<WebhookLogSummariesResponse>;
|
|
106523
106406
|
|
|
106524
106407
|
/**
|
|
106525
106408
|
* Retrieves the webhooks associated with this application.
|
|
@@ -106618,14 +106501,6 @@ export class WebhookApi extends BaseAPI implements WebhookApiInterface {
|
|
|
106618
106501
|
* Retrieves the log summary information for a given webhook. This is useful for displaying all the various logs that can be viewed.
|
|
106619
106502
|
* @summary Retrieve the log summaries
|
|
106620
106503
|
* @param {number} webhookOid The webhook oid to retrieve log summaries for.
|
|
106621
|
-
* @param {string} [requestId]
|
|
106622
|
-
* @param {string} [beginDate]
|
|
106623
|
-
* @param {string} [endDate]
|
|
106624
|
-
* @param {string} [status]
|
|
106625
|
-
* @param {string} [event]
|
|
106626
|
-
* @param {string} [orderId]
|
|
106627
|
-
* @param {string} [request]
|
|
106628
|
-
* @param {number} [duration]
|
|
106629
106504
|
* @param {number} [_limit] The maximum number of records to return on this one API call.
|
|
106630
106505
|
* @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
|
|
106631
106506
|
* @param {string} [_since] Fetch log summaries that have been delivered since this date/time.
|
|
@@ -106633,8 +106508,8 @@ export class WebhookApi extends BaseAPI implements WebhookApiInterface {
|
|
|
106633
106508
|
* @throws {RequiredError}
|
|
106634
106509
|
* @memberof WebhookApi
|
|
106635
106510
|
*/
|
|
106636
|
-
public getWebhookLogSummaries(webhookOid: number,
|
|
106637
|
-
return WebhookApiFp(this.configuration).getWebhookLogSummaries(webhookOid,
|
|
106511
|
+
public getWebhookLogSummaries(webhookOid: number, _limit?: number, _offset?: number, _since?: string, options?: any) {
|
|
106512
|
+
return WebhookApiFp(this.configuration).getWebhookLogSummaries(webhookOid, _limit, _offset, _since, options)(this.fetch, this.basePath);
|
|
106638
106513
|
}
|
|
106639
106514
|
|
|
106640
106515
|
/**
|