ultracart_rest_api_v2_typescript 3.11.5 → 3.11.6

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@3.11.5
+## ultracart_rest_api_v2_typescript@3.11.6
 
 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:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install ultracart_rest_api_v2_typescript@3.11.5 --save
+npm install ultracart_rest_api_v2_typescript@3.11.6 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.11.6 | 04/16/2025 | added channel partner order item properties |
 | 3.11.5 | 03/28/2025 | added paypal fastlane constants for payments |
 | 3.11.4 | 03/07/2025 | updated github readme.md |
 | 3.11.3 | 03/07/2025 | updated github readme.md files |

package/api.ts

@@ -6208,6 +6208,12 @@ export interface ChannelPartnerOrderItem {
      * @memberof ChannelPartnerOrderItem
      */
     options?: Array<ChannelPartnerOrderItemOption>;
+    /**
+     * Properties
+     * @type {Array<ChannelPartnerOrderItemProperty>}
+     * @memberof ChannelPartnerOrderItem
+     */
+    properties?: Array<ChannelPartnerOrderItemProperty>;
     /**
      * Quantity
      * @type {number}
@@ -6271,6 +6277,38 @@ export interface ChannelPartnerOrderItemOption {
     value?: string;
 }
 
+/**
+ * 
+ * @export
+ * @interface ChannelPartnerOrderItemProperty
+ */
+export interface ChannelPartnerOrderItemProperty {
+    /**
+     * True if this property is displayed to the customer
+     * @type {boolean}
+     * @memberof ChannelPartnerOrderItemProperty
+     */
+    display?: boolean;
+    /**
+     * The date/time that the property expires and is deleted
+     * @type {string}
+     * @memberof ChannelPartnerOrderItemProperty
+     */
+    expiration_dts?: string;
+    /**
+     * Name
+     * @type {string}
+     * @memberof ChannelPartnerOrderItemProperty
+     */
+    name?: string;
+    /**
+     * Value
+     * @type {string}
+     * @memberof ChannelPartnerOrderItemProperty
+     */
+    value?: string;
+}
+
 /**
  * 
  * @export
@@ -74059,6 +74097,103 @@ export const OrderApiFetchParamCreator = function (configuration?: Configuration
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Perform a refund operation on an order and then update the order if successful. 
+         * @summary Refund an order completely
+         * @param {string} order_id The order id to refund.
+         * @param {boolean} [reject_after_refund] Reject order after refund
+         * @param {boolean} [skip_customer_notification] Skip customer email notification
+         * @param {boolean} [auto_order_cancel] Cancel associated auto orders
+         * @param {boolean} [manual_refund] Consider a manual refund done externally
+         * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
+         * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
+         * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
+         * @param {string} [refund_reason] Reason for refund
+         * @param {string} [reject_reason] Reason for reject
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        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 {
+            // verify required parameter 'order_id' is not null or undefined
+            if (order_id === null || order_id === undefined) {
+                throw new RequiredError('order_id','Required parameter order_id was null or undefined when calling refundOrderCompletely.');
+            }
+            const localVarPath = `/order/orders/{order_id}/refund_completely`
+                .replace(`{${"order_id"}}`, encodeURIComponent(String(order_id)));
+            const localVarUrlObj = url.parse(localVarPath, true);
+            const localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+    if(configuration && configuration.apiVersion) {
+      localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
+    }
+
+
+
+            // authentication ultraCartOauth required
+            // oauth required
+            if (configuration && configuration.accessToken) {
+				const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+					? configuration.accessToken("ultraCartOauth", ["order_write"])
+					: configuration.accessToken;
+                localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
+            }
+
+            // authentication ultraCartSimpleApiKey required
+            if (configuration && configuration.apiKey) {
+                const localVarApiKeyValue = typeof configuration.apiKey === 'function'
+					? configuration.apiKey("x-ultracart-simple-key")
+					: configuration.apiKey;
+                localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
+            }
+
+            if (reject_after_refund !== undefined) {
+                localVarQueryParameter['reject_after_refund'] = reject_after_refund;
+            }
+
+            if (skip_customer_notification !== undefined) {
+                localVarQueryParameter['skip_customer_notification'] = skip_customer_notification;
+            }
+
+            if (auto_order_cancel !== undefined) {
+                localVarQueryParameter['auto_order_cancel'] = auto_order_cancel;
+            }
+
+            if (manual_refund !== undefined) {
+                localVarQueryParameter['manual_refund'] = manual_refund;
+            }
+
+            if (reverse_affiliate_transactions !== undefined) {
+                localVarQueryParameter['reverse_affiliate_transactions'] = reverse_affiliate_transactions;
+            }
+
+            if (issue_store_credit !== undefined) {
+                localVarQueryParameter['issue_store_credit'] = issue_store_credit;
+            }
+
+            if (auto_order_cancel_reason !== undefined) {
+                localVarQueryParameter['auto_order_cancel_reason'] = auto_order_cancel_reason;
+            }
+
+            if (refund_reason !== undefined) {
+                localVarQueryParameter['refund_reason'] = refund_reason;
+            }
+
+            if (reject_reason !== undefined) {
+                localVarQueryParameter['reject_reason'] = reject_reason;
+            }
+
+            localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
+            // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
+            delete localVarUrlObj.search;
+            localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
+
+            return {
+                url: url.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Create a replacement order based upon a previous order 
          * @summary Replacement order
@@ -74904,6 +75039,36 @@ export const OrderApiFp = function(configuration?: Configuration) {
                 });
             };
         },
+        /**
+         * Perform a refund operation on an order and then update the order if successful. 
+         * @summary Refund an order completely
+         * @param {string} order_id The order id to refund.
+         * @param {boolean} [reject_after_refund] Reject order after refund
+         * @param {boolean} [skip_customer_notification] Skip customer email notification
+         * @param {boolean} [auto_order_cancel] Cancel associated auto orders
+         * @param {boolean} [manual_refund] Consider a manual refund done externally
+         * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
+         * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
+         * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
+         * @param {string} [refund_reason] Reason for refund
+         * @param {string} [reject_reason] Reason for reject
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        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> {
+            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);
+            return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
+                return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
+
+                    if (response.status >= 200 && response.status < 300) {
+                      return response.json();
+                      
+                    } else {
+                        throw response;
+                    }
+                });
+            };
+        },
         /**
          * Create a replacement order based upon a previous order 
          * @summary Replacement order
@@ -75306,6 +75471,25 @@ export const OrderApiFactory = function (configuration?: Configuration, fetch?:
         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) {
             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);
         },
+        /**
+         * Perform a refund operation on an order and then update the order if successful. 
+         * @summary Refund an order completely
+         * @param {string} order_id The order id to refund.
+         * @param {boolean} [reject_after_refund] Reject order after refund
+         * @param {boolean} [skip_customer_notification] Skip customer email notification
+         * @param {boolean} [auto_order_cancel] Cancel associated auto orders
+         * @param {boolean} [manual_refund] Consider a manual refund done externally
+         * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
+         * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
+         * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
+         * @param {string} [refund_reason] Reason for refund
+         * @param {string} [reject_reason] Reason for reject
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        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) {
+            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);
+        },
         /**
          * Create a replacement order based upon a previous order 
          * @summary Replacement order
@@ -75642,6 +75826,25 @@ export interface OrderApiInterface {
      */
     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>;
 
+    /**
+     * Perform a refund operation on an order and then update the order if successful. 
+     * @summary Refund an order completely
+     * @param {string} order_id The order id to refund.
+     * @param {boolean} [reject_after_refund] Reject order after refund
+     * @param {boolean} [skip_customer_notification] Skip customer email notification
+     * @param {boolean} [auto_order_cancel] Cancel associated auto orders
+     * @param {boolean} [manual_refund] Consider a manual refund done externally
+     * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
+     * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
+     * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
+     * @param {string} [refund_reason] Reason for refund
+     * @param {string} [reject_reason] Reason for reject
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderApiInterface
+     */
+    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>;
+
     /**
      * Create a replacement order based upon a previous order 
      * @summary Replacement order
@@ -76020,6 +76223,27 @@ export class OrderApi extends BaseAPI implements OrderApiInterface {
         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);
     }
 
+    /**
+     * Perform a refund operation on an order and then update the order if successful. 
+     * @summary Refund an order completely
+     * @param {string} order_id The order id to refund.
+     * @param {boolean} [reject_after_refund] Reject order after refund
+     * @param {boolean} [skip_customer_notification] Skip customer email notification
+     * @param {boolean} [auto_order_cancel] Cancel associated auto orders
+     * @param {boolean} [manual_refund] Consider a manual refund done externally
+     * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
+     * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
+     * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
+     * @param {string} [refund_reason] Reason for refund
+     * @param {string} [reject_reason] Reason for reject
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderApi
+     */
+    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) {
+        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);
+    }
+
     /**
      * Create a replacement order based upon a previous order 
      * @summary Replacement order

package/dist/api.d.ts

@@ -6071,6 +6071,12 @@ export interface ChannelPartnerOrderItem {
      * @memberof ChannelPartnerOrderItem
      */
     options?: Array<ChannelPartnerOrderItemOption>;
