ultracart_rest_api_v2_typescript 3.11.4 → 3.11.6

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 CHANGED
@@ -1,4 +1,4 @@
1
- ## ultracart_rest_api_v2_typescript@3.11.4
1
+ ## ultracart_rest_api_v2_typescript@3.11.6
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.4 --save
39
+ npm install ultracart_rest_api_v2_typescript@3.11.6 --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.6 | 04/16/2025 | added channel partner order item properties |
58
+ | 3.11.5 | 03/28/2025 | added paypal fastlane constants for payments |
57
59
  | 3.11.4 | 03/07/2025 | updated github readme.md |
58
60
  | 3.11.3 | 03/07/2025 | updated github readme.md files |
59
61
  | 3.11.2 | 03/05/2025 | added ChannelPartnerOrder.use_prior_payment_information_from_order_id |
package/api.ts CHANGED
@@ -6167,7 +6167,8 @@ export namespace ChannelPartnerOrder {
6167
6167
  PayPal = <any> 'PayPal',
6168
6168
  PurchaseOrder = <any> 'Purchase Order',
6169
6169
  QuoteRequest = <any> 'Quote Request',
6170
- WireTransfer = <any> 'Wire Transfer'
6170
+ WireTransfer = <any> 'Wire Transfer',
6171
+ PayPalFastlane = <any> 'PayPal Fastlane'
6171
6172
  }
6172
6173
  }
6173
6174
 
