ultracart_rest_api_v2_typescript 3.10.221 → 3.10.223
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 +424 -0
- package/dist/api.d.ts +187 -0
- package/dist/api.js +348 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## ultracart_rest_api_v2_typescript@3.10.
|
|
1
|
+
## ultracart_rest_api_v2_typescript@3.10.223
|
|
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.223 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
|
|
|
54
54
|
|
|
55
55
|
| Version | Date | Comments |
|
|
56
56
|
| --: | :-: | --- |
|
|
57
|
+
| 3.10.223 | 01/09/2025 | fix for broken 4.0.39 due to incorrect query sig on getCustomers |
|
|
58
|
+
| 3.10.222 | 01/09/2025 | added emails parameter to customer queries, refundOrder added to Channel partner |
|
|
57
59
|
| 3.10.221 | 12/13/2024 | added user and group ids to conversation agent auth object |
|
|
58
60
|
| 3.10.220 | 11/11/2024 | added seo properties to item.content object |
|
|
59
61
|
| 3.10.219 | 11/07/2024 | Coupon - PercentOffWithItemsQuantityPurchase - added support for tags |
|
package/api.ts
CHANGED
|
@@ -15519,6 +15519,12 @@ export interface CustomerQuery {
|
|
|
15519
15519
|
* @memberof CustomerQuery
|
|
15520
15520
|
*/
|
|
15521
15521
|
email?: string;
|
|
15522
|
+
/**
|
|
15523
|
+
* Emails allows for searching on multiple email addresses and work with our without the single email variable. You may specify a single email address here or use the email property.
|
|
15524
|
+
* @type {Array<string>}
|
|
15525
|
+
* @memberof CustomerQuery
|
|
15526
|
+
*/
|
|
15527
|
+
emails?: Array<string>;
|
|
15522
15528
|
/**
|
|
15523
15529
|
* Last modified date end
|
|
15524
15530
|
* @type {string}
|
|
@@ -47137,6 +47143,120 @@ export const ChannelPartnerApiFetchParamCreator = function (configuration?: Conf
|
|
|
47137
47143
|
options: localVarRequestOptions,
|
|
47138
47144
|
};
|
|
47139
47145
|
},
|
|
47146
|
+
/**
|
|
47147
|
+
* Retrieves a single order using the specified order id. Only orders belonging to this channel partner may be retrieved.
|
|
47148
|
+
* @summary Retrieve a channel partner order
|
|
47149
|
+
* @param {string} order_id The order id to retrieve.
|
|
47150
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.getOrder documentation for examples
|
|
47151
|
+
* @param {*} [options] Override http request option.
|
|
47152
|
+
* @throws {RequiredError}
|
|
47153
|
+
*/
|
|
47154
|
+
getChannelPartnerOrder(order_id: string, _expand?: string, options: any = {}): FetchArgs {
|
|
47155
|
+
// verify required parameter 'order_id' is not null or undefined
|
|
47156
|
+
if (order_id === null || order_id === undefined) {
|
|
47157
|
+
throw new RequiredError('order_id','Required parameter order_id was null or undefined when calling getChannelPartnerOrder.');
|
|
47158
|
+
}
|
|
47159
|
+
const localVarPath = `/channel_partner/orders/{order_id}`
|
|
47160
|
+
.replace(`{${"order_id"}}`, encodeURIComponent(String(order_id)));
|
|
47161
|
+
const localVarUrlObj = url.parse(localVarPath, true);
|
|
47162
|
+
const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
|
|
47163
|
+
const localVarHeaderParameter = {} as any;
|
|
47164
|
+
const localVarQueryParameter = {} as any;
|
|
47165
|
+
|
|
47166
|
+
if(configuration && configuration.apiVersion) {
|
|
47167
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
47168
|
+
}
|
|
47169
|
+
|
|
47170
|
+
|
|
47171
|
+
|
|
47172
|
+
// authentication ultraCartOauth required
|
|
47173
|
+
// oauth required
|
|
47174
|
+
if (configuration && configuration.accessToken) {
|
|
47175
|
+
const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
47176
|
+
? configuration.accessToken("ultraCartOauth", ["channel_partner_read"])
|
|
47177
|
+
: configuration.accessToken;
|
|
47178
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
47179
|
+
}
|
|
47180
|
+
|
|
47181
|
+
// authentication ultraCartSimpleApiKey required
|
|
47182
|
+
if (configuration && configuration.apiKey) {
|
|
47183
|
+
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
47184
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
47185
|
+
: configuration.apiKey;
|
|
47186
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
47187
|
+
}
|
|
47188
|
+
|
|
47189
|
+
if (_expand !== undefined) {
|
|
47190
|
+
localVarQueryParameter['_expand'] = _expand;
|
|
47191
|
+
}
|
|
47192
|
+
|
|
47193
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
47194
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
47195
|
+
delete localVarUrlObj.search;
|
|
47196
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
47197
|
+
|
|
47198
|
+
return {
|
|
47199
|
+
url: url.format(localVarUrlObj),
|
|
47200
|
+
options: localVarRequestOptions,
|
|
47201
|
+
};
|
|
47202
|
+
},
|
|
47203
|
+
/**
|
|
47204
|
+
* Retrieves a single order using the channel partner order id, not the ultracart order id. Only orders belonging to this channel partner may be retrieved.
|
|
47205
|
+
* @summary Retrieve a channel partner order by the channel partner order id
|
|
47206
|
+
* @param {string} order_id The channel partner order id to retrieve.
|
|
47207
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.getOrder documentation for examples
|
|
47208
|
+
* @param {*} [options] Override http request option.
|
|
47209
|
+
* @throws {RequiredError}
|
|
47210
|
+
*/
|
|
47211
|
+
getChannelPartnerOrderByChannelPartnerOrderId(order_id: string, _expand?: string, options: any = {}): FetchArgs {
|
|
47212
|
+
// verify required parameter 'order_id' is not null or undefined
|
|
47213
|
+
if (order_id === null || order_id === undefined) {
|
|
47214
|
+
throw new RequiredError('order_id','Required parameter order_id was null or undefined when calling getChannelPartnerOrderByChannelPartnerOrderId.');
|
|
47215
|
+
}
|
|
47216
|
+
const localVarPath = `/channel_partner/orders/by_channel_partner_order_id/{order_id}`
|
|
47217
|
+
.replace(`{${"order_id"}}`, encodeURIComponent(String(order_id)));
|
|
47218
|
+
const localVarUrlObj = url.parse(localVarPath, true);
|
|
47219
|
+
const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
|
|
47220
|
+
const localVarHeaderParameter = {} as any;
|
|
47221
|
+
const localVarQueryParameter = {} as any;
|
|
47222
|
+
|
|
47223
|
+
if(configuration && configuration.apiVersion) {
|
|
47224
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
47225
|
+
}
|
|
47226
|
+
|
|
47227
|
+
|
|
47228
|
+
|
|
47229
|
+
// authentication ultraCartOauth required
|
|
47230
|
+
// oauth required
|
|
47231
|
+
if (configuration && configuration.accessToken) {
|
|
47232
|
+
const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
47233
|
+
? configuration.accessToken("ultraCartOauth", ["channel_partner_read"])
|
|
47234
|
+
: configuration.accessToken;
|
|
47235
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
47236
|
+
}
|
|
47237
|
+
|
|
47238
|
+
// authentication ultraCartSimpleApiKey required
|
|
47239
|
+
if (configuration && configuration.apiKey) {
|
|
47240
|
+
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
47241
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
47242
|
+
: configuration.apiKey;
|
|
47243
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
47244
|
+
}
|
|
47245
|
+
|
|
47246
|
+
if (_expand !== undefined) {
|
|
47247
|
+
localVarQueryParameter['_expand'] = _expand;
|
|
47248
|
+
}
|
|
47249
|
+
|
|
47250
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
47251
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
47252
|
+
delete localVarUrlObj.search;
|
|
47253
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
47254
|
+
|
|
47255
|
+
return {
|
|
47256
|
+
url: url.format(localVarUrlObj),
|
|
47257
|
+
options: localVarRequestOptions,
|
|
47258
|
+
};
|
|
47259
|
+
},
|
|
47140
47260
|
/**
|
|
47141
47261
|
* Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
47142
47262
|
* @summary Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
@@ -47409,6 +47529,107 @@ export const ChannelPartnerApiFetchParamCreator = function (configuration?: Conf
|
|
|
47409
47529
|
options: localVarRequestOptions,
|
|
47410
47530
|
};
|
|
47411
47531
|
},
|
|
47532
|
+
/**
|
|
47533
|
+
* Perform a refund operation on a channel partner order and then update the order if successful. All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded. UltraCart will calculate the actual amount to refund based upon the prior refunds.
|
|
47534
|
+
* @summary Refund a channel partner order
|
|
47535
|
+
* @param {Order} order Order to refund
|
|
47536
|
+
* @param {string} order_id The order id to refund.
|
|
47537
|
+
* @param {boolean} [reject_after_refund] Reject order after refund
|
|
47538
|
+
* @param {boolean} [skip_customer_notification] Skip customer email notification
|
|
47539
|
+
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
47540
|
+
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
47541
|
+
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
47542
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
47543
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
47544
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.refundOrder documentation for examples
|
|
47545
|
+
* @param {*} [options] Override http request option.
|
|
47546
|
+
* @throws {RequiredError}
|
|
47547
|
+
*/
|
|
47548
|
+
refundChannelPartnerOrder(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 {
|
|
47549
|
+
// verify required parameter 'order' is not null or undefined
|
|
47550
|
+
if (order === null || order === undefined) {
|
|
47551
|
+
throw new RequiredError('order','Required parameter order was null or undefined when calling refundChannelPartnerOrder.');
|
|
47552
|
+
}
|
|
47553
|
+
// verify required parameter 'order_id' is not null or undefined
|
|
47554
|
+
if (order_id === null || order_id === undefined) {
|
|
47555
|
+
throw new RequiredError('order_id','Required parameter order_id was null or undefined when calling refundChannelPartnerOrder.');
|
|
47556
|
+
}
|
|
47557
|
+
const localVarPath = `/channel_partner/orders/{order_id}/refund`
|
|
47558
|
+
.replace(`{${"order_id"}}`, encodeURIComponent(String(order_id)));
|
|
47559
|
+
const localVarUrlObj = url.parse(localVarPath, true);
|
|
47560
|
+
const localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
|
|
47561
|
+
const localVarHeaderParameter = {} as any;
|
|
47562
|
+
const localVarQueryParameter = {} as any;
|
|
47563
|
+
|
|
47564
|
+
if(configuration && configuration.apiVersion) {
|
|
47565
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
47566
|
+
}
|
|
47567
|
+
|
|
47568
|
+
|
|
47569
|
+
|
|
47570
|
+
// authentication ultraCartOauth required
|
|
47571
|
+
// oauth required
|
|
47572
|
+
if (configuration && configuration.accessToken) {
|
|
47573
|
+
const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
47574
|
+
? configuration.accessToken("ultraCartOauth", ["channel_partner_write"])
|
|
47575
|
+
: configuration.accessToken;
|
|
47576
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
47577
|
+
}
|
|
47578
|
+
|
|
47579
|
+
// authentication ultraCartSimpleApiKey required
|
|
47580
|
+
if (configuration && configuration.apiKey) {
|
|
47581
|
+
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
47582
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
47583
|
+
: configuration.apiKey;
|
|
47584
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
47585
|
+
}
|
|
47586
|
+
|
|
47587
|
+
if (reject_after_refund !== undefined) {
|
|
47588
|
+
localVarQueryParameter['reject_after_refund'] = reject_after_refund;
|
|
47589
|
+
}
|
|
47590
|
+
|
|
47591
|
+
if (skip_customer_notification !== undefined) {
|
|
47592
|
+
localVarQueryParameter['skip_customer_notification'] = skip_customer_notification;
|
|
47593
|
+
}
|
|
47594
|
+
|
|
47595
|
+
if (auto_order_cancel !== undefined) {
|
|
47596
|
+
localVarQueryParameter['auto_order_cancel'] = auto_order_cancel;
|
|
47597
|
+
}
|
|
47598
|
+
|
|
47599
|
+
if (manual_refund !== undefined) {
|
|
47600
|
+
localVarQueryParameter['manual_refund'] = manual_refund;
|
|
47601
|
+
}
|
|
47602
|
+
|
|
47603
|
+
if (reverse_affiliate_transactions !== undefined) {
|
|
47604
|
+
localVarQueryParameter['reverse_affiliate_transactions'] = reverse_affiliate_transactions;
|
|
47605
|
+
}
|
|
47606
|
+
|
|
47607
|
+
if (issue_store_credit !== undefined) {
|
|
47608
|
+
localVarQueryParameter['issue_store_credit'] = issue_store_credit;
|
|
47609
|
+
}
|
|
47610
|
+
|
|
47611
|
+
if (auto_order_cancel_reason !== undefined) {
|
|
47612
|
+
localVarQueryParameter['auto_order_cancel_reason'] = auto_order_cancel_reason;
|
|
47613
|
+
}
|
|
47614
|
+
|
|
47615
|
+
if (_expand !== undefined) {
|
|
47616
|
+
localVarQueryParameter['_expand'] = _expand;
|
|
47617
|
+
}
|
|
47618
|
+
|
|
47619
|
+
localVarHeaderParameter['Content-Type'] = 'application/json; charset=UTF-8';
|
|
47620
|
+
|
|
47621
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
47622
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
47623
|
+
delete localVarUrlObj.search;
|
|
47624
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
47625
|
+
const needsSerialization = (<any>"Order" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
|
|
47626
|
+
localVarRequestOptions.body = needsSerialization ? JSON.stringify(order || {}) : (order || "");
|
|
47627
|
+
|
|
47628
|
+
return {
|
|
47629
|
+
url: url.format(localVarUrlObj),
|
|
47630
|
+
options: localVarRequestOptions,
|
|
47631
|
+
};
|
|
47632
|
+
},
|
|
47412
47633
|
/**
|
|
47413
47634
|
* Update a ship to preference record for the channel partner.
|
|
47414
47635
|
* @summary Update a ship to preference record for the channel partner.
|
|
@@ -47591,6 +47812,50 @@ export const ChannelPartnerApiFp = function(configuration?: Configuration) {
|
|
|
47591
47812
|
});
|
|
47592
47813
|
};
|
|
47593
47814
|
},
|
|
47815
|
+
/**
|
|
47816
|
+
* Retrieves a single order using the specified order id. Only orders belonging to this channel partner may be retrieved.
|
|
47817
|
+
* @summary Retrieve a channel partner order
|
|
47818
|
+
* @param {string} order_id The order id to retrieve.
|
|
47819
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.getOrder documentation for examples
|
|
47820
|
+
* @param {*} [options] Override http request option.
|
|
47821
|
+
* @throws {RequiredError}
|
|
47822
|
+
*/
|
|
47823
|
+
getChannelPartnerOrder(order_id: string, _expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrderResponse> {
|
|
47824
|
+
const localVarFetchArgs = ChannelPartnerApiFetchParamCreator(configuration).getChannelPartnerOrder(order_id, _expand, options);
|
|
47825
|
+
return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
|
|
47826
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
|
|
47827
|
+
|
|
47828
|
+
if (response.status >= 200 && response.status < 300) {
|
|
47829
|
+
return response.json();
|
|
47830
|
+
|
|
47831
|
+
} else {
|
|
47832
|
+
throw response;
|
|
47833
|
+
}
|
|
47834
|
+
});
|
|
47835
|
+
};
|
|
47836
|
+
},
|
|
47837
|
+
/**
|
|
47838
|
+
* Retrieves a single order using the channel partner order id, not the ultracart order id. Only orders belonging to this channel partner may be retrieved.
|
|
47839
|
+
* @summary Retrieve a channel partner order by the channel partner order id
|
|
47840
|
+
* @param {string} order_id The channel partner order id to retrieve.
|
|
47841
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.getOrder documentation for examples
|
|
47842
|
+
* @param {*} [options] Override http request option.
|
|
47843
|
+
* @throws {RequiredError}
|
|
47844
|
+
*/
|
|
47845
|
+
getChannelPartnerOrderByChannelPartnerOrderId(order_id: string, _expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrderResponse> {
|
|
47846
|
+
const localVarFetchArgs = ChannelPartnerApiFetchParamCreator(configuration).getChannelPartnerOrderByChannelPartnerOrderId(order_id, _expand, options);
|
|
47847
|
+
return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
|
|
47848
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
|
|
47849
|
+
|
|
47850
|
+
if (response.status >= 200 && response.status < 300) {
|
|
47851
|
+
return response.json();
|
|
47852
|
+
|
|
47853
|
+
} else {
|
|
47854
|
+
throw response;
|
|
47855
|
+
}
|
|
47856
|
+
});
|
|
47857
|
+
};
|
|
47858
|
+
},
|
|
47594
47859
|
/**
|
|
47595
47860
|
* Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
47596
47861
|
* @summary Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
@@ -47697,6 +47962,36 @@ export const ChannelPartnerApiFp = function(configuration?: Configuration) {
|
|
|
47697
47962
|
});
|
|
47698
47963
|
};
|
|
47699
47964
|
},
|
|
47965
|
+
/**
|
|
47966
|
+
* Perform a refund operation on a channel partner order and then update the order if successful. All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded. UltraCart will calculate the actual amount to refund based upon the prior refunds.
|
|
47967
|
+
* @summary Refund a channel partner order
|
|
47968
|
+
* @param {Order} order Order to refund
|
|
47969
|
+
* @param {string} order_id The order id to refund.
|
|
47970
|
+
* @param {boolean} [reject_after_refund] Reject order after refund
|
|
47971
|
+
* @param {boolean} [skip_customer_notification] Skip customer email notification
|
|
47972
|
+
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
47973
|
+
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
47974
|
+
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
47975
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
47976
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
47977
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.refundOrder documentation for examples
|
|
47978
|
+
* @param {*} [options] Override http request option.
|
|
47979
|
+
* @throws {RequiredError}
|
|
47980
|
+
*/
|
|
47981
|
+
refundChannelPartnerOrder(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> {
|
|
47982
|
+
const localVarFetchArgs = ChannelPartnerApiFetchParamCreator(configuration).refundChannelPartnerOrder(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);
|
|
47983
|
+
return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
|
|
47984
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
|
|
47985
|
+
|
|
47986
|
+
if (response.status >= 200 && response.status < 300) {
|
|
47987
|
+
return response.json();
|
|
47988
|
+
|
|
47989
|
+
} else {
|
|
47990
|
+
throw response;
|
|
47991
|
+
}
|
|
47992
|
+
});
|
|
47993
|
+
};
|
|
47994
|
+
},
|
|
47700
47995
|
/**
|
|
47701
47996
|
* Update a ship to preference record for the channel partner.
|
|
47702
47997
|
* @summary Update a ship to preference record for the channel partner.
|
|
@@ -47780,6 +48075,28 @@ export const ChannelPartnerApiFactory = function (configuration?: Configuration,
|
|
|
47780
48075
|
estimateTaxForChannelPartnerOrder(channel_partner_order: ChannelPartnerOrder, options?: any) {
|
|
47781
48076
|
return ChannelPartnerApiFp(configuration).estimateTaxForChannelPartnerOrder(channel_partner_order, options)(fetch, basePath);
|
|
47782
48077
|
},
|
|
48078
|
+
/**
|
|
48079
|
+
* Retrieves a single order using the specified order id. Only orders belonging to this channel partner may be retrieved.
|
|
48080
|
+
* @summary Retrieve a channel partner order
|
|
48081
|
+
* @param {string} order_id The order id to retrieve.
|
|
48082
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.getOrder documentation for examples
|
|
48083
|
+
* @param {*} [options] Override http request option.
|
|
48084
|
+
* @throws {RequiredError}
|
|
48085
|
+
*/
|
|
48086
|
+
getChannelPartnerOrder(order_id: string, _expand?: string, options?: any) {
|
|
48087
|
+
return ChannelPartnerApiFp(configuration).getChannelPartnerOrder(order_id, _expand, options)(fetch, basePath);
|
|
48088
|
+
},
|
|
48089
|
+
/**
|
|
48090
|
+
* Retrieves a single order using the channel partner order id, not the ultracart order id. Only orders belonging to this channel partner may be retrieved.
|
|
48091
|
+
* @summary Retrieve a channel partner order by the channel partner order id
|
|
48092
|
+
* @param {string} order_id The channel partner order id to retrieve.
|
|
48093
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.getOrder documentation for examples
|
|
48094
|
+
* @param {*} [options] Override http request option.
|
|
48095
|
+
* @throws {RequiredError}
|
|
48096
|
+
*/
|
|
48097
|
+
getChannelPartnerOrderByChannelPartnerOrderId(order_id: string, _expand?: string, options?: any) {
|
|
48098
|
+
return ChannelPartnerApiFp(configuration).getChannelPartnerOrderByChannelPartnerOrderId(order_id, _expand, options)(fetch, basePath);
|
|
48099
|
+
},
|
|
47783
48100
|
/**
|
|
47784
48101
|
* Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
47785
48102
|
* @summary Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
@@ -47831,6 +48148,25 @@ export const ChannelPartnerApiFactory = function (configuration?: Configuration,
|
|
|
47831
48148
|
insertChannelPartnerShipToPreference(channel_partner_oid: number, ship_to_preference: ChannelPartnerShipToPreference, options?: any) {
|
|
47832
48149
|
return ChannelPartnerApiFp(configuration).insertChannelPartnerShipToPreference(channel_partner_oid, ship_to_preference, options)(fetch, basePath);
|
|
47833
48150
|
},
|
|
48151
|
+
/**
|
|
48152
|
+
* Perform a refund operation on a channel partner order and then update the order if successful. All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded. UltraCart will calculate the actual amount to refund based upon the prior refunds.
|
|
48153
|
+
* @summary Refund a channel partner order
|
|
48154
|
+
* @param {Order} order Order to refund
|
|
48155
|
+
* @param {string} order_id The order id to refund.
|
|
48156
|
+
* @param {boolean} [reject_after_refund] Reject order after refund
|
|
48157
|
+
* @param {boolean} [skip_customer_notification] Skip customer email notification
|
|
48158
|
+
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
48159
|
+
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
48160
|
+
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
48161
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
48162
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
48163
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.refundOrder documentation for examples
|
|
48164
|
+
* @param {*} [options] Override http request option.
|
|
48165
|
+
* @throws {RequiredError}
|
|
48166
|
+
*/
|
|
48167
|
+
refundChannelPartnerOrder(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) {
|
|
48168
|
+
return ChannelPartnerApiFp(configuration).refundChannelPartnerOrder(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);
|
|
48169
|
+
},
|
|
47834
48170
|
/**
|
|
47835
48171
|
* Update a ship to preference record for the channel partner.
|
|
47836
48172
|
* @summary Update a ship to preference record for the channel partner.
|
|
@@ -47903,6 +48239,28 @@ export interface ChannelPartnerApiInterface {
|
|
|
47903
48239
|
*/
|
|
47904
48240
|
estimateTaxForChannelPartnerOrder(channel_partner_order: ChannelPartnerOrder, options?: any): Promise<ChannelPartnerEstimateTaxResponse>;
|
|
47905
48241
|
|
|
48242
|
+
/**
|
|
48243
|
+
* Retrieves a single order using the specified order id. Only orders belonging to this channel partner may be retrieved.
|
|
48244
|
+
* @summary Retrieve a channel partner order
|
|
48245
|
+
* @param {string} order_id The order id to retrieve.
|
|
48246
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.getOrder documentation for examples
|
|
48247
|
+
* @param {*} [options] Override http request option.
|
|
48248
|
+
* @throws {RequiredError}
|
|
48249
|
+
* @memberof ChannelPartnerApiInterface
|
|
48250
|
+
*/
|
|
48251
|
+
getChannelPartnerOrder(order_id: string, _expand?: string, options?: any): Promise<OrderResponse>;
|
|
48252
|
+
|
|
48253
|
+
/**
|
|
48254
|
+
* Retrieves a single order using the channel partner order id, not the ultracart order id. Only orders belonging to this channel partner may be retrieved.
|
|
48255
|
+
* @summary Retrieve a channel partner order by the channel partner order id
|
|
48256
|
+
* @param {string} order_id The channel partner order id to retrieve.
|
|
48257
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.getOrder documentation for examples
|
|
48258
|
+
* @param {*} [options] Override http request option.
|
|
48259
|
+
* @throws {RequiredError}
|
|
48260
|
+
* @memberof ChannelPartnerApiInterface
|
|
48261
|
+
*/
|
|
48262
|
+
getChannelPartnerOrderByChannelPartnerOrderId(order_id: string, _expand?: string, options?: any): Promise<OrderResponse>;
|
|
48263
|
+
|
|
47906
48264
|
/**
|
|
47907
48265
|
* Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
47908
48266
|
* @summary Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
@@ -47954,6 +48312,25 @@ export interface ChannelPartnerApiInterface {
|
|
|
47954
48312
|
*/
|
|
47955
48313
|
insertChannelPartnerShipToPreference(channel_partner_oid: number, ship_to_preference: ChannelPartnerShipToPreference, options?: any): Promise<ChannelPartnerShipToPreferenceResponse>;
|
|
47956
48314
|
|
|
48315
|
+
/**
|
|
48316
|
+
* Perform a refund operation on a channel partner order and then update the order if successful. All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded. UltraCart will calculate the actual amount to refund based upon the prior refunds.
|
|
48317
|
+
* @summary Refund a channel partner order
|
|
48318
|
+
* @param {Order} order Order to refund
|
|
48319
|
+
* @param {string} order_id The order id to refund.
|
|
48320
|
+
* @param {boolean} [reject_after_refund] Reject order after refund
|
|
48321
|
+
* @param {boolean} [skip_customer_notification] Skip customer email notification
|
|
48322
|
+
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
48323
|
+
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
48324
|
+
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
48325
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
48326
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
48327
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.refundOrder documentation for examples
|
|
48328
|
+
* @param {*} [options] Override http request option.
|
|
48329
|
+
* @throws {RequiredError}
|
|
48330
|
+
* @memberof ChannelPartnerApiInterface
|
|
48331
|
+
*/
|
|
48332
|
+
refundChannelPartnerOrder(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>;
|
|
48333
|
+
|
|
47957
48334
|
/**
|
|
47958
48335
|
* Update a ship to preference record for the channel partner.
|
|
47959
48336
|
* @summary Update a ship to preference record for the channel partner.
|
|
@@ -48036,6 +48413,32 @@ export class ChannelPartnerApi extends BaseAPI implements ChannelPartnerApiInter
|
|
|
48036
48413
|
return ChannelPartnerApiFp(this.configuration).estimateTaxForChannelPartnerOrder(channel_partner_order, options)(this.fetch, this.basePath);
|
|
48037
48414
|
}
|
|
48038
48415
|
|
|
48416
|
+
/**
|
|
48417
|
+
* Retrieves a single order using the specified order id. Only orders belonging to this channel partner may be retrieved.
|
|
48418
|
+
* @summary Retrieve a channel partner order
|
|
48419
|
+
* @param {string} order_id The order id to retrieve.
|
|
48420
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.getOrder documentation for examples
|
|
48421
|
+
* @param {*} [options] Override http request option.
|
|
48422
|
+
* @throws {RequiredError}
|
|
48423
|
+
* @memberof ChannelPartnerApi
|
|
48424
|
+
*/
|
|
48425
|
+
public getChannelPartnerOrder(order_id: string, _expand?: string, options?: any) {
|
|
48426
|
+
return ChannelPartnerApiFp(this.configuration).getChannelPartnerOrder(order_id, _expand, options)(this.fetch, this.basePath);
|
|
48427
|
+
}
|
|
48428
|
+
|
|
48429
|
+
/**
|
|
48430
|
+
* Retrieves a single order using the channel partner order id, not the ultracart order id. Only orders belonging to this channel partner may be retrieved.
|
|
48431
|
+
* @summary Retrieve a channel partner order by the channel partner order id
|
|
48432
|
+
* @param {string} order_id The channel partner order id to retrieve.
|
|
48433
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.getOrder documentation for examples
|
|
48434
|
+
* @param {*} [options] Override http request option.
|
|
48435
|
+
* @throws {RequiredError}
|
|
48436
|
+
* @memberof ChannelPartnerApi
|
|
48437
|
+
*/
|
|
48438
|
+
public getChannelPartnerOrderByChannelPartnerOrderId(order_id: string, _expand?: string, options?: any) {
|
|
48439
|
+
return ChannelPartnerApiFp(this.configuration).getChannelPartnerOrderByChannelPartnerOrderId(order_id, _expand, options)(this.fetch, this.basePath);
|
|
48440
|
+
}
|
|
48441
|
+
|
|
48039
48442
|
/**
|
|
48040
48443
|
* Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
48041
48444
|
* @summary Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
@@ -48097,6 +48500,27 @@ export class ChannelPartnerApi extends BaseAPI implements ChannelPartnerApiInter
|
|
|
48097
48500
|
return ChannelPartnerApiFp(this.configuration).insertChannelPartnerShipToPreference(channel_partner_oid, ship_to_preference, options)(this.fetch, this.basePath);
|
|
48098
48501
|
}
|
|
48099
48502
|
|
|
48503
|
+
/**
|
|
48504
|
+
* Perform a refund operation on a channel partner order and then update the order if successful. All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded. UltraCart will calculate the actual amount to refund based upon the prior refunds.
|
|
48505
|
+
* @summary Refund a channel partner order
|
|
48506
|
+
* @param {Order} order Order to refund
|
|
48507
|
+
* @param {string} order_id The order id to refund.
|
|
48508
|
+
* @param {boolean} [reject_after_refund] Reject order after refund
|
|
48509
|
+
* @param {boolean} [skip_customer_notification] Skip customer email notification
|
|
48510
|
+
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
48511
|
+
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
48512
|
+
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
48513
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
48514
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
48515
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.refundOrder documentation for examples
|
|
48516
|
+
* @param {*} [options] Override http request option.
|
|
48517
|
+
* @throws {RequiredError}
|
|
48518
|
+
* @memberof ChannelPartnerApi
|
|
48519
|
+
*/
|
|
48520
|
+
public refundChannelPartnerOrder(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) {
|
|
48521
|
+
return ChannelPartnerApiFp(this.configuration).refundChannelPartnerOrder(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);
|
|
48522
|
+
}
|
|
48523
|
+
|
|
48100
48524
|
/**
|
|
48101
48525
|
* Update a ship to preference record for the channel partner.
|
|
48102
48526
|
* @summary Update a ship to preference record for the channel partner.
|
package/dist/api.d.ts
CHANGED
|
@@ -15152,6 +15152,12 @@ export interface CustomerQuery {
|
|
|
15152
15152
|
* @memberof CustomerQuery
|
|
15153
15153
|
*/
|
|
15154
15154
|
email?: string;
|
|
15155
|
+
/**
|
|
15156
|
+
* Emails allows for searching on multiple email addresses and work with our without the single email variable. You may specify a single email address here or use the email property.
|
|
15157
|
+
* @type {Array<string>}
|
|
15158
|
+
* @memberof CustomerQuery
|
|
15159
|
+
*/
|
|
15160
|
+
emails?: Array<string>;
|
|
15155
15161
|
/**
|
|
15156
15162
|
* Last modified date end
|
|
15157
15163
|
* @type {string}
|
|
@@ -44973,6 +44979,24 @@ export declare const ChannelPartnerApiFetchParamCreator: (configuration?: Config
|
|
|
44973
44979
|
* @throws {RequiredError}
|
|
44974
44980
|
*/
|
|
44975
44981
|
estimateTaxForChannelPartnerOrder(channel_partner_order: ChannelPartnerOrder, options?: any): FetchArgs;
|
|
44982
|
+
/**
|
|
44983
|
+
* Retrieves a single order using the specified order id. Only orders belonging to this channel partner may be retrieved.
|
|
44984
|
+
* @summary Retrieve a channel partner order
|
|
44985
|
+
* @param {string} order_id The order id to retrieve.
|
|
44986
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.getOrder documentation for examples
|
|
44987
|
+
* @param {*} [options] Override http request option.
|
|
44988
|
+
* @throws {RequiredError}
|
|
44989
|
+
*/
|
|
44990
|
+
getChannelPartnerOrder(order_id: string, _expand?: string, options?: any): FetchArgs;
|
|
44991
|
+
/**
|
|
44992
|
+
* Retrieves a single order using the channel partner order id, not the ultracart order id. Only orders belonging to this channel partner may be retrieved.
|
|
44993
|
+
* @summary Retrieve a channel partner order by the channel partner order id
|
|
44994
|
+
* @param {string} order_id The channel partner order id to retrieve.
|
|
44995
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.getOrder documentation for examples
|
|
44996
|
+
* @param {*} [options] Override http request option.
|
|
44997
|
+
* @throws {RequiredError}
|
|
44998
|
+
*/
|
|
44999
|
+
getChannelPartnerOrderByChannelPartnerOrderId(order_id: string, _expand?: string, options?: any): FetchArgs;
|
|
44976
45000
|
/**
|
|
44977
45001
|
* Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
44978
45002
|
* @summary Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
@@ -45014,6 +45038,23 @@ export declare const ChannelPartnerApiFetchParamCreator: (configuration?: Config
|
|
|
45014
45038
|
* @throws {RequiredError}
|
|
45015
45039
|
*/
|
|
45016
45040
|
insertChannelPartnerShipToPreference(channel_partner_oid: number, ship_to_preference: ChannelPartnerShipToPreference, options?: any): FetchArgs;
|
|
45041
|
+
/**
|
|
45042
|
+
* Perform a refund operation on a channel partner order and then update the order if successful. All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded. UltraCart will calculate the actual amount to refund based upon the prior refunds.
|
|
45043
|
+
* @summary Refund a channel partner order
|
|
45044
|
+
* @param {Order} order Order to refund
|
|
45045
|
+
* @param {string} order_id The order id to refund.
|
|
45046
|
+
* @param {boolean} [reject_after_refund] Reject order after refund
|
|
45047
|
+
* @param {boolean} [skip_customer_notification] Skip customer email notification
|
|
45048
|
+
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
45049
|
+
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
45050
|
+
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
45051
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
45052
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
45053
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.refundOrder documentation for examples
|
|
45054
|
+
* @param {*} [options] Override http request option.
|
|
45055
|
+
* @throws {RequiredError}
|
|
45056
|
+
*/
|
|
45057
|
+
refundChannelPartnerOrder(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;
|
|
45017
45058
|
/**
|
|
45018
45059
|
* Update a ship to preference record for the channel partner.
|
|
45019
45060
|
* @summary Update a ship to preference record for the channel partner.
|
|
@@ -45071,6 +45112,24 @@ export declare const ChannelPartnerApiFp: (configuration?: Configuration) => {
|
|
|
45071
45112
|
* @throws {RequiredError}
|
|
45072
45113
|
*/
|
|
45073
45114
|
estimateTaxForChannelPartnerOrder(channel_partner_order: ChannelPartnerOrder, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ChannelPartnerEstimateTaxResponse>;
|
|
45115
|
+
/**
|
|
45116
|
+
* Retrieves a single order using the specified order id. Only orders belonging to this channel partner may be retrieved.
|
|
45117
|
+
* @summary Retrieve a channel partner order
|
|
45118
|
+
* @param {string} order_id The order id to retrieve.
|
|
45119
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.getOrder documentation for examples
|
|
45120
|
+
* @param {*} [options] Override http request option.
|
|
45121
|
+
* @throws {RequiredError}
|
|
45122
|
+
*/
|
|
45123
|
+
getChannelPartnerOrder(order_id: string, _expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrderResponse>;
|
|
45124
|
+
/**
|
|
45125
|
+
* Retrieves a single order using the channel partner order id, not the ultracart order id. Only orders belonging to this channel partner may be retrieved.
|
|
45126
|
+
* @summary Retrieve a channel partner order by the channel partner order id
|
|
45127
|
+
* @param {string} order_id The channel partner order id to retrieve.
|
|
45128
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.getOrder documentation for examples
|
|
45129
|
+
* @param {*} [options] Override http request option.
|
|
45130
|
+
* @throws {RequiredError}
|
|
45131
|
+
*/
|
|
45132
|
+
getChannelPartnerOrderByChannelPartnerOrderId(order_id: string, _expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrderResponse>;
|
|
45074
45133
|
/**
|
|
45075
45134
|
* Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
45076
45135
|
* @summary Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
@@ -45112,6 +45171,23 @@ export declare const ChannelPartnerApiFp: (configuration?: Configuration) => {
|
|
|
45112
45171
|
* @throws {RequiredError}
|
|
45113
45172
|
*/
|
|
45114
45173
|
insertChannelPartnerShipToPreference(channel_partner_oid: number, ship_to_preference: ChannelPartnerShipToPreference, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ChannelPartnerShipToPreferenceResponse>;
|
|
45174
|
+
/**
|
|
45175
|
+
* Perform a refund operation on a channel partner order and then update the order if successful. All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded. UltraCart will calculate the actual amount to refund based upon the prior refunds.
|
|
45176
|
+
* @summary Refund a channel partner order
|
|
45177
|
+
* @param {Order} order Order to refund
|
|
45178
|
+
* @param {string} order_id The order id to refund.
|
|
45179
|
+
* @param {boolean} [reject_after_refund] Reject order after refund
|
|
45180
|
+
* @param {boolean} [skip_customer_notification] Skip customer email notification
|
|
45181
|
+
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
45182
|
+
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
45183
|
+
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
45184
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
45185
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
45186
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.refundOrder documentation for examples
|
|
45187
|
+
* @param {*} [options] Override http request option.
|
|
45188
|
+
* @throws {RequiredError}
|
|
45189
|
+
*/
|
|
45190
|
+
refundChannelPartnerOrder(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>;
|
|
45115
45191
|
/**
|
|
45116
45192
|
* Update a ship to preference record for the channel partner.
|
|
45117
45193
|
* @summary Update a ship to preference record for the channel partner.
|
|
@@ -45169,6 +45245,24 @@ export declare const ChannelPartnerApiFactory: (configuration?: Configuration, f
|
|
|
45169
45245
|
* @throws {RequiredError}
|
|
45170
45246
|
*/
|
|
45171
45247
|
estimateTaxForChannelPartnerOrder(channel_partner_order: ChannelPartnerOrder, options?: any): Promise<ChannelPartnerEstimateTaxResponse>;
|
|
45248
|
+
/**
|
|
45249
|
+
* Retrieves a single order using the specified order id. Only orders belonging to this channel partner may be retrieved.
|
|
45250
|
+
* @summary Retrieve a channel partner order
|
|
45251
|
+
* @param {string} order_id The order id to retrieve.
|
|
45252
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.getOrder documentation for examples
|
|
45253
|
+
* @param {*} [options] Override http request option.
|
|
45254
|
+
* @throws {RequiredError}
|
|
45255
|
+
*/
|
|
45256
|
+
getChannelPartnerOrder(order_id: string, _expand?: string, options?: any): Promise<OrderResponse>;
|
|
45257
|
+
/**
|
|
45258
|
+
* Retrieves a single order using the channel partner order id, not the ultracart order id. Only orders belonging to this channel partner may be retrieved.
|
|
45259
|
+
* @summary Retrieve a channel partner order by the channel partner order id
|
|
45260
|
+
* @param {string} order_id The channel partner order id to retrieve.
|
|
45261
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.getOrder documentation for examples
|
|
45262
|
+
* @param {*} [options] Override http request option.
|
|
45263
|
+
* @throws {RequiredError}
|
|
45264
|
+
*/
|
|
45265
|
+
getChannelPartnerOrderByChannelPartnerOrderId(order_id: string, _expand?: string, options?: any): Promise<OrderResponse>;
|
|
45172
45266
|
/**
|
|
45173
45267
|
* Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
45174
45268
|
* @summary Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
@@ -45210,6 +45304,23 @@ export declare const ChannelPartnerApiFactory: (configuration?: Configuration, f
|
|
|
45210
45304
|
* @throws {RequiredError}
|
|
45211
45305
|
*/
|
|
45212
45306
|
insertChannelPartnerShipToPreference(channel_partner_oid: number, ship_to_preference: ChannelPartnerShipToPreference, options?: any): Promise<ChannelPartnerShipToPreferenceResponse>;
|
|
45307
|
+
/**
|
|
45308
|
+
* Perform a refund operation on a channel partner order and then update the order if successful. All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded. UltraCart will calculate the actual amount to refund based upon the prior refunds.
|
|
45309
|
+
* @summary Refund a channel partner order
|
|
45310
|
+
* @param {Order} order Order to refund
|
|
45311
|
+
* @param {string} order_id The order id to refund.
|
|
45312
|
+
* @param {boolean} [reject_after_refund] Reject order after refund
|
|
45313
|
+
* @param {boolean} [skip_customer_notification] Skip customer email notification
|
|
45314
|
+
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
45315
|
+
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
45316
|
+
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
45317
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
45318
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
45319
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.refundOrder documentation for examples
|
|
45320
|
+
* @param {*} [options] Override http request option.
|
|
45321
|
+
* @throws {RequiredError}
|
|
45322
|
+
*/
|
|
45323
|
+
refundChannelPartnerOrder(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>;
|
|
45213
45324
|
/**
|
|
45214
45325
|
* Update a ship to preference record for the channel partner.
|
|
45215
45326
|
* @summary Update a ship to preference record for the channel partner.
|
|
@@ -45273,6 +45384,26 @@ export interface ChannelPartnerApiInterface {
|
|
|
45273
45384
|
* @memberof ChannelPartnerApiInterface
|
|
45274
45385
|
*/
|
|
45275
45386
|
estimateTaxForChannelPartnerOrder(channel_partner_order: ChannelPartnerOrder, options?: any): Promise<ChannelPartnerEstimateTaxResponse>;
|
|
45387
|
+
/**
|
|
45388
|
+
* Retrieves a single order using the specified order id. Only orders belonging to this channel partner may be retrieved.
|
|
45389
|
+
* @summary Retrieve a channel partner order
|
|
45390
|
+
* @param {string} order_id The order id to retrieve.
|
|
45391
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.getOrder documentation for examples
|
|
45392
|
+
* @param {*} [options] Override http request option.
|
|
45393
|
+
* @throws {RequiredError}
|
|
45394
|
+
* @memberof ChannelPartnerApiInterface
|
|
45395
|
+
*/
|
|
45396
|
+
getChannelPartnerOrder(order_id: string, _expand?: string, options?: any): Promise<OrderResponse>;
|
|
45397
|
+
/**
|
|
45398
|
+
* Retrieves a single order using the channel partner order id, not the ultracart order id. Only orders belonging to this channel partner may be retrieved.
|
|
45399
|
+
* @summary Retrieve a channel partner order by the channel partner order id
|
|
45400
|
+
* @param {string} order_id The channel partner order id to retrieve.
|
|
45401
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.getOrder documentation for examples
|
|
45402
|
+
* @param {*} [options] Override http request option.
|
|
45403
|
+
* @throws {RequiredError}
|
|
45404
|
+
* @memberof ChannelPartnerApiInterface
|
|
45405
|
+
*/
|
|
45406
|
+
getChannelPartnerOrderByChannelPartnerOrderId(order_id: string, _expand?: string, options?: any): Promise<OrderResponse>;
|
|
45276
45407
|
/**
|
|
45277
45408
|
* Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
45278
45409
|
* @summary Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
@@ -45319,6 +45450,24 @@ export interface ChannelPartnerApiInterface {
|
|
|
45319
45450
|
* @memberof ChannelPartnerApiInterface
|
|
45320
45451
|
*/
|
|
45321
45452
|
insertChannelPartnerShipToPreference(channel_partner_oid: number, ship_to_preference: ChannelPartnerShipToPreference, options?: any): Promise<ChannelPartnerShipToPreferenceResponse>;
|
|
45453
|
+
/**
|
|
45454
|
+
* Perform a refund operation on a channel partner order and then update the order if successful. All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded. UltraCart will calculate the actual amount to refund based upon the prior refunds.
|
|
45455
|
+
* @summary Refund a channel partner order
|
|
45456
|
+
* @param {Order} order Order to refund
|
|
45457
|
+
* @param {string} order_id The order id to refund.
|
|
45458
|
+
* @param {boolean} [reject_after_refund] Reject order after refund
|
|
45459
|
+
* @param {boolean} [skip_customer_notification] Skip customer email notification
|
|
45460
|
+
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
45461
|
+
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
45462
|
+
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
45463
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
45464
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
45465
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.refundOrder documentation for examples
|
|
45466
|
+
* @param {*} [options] Override http request option.
|
|
45467
|
+
* @throws {RequiredError}
|
|
45468
|
+
* @memberof ChannelPartnerApiInterface
|
|
45469
|
+
*/
|
|
45470
|
+
refundChannelPartnerOrder(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>;
|
|
45322
45471
|
/**
|
|
45323
45472
|
* Update a ship to preference record for the channel partner.
|
|
45324
45473
|
* @summary Update a ship to preference record for the channel partner.
|
|
@@ -45384,6 +45533,26 @@ export declare class ChannelPartnerApi extends BaseAPI implements ChannelPartner
|
|
|
45384
45533
|
* @memberof ChannelPartnerApi
|
|
45385
45534
|
*/
|
|
45386
45535
|
estimateTaxForChannelPartnerOrder(channel_partner_order: ChannelPartnerOrder, options?: any): Promise<ChannelPartnerEstimateTaxResponse>;
|
|
45536
|
+
/**
|
|
45537
|
+
* Retrieves a single order using the specified order id. Only orders belonging to this channel partner may be retrieved.
|
|
45538
|
+
* @summary Retrieve a channel partner order
|
|
45539
|
+
* @param {string} order_id The order id to retrieve.
|
|
45540
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.getOrder documentation for examples
|
|
45541
|
+
* @param {*} [options] Override http request option.
|
|
45542
|
+
* @throws {RequiredError}
|
|
45543
|
+
* @memberof ChannelPartnerApi
|
|
45544
|
+
*/
|
|
45545
|
+
getChannelPartnerOrder(order_id: string, _expand?: string, options?: any): Promise<OrderResponse>;
|
|
45546
|
+
/**
|
|
45547
|
+
* Retrieves a single order using the channel partner order id, not the ultracart order id. Only orders belonging to this channel partner may be retrieved.
|
|
45548
|
+
* @summary Retrieve a channel partner order by the channel partner order id
|
|
45549
|
+
* @param {string} order_id The channel partner order id to retrieve.
|
|
45550
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.getOrder documentation for examples
|
|
45551
|
+
* @param {*} [options] Override http request option.
|
|
45552
|
+
* @throws {RequiredError}
|
|
45553
|
+
* @memberof ChannelPartnerApi
|
|
45554
|
+
*/
|
|
45555
|
+
getChannelPartnerOrderByChannelPartnerOrderId(order_id: string, _expand?: string, options?: any): Promise<OrderResponse>;
|
|
45387
45556
|
/**
|
|
45388
45557
|
* Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
45389
45558
|
* @summary Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
@@ -45430,6 +45599,24 @@ export declare class ChannelPartnerApi extends BaseAPI implements ChannelPartner
|
|
|
45430
45599
|
* @memberof ChannelPartnerApi
|
|
45431
45600
|
*/
|
|
45432
45601
|
insertChannelPartnerShipToPreference(channel_partner_oid: number, ship_to_preference: ChannelPartnerShipToPreference, options?: any): Promise<ChannelPartnerShipToPreferenceResponse>;
|
|
45602
|
+
/**
|
|
45603
|
+
* Perform a refund operation on a channel partner order and then update the order if successful. All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded. UltraCart will calculate the actual amount to refund based upon the prior refunds.
|
|
45604
|
+
* @summary Refund a channel partner order
|
|
45605
|
+
* @param {Order} order Order to refund
|
|
45606
|
+
* @param {string} order_id The order id to refund.
|
|
45607
|
+
* @param {boolean} [reject_after_refund] Reject order after refund
|
|
45608
|
+
* @param {boolean} [skip_customer_notification] Skip customer email notification
|
|
45609
|
+
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
45610
|
+
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
45611
|
+
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
45612
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
45613
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
45614
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.refundOrder documentation for examples
|
|
45615
|
+
* @param {*} [options] Override http request option.
|
|
45616
|
+
* @throws {RequiredError}
|
|
45617
|
+
* @memberof ChannelPartnerApi
|
|
45618
|
+
*/
|
|
45619
|
+
refundChannelPartnerOrder(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>;
|
|
45433
45620
|
/**
|
|
45434
45621
|
* Update a ship to preference record for the channel partner.
|
|
45435
45622
|
* @summary Update a ship to preference record for the channel partner.
|
package/dist/api.js
CHANGED
|
@@ -3589,6 +3589,106 @@ var ChannelPartnerApiFetchParamCreator = function (configuration) {
|
|
|
3589
3589
|
options: localVarRequestOptions,
|
|
3590
3590
|
};
|
|
3591
3591
|
},
|
|
3592
|
+
/**
|
|
3593
|
+
* Retrieves a single order using the specified order id. Only orders belonging to this channel partner may be retrieved.
|
|
3594
|
+
* @summary Retrieve a channel partner order
|
|
3595
|
+
* @param {string} order_id The order id to retrieve.
|
|
3596
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.getOrder documentation for examples
|
|
3597
|
+
* @param {*} [options] Override http request option.
|
|
3598
|
+
* @throws {RequiredError}
|
|
3599
|
+
*/
|
|
3600
|
+
getChannelPartnerOrder: function (order_id, _expand, options) {
|
|
3601
|
+
if (options === void 0) { options = {}; }
|
|
3602
|
+
// verify required parameter 'order_id' is not null or undefined
|
|
3603
|
+
if (order_id === null || order_id === undefined) {
|
|
3604
|
+
throw new RequiredError('order_id', 'Required parameter order_id was null or undefined when calling getChannelPartnerOrder.');
|
|
3605
|
+
}
|
|
3606
|
+
var localVarPath = "/channel_partner/orders/{order_id}"
|
|
3607
|
+
.replace("{".concat("order_id", "}"), encodeURIComponent(String(order_id)));
|
|
3608
|
+
var localVarUrlObj = url.parse(localVarPath, true);
|
|
3609
|
+
var localVarRequestOptions = Object.assign({ method: 'GET' }, options);
|
|
3610
|
+
var localVarHeaderParameter = {};
|
|
3611
|
+
var localVarQueryParameter = {};
|
|
3612
|
+
if (configuration && configuration.apiVersion) {
|
|
3613
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
3614
|
+
}
|
|
3615
|
+
// authentication ultraCartOauth required
|
|
3616
|
+
// oauth required
|
|
3617
|
+
if (configuration && configuration.accessToken) {
|
|
3618
|
+
var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
3619
|
+
? configuration.accessToken("ultraCartOauth", ["channel_partner_read"])
|
|
3620
|
+
: configuration.accessToken;
|
|
3621
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
3622
|
+
}
|
|
3623
|
+
// authentication ultraCartSimpleApiKey required
|
|
3624
|
+
if (configuration && configuration.apiKey) {
|
|
3625
|
+
var localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
3626
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
3627
|
+
: configuration.apiKey;
|
|
3628
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
3629
|
+
}
|
|
3630
|
+
if (_expand !== undefined) {
|
|
3631
|
+
localVarQueryParameter['_expand'] = _expand;
|
|
3632
|
+
}
|
|
3633
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
3634
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
3635
|
+
delete localVarUrlObj.search;
|
|
3636
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
3637
|
+
return {
|
|
3638
|
+
url: url.format(localVarUrlObj),
|
|
3639
|
+
options: localVarRequestOptions,
|
|
3640
|
+
};
|
|
3641
|
+
},
|
|
3642
|
+
/**
|
|
3643
|
+
* Retrieves a single order using the channel partner order id, not the ultracart order id. Only orders belonging to this channel partner may be retrieved.
|
|
3644
|
+
* @summary Retrieve a channel partner order by the channel partner order id
|
|
3645
|
+
* @param {string} order_id The channel partner order id to retrieve.
|
|
3646
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.getOrder documentation for examples
|
|
3647
|
+
* @param {*} [options] Override http request option.
|
|
3648
|
+
* @throws {RequiredError}
|
|
3649
|
+
*/
|
|
3650
|
+
getChannelPartnerOrderByChannelPartnerOrderId: function (order_id, _expand, options) {
|
|
3651
|
+
if (options === void 0) { options = {}; }
|
|
3652
|
+
// verify required parameter 'order_id' is not null or undefined
|
|
3653
|
+
if (order_id === null || order_id === undefined) {
|
|
3654
|
+
throw new RequiredError('order_id', 'Required parameter order_id was null or undefined when calling getChannelPartnerOrderByChannelPartnerOrderId.');
|
|
3655
|
+
}
|
|
3656
|
+
var localVarPath = "/channel_partner/orders/by_channel_partner_order_id/{order_id}"
|
|
3657
|
+
.replace("{".concat("order_id", "}"), encodeURIComponent(String(order_id)));
|
|
3658
|
+
var localVarUrlObj = url.parse(localVarPath, true);
|
|
3659
|
+
var localVarRequestOptions = Object.assign({ method: 'GET' }, options);
|
|
3660
|
+
var localVarHeaderParameter = {};
|
|
3661
|
+
var localVarQueryParameter = {};
|
|
3662
|
+
if (configuration && configuration.apiVersion) {
|
|
3663
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
3664
|
+
}
|
|
3665
|
+
// authentication ultraCartOauth required
|
|
3666
|
+
// oauth required
|
|
3667
|
+
if (configuration && configuration.accessToken) {
|
|
3668
|
+
var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
3669
|
+
? configuration.accessToken("ultraCartOauth", ["channel_partner_read"])
|
|
3670
|
+
: configuration.accessToken;
|
|
3671
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
3672
|
+
}
|
|
3673
|
+
// authentication ultraCartSimpleApiKey required
|
|
3674
|
+
if (configuration && configuration.apiKey) {
|
|
3675
|
+
var localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
3676
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
3677
|
+
: configuration.apiKey;
|
|
3678
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
3679
|
+
}
|
|
3680
|
+
if (_expand !== undefined) {
|
|
3681
|
+
localVarQueryParameter['_expand'] = _expand;
|
|
3682
|
+
}
|
|
3683
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
3684
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
3685
|
+
delete localVarUrlObj.search;
|
|
3686
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
3687
|
+
return {
|
|
3688
|
+
url: url.format(localVarUrlObj),
|
|
3689
|
+
options: localVarRequestOptions,
|
|
3690
|
+
};
|
|
3691
|
+
},
|
|
3592
3692
|
/**
|
|
3593
3693
|
* Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
3594
3694
|
* @summary Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
@@ -3829,6 +3929,92 @@ var ChannelPartnerApiFetchParamCreator = function (configuration) {
|
|
|
3829
3929
|
options: localVarRequestOptions,
|
|
3830
3930
|
};
|
|
3831
3931
|
},
|
|
3932
|
+
/**
|
|
3933
|
+
* Perform a refund operation on a channel partner order and then update the order if successful. All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded. UltraCart will calculate the actual amount to refund based upon the prior refunds.
|
|
3934
|
+
* @summary Refund a channel partner order
|
|
3935
|
+
* @param {Order} order Order to refund
|
|
3936
|
+
* @param {string} order_id The order id to refund.
|
|
3937
|
+
* @param {boolean} [reject_after_refund] Reject order after refund
|
|
3938
|
+
* @param {boolean} [skip_customer_notification] Skip customer email notification
|
|
3939
|
+
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
3940
|
+
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
3941
|
+
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
3942
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
3943
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
3944
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.refundOrder documentation for examples
|
|
3945
|
+
* @param {*} [options] Override http request option.
|
|
3946
|
+
* @throws {RequiredError}
|
|
3947
|
+
*/
|
|
3948
|
+
refundChannelPartnerOrder: 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) {
|
|
3949
|
+
if (options === void 0) { options = {}; }
|
|
3950
|
+
// verify required parameter 'order' is not null or undefined
|
|
3951
|
+
if (order === null || order === undefined) {
|
|
3952
|
+
throw new RequiredError('order', 'Required parameter order was null or undefined when calling refundChannelPartnerOrder.');
|
|
3953
|
+
}
|
|
3954
|
+
// verify required parameter 'order_id' is not null or undefined
|
|
3955
|
+
if (order_id === null || order_id === undefined) {
|
|
3956
|
+
throw new RequiredError('order_id', 'Required parameter order_id was null or undefined when calling refundChannelPartnerOrder.');
|
|
3957
|
+
}
|
|
3958
|
+
var localVarPath = "/channel_partner/orders/{order_id}/refund"
|
|
3959
|
+
.replace("{".concat("order_id", "}"), encodeURIComponent(String(order_id)));
|
|
3960
|
+
var localVarUrlObj = url.parse(localVarPath, true);
|
|
3961
|
+
var localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
|
|
3962
|
+
var localVarHeaderParameter = {};
|
|
3963
|
+
var localVarQueryParameter = {};
|
|
3964
|
+
if (configuration && configuration.apiVersion) {
|
|
3965
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
3966
|
+
}
|
|
3967
|
+
// authentication ultraCartOauth required
|
|
3968
|
+
// oauth required
|
|
3969
|
+
if (configuration && configuration.accessToken) {
|
|
3970
|
+
var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
3971
|
+
? configuration.accessToken("ultraCartOauth", ["channel_partner_write"])
|
|
3972
|
+
: configuration.accessToken;
|
|
3973
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
3974
|
+
}
|
|
3975
|
+
// authentication ultraCartSimpleApiKey required
|
|
3976
|
+
if (configuration && configuration.apiKey) {
|
|
3977
|
+
var localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
3978
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
3979
|
+
: configuration.apiKey;
|
|
3980
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
3981
|
+
}
|
|
3982
|
+
if (reject_after_refund !== undefined) {
|
|
3983
|
+
localVarQueryParameter['reject_after_refund'] = reject_after_refund;
|
|
3984
|
+
}
|
|
3985
|
+
if (skip_customer_notification !== undefined) {
|
|
3986
|
+
localVarQueryParameter['skip_customer_notification'] = skip_customer_notification;
|
|
3987
|
+
}
|
|
3988
|
+
if (auto_order_cancel !== undefined) {
|
|
3989
|
+
localVarQueryParameter['auto_order_cancel'] = auto_order_cancel;
|
|
3990
|
+
}
|
|
3991
|
+
if (manual_refund !== undefined) {
|
|
3992
|
+
localVarQueryParameter['manual_refund'] = manual_refund;
|
|
3993
|
+
}
|
|
3994
|
+
if (reverse_affiliate_transactions !== undefined) {
|
|
3995
|
+
localVarQueryParameter['reverse_affiliate_transactions'] = reverse_affiliate_transactions;
|
|
3996
|
+
}
|
|
3997
|
+
if (issue_store_credit !== undefined) {
|
|
3998
|
+
localVarQueryParameter['issue_store_credit'] = issue_store_credit;
|
|
3999
|
+
}
|
|
4000
|
+
if (auto_order_cancel_reason !== undefined) {
|
|
4001
|
+
localVarQueryParameter['auto_order_cancel_reason'] = auto_order_cancel_reason;
|
|
4002
|
+
}
|
|
4003
|
+
if (_expand !== undefined) {
|
|
4004
|
+
localVarQueryParameter['_expand'] = _expand;
|
|
4005
|
+
}
|
|
4006
|
+
localVarHeaderParameter['Content-Type'] = 'application/json; charset=UTF-8';
|
|
4007
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
4008
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
4009
|
+
delete localVarUrlObj.search;
|
|
4010
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
4011
|
+
var needsSerialization = ("Order" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
|
|
4012
|
+
localVarRequestOptions.body = needsSerialization ? JSON.stringify(order || {}) : (order || "");
|
|
4013
|
+
return {
|
|
4014
|
+
url: url.format(localVarUrlObj),
|
|
4015
|
+
options: localVarRequestOptions,
|
|
4016
|
+
};
|
|
4017
|
+
},
|
|
3832
4018
|
/**
|
|
3833
4019
|
* Update a ship to preference record for the channel partner.
|
|
3834
4020
|
* @summary Update a ship to preference record for the channel partner.
|
|
@@ -4009,6 +4195,52 @@ var ChannelPartnerApiFp = function (configuration) {
|
|
|
4009
4195
|
});
|
|
4010
4196
|
};
|
|
4011
4197
|
},
|
|
4198
|
+
/**
|
|
4199
|
+
* Retrieves a single order using the specified order id. Only orders belonging to this channel partner may be retrieved.
|
|
4200
|
+
* @summary Retrieve a channel partner order
|
|
4201
|
+
* @param {string} order_id The order id to retrieve.
|
|
4202
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.getOrder documentation for examples
|
|
4203
|
+
* @param {*} [options] Override http request option.
|
|
4204
|
+
* @throws {RequiredError}
|
|
4205
|
+
*/
|
|
4206
|
+
getChannelPartnerOrder: function (order_id, _expand, options) {
|
|
4207
|
+
var localVarFetchArgs = (0, exports.ChannelPartnerApiFetchParamCreator)(configuration).getChannelPartnerOrder(order_id, _expand, options);
|
|
4208
|
+
return function (fetch, basePath) {
|
|
4209
|
+
if (fetch === void 0) { fetch = portableFetch; }
|
|
4210
|
+
if (basePath === void 0) { basePath = BASE_PATH; }
|
|
4211
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
|
|
4212
|
+
if (response.status >= 200 && response.status < 300) {
|
|
4213
|
+
return response.json();
|
|
4214
|
+
}
|
|
4215
|
+
else {
|
|
4216
|
+
throw response;
|
|
4217
|
+
}
|
|
4218
|
+
});
|
|
4219
|
+
};
|
|
4220
|
+
},
|
|
4221
|
+
/**
|
|
4222
|
+
* Retrieves a single order using the channel partner order id, not the ultracart order id. Only orders belonging to this channel partner may be retrieved.
|
|
4223
|
+
* @summary Retrieve a channel partner order by the channel partner order id
|
|
4224
|
+
* @param {string} order_id The channel partner order id to retrieve.
|
|
4225
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.getOrder documentation for examples
|
|
4226
|
+
* @param {*} [options] Override http request option.
|
|
4227
|
+
* @throws {RequiredError}
|
|
4228
|
+
*/
|
|
4229
|
+
getChannelPartnerOrderByChannelPartnerOrderId: function (order_id, _expand, options) {
|
|
4230
|
+
var localVarFetchArgs = (0, exports.ChannelPartnerApiFetchParamCreator)(configuration).getChannelPartnerOrderByChannelPartnerOrderId(order_id, _expand, options);
|
|
4231
|
+
return function (fetch, basePath) {
|
|
4232
|
+
if (fetch === void 0) { fetch = portableFetch; }
|
|
4233
|
+
if (basePath === void 0) { basePath = BASE_PATH; }
|
|
4234
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
|
|
4235
|
+
if (response.status >= 200 && response.status < 300) {
|
|
4236
|
+
return response.json();
|
|
4237
|
+
}
|
|
4238
|
+
else {
|
|
4239
|
+
throw response;
|
|
4240
|
+
}
|
|
4241
|
+
});
|
|
4242
|
+
};
|
|
4243
|
+
},
|
|
4012
4244
|
/**
|
|
4013
4245
|
* Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
4014
4246
|
* @summary Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
@@ -4120,6 +4352,37 @@ var ChannelPartnerApiFp = function (configuration) {
|
|
|
4120
4352
|
});
|
|
4121
4353
|
};
|
|
4122
4354
|
},
|
|
4355
|
+
/**
|
|
4356
|
+
* Perform a refund operation on a channel partner order and then update the order if successful. All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded. UltraCart will calculate the actual amount to refund based upon the prior refunds.
|
|
4357
|
+
* @summary Refund a channel partner order
|
|
4358
|
+
* @param {Order} order Order to refund
|
|
4359
|
+
* @param {string} order_id The order id to refund.
|
|
4360
|
+
* @param {boolean} [reject_after_refund] Reject order after refund
|
|
4361
|
+
* @param {boolean} [skip_customer_notification] Skip customer email notification
|
|
4362
|
+
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
4363
|
+
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
4364
|
+
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
4365
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
4366
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
4367
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.refundOrder documentation for examples
|
|
4368
|
+
* @param {*} [options] Override http request option.
|
|
4369
|
+
* @throws {RequiredError}
|
|
4370
|
+
*/
|
|
4371
|
+
refundChannelPartnerOrder: 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) {
|
|
4372
|
+
var localVarFetchArgs = (0, exports.ChannelPartnerApiFetchParamCreator)(configuration).refundChannelPartnerOrder(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);
|
|
4373
|
+
return function (fetch, basePath) {
|
|
4374
|
+
if (fetch === void 0) { fetch = portableFetch; }
|
|
4375
|
+
if (basePath === void 0) { basePath = BASE_PATH; }
|
|
4376
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
|
|
4377
|
+
if (response.status >= 200 && response.status < 300) {
|
|
4378
|
+
return response.json();
|
|
4379
|
+
}
|
|
4380
|
+
else {
|
|
4381
|
+
throw response;
|
|
4382
|
+
}
|
|
4383
|
+
});
|
|
4384
|
+
};
|
|
4385
|
+
},
|
|
4123
4386
|
/**
|
|
4124
4387
|
* Update a ship to preference record for the channel partner.
|
|
4125
4388
|
* @summary Update a ship to preference record for the channel partner.
|
|
@@ -4204,6 +4467,28 @@ var ChannelPartnerApiFactory = function (configuration, fetch, basePath) {
|
|
|
4204
4467
|
estimateTaxForChannelPartnerOrder: function (channel_partner_order, options) {
|
|
4205
4468
|
return (0, exports.ChannelPartnerApiFp)(configuration).estimateTaxForChannelPartnerOrder(channel_partner_order, options)(fetch, basePath);
|
|
4206
4469
|
},
|
|
4470
|
+
/**
|
|
4471
|
+
* Retrieves a single order using the specified order id. Only orders belonging to this channel partner may be retrieved.
|
|
4472
|
+
* @summary Retrieve a channel partner order
|
|
4473
|
+
* @param {string} order_id The order id to retrieve.
|
|
4474
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.getOrder documentation for examples
|
|
4475
|
+
* @param {*} [options] Override http request option.
|
|
4476
|
+
* @throws {RequiredError}
|
|
4477
|
+
*/
|
|
4478
|
+
getChannelPartnerOrder: function (order_id, _expand, options) {
|
|
4479
|
+
return (0, exports.ChannelPartnerApiFp)(configuration).getChannelPartnerOrder(order_id, _expand, options)(fetch, basePath);
|
|
4480
|
+
},
|
|
4481
|
+
/**
|
|
4482
|
+
* Retrieves a single order using the channel partner order id, not the ultracart order id. Only orders belonging to this channel partner may be retrieved.
|
|
4483
|
+
* @summary Retrieve a channel partner order by the channel partner order id
|
|
4484
|
+
* @param {string} order_id The channel partner order id to retrieve.
|
|
4485
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.getOrder documentation for examples
|
|
4486
|
+
* @param {*} [options] Override http request option.
|
|
4487
|
+
* @throws {RequiredError}
|
|
4488
|
+
*/
|
|
4489
|
+
getChannelPartnerOrderByChannelPartnerOrderId: function (order_id, _expand, options) {
|
|
4490
|
+
return (0, exports.ChannelPartnerApiFp)(configuration).getChannelPartnerOrderByChannelPartnerOrderId(order_id, _expand, options)(fetch, basePath);
|
|
4491
|
+
},
|
|
4207
4492
|
/**
|
|
4208
4493
|
* Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
4209
4494
|
* @summary Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
@@ -4255,6 +4540,25 @@ var ChannelPartnerApiFactory = function (configuration, fetch, basePath) {
|
|
|
4255
4540
|
insertChannelPartnerShipToPreference: function (channel_partner_oid, ship_to_preference, options) {
|
|
4256
4541
|
return (0, exports.ChannelPartnerApiFp)(configuration).insertChannelPartnerShipToPreference(channel_partner_oid, ship_to_preference, options)(fetch, basePath);
|
|
4257
4542
|
},
|
|
4543
|
+
/**
|
|
4544
|
+
* Perform a refund operation on a channel partner order and then update the order if successful. All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded. UltraCart will calculate the actual amount to refund based upon the prior refunds.
|
|
4545
|
+
* @summary Refund a channel partner order
|
|
4546
|
+
* @param {Order} order Order to refund
|
|
4547
|
+
* @param {string} order_id The order id to refund.
|
|
4548
|
+
* @param {boolean} [reject_after_refund] Reject order after refund
|
|
4549
|
+
* @param {boolean} [skip_customer_notification] Skip customer email notification
|
|
4550
|
+
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
4551
|
+
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
4552
|
+
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
4553
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
4554
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
4555
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.refundOrder documentation for examples
|
|
4556
|
+
* @param {*} [options] Override http request option.
|
|
4557
|
+
* @throws {RequiredError}
|
|
4558
|
+
*/
|
|
4559
|
+
refundChannelPartnerOrder: 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) {
|
|
4560
|
+
return (0, exports.ChannelPartnerApiFp)(configuration).refundChannelPartnerOrder(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);
|
|
4561
|
+
},
|
|
4258
4562
|
/**
|
|
4259
4563
|
* Update a ship to preference record for the channel partner.
|
|
4260
4564
|
* @summary Update a ship to preference record for the channel partner.
|
|
@@ -4337,6 +4641,30 @@ var ChannelPartnerApi = /** @class */ (function (_super) {
|
|
|
4337
4641
|
ChannelPartnerApi.prototype.estimateTaxForChannelPartnerOrder = function (channel_partner_order, options) {
|
|
4338
4642
|
return (0, exports.ChannelPartnerApiFp)(this.configuration).estimateTaxForChannelPartnerOrder(channel_partner_order, options)(this.fetch, this.basePath);
|
|
4339
4643
|
};
|
|
4644
|
+
/**
|
|
4645
|
+
* Retrieves a single order using the specified order id. Only orders belonging to this channel partner may be retrieved.
|
|
4646
|
+
* @summary Retrieve a channel partner order
|
|
4647
|
+
* @param {string} order_id The order id to retrieve.
|
|
4648
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.getOrder documentation for examples
|
|
4649
|
+
* @param {*} [options] Override http request option.
|
|
4650
|
+
* @throws {RequiredError}
|
|
4651
|
+
* @memberof ChannelPartnerApi
|
|
4652
|
+
*/
|
|
4653
|
+
ChannelPartnerApi.prototype.getChannelPartnerOrder = function (order_id, _expand, options) {
|
|
4654
|
+
return (0, exports.ChannelPartnerApiFp)(this.configuration).getChannelPartnerOrder(order_id, _expand, options)(this.fetch, this.basePath);
|
|
4655
|
+
};
|
|
4656
|
+
/**
|
|
4657
|
+
* Retrieves a single order using the channel partner order id, not the ultracart order id. Only orders belonging to this channel partner may be retrieved.
|
|
4658
|
+
* @summary Retrieve a channel partner order by the channel partner order id
|
|
4659
|
+
* @param {string} order_id The channel partner order id to retrieve.
|
|
4660
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.getOrder documentation for examples
|
|
4661
|
+
* @param {*} [options] Override http request option.
|
|
4662
|
+
* @throws {RequiredError}
|
|
4663
|
+
* @memberof ChannelPartnerApi
|
|
4664
|
+
*/
|
|
4665
|
+
ChannelPartnerApi.prototype.getChannelPartnerOrderByChannelPartnerOrderId = function (order_id, _expand, options) {
|
|
4666
|
+
return (0, exports.ChannelPartnerApiFp)(this.configuration).getChannelPartnerOrderByChannelPartnerOrderId(order_id, _expand, options)(this.fetch, this.basePath);
|
|
4667
|
+
};
|
|
4340
4668
|
/**
|
|
4341
4669
|
* Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
4342
4670
|
* @summary Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
@@ -4393,6 +4721,26 @@ var ChannelPartnerApi = /** @class */ (function (_super) {
|
|
|
4393
4721
|
ChannelPartnerApi.prototype.insertChannelPartnerShipToPreference = function (channel_partner_oid, ship_to_preference, options) {
|
|
4394
4722
|
return (0, exports.ChannelPartnerApiFp)(this.configuration).insertChannelPartnerShipToPreference(channel_partner_oid, ship_to_preference, options)(this.fetch, this.basePath);
|
|
4395
4723
|
};
|
|
4724
|
+
/**
|
|
4725
|
+
* Perform a refund operation on a channel partner order and then update the order if successful. All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded. UltraCart will calculate the actual amount to refund based upon the prior refunds.
|
|
4726
|
+
* @summary Refund a channel partner order
|
|
4727
|
+
* @param {Order} order Order to refund
|
|
4728
|
+
* @param {string} order_id The order id to refund.
|
|
4729
|
+
* @param {boolean} [reject_after_refund] Reject order after refund
|
|
4730
|
+
* @param {boolean} [skip_customer_notification] Skip customer email notification
|
|
4731
|
+
* @param {boolean} [auto_order_cancel] Cancel associated auto orders
|
|
4732
|
+
* @param {boolean} [manual_refund] Consider a manual refund done externally
|
|
4733
|
+
* @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
|
|
4734
|
+
* @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
|
4735
|
+
* @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
|
|
4736
|
+
* @param {string} [_expand] The object expansion to perform on the result. See OrderApi.refundOrder documentation for examples
|
|
4737
|
+
* @param {*} [options] Override http request option.
|
|
4738
|
+
* @throws {RequiredError}
|
|
4739
|
+
* @memberof ChannelPartnerApi
|
|
4740
|
+
*/
|
|
4741
|
+
ChannelPartnerApi.prototype.refundChannelPartnerOrder = 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) {
|
|
4742
|
+
return (0, exports.ChannelPartnerApiFp)(this.configuration).refundChannelPartnerOrder(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);
|
|
4743
|
+
};
|
|
4396
4744
|
/**
|
|
4397
4745
|
* Update a ship to preference record for the channel partner.
|
|
4398
4746
|
* @summary Update a ship to preference record for the channel partner.
|