+    /**
+     * Properties
+     * @type {Array<ChannelPartnerOrderItemProperty>}
+     * @memberof ChannelPartnerOrderItem
+     */
+    properties?: Array<ChannelPartnerOrderItemProperty>;
     /**
      * Quantity
      * @type {number}
@@ -6131,6 +6137,37 @@ export interface ChannelPartnerOrderItemOption {
      */
     value?: string;
 }
+/**
+ *
+ * @export
+ * @interface ChannelPartnerOrderItemProperty
+ */
+export interface ChannelPartnerOrderItemProperty {
+    /**
+     * True if this property is displayed to the customer
+     * @type {boolean}
+     * @memberof ChannelPartnerOrderItemProperty
+     */
+    display?: boolean;
+    /**
+     * The date/time that the property expires and is deleted
+     * @type {string}
+     * @memberof ChannelPartnerOrderItemProperty
+     */
+    expiration_dts?: string;
+    /**
+     * Name
+     * @type {string}
+     * @memberof ChannelPartnerOrderItemProperty
+     */
+    name?: string;
+    /**
+     * Value
+     * @type {string}
+     * @memberof ChannelPartnerOrderItemProperty
+     */
+    value?: string;
+}
 /**
  *
  * @export
@@ -55814,6 +55851,23 @@ export declare const OrderApiFetchParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     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;
+    /**
+     * Perform a refund operation on an order and then update the order if successful.
+     * @summary Refund an order completely
+     * @param {string} order_id The order id to refund.
+     * @param {boolean} [reject_after_refund] Reject order after refund
+     * @param {boolean} [skip_customer_notification] Skip customer email notification
+     * @param {boolean} [auto_order_cancel] Cancel associated auto orders
+     * @param {boolean} [manual_refund] Consider a manual refund done externally
+     * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
+     * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
+     * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
+     * @param {string} [refund_reason] Reason for refund
+     * @param {string} [reject_reason] Reason for reject
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    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;
     /**
      * Create a replacement order based upon a previous order
      * @summary Replacement order
@@ -56093,6 +56147,23 @@ export declare const OrderApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     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>;
+    /**
+     * Perform a refund operation on an order and then update the order if successful.
+     * @summary Refund an order completely
+     * @param {string} order_id The order id to refund.
+     * @param {boolean} [reject_after_refund] Reject order after refund
+     * @param {boolean} [skip_customer_notification] Skip customer email notification
+     * @param {boolean} [auto_order_cancel] Cancel associated auto orders
+     * @param {boolean} [manual_refund] Consider a manual refund done externally
+     * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
+     * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
+     * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
+     * @param {string} [refund_reason] Reason for refund
+     * @param {string} [reject_reason] Reason for reject
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    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>;
     /**
      * Create a replacement order based upon a previous order
      * @summary Replacement order
@@ -56372,6 +56443,23 @@ export declare const OrderApiFactory: (configuration?: Configuration, fetch?: Fe
      * @throws {RequiredError}
      */
     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>;