@@ -6207,6 +6208,12 @@ export interface ChannelPartnerOrderItem {
6207
6208
  * @memberof ChannelPartnerOrderItem
6208
6209
  */
6209
6210
  options?: Array<ChannelPartnerOrderItemOption>;
6211
+ /**
6212
+ * Properties
6213
+ * @type {Array<ChannelPartnerOrderItemProperty>}
6214
+ * @memberof ChannelPartnerOrderItem
6215
+ */
6216
+ properties?: Array<ChannelPartnerOrderItemProperty>;
6210
6217
  /**
6211
6218
  * Quantity
6212
6219
  * @type {number}
@@ -6270,6 +6277,38 @@ export interface ChannelPartnerOrderItemOption {
6270
6277
  value?: string;
6271
6278
  }
6272
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
+
6273
6312
  /**
6274
6313
  *
6275
6314
  * @export
@@ -34405,7 +34444,8 @@ export namespace OrderPayment {
34405
34444
  Venmo = <any> 'Venmo',
34406
34445
  ApplePay = <any> 'Apple Pay',
34407
34446
  GooglePay = <any> 'Google Pay',
34408
- HealthBenefitCard = <any> 'Health Benefit Card'
34447
+ HealthBenefitCard = <any> 'Health Benefit Card',
34448
+ PayPalFastlane = <any> 'PayPal Fastlane'
34409
34449
  }
34410
34450
  /**
34411
34451
  * @export
@@ -35272,7 +35312,8 @@ export namespace OrderQuery {
35272
35312
  WireTransfer = <any> 'Wire Transfer',
35273
35313
  Venmo = <any> 'Venmo',
35274
35314
  ApplePay = <any> 'Apple Pay',
35275
- GooglePay = <any> ' Google Pay'
35315
+ GooglePay = <any> ' Google Pay',
35316
+ PayPalFastlane = <any> 'PayPal Fastlane'
35276
35317
  }
35277
35318
  /**
35278
35319
  * @export
@@ -74056,6 +74097,103 @@ export const OrderApiFetchParamCreator = function (configuration?: Configuration
74056
74097
  options: localVarRequestOptions,
74057
74098
  };
74058
74099
  },
74100
+ /**
74101
+ * Perform a refund operation on an order and then update the order if successful.
74102
+ * @summary Refund an order completely
74103
+ * @param {string} order_id The order id to refund.
74104
+ * @param {boolean} [reject_after_refund] Reject order after refund
74105
+ * @param {boolean} [skip_customer_notification] Skip customer email notification
74106
+ * @param {boolean} [auto_order_cancel] Cancel associated auto orders
74107
+ * @param {boolean} [manual_refund] Consider a manual refund done externally
74108
+ * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
74109
+ * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
74110
+ * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
74111
+ * @param {string} [refund_reason] Reason for refund
74112
+ * @param {string} [reject_reason] Reason for reject
74113
+ * @param {*} [options] Override http request option.
74114
+ * @throws {RequiredError}
74115
+ */
74116
+ 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 {
74117
+ // verify required parameter 'order_id' is not null or undefined
74118
+ if (order_id === null || order_id === undefined) {
74119
+ throw new RequiredError('order_id','Required parameter order_id was null or undefined when calling refundOrderCompletely.');
74120
+ }
74121
+ const localVarPath = `/order/orders/{order_id}/refund_completely`
74122
+ .replace(`{${"order_id"}}`, encodeURIComponent(String(order_id)));
74123
+ const localVarUrlObj = url.parse(localVarPath, true);
74124
+ const localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
74125
+ const localVarHeaderParameter = {} as any;
74126
+ const localVarQueryParameter = {} as any;
74127
+
74128
+ if(configuration && configuration.apiVersion) {
74129
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
74130
+ }
74131
+
74132
+
74133
+
74134
+ // authentication ultraCartOauth required
74135
+ // oauth required
74136
+ if (configuration && configuration.accessToken) {
74137
+ const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
74138
+ ? configuration.accessToken("ultraCartOauth", ["order_write"])
74139
+ : configuration.accessToken;
74140
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
74141
+ }
74142
+
74143
+ // authentication ultraCartSimpleApiKey required
74144
+ if (configuration && configuration.apiKey) {
74145
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
74146
+ ? configuration.apiKey("x-ultracart-simple-key")
74147
+ : configuration.apiKey;
74148
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
74149
+ }
74150
+
74151
+ if (reject_after_refund !== undefined) {
74152
+ localVarQueryParameter['reject_after_refund'] = reject_after_refund;
74153
+ }
74154
+
74155
+ if (skip_customer_notification !== undefined) {
74156
+ localVarQueryParameter['skip_customer_notification'] = skip_customer_notification;
74157
+ }
74158
+
74159
+ if (auto_order_cancel !== undefined) {
74160
+ localVarQueryParameter['auto_order_cancel'] = auto_order_cancel;
74161
+ }
74162
+
74163
+ if (manual_refund !== undefined) {
74164
+ localVarQueryParameter['manual_refund'] = manual_refund;
74165
+ }
74166
+
74167
+ if (reverse_affiliate_transactions !== undefined) {
74168
+ localVarQueryParameter['reverse_affiliate_transactions'] = reverse_affiliate_transactions;
74169
+ }
74170
+
74171
+ if (issue_store_credit !== undefined) {
74172
+ localVarQueryParameter['issue_store_credit'] = issue_store_credit;
74173
+ }
74174
+
74175
+ if (auto_order_cancel_reason !== undefined) {
74176
+ localVarQueryParameter['auto_order_cancel_reason'] = auto_order_cancel_reason;
74177
+ }
74178
+
74179
+ if (refund_reason !== undefined) {
74180
+ localVarQueryParameter['refund_reason'] = refund_reason;
74181
+ }
74182
+
74183
+ if (reject_reason !== undefined) {
74184
+ localVarQueryParameter['reject_reason'] = reject_reason;
74185
+ }
74186
+
74187
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
74188
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
74189
+ delete localVarUrlObj.search;
74190
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
74191
+
74192
+ return {
74193
+ url: url.format(localVarUrlObj),
74194
+ options: localVarRequestOptions,
74195
+ };
74196
+ },
74059
74197
  /**
74060
74198
  * Create a replacement order based upon a previous order
74061
74199
  * @summary Replacement order
@@ -74901,6 +75039,36 @@ export const OrderApiFp = function(configuration?: Configuration) {
74901
75039
  });
74902
75040
  };
74903
75041
  },
75042
+ /**
75043
+ * Perform a refund operation on an order and then update the order if successful.
75044
+ * @summary Refund an order completely
75045
+ * @param {string} order_id The order id to refund.
75046
+ * @param {boolean} [reject_after_refund] Reject order after refund
75047
+ * @param {boolean} [skip_customer_notification] Skip customer email notification
75048
+ * @param {boolean} [auto_order_cancel] Cancel associated auto orders
75049
+ * @param {boolean} [manual_refund] Consider a manual refund done externally
75050
+ * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
75051
+ * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
75052
+ * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
75053
+ * @param {string} [refund_reason] Reason for refund
75054
+ * @param {string} [reject_reason] Reason for reject
75055
+ * @param {*} [options] Override http request option.
75056
+ * @throws {RequiredError}
75057
+ */
75058
+ 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> {
75059
+ 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);
75060
+ return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
75061
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
75062
+
75063
+ if (response.status >= 200 && response.status < 300) {
75064
+ return response.json();
75065
+
75066
+ } else {
75067
+ throw response;
75068
+ }
75069
+ });
75070
+ };
75071
+ },
74904
75072
  /**
74905
75073
  * Create a replacement order based upon a previous order
74906
75074
  * @summary Replacement order
@@ -75303,6 +75471,25 @@ export const OrderApiFactory = function (configuration?: Configuration, fetch?:
75303
75471
  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) {
75304
75472
  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);
75305
75473
  },
75474
+ /**
75475
+ * Perform a refund operation on an order and then update the order if successful.
75476
+ * @summary Refund an order completely
75477
+ * @param {string} order_id The order id to refund.
75478
+ * @param {boolean} [reject_after_refund] Reject order after refund
75479
+ * @param {boolean} [skip_customer_notification] Skip customer email notification
75480
+ * @param {boolean} [auto_order_cancel] Cancel associated auto orders
75481
+ * @param {boolean} [manual_refund] Consider a manual refund done externally
75482
+ * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
75483
+ * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
75484
+ * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
75485
+ * @param {string} [refund_reason] Reason for refund
75486
+ * @param {string} [reject_reason] Reason for reject
75487
+ * @param {*} [options] Override http request option.
75488
+ * @throws {RequiredError}
75489
+ */
75490
+ 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) {
75491
+ 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);
75492
+ },
75306
75493
  /**
75307
75494
  * Create a replacement order based upon a previous order
75308
75495
  * @summary Replacement order
@@ -75639,6 +75826,25 @@ export interface OrderApiInterface {
75639
75826
  */
