ultracart_rest_api_v2_typescript 3.11.5 → 3.11.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -2
- package/api.ts +248 -0
- package/dist/api.d.ts +148 -0
- package/dist/api.js +152 -0
- 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.7
|
|
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.7 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
|
|
|
54
54
|
|
|
55
55
|
| Version | Date | Comments |
|
|
56
56
|
| --: | :-: | --- |
|
|
57
|
+
| 3.11.7 | 04/21/2025 | conversation agent additional fields |
|
|
58
|
+
| 3.11.6 | 04/16/2025 | added channel partner order item properties |
|
|
57
59
|
| 3.11.5 | 03/28/2025 | added paypal fastlane constants for payments |
|
|
58
60
|
| 3.11.4 | 03/07/2025 | updated github readme.md |
|
|
59
61
|
| 3.11.3 | 03/07/2025 | updated github readme.md files |
|
package/api.ts
CHANGED
|
@@ -6208,6 +6208,12 @@ export interface ChannelPartnerOrderItem {
|
|
|
6208
6208
|
* @memberof ChannelPartnerOrderItem
|
|
6209
6209
|
*/
|
|
6210
6210
|
options?: Array<ChannelPartnerOrderItemOption>;
|
|
6211
|
+
/**
|
|
6212
|
+
* Properties
|
|
6213
|
+
* @type {Array<ChannelPartnerOrderItemProperty>}
|
|
6214
|
+
* @memberof ChannelPartnerOrderItem
|
|
6215
|
+
*/
|
|
6216
|
+
properties?: Array<ChannelPartnerOrderItemProperty>;
|
|
6211
6217
|
/**
|
|
6212
6218
|
* Quantity
|
|
6213
6219
|
* @type {number}
|
|
@@ -6271,6 +6277,38 @@ export interface ChannelPartnerOrderItemOption {
|
|
|
6271
6277
|
value?: string;
|
|
6272
6278
|
}
|
|
6273
6279
|
|
|
6280
|
+
/**
|
|
6281
|
+
*
|
|
6282
|
+
* @export
|
|
6283
|
+
* @interface ChannelPartnerOrderItemProperty
|
|
6284
|
+
*/
|
|
6285
|
+
export interface ChannelPartnerOrderItemProperty {
|
|
6286
|
+
/**
|
|
6287
|
+
* True if this property is displayed to the customer
|
|
6288
|
+
* @type {boolean}
|
|
6289
|
+
* @memberof ChannelPartnerOrderItemProperty
|
|
6290
|
+
*/
|
|
6291
|
+
display?: boolean;
|
|
6292
|
+
/**
|
|
6293
|
+
* The date/time that the property expires and is deleted
|
|
6294
|
+
* @type {string}
|
|
6295
|
+
* @memberof ChannelPartnerOrderItemProperty
|
|
6296
|
+
*/
|
|
6297
|
+
expiration_dts?: string;
|
|
6298
|
+
/**
|
|
6299
|
+
* Name
|
|
6300
|
+
* @type {string}
|
|
6301
|
+
* @memberof ChannelPartnerOrderItemProperty
|
|
6302
|
+
*/
|
|
6303
|
+
name?: string;
|
|
6304
|
+
/**
|
|
6305
|
+
* Value
|
|
6306
|
+
* @type {string}
|
|
6307
|
+
* @memberof ChannelPartnerOrderItemProperty
|
|
6308
|
+
*/
|
|
6309
|
+
value?: string;
|
|
6310
|
+
}
|
|
6311
|
+
|
|
6274
6312
|
/**
|
|
6275
6313
|
*
|
|
6276
6314
|
* @export
|
|
@@ -7191,6 +7229,30 @@ export interface ConversationAgentAuthResponse {
|
|
|
7191
7229
|
* @interface ConversationAgentProfile
|
|
7192
7230
|
*/
|
|
7193
7231
|
export interface ConversationAgentProfile {
|
|
7232
|
+
/**
|
|
7233
|
+
* AI powered chat bot
|
|
7234
|
+
* @type {boolean}
|
|
7235
|
+
* @memberof ConversationAgentProfile
|
|
7236
|
+
*/
|
|
7237
|
+
ai?: boolean;
|
|
7238
|
+
/**
|
|
7239
|
+
* Additional instructions for this AI when handle web chats
|
|
7240
|
+
* @type {string}
|
|
7241
|
+
* @memberof ConversationAgentProfile
|
|
7242
|
+
*/
|
|
7243
|
+
ai_chat_instructions?: string;
|
|
7244
|
+
/**
|
|
7245
|
+
* Persona of this AI agent
|
|
7246
|
+
* @type {string}
|
|
7247
|
+
* @memberof ConversationAgentProfile
|
|
7248
|
+
*/
|
|
7249
|
+
ai_persona?: string;
|
|
7250
|
+
/**
|
|
7251
|
+
* Additional instructions for this AI when handle SMS messages
|
|
7252
|
+
* @type {string}
|
|
7253
|
+
* @memberof ConversationAgentProfile
|
|
7254
|
+
*/
|
|
7255
|
+
ai_sms_instructions?: string;
|
|
7194
7256
|
/**
|
|
7195
7257
|
* The number of engagement chats that can be pushed on them at any given time.
|
|
7196
7258
|
* @type {number}
|
|
@@ -74059,6 +74121,103 @@ export const OrderApiFetchParamCreator = function (configuration?: Configuration
|
|
|
74059
74121
|
options: localVarRequestOptions,
|
|
74060
74122
|
};
|
|
74061
74123
|
},
|
|
74124
|
+
/**
|
|
74125
|
+
* Perform a refund operation on an order and then update the order if successful.
|
|
74126
|
+
* @summary Refund an order completely
|
|
74127
|
+
* @param {string} order_id The order id to refund.
|
|
74128
|
+
* @param {boolean} [reject_after_refund] Reject order after refund
|
|
74129
|
+
* @param {boolean} [skip_customer_notification] Skip customer email notification
|
|
74130
|
+
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
74131
|
+
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
74132
|
+
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
74133
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
74134
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
74135
|
+
* @param {string} [refund_reason] Reason for refund
|
|
74136
|
+
* @param {string} [reject_reason] Reason for reject
|
|
74137
|
+
* @param {*} [options] Override http request option.
|
|
74138
|
+
* @throws {RequiredError}
|
|
74139
|
+
*/
|
|
74140
|
+
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 {
|
|
74141
|
+
// verify required parameter 'order_id' is not null or undefined
|
|
74142
|
+
if (order_id === null || order_id === undefined) {
|
|
74143
|
+
throw new RequiredError('order_id','Required parameter order_id was null or undefined when calling refundOrderCompletely.');
|
|
74144
|
+
}
|
|
74145
|
+
const localVarPath = `/order/orders/{order_id}/refund_completely`
|
|
74146
|
+
.replace(`{${"order_id"}}`, encodeURIComponent(String(order_id)));
|
|
74147
|
+
const localVarUrlObj = url.parse(localVarPath, true);
|
|
74148
|
+
const localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
|
|
74149
|
+
const localVarHeaderParameter = {} as any;
|
|
74150
|
+
const localVarQueryParameter = {} as any;
|
|
74151
|
+
|
|
74152
|
+
if(configuration && configuration.apiVersion) {
|
|
74153
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
74154
|
+
}
|
|
74155
|
+
|
|
74156
|
+
|
|
74157
|
+
|
|
74158
|
+
// authentication ultraCartOauth required
|
|
74159
|
+
// oauth required
|
|
74160
|
+
if (configuration && configuration.accessToken) {
|
|
74161
|
+
const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
74162
|
+
? configuration.accessToken("ultraCartOauth", ["order_write"])
|
|
74163
|
+
: configuration.accessToken;
|
|
74164
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
74165
|
+
}
|
|
74166
|
+
|
|
74167
|
+
// authentication ultraCartSimpleApiKey required
|
|
74168
|
+
if (configuration && configuration.apiKey) {
|
|
74169
|
+
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
74170
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
74171
|
+
: configuration.apiKey;
|
|
74172
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
74173
|
+
}
|
|
74174
|
+
|
|
74175
|
+
if (reject_after_refund !== undefined) {
|
|
74176
|
+
localVarQueryParameter['reject_after_refund'] = reject_after_refund;
|
|
74177
|
+
}
|
|
74178
|
+
|
|
74179
|
+
if (skip_customer_notification !== undefined) {
|
|
74180
|
+
localVarQueryParameter['skip_customer_notification'] = skip_customer_notification;
|
|
74181
|
+
}
|
|
74182
|
+
|
|
74183
|
+
if (auto_order_cancel !== undefined) {
|
|
74184
|
+
localVarQueryParameter['auto_order_cancel'] = auto_order_cancel;
|
|
74185
|
+
}
|
|
74186
|
+
|
|
74187
|
+
if (manual_refund !== undefined) {
|
|
74188
|
+
localVarQueryParameter['manual_refund'] = manual_refund;
|
|
74189
|
+
}
|
|
74190
|
+
|
|
74191
|
+
if (reverse_affiliate_transactions !== undefined) {
|
|
74192
|
+
localVarQueryParameter['reverse_affiliate_transactions'] = reverse_affiliate_transactions;
|
|
74193
|
+
}
|
|
74194
|
+
|
|
74195
|
+
if (issue_store_credit !== undefined) {
|
|
74196
|
+
localVarQueryParameter['issue_store_credit'] = issue_store_credit;
|
|
74197
|
+
}
|
|
74198
|
+
|
|
74199
|
+
if (auto_order_cancel_reason !== undefined) {
|
|
74200
|
+
localVarQueryParameter['auto_order_cancel_reason'] = auto_order_cancel_reason;
|
|
74201
|
+
}
|
|
74202
|
+
|
|
74203
|
+
if (refund_reason !== undefined) {
|
|
74204
|
+
localVarQueryParameter['refund_reason'] = refund_reason;
|
|
74205
|
+
}
|
|
74206
|
+
|
|
74207
|
+
if (reject_reason !== undefined) {
|
|
74208
|
+
localVarQueryParameter['reject_reason'] = reject_reason;
|
|
74209
|
+
}
|
|
74210
|
+
|
|
74211
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
74212
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
74213
|
+
delete localVarUrlObj.search;
|
|
74214
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
74215
|
+
|
|
74216
|
+
return {
|
|
74217
|
+
url: url.format(localVarUrlObj),
|
|
74218
|
+
options: localVarRequestOptions,
|
|
74219
|
+
};
|
|
74220
|
+
},
|
|
74062
74221
|
/**
|
|
74063
74222
|
* Create a replacement order based upon a previous order
|
|
74064
74223
|
* @summary Replacement order
|
|
@@ -74904,6 +75063,36 @@ export const OrderApiFp = function(configuration?: Configuration) {
|
|
|
74904
75063
|
});
|
|
74905
75064
|
};
|
|
74906
75065
|
},
|
|
75066
|
+
/**
|
|
75067
|
+
* Perform a refund operation on an order and then update the order if successful.
|
|
75068
|
+
* @summary Refund an order completely
|
|
75069
|
+
* @param {string} order_id The order id to refund.
|
|
75070
|
+
* @param {boolean} [reject_after_refund] Reject order after refund
|
|
75071
|
+
* @param {boolean} [skip_customer_notification] Skip customer email notification
|
|
75072
|
+
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
75073
|
+
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
75074
|
+
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
75075
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
75076
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
75077
|
+
* @param {string} [refund_reason] Reason for refund
|
|
75078
|
+
* @param {string} [reject_reason] Reason for reject
|
|
75079
|
+
* @param {*} [options] Override http request option.
|
|
75080
|
+
* @throws {RequiredError}
|
|
75081
|
+
*/
|
|
75082
|
+
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> {
|
|
75083
|
+
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);
|
|
75084
|
+
return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
|
|
75085
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
|
|
75086
|
+
|
|
75087
|
+
if (response.status >= 200 && response.status < 300) {
|
|
75088
|
+
return response.json();
|
|
75089
|
+
|
|
75090
|
+
} else {
|
|
75091
|
+
throw response;
|
|
75092
|
+
}
|
|
75093
|
+
});
|
|
75094
|
+
};
|
|
75095
|
+
},
|
|
74907
75096
|
/**
|
|
74908
75097
|
* Create a replacement order based upon a previous order
|
|
74909
75098
|
* @summary Replacement order
|
|
@@ -75306,6 +75495,25 @@ export const OrderApiFactory = function (configuration?: Configuration, fetch?:
|
|
|
75306
75495
|
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) {
|
|
75307
75496
|
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);
|
|
75308
75497
|
},
|
|
75498
|
+
/**
|
|
75499
|
+
* Perform a refund operation on an order and then update the order if successful.
|
|
75500
|
+
* @summary Refund an order completely
|
|
75501
|
+
* @param {string} order_id The order id to refund.
|
|
75502
|
+
* @param {boolean} [reject_after_refund] Reject order after refund
|
|
75503
|
+
* @param {boolean} [skip_customer_notification] Skip customer email notification
|
|
75504
|
+
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
75505
|
+
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
75506
|
+
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
75507
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
75508
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
75509
|
+
* @param {string} [refund_reason] Reason for refund
|
|
75510
|
+
* @param {string} [reject_reason] Reason for reject
|
|
75511
|
+
* @param {*} [options] Override http request option.
|
|
75512
|
+
* @throws {RequiredError}
|
|
75513
|
+
*/
|
|
75514
|
+
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) {
|
|
75515
|
+
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);
|
|
75516
|
+
},
|
|
75309
75517
|
/**
|
|
75310
75518
|
* Create a replacement order based upon a previous order
|
|
75311
75519
|
* @summary Replacement order
|
|
@@ -75642,6 +75850,25 @@ export interface OrderApiInterface {
|
|
|
75642
75850
|
*/
|
|
75643
75851
|
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>;
|
|
75644
75852
|
|
|
75853
|
+
/**
|
|
75854
|
+
* Perform a refund operation on an order and then update the order if successful.
|
|
75855
|
+
* @summary Refund an order completely
|
|
75856
|
+
* @param {string} order_id The order id to refund.
|
|
75857
|
+
* @param {boolean} [reject_after_refund] Reject order after refund
|
|
75858
|
+
* @param {boolean} [skip_customer_notification] Skip customer email notification
|
|
75859
|
+
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
75860
|
+
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
75861
|
+
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
75862
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
75863
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
75864
|
+
* @param {string} [refund_reason] Reason for refund
|
|
75865
|
+
* @param {string} [reject_reason] Reason for reject
|
|
75866
|
+
* @param {*} [options] Override http request option.
|
|
75867
|
+
* @throws {RequiredError}
|
|
75868
|
+
* @memberof OrderApiInterface
|
|
75869
|
+
*/
|
|
75870
|
+
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>;
|
|
75871
|
+
|
|
75645
75872
|
/**
|
|
75646
75873
|
* Create a replacement order based upon a previous order
|
|
75647
75874
|
* @summary Replacement order
|
|
@@ -76020,6 +76247,27 @@ export class OrderApi extends BaseAPI implements OrderApiInterface {
|
|
|
76020
76247
|
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);
|
|
76021
76248
|
}
|
|
76022
76249
|
|
|
76250
|
+
/**
|
|
76251
|
+
* Perform a refund operation on an order and then update the order if successful.
|
|
76252
|
+
* @summary Refund an order completely
|
|
76253
|
+
* @param {string} order_id The order id to refund.
|
|
76254
|
+
* @param {boolean} [reject_after_refund] Reject order after refund
|
|
76255
|
+
* @param {boolean} [skip_customer_notification] Skip customer email notification
|
|
76256
|
+
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
76257
|
+
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
76258
|
+
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
76259
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
76260
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
76261
|
+
* @param {string} [refund_reason] Reason for refund
|
|
76262
|
+
* @param {string} [reject_reason] Reason for reject
|
|
76263
|
+
* @param {*} [options] Override http request option.
|
|
76264
|
+
* @throws {RequiredError}
|
|
76265
|
+
* @memberof OrderApi
|
|
76266
|
+
*/
|
|
76267
|
+
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) {
|
|
76268
|
+
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);
|
|
76269
|
+
}
|
|
76270
|
+
|
|
76023
76271
|
/**
|
|
76024
76272
|
* Create a replacement order based upon a previous order
|
|
76025
76273
|
* @summary Replacement order
|
package/dist/api.d.ts
CHANGED
|
@@ -6071,6 +6071,12 @@ export interface ChannelPartnerOrderItem {
|
|
|
6071
6071
|
* @memberof ChannelPartnerOrderItem
|
|
6072
6072
|
*/
|
|
6073
6073
|
options?: Array<ChannelPartnerOrderItemOption>;
|
|
6074
|
+
/**
|
|
6075
|
+
* Properties
|
|
6076
|
+
* @type {Array<ChannelPartnerOrderItemProperty>}
|
|
6077
|
+
* @memberof ChannelPartnerOrderItem
|
|
6078
|
+
*/
|
|
6079
|
+
properties?: Array<ChannelPartnerOrderItemProperty>;
|
|
6074
6080
|
/**
|
|
6075
6081
|
* Quantity
|
|
6076
6082
|
* @type {number}
|
|
@@ -6131,6 +6137,37 @@ export interface ChannelPartnerOrderItemOption {
|
|
|
6131
6137
|
*/
|
|
6132
6138
|
value?: string;
|
|
6133
6139
|
}
|
|
6140
|
+
/**
|
|
6141
|
+
*
|
|
6142
|
+
* @export
|
|
6143
|
+
* @interface ChannelPartnerOrderItemProperty
|
|
6144
|
+
*/
|
|
6145
|
+
export interface ChannelPartnerOrderItemProperty {
|
|
6146
|
+
/**
|
|
6147
|
+
* True if this property is displayed to the customer
|
|
6148
|
+
* @type {boolean}
|
|
6149
|
+
* @memberof ChannelPartnerOrderItemProperty
|
|
6150
|
+
*/
|
|
6151
|
+
display?: boolean;
|
|
6152
|
+
/**
|
|
6153
|
+
* The date/time that the property expires and is deleted
|
|
6154
|
+
* @type {string}
|
|
6155
|
+
* @memberof ChannelPartnerOrderItemProperty
|
|
6156
|
+
*/
|
|
6157
|
+
expiration_dts?: string;
|
|
6158
|
+
/**
|
|
6159
|
+
* Name
|
|
6160
|
+
* @type {string}
|
|
6161
|
+
* @memberof ChannelPartnerOrderItemProperty
|
|
6162
|
+
*/
|
|
6163
|
+
name?: string;
|
|
6164
|
+
/**
|
|
6165
|
+
* Value
|
|
6166
|
+
* @type {string}
|
|
6167
|
+
* @memberof ChannelPartnerOrderItemProperty
|
|
6168
|
+
*/
|
|
6169
|
+
value?: string;
|
|
6170
|
+
}
|
|
6134
6171
|
/**
|
|
6135
6172
|
*
|
|
6136
6173
|
* @export
|
|
@@ -7029,6 +7066,30 @@ export interface ConversationAgentAuthResponse {
|
|
|
7029
7066
|
* @interface ConversationAgentProfile
|
|
7030
7067
|
*/
|
|
7031
7068
|
export interface ConversationAgentProfile {
|
|
7069
|
+
/**
|
|
7070
|
+
* AI powered chat bot
|
|
7071
|
+
* @type {boolean}
|
|
7072
|
+
* @memberof ConversationAgentProfile
|
|
7073
|
+
*/
|
|
7074
|
+
ai?: boolean;
|
|
7075
|
+
/**
|
|
7076
|
+
* Additional instructions for this AI when handle web chats
|
|
7077
|
+
* @type {string}
|
|
7078
|
+
* @memberof ConversationAgentProfile
|
|
7079
|
+
*/
|
|
7080
|
+
ai_chat_instructions?: string;
|
|
7081
|
+
/**
|
|
7082
|
+
* Persona of this AI agent
|
|
7083
|
+
* @type {string}
|
|
7084
|
+
* @memberof ConversationAgentProfile
|
|
7085
|
+
*/
|
|
7086
|
+
ai_persona?: string;
|
|
7087
|
+
/**
|
|
7088
|
+
* Additional instructions for this AI when handle SMS messages
|
|
7089
|
+
* @type {string}
|
|
7090
|
+
* @memberof ConversationAgentProfile
|
|
7091
|
+
*/
|
|
7092
|
+
ai_sms_instructions?: string;
|
|
7032
7093
|
/**
|
|
7033
7094
|
* The number of engagement chats that can be pushed on them at any given time.
|
|
7034
7095
|
* @type {number}
|
|
@@ -55814,6 +55875,23 @@ export declare const OrderApiFetchParamCreator: (configuration?: Configuration)
|
|
|
55814
55875
|
* @throws {RequiredError}
|
|
55815
55876
|
*/
|
|
55816
55877
|
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;
|
|
55878
|
+
/**
|
|
55879
|
+
* Perform a refund operation on an order and then update the order if successful.
|
|
55880
|
+
* @summary Refund an order completely
|
|
55881
|
+
* @param {string} order_id The order id to refund.
|
|
55882
|
+
* @param {boolean} [reject_after_refund] Reject order after refund
|
|
55883
|
+
* @param {boolean} [skip_customer_notification] Skip customer email notification
|
|
55884
|
+
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
55885
|
+
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
55886
|
+
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
55887
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
55888
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
55889
|
+
* @param {string} [refund_reason] Reason for refund
|
|
55890
|
+
* @param {string} [reject_reason] Reason for reject
|
|
55891
|
+
* @param {*} [options] Override http request option.
|
|
55892
|
+
* @throws {RequiredError}
|
|
55893
|
+
*/
|
|
55894
|
+
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;
|
|
55817
55895
|
/**
|
|
55818
55896
|
* Create a replacement order based upon a previous order
|
|
55819
55897
|
* @summary Replacement order
|
|
@@ -56093,6 +56171,23 @@ export declare const OrderApiFp: (configuration?: Configuration) => {
|
|
|
56093
56171
|
* @throws {RequiredError}
|
|
56094
56172
|
*/
|
|
56095
56173
|
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>;
|
|
56174
|
+
/**
|
|
56175
|
+
* Perform a refund operation on an order and then update the order if successful.
|
|
56176
|
+
* @summary Refund an order completely
|
|
56177
|
+
* @param {string} order_id The order id to refund.
|
|
56178
|
+
* @param {boolean} [reject_after_refund] Reject order after refund
|
|
56179
|
+
* @param {boolean} [skip_customer_notification] Skip customer email notification
|
|
56180
|
+
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
56181
|
+
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
56182
|
+
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
56183
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
56184
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
56185
|
+
* @param {string} [refund_reason] Reason for refund
|
|
56186
|
+
* @param {string} [reject_reason] Reason for reject
|
|
56187
|
+
* @param {*} [options] Override http request option.
|
|
56188
|
+
* @throws {RequiredError}
|
|
56189
|
+
*/
|
|
56190
|
+
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>;
|
|
56096
56191
|
/**
|
|
56097
56192
|
* Create a replacement order based upon a previous order
|
|
56098
56193
|
* @summary Replacement order
|
|
@@ -56372,6 +56467,23 @@ export declare const OrderApiFactory: (configuration?: Configuration, fetch?: Fe
|
|
|
56372
56467
|
* @throws {RequiredError}
|
|
56373
56468
|
*/
|
|
56374
56469
|
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>;
|
|
56470
|
+
/**
|
|
56471
|
+
* Perform a refund operation on an order and then update the order if successful.
|
|
56472
|
+
* @summary Refund an order completely
|
|
56473
|
+
* @param {string} order_id The order id to refund.
|
|
56474
|
+
* @param {boolean} [reject_after_refund] Reject order after refund
|
|
56475
|
+
* @param {boolean} [skip_customer_notification] Skip customer email notification
|
|
56476
|
+
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
56477
|
+
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
56478
|
+
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
56479
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
56480
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
56481
|
+
* @param {string} [refund_reason] Reason for refund
|
|
56482
|
+
* @param {string} [reject_reason] Reason for reject
|
|
56483
|
+
* @param {*} [options] Override http request option.
|
|
56484
|
+
* @throws {RequiredError}
|
|
56485
|
+
*/
|
|
56486
|
+
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>;
|
|
56375
56487
|
/**
|
|
56376
56488
|
* Create a replacement order based upon a previous order
|
|
56377
56489
|
* @summary Replacement order
|
|
@@ -56673,6 +56785,24 @@ export interface OrderApiInterface {
|
|
|
56673
56785
|
* @memberof OrderApiInterface
|
|
56674
56786
|
*/
|
|
56675
56787
|
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>;
|
|
56788
|
+
/**
|
|
56789
|
+
* Perform a refund operation on an order and then update the order if successful.
|
|
56790
|
+
* @summary Refund an order completely
|
|
56791
|
+
* @param {string} order_id The order id to refund.
|
|
56792
|
+
* @param {boolean} [reject_after_refund] Reject order after refund
|
|
56793
|
+
* @param {boolean} [skip_customer_notification] Skip customer email notification
|
|
56794
|
+
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
56795
|
+
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
56796
|
+
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
56797
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
56798
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
56799
|
+
* @param {string} [refund_reason] Reason for refund
|
|
56800
|
+
* @param {string} [reject_reason] Reason for reject
|
|
56801
|
+
* @param {*} [options] Override http request option.
|
|
56802
|
+
* @throws {RequiredError}
|
|
56803
|
+
* @memberof OrderApiInterface
|
|
56804
|
+
*/
|
|
56805
|
+
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>;
|
|
56676
56806
|
/**
|
|
56677
56807
|
* Create a replacement order based upon a previous order
|
|
56678
56808
|
* @summary Replacement order
|
|
@@ -56981,6 +57111,24 @@ export declare class OrderApi extends BaseAPI implements OrderApiInterface {
|
|
|
56981
57111
|
* @memberof OrderApi
|
|
56982
57112
|
*/
|
|
56983
57113
|
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>;
|
|
57114
|
+
/**
|
|
57115
|
+
* Perform a refund operation on an order and then update the order if successful.
|
|
57116
|
+
* @summary Refund an order completely
|
|
57117
|
+
* @param {string} order_id The order id to refund.
|
|
57118
|
+
* @param {boolean} [reject_after_refund] Reject order after refund
|
|
57119
|
+
* @param {boolean} [skip_customer_notification] Skip customer email notification
|
|
57120
|
+
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
57121
|
+
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
57122
|
+
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
57123
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
57124
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
57125
|
+
* @param {string} [refund_reason] Reason for refund
|
|
57126
|
+
* @param {string} [reject_reason] Reason for reject
|
|
57127
|
+
* @param {*} [options] Override http request option.
|
|
57128
|
+
* @throws {RequiredError}
|
|
57129
|
+
* @memberof OrderApi
|
|
57130
|
+
*/
|
|
57131
|
+
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>;
|
|
56984
57132
|
/**
|
|
56985
57133
|
* Create a replacement order based upon a previous order
|
|
56986
57134
|
* @summary Replacement order
|
package/dist/api.js
CHANGED
|
@@ -26250,6 +26250,88 @@ var OrderApiFetchParamCreator = function (configuration) {
|
|
|
26250
26250
|
options: localVarRequestOptions,
|
|
26251
26251
|
};
|
|
26252
26252
|
},
|
|
26253
|
+
/**
|
|
26254
|
+
* Perform a refund operation on an order and then update the order if successful.
|
|
26255
|
+
* @summary Refund an order completely
|
|
26256
|
+
* @param {string} order_id The order id to refund.
|
|
26257
|
+
* @param {boolean} [reject_after_refund] Reject order after refund
|
|
26258
|
+
* @param {boolean} [skip_customer_notification] Skip customer email notification
|
|
26259
|
+
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
26260
|
+
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
26261
|
+
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
26262
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
26263
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
26264
|
+
* @param {string} [refund_reason] Reason for refund
|
|
26265
|
+
* @param {string} [reject_reason] Reason for reject
|
|
26266
|
+
* @param {*} [options] Override http request option.
|
|
26267
|
+
* @throws {RequiredError}
|
|
26268
|
+
*/
|
|
26269
|
+
refundOrderCompletely: function (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) {
|
|
26270
|
+
if (options === void 0) { options = {}; }
|
|
26271
|
+
// verify required parameter 'order_id' is not null or undefined
|
|
26272
|
+
if (order_id === null || order_id === undefined) {
|
|
26273
|
+
throw new RequiredError('order_id', 'Required parameter order_id was null or undefined when calling refundOrderCompletely.');
|
|
26274
|
+
}
|
|
26275
|
+
var localVarPath = "/order/orders/{order_id}/refund_completely"
|
|
26276
|
+
.replace("{".concat("order_id", "}"), encodeURIComponent(String(order_id)));
|
|
26277
|
+
var localVarUrlObj = url.parse(localVarPath, true);
|
|
26278
|
+
var localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
|
|
26279
|
+
var localVarHeaderParameter = {};
|
|
26280
|
+
var localVarQueryParameter = {};
|
|
26281
|
+
if (configuration && configuration.apiVersion) {
|
|
26282
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
26283
|
+
}
|
|
26284
|
+
// authentication ultraCartOauth required
|
|
26285
|
+
// oauth required
|
|
26286
|
+
if (configuration && configuration.accessToken) {
|
|
26287
|
+
var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
26288
|
+
? configuration.accessToken("ultraCartOauth", ["order_write"])
|
|
26289
|
+
: configuration.accessToken;
|
|
26290
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
26291
|
+
}
|
|
26292
|
+
// authentication ultraCartSimpleApiKey required
|
|
26293
|
+
if (configuration && configuration.apiKey) {
|
|
26294
|
+
var localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
26295
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
26296
|
+
: configuration.apiKey;
|
|
26297
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
26298
|
+
}
|
|
26299
|
+
if (reject_after_refund !== undefined) {
|
|
26300
|
+
localVarQueryParameter['reject_after_refund'] = reject_after_refund;
|
|
26301
|
+
}
|
|
26302
|
+
if (skip_customer_notification !== undefined) {
|
|
26303
|
+
localVarQueryParameter['skip_customer_notification'] = skip_customer_notification;
|
|
26304
|
+
}
|
|
26305
|
+
if (auto_order_cancel !== undefined) {
|
|
26306
|
+
localVarQueryParameter['auto_order_cancel'] = auto_order_cancel;
|
|
26307
|
+
}
|
|
26308
|
+
if (manual_refund !== undefined) {
|
|
26309
|
+
localVarQueryParameter['manual_refund'] = manual_refund;
|
|
26310
|
+
}
|
|
26311
|
+
if (reverse_affiliate_transactions !== undefined) {
|
|
26312
|
+
localVarQueryParameter['reverse_affiliate_transactions'] = reverse_affiliate_transactions;
|
|
26313
|
+
}
|
|
26314
|
+
if (issue_store_credit !== undefined) {
|
|
26315
|
+
localVarQueryParameter['issue_store_credit'] = issue_store_credit;
|
|
26316
|
+
}
|
|
26317
|
+
if (auto_order_cancel_reason !== undefined) {
|
|
26318
|
+
localVarQueryParameter['auto_order_cancel_reason'] = auto_order_cancel_reason;
|
|
26319
|
+
}
|
|
26320
|
+
if (refund_reason !== undefined) {
|
|
26321
|
+
localVarQueryParameter['refund_reason'] = refund_reason;
|
|
26322
|
+
}
|
|
26323
|
+
if (reject_reason !== undefined) {
|
|
26324
|
+
localVarQueryParameter['reject_reason'] = reject_reason;
|
|
26325
|
+
}
|
|
26326
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
26327
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
26328
|
+
delete localVarUrlObj.search;
|
|
26329
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
26330
|
+
return {
|
|
26331
|
+
url: url.format(localVarUrlObj),
|
|
26332
|
+
options: localVarRequestOptions,
|
|
26333
|
+
};
|
|
26334
|
+
},
|
|
26253
26335
|
/**
|
|
26254
26336
|
* Create a replacement order based upon a previous order
|
|
26255
26337
|
* @summary Replacement order
|
|
@@ -27075,6 +27157,37 @@ var OrderApiFp = function (configuration) {
|
|
|
27075
27157
|
});
|
|
27076
27158
|
};
|
|
27077
27159
|
},
|
|
27160
|
+
/**
|
|
27161
|
+
* Perform a refund operation on an order and then update the order if successful.
|
|
27162
|
+
* @summary Refund an order completely
|
|
27163
|
+
* @param {string} order_id The order id to refund.
|
|
27164
|
+
* @param {boolean} [reject_after_refund] Reject order after refund
|
|
27165
|
+
* @param {boolean} [skip_customer_notification] Skip customer email notification
|
|
27166
|
+
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
27167
|
+
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
27168
|
+
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
27169
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
27170
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
27171
|
+
* @param {string} [refund_reason] Reason for refund
|
|
27172
|
+
* @param {string} [reject_reason] Reason for reject
|
|
27173
|
+
* @param {*} [options] Override http request option.
|
|
27174
|
+
* @throws {RequiredError}
|
|
27175
|
+
*/
|
|
27176
|
+
refundOrderCompletely: function (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) {
|
|
27177
|
+
var localVarFetchArgs = (0, exports.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);
|
|
27178
|
+
return function (fetch, basePath) {
|
|
27179
|
+
if (fetch === void 0) { fetch = portableFetch; }
|
|
27180
|
+
if (basePath === void 0) { basePath = BASE_PATH; }
|
|
27181
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
|
|
27182
|
+
if (response.status >= 200 && response.status < 300) {
|
|
27183
|
+
return response.json();
|
|
27184
|
+
}
|
|
27185
|
+
else {
|
|
27186
|
+
throw response;
|
|
27187
|
+
}
|
|
27188
|
+
});
|
|
27189
|
+
};
|
|
27190
|
+
},
|
|
27078
27191
|
/**
|
|
27079
27192
|
* Create a replacement order based upon a previous order
|
|
27080
27193
|
* @summary Replacement order
|
|
@@ -27483,6 +27596,25 @@ var OrderApiFactory = function (configuration, fetch, basePath) {
|
|
|
27483
27596
|
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) {
|
|
27484
27597
|
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);
|
|
27485
27598
|
},
|
|
27599
|
+
/**
|
|
27600
|
+
* Perform a refund operation on an order and then update the order if successful.
|
|
27601
|
+
* @summary Refund an order completely
|
|
27602
|
+
* @param {string} order_id The order id to refund.
|
|
27603
|
+
* @param {boolean} [reject_after_refund] Reject order after refund
|
|
27604
|
+
* @param {boolean} [skip_customer_notification] Skip customer email notification
|
|
27605
|
+
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
27606
|
+
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
27607
|
+
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
27608
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
27609
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
27610
|
+
* @param {string} [refund_reason] Reason for refund
|
|
27611
|
+
* @param {string} [reject_reason] Reason for reject
|
|
27612
|
+
* @param {*} [options] Override http request option.
|
|
27613
|
+
* @throws {RequiredError}
|
|
27614
|
+
*/
|
|
27615
|
+
refundOrderCompletely: function (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) {
|
|
27616
|
+
return (0, exports.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);
|
|
27617
|
+
},
|
|
27486
27618
|
/**
|
|
27487
27619
|
* Create a replacement order based upon a previous order
|
|
27488
27620
|
* @summary Replacement order
|
|
@@ -27845,6 +27977,26 @@ var OrderApi = /** @class */ (function (_super) {
|
|
|
27845
27977
|
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) {
|
|
27846
27978
|
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);
|
|
27847
27979
|
};
|
|
27980
|
+
/**
|
|
27981
|
+
* Perform a refund operation on an order and then update the order if successful.
|
|
27982
|
+
* @summary Refund an order completely
|
|
27983
|
+
* @param {string} order_id The order id to refund.
|
|
27984
|
+
* @param {boolean} [reject_after_refund] Reject order after refund
|
|
27985
|
+
* @param {boolean} [skip_customer_notification] Skip customer email notification
|
|
27986
|
+
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
27987
|
+
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
27988
|
+
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
27989
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
27990
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
27991
|
+
* @param {string} [refund_reason] Reason for refund
|
|
27992
|
+
* @param {string} [reject_reason] Reason for reject
|
|
27993
|
+
* @param {*} [options] Override http request option.
|
|
27994
|
+
* @throws {RequiredError}
|
|
27995
|
+
* @memberof OrderApi
|
|
27996
|
+
*/
|
|
27997
|
+
OrderApi.prototype.refundOrderCompletely = function (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) {
|
|
27998
|
+
return (0, exports.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);
|
|
27999
|
+
};
|
|
27848
28000
|
/**
|
|
27849
28001
|
* Create a replacement order based upon a previous order
|
|
27850
28002
|
* @summary Replacement order
|