+    /**
+     * Perform a refund operation on an order and then update the order if successful.
+     * @summary Refund an order completely
+     * @param {string} order_id The order id to refund.
+     * @param {boolean} [reject_after_refund] Reject order after refund
+     * @param {boolean} [skip_customer_notification] Skip customer email notification
+     * @param {boolean} [auto_order_cancel] Cancel associated auto orders
+     * @param {boolean} [manual_refund] Consider a manual refund done externally
+     * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
+     * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
+     * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
+     * @param {string} [refund_reason] Reason for refund
+     * @param {string} [reject_reason] Reason for reject
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    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>;
     /**
      * Create a replacement order based upon a previous order
      * @summary Replacement order
@@ -56673,6 +56761,24 @@ export interface OrderApiInterface {
      * @memberof OrderApiInterface
      */
     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>;
+    /**
+     * Perform a refund operation on an order and then update the order if successful.
+     * @summary Refund an order completely
+     * @param {string} order_id The order id to refund.
+     * @param {boolean} [reject_after_refund] Reject order after refund
+     * @param {boolean} [skip_customer_notification] Skip customer email notification
+     * @param {boolean} [auto_order_cancel] Cancel associated auto orders
+     * @param {boolean} [manual_refund] Consider a manual refund done externally
+     * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
+     * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
+     * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
+     * @param {string} [refund_reason] Reason for refund
+     * @param {string} [reject_reason] Reason for reject
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderApiInterface
+     */
+    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>;
     /**
      * Create a replacement order based upon a previous order
      * @summary Replacement order
@@ -56981,6 +57087,24 @@ export declare class OrderApi extends BaseAPI implements OrderApiInterface {
      * @memberof OrderApi
      */
     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>;