75640
75827
  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>;
75641
75828
 
75829
+ /**
75830
+ * Perform a refund operation on an order and then update the order if successful.
75831
+ * @summary Refund an order completely
75832
+ * @param {string} order_id The order id to refund.
75833
+ * @param {boolean} [reject_after_refund] Reject order after refund
75834
+ * @param {boolean} [skip_customer_notification] Skip customer email notification
75835
+ * @param {boolean} [auto_order_cancel] Cancel associated auto orders
75836
+ * @param {boolean} [manual_refund] Consider a manual refund done externally
75837
+ * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
75838
+ * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
75839
+ * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
75840
+ * @param {string} [refund_reason] Reason for refund
75841
+ * @param {string} [reject_reason] Reason for reject
75842
+ * @param {*} [options] Override http request option.
75843
+ * @throws {RequiredError}
75844
+ * @memberof OrderApiInterface
75845
+ */
75846
+ 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>;
75847
+
75642
75848
  /**
75643
75849
  * Create a replacement order based upon a previous order
75644
75850
  * @summary Replacement order
@@ -76017,6 +76223,27 @@ export class OrderApi extends BaseAPI implements OrderApiInterface {
76017
76223
  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);
76018
76224
  }
76019
76225
 
76226
+ /**
76227
+ * Perform a refund operation on an order and then update the order if successful.
76228
+ * @summary Refund an order completely
76229
+ * @param {string} order_id The order id to refund.
76230
+ * @param {boolean} [reject_after_refund] Reject order after refund
76231
+ * @param {boolean} [skip_customer_notification] Skip customer email notification
76232
+ * @param {boolean} [auto_order_cancel] Cancel associated auto orders
76233
+ * @param {boolean} [manual_refund] Consider a manual refund done externally
76234
+ * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
76235
+ * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
76236
+ * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
76237
+ * @param {string} [refund_reason] Reason for refund
76238
+ * @param {string} [reject_reason] Reason for reject
76239
+ * @param {*} [options] Override http request option.
76240
+ * @throws {RequiredError}
76241
+ * @memberof OrderApi
76242
+ */
76243
+ 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) {
76244
+ 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);
76245
+ }
76246
+
76020
76247
  /**
76021
76248
  * Create a replacement order based upon a previous order
76022
76249
  * @summary Replacement order
package/dist/api.d.ts CHANGED
@@ -6031,7 +6031,8 @@ export declare namespace ChannelPartnerOrder {
6031
6031
  PayPal,
6032
6032
  PurchaseOrder,
6033
6033
  QuoteRequest,
6034
- WireTransfer
6034
+ WireTransfer,
6035
+ PayPalFastlane
6035
6036
  }
6036
6037
  }
6037
6038
  /**
@@ -6070,6 +6071,12 @@ export interface ChannelPartnerOrderItem {
6070
6071
  * @memberof ChannelPartnerOrderItem
6071
6072
  */
6072
6073
  options?: Array<ChannelPartnerOrderItemOption>;
6074
+ /**
6075
+ * Properties
6076
+ * @type {Array<ChannelPartnerOrderItemProperty>}
6077
+ * @memberof ChannelPartnerOrderItem
6078
+ */
6079
+ properties?: Array<ChannelPartnerOrderItemProperty>;
6073
6080
  /**
6074
6081
  * Quantity
6075
6082
  * @type {number}
@@ -6130,6 +6137,37 @@ export interface ChannelPartnerOrderItemOption {
6130
6137
  */
6131
6138
  value?: string;
6132
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
+ }
6133
6171
  /**
6134
6172
  *
6135
6173
  * @export
@@ -33686,7 +33724,8 @@ export declare namespace OrderPayment {
33686
33724
  Venmo,
33687
33725
  ApplePay,
33688
33726
  GooglePay,
33689
- HealthBenefitCard
33727
+ HealthBenefitCard,
33728
+ PayPalFastlane
33690
33729
  }
33691
33730
  /**
33692
33731
  * @export
@@ -34534,7 +34573,8 @@ export declare namespace OrderQuery {
34534
34573
  WireTransfer,
34535
34574
  Venmo,
34536
34575
  ApplePay,
34537
- GooglePay
34576
+ GooglePay,
34577
+ PayPalFastlane
34538
34578
  }
34539
34579
  /**
34540
34580
  * @export
@@ -55811,6 +55851,23 @@ export declare const OrderApiFetchParamCreator: (configuration?: Configuration)
55811
55851
  * @throws {RequiredError}
55812
55852
  */
55813
55853
  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;
55854
+ /**
55855
+ * Perform a refund operation on an order and then update the order if successful.
55856
+ * @summary Refund an order completely
55857
+ * @param {string} order_id The order id to refund.
55858
+ * @param {boolean} [reject_after_refund] Reject order after refund
55859
+ * @param {boolean} [skip_customer_notification] Skip customer email notification
55860
+ * @param {boolean} [auto_order_cancel] Cancel associated auto orders
55861
+ * @param {boolean} [manual_refund] Consider a manual refund done externally
55862
+ * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
55863
+ * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
55864
+ * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
55865
+ * @param {string} [refund_reason] Reason for refund
55866
+ * @param {string} [reject_reason] Reason for reject
55867
+ * @param {*} [options] Override http request option.
55868
+ * @throws {RequiredError}
55869
+ */
55870
+ 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;
55814
55871
  /**
55815
55872
  * Create a replacement order based upon a previous order
55816
55873
  * @summary Replacement order
@@ -56090,6 +56147,23 @@ export declare const OrderApiFp: (configuration?: Configuration) => {
56090
56147
  * @throws {RequiredError}
56091
56148
  */
56092
56149
  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>;