+    /**
+     * Perform a refund operation on an order and then update the order if successful.
+     * @summary Refund an order completely
+     * @param {string} order_id The order id to refund.
+     * @param {boolean} [reject_after_refund] Reject order after refund
+     * @param {boolean} [skip_customer_notification] Skip customer email notification
+     * @param {boolean} [auto_order_cancel] Cancel associated auto orders
+     * @param {boolean} [manual_refund] Consider a manual refund done externally
+     * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
+     * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
+     * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
+     * @param {string} [refund_reason] Reason for refund
+     * @param {string} [reject_reason] Reason for reject
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderApi
+     */
+    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>;
     /**
      * Create a replacement order based upon a previous order
      * @summary Replacement order

package/dist/api.js

@@ -26250,6 +26250,88 @@ var OrderApiFetchParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Perform a refund operation on an order and then update the order if successful.
+         * @summary Refund an order completely
+         * @param {string} order_id The order id to refund.
+         * @param {boolean} [reject_after_refund] Reject order after refund
+         * @param {boolean} [skip_customer_notification] Skip customer email notification
+         * @param {boolean} [auto_order_cancel] Cancel associated auto orders
+         * @param {boolean} [manual_refund] Consider a manual refund done externally
+         * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
+         * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
+         * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
+         * @param {string} [refund_reason] Reason for refund
+         * @param {string} [reject_reason] Reason for reject
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        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) {
+            if (options === void 0) { options = {}; }
+            // verify required parameter 'order_id' is not null or undefined
+            if (order_id === null || order_id === undefined) {
+                throw new RequiredError('order_id', 'Required parameter order_id was null or undefined when calling refundOrderCompletely.');
+            }
+            var localVarPath = "/order/orders/{order_id}/refund_completely"
+                .replace("{".concat("order_id", "}"), encodeURIComponent(String(order_id)));
+            var localVarUrlObj = url.parse(localVarPath, true);
+            var localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
+            var localVarHeaderParameter = {};
+            var localVarQueryParameter = {};
+            if (configuration && configuration.apiVersion) {
+                localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
+            }
+            // authentication ultraCartOauth required
+            // oauth required
+            if (configuration && configuration.accessToken) {
+                var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+                    ? configuration.accessToken("ultraCartOauth", ["order_write"])
+                    : configuration.accessToken;
+                localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
+            }
+            // authentication ultraCartSimpleApiKey required
+            if (configuration && configuration.apiKey) {
+                var localVarApiKeyValue = typeof configuration.apiKey === 'function'
+                    ? configuration.apiKey("x-ultracart-simple-key")
+                    : configuration.apiKey;
+                localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
+            }
+            if (reject_after_refund !== undefined) {
+                localVarQueryParameter['reject_after_refund'] = reject_after_refund;
+            }
+            if (skip_customer_notification !== undefined) {
+                localVarQueryParameter['skip_customer_notification'] = skip_customer_notification;
+            }
+            if (auto_order_cancel !== undefined) {
+                localVarQueryParameter['auto_order_cancel'] = auto_order_cancel;
+            }
+            if (manual_refund !== undefined) {
+                localVarQueryParameter['manual_refund'] = manual_refund;
+            }
+            if (reverse_affiliate_transactions !== undefined) {
+                localVarQueryParameter['reverse_affiliate_transactions'] = reverse_affiliate_transactions;
+            }
+            if (issue_store_credit !== undefined) {
+                localVarQueryParameter['issue_store_credit'] = issue_store_credit;
+            }
+            if (auto_order_cancel_reason !== undefined) {
+                localVarQueryParameter['auto_order_cancel_reason'] = auto_order_cancel_reason;
+            }
+            if (refund_reason !== undefined) {
+                localVarQueryParameter['refund_reason'] = refund_reason;
+            }
+            if (reject_reason !== undefined) {
+                localVarQueryParameter['reject_reason'] = reject_reason;
+            }
+            localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
+            // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
+            delete localVarUrlObj.search;
+            localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
+            return {
+                url: url.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Create a replacement order based upon a previous order
          * @summary Replacement order
@@ -27075,6 +27157,37 @@ var OrderApiFp = function (configuration) {
                 });
             };
         },
+        /**
+         * Perform a refund operation on an order and then update the order if successful.
+         * @summary Refund an order completely
+         * @param {string} order_id The order id to refund.
+         * @param {boolean} [reject_after_refund] Reject order after refund
+         * @param {boolean} [skip_customer_notification] Skip customer email notification
+         * @param {boolean} [auto_order_cancel] Cancel associated auto orders
+         * @param {boolean} [manual_refund] Consider a manual refund done externally
+         * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
+         * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
+         * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
+         * @param {string} [refund_reason] Reason for refund
+         * @param {string} [reject_reason] Reason for reject
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        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) {
+            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);
+            return function (fetch, basePath) {
+                if (fetch === void 0) { fetch = portableFetch; }
+                if (basePath === void 0) { basePath = BASE_PATH; }
+                return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
+                    if (response.status >= 200 && response.status < 300) {
+                        return response.json();
+                    }
+                    else {
+                        throw response;
+                    }
+                });
+            };
+        },
         /**
          * Create a replacement order based upon a previous order
          * @summary Replacement order
@@ -27483,6 +27596,25 @@ var OrderApiFactory = function (configuration, fetch, basePath) {
         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) {
             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);
         },
+        /**
+         * Perform a refund operation on an order and then update the order if successful.
+         * @summary Refund an order completely
+         * @param {string} order_id The order id to refund.
+         * @param {boolean} [reject_after_refund] Reject order after refund
+         * @param {boolean} [skip_customer_notification] Skip customer email notification
+         * @param {boolean} [auto_order_cancel] Cancel associated auto orders
+         * @param {boolean} [manual_refund] Consider a manual refund done externally
+         * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
+         * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
+         * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
+         * @param {string} [refund_reason] Reason for refund
+         * @param {string} [reject_reason] Reason for reject
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        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) {
+            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);
+        },
         /**
          * Create a replacement order based upon a previous order
          * @summary Replacement order
@@ -27845,6 +27977,26 @@ var OrderApi = /** @class */ (function (_super) {
     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) {
         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);
     };
+    /**
+     * Perform a refund operation on an order and then update the order if successful.
+     * @summary Refund an order completely
+     * @param {string} order_id The order id to refund.
+     * @param {boolean} [reject_after_refund] Reject order after refund
+     * @param {boolean} [skip_customer_notification] Skip customer email notification
+     * @param {boolean} [auto_order_cancel] Cancel associated auto orders
+     * @param {boolean} [manual_refund] Consider a manual refund done externally
+     * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
+     * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
+     * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
+     * @param {string} [refund_reason] Reason for refund
+     * @param {string} [reject_reason] Reason for reject
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderApi
+     */
+    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) {
+        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);
+    };
     /**
      * Create a replacement order based upon a previous order
      * @summary Replacement order

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultracart_rest_api_v2_typescript",
-  "version": "3.11.5",
+  "version": "3.11.6",
   "description": "UltraCart Rest TypeScript SDK",
   "author": "UltraCart",
   "keywords": [