56150
+ /**
56151
+ * Perform a refund operation on an order and then update the order if successful.
56152
+ * @summary Refund an order completely
56153
+ * @param {string} order_id The order id to refund.
56154
+ * @param {boolean} [reject_after_refund] Reject order after refund
56155
+ * @param {boolean} [skip_customer_notification] Skip customer email notification
56156
+ * @param {boolean} [auto_order_cancel] Cancel associated auto orders
56157
+ * @param {boolean} [manual_refund] Consider a manual refund done externally
56158
+ * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
56159
+ * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
56160
+ * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
56161
+ * @param {string} [refund_reason] Reason for refund
56162
+ * @param {string} [reject_reason] Reason for reject
56163
+ * @param {*} [options] Override http request option.
56164
+ * @throws {RequiredError}
56165
+ */
56166
+ 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>;
56093
56167
  /**
56094
56168
  * Create a replacement order based upon a previous order
56095
56169
  * @summary Replacement order
@@ -56369,6 +56443,23 @@ export declare const OrderApiFactory: (configuration?: Configuration, fetch?: Fe
56369
56443
  * @throws {RequiredError}
56370
56444
  */
56371
56445
  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>;
56446
+ /**
56447
+ * Perform a refund operation on an order and then update the order if successful.
56448
+ * @summary Refund an order completely
56449
+ * @param {string} order_id The order id to refund.
56450
+ * @param {boolean} [reject_after_refund] Reject order after refund
56451
+ * @param {boolean} [skip_customer_notification] Skip customer email notification
56452
+ * @param {boolean} [auto_order_cancel] Cancel associated auto orders
56453
+ * @param {boolean} [manual_refund] Consider a manual refund done externally
56454
+ * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
56455
+ * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
56456
+ * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
56457
+ * @param {string} [refund_reason] Reason for refund
56458
+ * @param {string} [reject_reason] Reason for reject
56459
+ * @param {*} [options] Override http request option.
56460
+ * @throws {RequiredError}
56461
+ */
56462
+ 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>;
56372
56463
  /**
56373
56464
  * Create a replacement order based upon a previous order
56374
56465
  * @summary Replacement order
@@ -56670,6 +56761,24 @@ export interface OrderApiInterface {
56670
56761
  * @memberof OrderApiInterface
56671
56762
  */
56672
56763
  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>;
56764
+ /**
56765
+ * Perform a refund operation on an order and then update the order if successful.
56766
+ * @summary Refund an order completely
56767
+ * @param {string} order_id The order id to refund.
56768
+ * @param {boolean} [reject_after_refund] Reject order after refund
56769
+ * @param {boolean} [skip_customer_notification] Skip customer email notification
56770
+ * @param {boolean} [auto_order_cancel] Cancel associated auto orders
56771
+ * @param {boolean} [manual_refund] Consider a manual refund done externally
56772
+ * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
56773
+ * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
56774
+ * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
56775
+ * @param {string} [refund_reason] Reason for refund
56776
+ * @param {string} [reject_reason] Reason for reject
56777
+ * @param {*} [options] Override http request option.
56778
+ * @throws {RequiredError}
56779
+ * @memberof OrderApiInterface
56780
+ */
56781
+ 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>;
56673
56782
  /**
56674
56783
  * Create a replacement order based upon a previous order
56675
56784
  * @summary Replacement order
@@ -56978,6 +57087,24 @@ export declare class OrderApi extends BaseAPI implements OrderApiInterface {
56978
57087
  * @memberof OrderApi
56979
57088
  */
56980
57089
  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>;
57090
+ /**
57091
+ * Perform a refund operation on an order and then update the order if successful.
57092
+ * @summary Refund an order completely
57093
+ * @param {string} order_id The order id to refund.
57094
+ * @param {boolean} [reject_after_refund] Reject order after refund
57095
+ * @param {boolean} [skip_customer_notification] Skip customer email notification
57096
+ * @param {boolean} [auto_order_cancel] Cancel associated auto orders
57097
+ * @param {boolean} [manual_refund] Consider a manual refund done externally
57098
+ * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
57099
+ * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
57100
+ * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
57101
+ * @param {string} [refund_reason] Reason for refund
57102
+ * @param {string} [reject_reason] Reason for reject
57103
+ * @param {*} [options] Override http request option.
57104
+ * @throws {RequiredError}
57105
+ * @memberof OrderApi
57106
+ */
57107
+ 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>;
56981
57108
  /**
56982
57109
  * Create a replacement order based upon a previous order
56983
57110
  * @summary Replacement order
package/dist/api.js CHANGED
@@ -340,6 +340,7 @@ var ChannelPartnerOrder;
340
340
  PaymentMethodEnum[PaymentMethodEnum["PurchaseOrder"] = 'Purchase Order'] = "PurchaseOrder";
341
341
  PaymentMethodEnum[PaymentMethodEnum["QuoteRequest"] = 'Quote Request'] = "QuoteRequest";
342
342
  PaymentMethodEnum[PaymentMethodEnum["WireTransfer"] = 'Wire Transfer'] = "WireTransfer";
343
+ PaymentMethodEnum[PaymentMethodEnum["PayPalFastlane"] = 'PayPal Fastlane'] = "PayPalFastlane";
343
344
  })(PaymentMethodEnum = ChannelPartnerOrder.PaymentMethodEnum || (ChannelPartnerOrder.PaymentMethodEnum = {}));
344
345
  })(ChannelPartnerOrder = exports.ChannelPartnerOrder || (exports.ChannelPartnerOrder = {}));
345
346
  /**
@@ -1404,6 +1405,7 @@ var OrderPayment;
1404
1405
  PaymentMethodEnum[PaymentMethodEnum["ApplePay"] = 'Apple Pay'] = "ApplePay";
1405
1406
  PaymentMethodEnum[PaymentMethodEnum["GooglePay"] = 'Google Pay'] = "GooglePay";
1406
1407
  PaymentMethodEnum[PaymentMethodEnum["HealthBenefitCard"] = 'Health Benefit Card'] = "HealthBenefitCard";
1408
+ PaymentMethodEnum[PaymentMethodEnum["PayPalFastlane"] = 'PayPal Fastlane'] = "PayPalFastlane";
1407
1409
  })(PaymentMethodEnum = OrderPayment.PaymentMethodEnum || (OrderPayment.PaymentMethodEnum = {}));
1408
1410
  /**
1409
1411
  * @export
@@ -1513,6 +1515,7 @@ var OrderQuery;
1513
1515
  PaymentMethodEnum[PaymentMethodEnum["Venmo"] = 'Venmo'] = "Venmo";
1514
1516
  PaymentMethodEnum[PaymentMethodEnum["ApplePay"] = 'Apple Pay'] = "ApplePay";
1515
1517
  PaymentMethodEnum[PaymentMethodEnum["GooglePay"] = ' Google Pay'] = "GooglePay";
1518
+ PaymentMethodEnum[PaymentMethodEnum["PayPalFastlane"] = 'PayPal Fastlane'] = "PayPalFastlane";
1516
1519
  })(PaymentMethodEnum = OrderQuery.PaymentMethodEnum || (OrderQuery.PaymentMethodEnum = {}));
1517
1520
  /**
1518
1521
  * @export
@@ -26247,6 +26250,88 @@ var OrderApiFetchParamCreator = function (configuration) {
26247
26250
  options: localVarRequestOptions,
26248
26251
  };
26249
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
+ },
26250
26335
  /**
26251
26336
  * Create a replacement order based upon a previous order
26252
26337
  * @summary Replacement order
@@ -27072,6 +27157,37 @@ var OrderApiFp = function (configuration) {
27072
27157
  });
27073
27158
  };
27074
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
+ },
27075
27191
  /**
27076
27192
  * Create a replacement order based upon a previous order
27077
27193
  * @summary Replacement order
@@ -27480,6 +27596,25 @@ var OrderApiFactory = function (configuration, fetch, basePath) {
27480
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) {
27481
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);
27482
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
+ },
27483
27618
  /**
27484
27619
  * Create a replacement order based upon a previous order
27485
27620
  * @summary Replacement order
@@ -27842,6 +27977,26 @@ var OrderApi = /** @class */ (function (_super) {
27842
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) {
27843
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);
27844
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
+ };
27845
28000
  /**
27846
28001
  * Create a replacement order based upon a previous order
27847
28002
  * @summary Replacement order
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "3.11.4",
3
+ "version": "3.11.6",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "keywords": [