ultracart_api 3.10.221 → 3.10.222

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b31a4f1687dc53aacc495cdcee49c393129186b7fbe407d107915494cd25bdd0
-  data.tar.gz: df0dda2bfa9210cdd5f5e6f96f64f9d436c3b559d05757ec0af861ea02e190d2
+  metadata.gz: 92ec2b8db03e8c43a775434125047cf0f2320a366c5c48ab6bcb43f4cbabf7ab
+  data.tar.gz: a2d56acc2d2ab230891c0fe5d761e1b4b6a916919265ce28b34f53a6669d9d2f
 SHA512:
-  metadata.gz: 5d8e5882036b399f4ee65a2a447b57a795010e027aa640c36ebd205ca830f7b90092dd8d61ffd9afd0ca865ef12b3235ce72101ed00ccca6c6a9ac36d9b163e6
-  data.tar.gz: 135d00e2a2bfc0f738bb932ba877f7aa1fa7d904b07a3171e0d6f6dcb8f772b4613e4a11e031aded196db5a31d1fe08a32e654fdbb74db225c78048ceea61ca3
+  metadata.gz: a67bacab4ad13720cfb1d58c8b90a78575d20c73b198024371214e8f8800488e308bde6c870f3b8802a4bb799e665ec85d8b6536199e5e7b5b28a7f081ea4c07
+  data.tar.gz: 60430a9e793ad4a8202e96fcedb88ade229c0a0765d60ab449507ca640957f093a3a99eb5984a1191e3d6c71738db4cc7a45de153660ce5835a8c99db9af1707

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.0.0
-- Package version: 3.10.221
+- Package version: 3.10.222
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-3.10.221.gem
+gem install ./ultracart_api-3.10.222.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.10.221.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.10.222.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'ultracart_api', '~> 3.10.221'
+    gem 'ultracart_api', '~> 3.10.222'
 
 ### Install from Git
 
@@ -103,11 +103,14 @@ Class | Method | HTTP request | Description
 *UltracartClient::ChannelPartnerApi* | [**delete_channel_partner_ship_to_preference**](docs/ChannelPartnerApi.md#delete_channel_partner_ship_to_preference) | **DELETE** /channel_partner/channel_partners/{channel_partner_oid}/ship_to_preferences/{channel_partner_ship_to_preference_oid} | Delete a ship to preference record for the channel partner.
 *UltracartClient::ChannelPartnerApi* | [**estimate_shipping_for_channel_partner_order**](docs/ChannelPartnerApi.md#estimate_shipping_for_channel_partner_order) | **POST** /channel_partner/estimate_shipping | Estimate shipping for channel partner order
 *UltracartClient::ChannelPartnerApi* | [**estimate_tax_for_channel_partner_order**](docs/ChannelPartnerApi.md#estimate_tax_for_channel_partner_order) | **POST** /channel_partner/estimate_tax | Estimate tax for channel partner order
+*UltracartClient::ChannelPartnerApi* | [**get_channel_partner_order**](docs/ChannelPartnerApi.md#get_channel_partner_order) | **GET** /channel_partner/orders/{order_id} | Retrieve a channel partner order
+*UltracartClient::ChannelPartnerApi* | [**get_channel_partner_order_by_channel_partner_order_id**](docs/ChannelPartnerApi.md#get_channel_partner_order_by_channel_partner_order_id) | **GET** /channel_partner/orders/by_channel_partner_order_id/{order_id} | Retrieve a channel partner order by the channel partner order id
 *UltracartClient::ChannelPartnerApi* | [**get_channel_partner_ship_to_preference**](docs/ChannelPartnerApi.md#get_channel_partner_ship_to_preference) | **GET** /channel_partner/channel_partners/{channel_partner_oid}/ship_to_preferences/{channel_partner_ship_to_preference_oid} | Retrieve the ship to preference associated with the channel partner and the specific id.
 *UltracartClient::ChannelPartnerApi* | [**get_channel_partner_ship_to_preferences**](docs/ChannelPartnerApi.md#get_channel_partner_ship_to_preferences) | **GET** /channel_partner/channel_partners/{channel_partner_oid}/ship_to_preferences | Retrieve the ship to preferences associated with the channel partner.
 *UltracartClient::ChannelPartnerApi* | [**get_channel_partners**](docs/ChannelPartnerApi.md#get_channel_partners) | **GET** /channel_partner/channel_partners | Retrieve the channel partners configured on the account.
 *UltracartClient::ChannelPartnerApi* | [**import_channel_partner_order**](docs/ChannelPartnerApi.md#import_channel_partner_order) | **POST** /channel_partner/import | Insert channel partner order
 *UltracartClient::ChannelPartnerApi* | [**insert_channel_partner_ship_to_preference**](docs/ChannelPartnerApi.md#insert_channel_partner_ship_to_preference) | **POST** /channel_partner/channel_partners/{channel_partner_oid}/ship_to_preferences | Insert a ship to preference record for the channel partner.
+*UltracartClient::ChannelPartnerApi* | [**refund_channel_partner_order**](docs/ChannelPartnerApi.md#refund_channel_partner_order) | **PUT** /channel_partner/orders/{order_id}/refund | Refund a channel partner order
 *UltracartClient::ChannelPartnerApi* | [**update_channel_partner_ship_to_preference**](docs/ChannelPartnerApi.md#update_channel_partner_ship_to_preference) | **PUT** /channel_partner/channel_partners/{channel_partner_oid}/ship_to_preferences/{channel_partner_ship_to_preference_oid} | Update a ship to preference record for the channel partner.
 *UltracartClient::ChargebackApi* | [**delete_chargeback**](docs/ChargebackApi.md#delete_chargeback) | **DELETE** /chargeback/chargebacks/{chargeback_dispute_oid} | Delete a chargeback
 *UltracartClient::ChargebackApi* | [**get_chargeback_dispute**](docs/ChargebackApi.md#get_chargeback_dispute) | **GET** /chargeback/chargebacks/{chargeback_dispute_oid} | Retrieve a chargeback
@@ -1512,6 +1515,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.222 | 01/09/2025 | added emails parameter to customer queries, refundOrder added to Channel partner |
 | 3.10.221 | 12/13/2024 | added user and group ids to conversation agent auth object |
 | 3.10.220 | 11/11/2024 | added seo properties to item.content object |
 | 3.10.219 | 11/07/2024 | Coupon - PercentOffWithItemsQuantityPurchase - added support for tags |

data/docs/ChannelPartnerApi.md

@@ -9,11 +9,14 @@ Method | HTTP request | Description
 [**delete_channel_partner_ship_to_preference**](ChannelPartnerApi.md#delete_channel_partner_ship_to_preference) | **DELETE** /channel_partner/channel_partners/{channel_partner_oid}/ship_to_preferences/{channel_partner_ship_to_preference_oid} | Delete a ship to preference record for the channel partner.
 [**estimate_shipping_for_channel_partner_order**](ChannelPartnerApi.md#estimate_shipping_for_channel_partner_order) | **POST** /channel_partner/estimate_shipping | Estimate shipping for channel partner order
 [**estimate_tax_for_channel_partner_order**](ChannelPartnerApi.md#estimate_tax_for_channel_partner_order) | **POST** /channel_partner/estimate_tax | Estimate tax for channel partner order
+[**get_channel_partner_order**](ChannelPartnerApi.md#get_channel_partner_order) | **GET** /channel_partner/orders/{order_id} | Retrieve a channel partner order
+[**get_channel_partner_order_by_channel_partner_order_id**](ChannelPartnerApi.md#get_channel_partner_order_by_channel_partner_order_id) | **GET** /channel_partner/orders/by_channel_partner_order_id/{order_id} | Retrieve a channel partner order by the channel partner order id
 [**get_channel_partner_ship_to_preference**](ChannelPartnerApi.md#get_channel_partner_ship_to_preference) | **GET** /channel_partner/channel_partners/{channel_partner_oid}/ship_to_preferences/{channel_partner_ship_to_preference_oid} | Retrieve the ship to preference associated with the channel partner and the specific id.
 [**get_channel_partner_ship_to_preferences**](ChannelPartnerApi.md#get_channel_partner_ship_to_preferences) | **GET** /channel_partner/channel_partners/{channel_partner_oid}/ship_to_preferences | Retrieve the ship to preferences associated with the channel partner.
 [**get_channel_partners**](ChannelPartnerApi.md#get_channel_partners) | **GET** /channel_partner/channel_partners | Retrieve the channel partners configured on the account.
 [**import_channel_partner_order**](ChannelPartnerApi.md#import_channel_partner_order) | **POST** /channel_partner/import | Insert channel partner order
 [**insert_channel_partner_ship_to_preference**](ChannelPartnerApi.md#insert_channel_partner_ship_to_preference) | **POST** /channel_partner/channel_partners/{channel_partner_oid}/ship_to_preferences | Insert a ship to preference record for the channel partner.
+[**refund_channel_partner_order**](ChannelPartnerApi.md#refund_channel_partner_order) | **PUT** /channel_partner/orders/{order_id}/refund | Refund a channel partner order
 [**update_channel_partner_ship_to_preference**](ChannelPartnerApi.md#update_channel_partner_ship_to_preference) | **PUT** /channel_partner/channel_partners/{channel_partner_oid}/ship_to_preferences/{channel_partner_ship_to_preference_oid} | Update a ship to preference record for the channel partner.
 
 
@@ -269,6 +272,114 @@ Name | Type | Description  | Notes
 
 
 
+# **get_channel_partner_order**
+> OrderResponse get_channel_partner_order(order_id, opts)
+
+Retrieve a channel partner order
+
+Retrieves a single order using the specified order id.  Only orders belonging to this channel partner may be retrieved. 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::ChannelPartnerApi.new_using_api_key(simple_key, false, false)
+
+
+order_id = 'order_id_example' # String | The order id to retrieve.
+
+opts = { 
+  _expand: '_expand_example' # String | The object expansion to perform on the result.  See OrderApi.getOrder documentation for examples
+}
+
+begin
+  #Retrieve a channel partner order
+  result = api_instance.get_channel_partner_order(order_id, opts)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ChannelPartnerApi->get_channel_partner_order: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **order_id** | **String**| The order id to retrieve. | 
+ **_expand** | **String**| The object expansion to perform on the result.  See OrderApi.getOrder documentation for examples | [optional] 
+
+### Return type
+
+[**OrderResponse**](OrderResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_channel_partner_order_by_channel_partner_order_id**
+> OrderResponse get_channel_partner_order_by_channel_partner_order_id(order_id, opts)
+
+Retrieve a channel partner order by the channel partner order id
+
+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. 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::ChannelPartnerApi.new_using_api_key(simple_key, false, false)
+
+
+order_id = 'order_id_example' # String | The channel partner order id to retrieve.
+
+opts = { 
+  _expand: '_expand_example' # String | The object expansion to perform on the result.  See OrderApi.getOrder documentation for examples
+}
+
+begin
+  #Retrieve a channel partner order by the channel partner order id
+  result = api_instance.get_channel_partner_order_by_channel_partner_order_id(order_id, opts)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ChannelPartnerApi->get_channel_partner_order_by_channel_partner_order_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **order_id** | **String**| The channel partner order id to retrieve. | 
+ **_expand** | **String**| The object expansion to perform on the result.  See OrderApi.getOrder documentation for examples | [optional] 
+
+### Return type
+
+[**OrderResponse**](OrderResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **get_channel_partner_ship_to_preference**
 > ChannelPartnerShipToPreferenceResponse get_channel_partner_ship_to_preference(channel_partner_oid, channel_partner_ship_to_preference_oid)
 
@@ -520,6 +631,77 @@ Name | Type | Description  | Notes
 
 
 
+# **refund_channel_partner_order**
+> OrderResponse refund_channel_partner_order(order, order_id, opts)
+
+Refund a channel partner order
+
+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. 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::ChannelPartnerApi.new_using_api_key(simple_key, false, false)
+
+
+order = UltracartClient::Order.new # Order | Order to refund
+
+order_id = 'order_id_example' # String | The order id to refund.
+
+opts = { 
+  reject_after_refund: false, # BOOLEAN | Reject order after refund
+  skip_customer_notification: false, # BOOLEAN | Skip customer email notification
+  auto_order_cancel: false, # BOOLEAN | Cancel associated auto orders
+  manual_refund: false, # BOOLEAN | Consider a manual refund done externally
+  reverse_affiliate_transactions: true, # BOOLEAN | Reverse affiliate transactions
+  issue_store_credit: false, # BOOLEAN | Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
+  auto_order_cancel_reason: 'auto_order_cancel_reason_example', # String | Reason for auto orders cancellation
+  _expand: '_expand_example' # String | The object expansion to perform on the result.  See OrderApi.refundOrder documentation for examples
+}
+
+begin
+  #Refund a channel partner order
+  result = api_instance.refund_channel_partner_order(order, order_id, opts)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ChannelPartnerApi->refund_channel_partner_order: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **order** | [**Order**](Order.md)| Order to refund | 
+ **order_id** | **String**| The order id to refund. | 
+ **reject_after_refund** | **BOOLEAN**| Reject order after refund | [optional] [default to false]
+ **skip_customer_notification** | **BOOLEAN**| Skip customer email notification | [optional] [default to false]
+ **auto_order_cancel** | **BOOLEAN**| Cancel associated auto orders | [optional] [default to false]
+ **manual_refund** | **BOOLEAN**| Consider a manual refund done externally | [optional] [default to false]
+ **reverse_affiliate_transactions** | **BOOLEAN**| Reverse affiliate transactions | [optional] [default to true]
+ **issue_store_credit** | **BOOLEAN**| Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account | [optional] [default to false]
+ **auto_order_cancel_reason** | **String**| Reason for auto orders cancellation | [optional] 
+ **_expand** | **String**| The object expansion to perform on the result.  See OrderApi.refundOrder documentation for examples | [optional] 
+
+### Return type
+
+[**OrderResponse**](OrderResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json; charset=UTF-8
+ - **Accept**: application/json
+
+
+
 # **update_channel_partner_ship_to_preference**
 > ChannelPartnerShipToPreferenceResponse update_channel_partner_ship_to_preference(channel_partner_oid, channel_partner_ship_to_preference_oid, ship_to_preference)
 

data/docs/CustomerApi.md

@@ -634,6 +634,7 @@ opts = {
   shipping_evening_phone: 'shipping_evening_phone_example', # String | Shipping evening phone
   pricing_tier_oid: 56, # Integer | Pricing tier oid
   pricing_tier_name: 'pricing_tier_name_example', # String | Pricing tier name
+  emails: nil, # Object | Emails
   _limit: 100, # Integer | The maximum number of records to return on this one API call. (Max 200)
   _offset: 0, # Integer | Pagination of the record set.  Offset is a zero based index.
   _since: '_since_example', # String | Fetch customers that have been created/modified since this date/time.
@@ -681,6 +682,7 @@ Name | Type | Description  | Notes
  **shipping_evening_phone** | **String**| Shipping evening phone | [optional] 
  **pricing_tier_oid** | **Integer**| Pricing tier oid | [optional] 
  **pricing_tier_name** | **String**| Pricing tier name | [optional] 
+ **emails** | [**Object**](.md)| Emails | [optional] 
  **_limit** | **Integer**| The maximum number of records to return on this one API call. (Max 200) | [optional] [default to 100]
  **_offset** | **Integer**| Pagination of the record set.  Offset is a zero based index. | [optional] [default to 0]
  **_since** | **String**| Fetch customers that have been created/modified since this date/time. | [optional] 

data/docs/CustomerQuery.md

@@ -15,6 +15,7 @@ Name | Type | Description | Notes
 **billing_postal_code** | **String** | Billing postal code | [optional] 
 **billing_state** | **String** | Billing state | [optional] 
 **email** | **String** | Email address of this customer profile | [optional] 
+**emails** | **Array<String>** | 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. | [optional] 
 **last_modified_dts_end** | **String** | Last modified date end | [optional] 
 **last_modified_dts_start** | **String** | Last modified date start | [optional] 
 **pricing_tier_name** | **String** | Pricing tier name | [optional] 

data/lib/ultracart_api/api/channel_partner_api.rb

@@ -312,6 +312,122 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Retrieve a channel partner order
+    # Retrieves a single order using the specified order id.  Only orders belonging to this channel partner may be retrieved. 
+    # @param order_id The order id to retrieve.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :_expand The object expansion to perform on the result.  See OrderApi.getOrder documentation for examples
+    # @return [OrderResponse]
+    def get_channel_partner_order(order_id, opts = {})
+      data, _status_code, _headers = get_channel_partner_order_with_http_info(order_id, opts)
+      data
+    end
+
+    # Retrieve a channel partner order
+    # Retrieves a single order using the specified order id.  Only orders belonging to this channel partner may be retrieved. 
+    # @param order_id The order id to retrieve.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :_expand The object expansion to perform on the result.  See OrderApi.getOrder documentation for examples
+    # @return [Array<(OrderResponse, Fixnum, Hash)>] OrderResponse data, response status code and response headers
+    def get_channel_partner_order_with_http_info(order_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ChannelPartnerApi.get_channel_partner_order ...'
+      end
+      # verify the required parameter 'order_id' is set
+      if @api_client.config.client_side_validation && order_id.nil?
+        fail ArgumentError, "Missing the required parameter 'order_id' when calling ChannelPartnerApi.get_channel_partner_order"
+      end
+      # resource path
+      local_var_path = '/channel_partner/orders/{order_id}'.sub('{' + 'order_id' + '}', order_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'OrderResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ChannelPartnerApi#get_channel_partner_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Retrieve a channel partner order by the channel partner order id
+    # 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. 
+    # @param order_id The channel partner order id to retrieve.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :_expand The object expansion to perform on the result.  See OrderApi.getOrder documentation for examples
+    # @return [OrderResponse]
+    def get_channel_partner_order_by_channel_partner_order_id(order_id, opts = {})
+      data, _status_code, _headers = get_channel_partner_order_by_channel_partner_order_id_with_http_info(order_id, opts)
+      data
+    end
+
+    # Retrieve a channel partner order by the channel partner order id
+    # 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. 
+    # @param order_id The channel partner order id to retrieve.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :_expand The object expansion to perform on the result.  See OrderApi.getOrder documentation for examples
+    # @return [Array<(OrderResponse, Fixnum, Hash)>] OrderResponse data, response status code and response headers
+    def get_channel_partner_order_by_channel_partner_order_id_with_http_info(order_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ChannelPartnerApi.get_channel_partner_order_by_channel_partner_order_id ...'
+      end
+      # verify the required parameter 'order_id' is set
+      if @api_client.config.client_side_validation && order_id.nil?
+        fail ArgumentError, "Missing the required parameter 'order_id' when calling ChannelPartnerApi.get_channel_partner_order_by_channel_partner_order_id"
+      end
+      # resource path
+      local_var_path = '/channel_partner/orders/by_channel_partner_order_id/{order_id}'.sub('{' + 'order_id' + '}', order_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'OrderResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ChannelPartnerApi#get_channel_partner_order_by_channel_partner_order_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Retrieve the ship to preference associated with the channel partner and the specific id.
     # Retrieve the ship to preference associated with the channel partner and the specific id. 
     # @param channel_partner_oid 
@@ -593,6 +709,91 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Refund a channel partner order
+    # 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. 
+    # @param order Order to refund
+    # @param order_id The order id to refund.
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :reject_after_refund Reject order after refund (default to false)
+    # @option opts [BOOLEAN] :skip_customer_notification Skip customer email notification (default to false)
+    # @option opts [BOOLEAN] :auto_order_cancel Cancel associated auto orders (default to false)
+    # @option opts [BOOLEAN] :manual_refund Consider a manual refund done externally (default to false)
+    # @option opts [BOOLEAN] :reverse_affiliate_transactions Reverse affiliate transactions (default to true)
+    # @option opts [BOOLEAN] :issue_store_credit Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account (default to false)
+    # @option opts [String] :auto_order_cancel_reason Reason for auto orders cancellation
+    # @option opts [String] :_expand The object expansion to perform on the result.  See OrderApi.refundOrder documentation for examples
+    # @return [OrderResponse]
+    def refund_channel_partner_order(order, order_id, opts = {})
+      data, _status_code, _headers = refund_channel_partner_order_with_http_info(order, order_id, opts)
+      data
+    end
+
+    # Refund a channel partner order
+    # 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. 
+    # @param order Order to refund
+    # @param order_id The order id to refund.
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :reject_after_refund Reject order after refund
+    # @option opts [BOOLEAN] :skip_customer_notification Skip customer email notification
+    # @option opts [BOOLEAN] :auto_order_cancel Cancel associated auto orders
+    # @option opts [BOOLEAN] :manual_refund Consider a manual refund done externally
+    # @option opts [BOOLEAN] :reverse_affiliate_transactions Reverse affiliate transactions
+    # @option opts [BOOLEAN] :issue_store_credit Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
+    # @option opts [String] :auto_order_cancel_reason Reason for auto orders cancellation
+    # @option opts [String] :_expand The object expansion to perform on the result.  See OrderApi.refundOrder documentation for examples
+    # @return [Array<(OrderResponse, Fixnum, Hash)>] OrderResponse data, response status code and response headers
+    def refund_channel_partner_order_with_http_info(order, order_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ChannelPartnerApi.refund_channel_partner_order ...'
+      end
+      # verify the required parameter 'order' is set
+      if @api_client.config.client_side_validation && order.nil?
+        fail ArgumentError, "Missing the required parameter 'order' when calling ChannelPartnerApi.refund_channel_partner_order"
+      end
+      # verify the required parameter 'order_id' is set
+      if @api_client.config.client_side_validation && order_id.nil?
+        fail ArgumentError, "Missing the required parameter 'order_id' when calling ChannelPartnerApi.refund_channel_partner_order"
+      end
+      # resource path
+      local_var_path = '/channel_partner/orders/{order_id}/refund'.sub('{' + 'order_id' + '}', order_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'reject_after_refund'] = opts[:'reject_after_refund'] if !opts[:'reject_after_refund'].nil?
+      query_params[:'skip_customer_notification'] = opts[:'skip_customer_notification'] if !opts[:'skip_customer_notification'].nil?
+      query_params[:'auto_order_cancel'] = opts[:'auto_order_cancel'] if !opts[:'auto_order_cancel'].nil?
+      query_params[:'manual_refund'] = opts[:'manual_refund'] if !opts[:'manual_refund'].nil?
+      query_params[:'reverse_affiliate_transactions'] = opts[:'reverse_affiliate_transactions'] if !opts[:'reverse_affiliate_transactions'].nil?
+      query_params[:'issue_store_credit'] = opts[:'issue_store_credit'] if !opts[:'issue_store_credit'].nil?
+      query_params[:'auto_order_cancel_reason'] = opts[:'auto_order_cancel_reason'] if !opts[:'auto_order_cancel_reason'].nil?
+      query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(order)
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'OrderResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ChannelPartnerApi#refund_channel_partner_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Update a ship to preference record for the channel partner.
     # Update a ship to preference record for the channel partner. 
     # @param channel_partner_oid 

data/lib/ultracart_api/api/customer_api.rb

@@ -684,6 +684,7 @@ module UltracartClient
     # @option opts [String] :shipping_evening_phone Shipping evening phone
     # @option opts [Integer] :pricing_tier_oid Pricing tier oid
     # @option opts [String] :pricing_tier_name Pricing tier name
+    # @option opts [Object] :emails Emails
     # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Max 200) (default to 100)
     # @option opts [Integer] :_offset Pagination of the record set.  Offset is a zero based index. (default to 0)
     # @option opts [String] :_since Fetch customers that have been created/modified since this date/time.
@@ -725,6 +726,7 @@ module UltracartClient
     # @option opts [String] :shipping_evening_phone Shipping evening phone
     # @option opts [Integer] :pricing_tier_oid Pricing tier oid
     # @option opts [String] :pricing_tier_name Pricing tier name
+    # @option opts [Object] :emails Emails
     # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Max 200)
     # @option opts [Integer] :_offset Pagination of the record set.  Offset is a zero based index.
     # @option opts [String] :_since Fetch customers that have been created/modified since this date/time.
@@ -767,6 +769,7 @@ module UltracartClient
       query_params[:'shipping_evening_phone'] = opts[:'shipping_evening_phone'] if !opts[:'shipping_evening_phone'].nil?
       query_params[:'pricing_tier_oid'] = opts[:'pricing_tier_oid'] if !opts[:'pricing_tier_oid'].nil?
       query_params[:'pricing_tier_name'] = opts[:'pricing_tier_name'] if !opts[:'pricing_tier_name'].nil?
+      query_params[:'emails'] = opts[:'emails'] if !opts[:'emails'].nil?
       query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
       query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
       query_params[:'_since'] = opts[:'_since'] if !opts[:'_since'].nil?

data/lib/ultracart_api/models/customer_query.rb

@@ -50,6 +50,9 @@ module UltracartClient
     # Email address of this customer profile
     attr_accessor :email
 
+    # 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.
+    attr_accessor :emails
+
     # Last modified date end
     attr_accessor :last_modified_dts_end
 
@@ -116,6 +119,7 @@ module UltracartClient
         :'billing_postal_code' => :'billing_postal_code',
         :'billing_state' => :'billing_state',
         :'email' => :'email',
+        :'emails' => :'emails',
         :'last_modified_dts_end' => :'last_modified_dts_end',
         :'last_modified_dts_start' => :'last_modified_dts_start',
         :'pricing_tier_name' => :'pricing_tier_name',
@@ -151,6 +155,7 @@ module UltracartClient
         :'billing_postal_code' => :'String',
         :'billing_state' => :'String',
         :'email' => :'String',
+        :'emails' => :'Array<String>',
         :'last_modified_dts_end' => :'String',
         :'last_modified_dts_start' => :'String',
         :'pricing_tier_name' => :'String',
@@ -231,6 +236,12 @@ module UltracartClient
         self.email = attributes[:'email']
       end
 
+      if attributes.has_key?(:'emails')
+        if (value = attributes[:'emails']).is_a?(Array)
+          self.emails = value
+        end
+      end
+
       if attributes.has_key?(:'last_modified_dts_end')
         self.last_modified_dts_end = attributes[:'last_modified_dts_end']
       end
@@ -615,6 +626,7 @@ module UltracartClient
           billing_postal_code == o.billing_postal_code &&
           billing_state == o.billing_state &&
           email == o.email &&
+          emails == o.emails &&
           last_modified_dts_end == o.last_modified_dts_end &&
           last_modified_dts_start == o.last_modified_dts_start &&
           pricing_tier_name == o.pricing_tier_name &&
@@ -643,7 +655,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [all_tags, any_tags, billing_city, billing_company, billing_country_code, billing_day_phone, billing_evening_phone, billing_first_name, billing_last_name, billing_postal_code, billing_state, email, last_modified_dts_end, last_modified_dts_start, pricing_tier_name, pricing_tier_oid, qb_class, quickbooks_code, shipping_city, shipping_company, shipping_country_code, shipping_day_phone, shipping_evening_phone, shipping_first_name, shipping_last_name, shipping_postal_code, shipping_state, signup_dts_end, signup_dts_start].hash
+      [all_tags, any_tags, billing_city, billing_company, billing_country_code, billing_day_phone, billing_evening_phone, billing_first_name, billing_last_name, billing_postal_code, billing_state, email, emails, last_modified_dts_end, last_modified_dts_start, pricing_tier_name, pricing_tier_oid, qb_class, quickbooks_code, shipping_city, shipping_company, shipping_country_code, shipping_day_phone, shipping_evening_phone, shipping_first_name, shipping_last_name, shipping_postal_code, shipping_state, signup_dts_end, signup_dts_start].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/version.rb

@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.15-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '3.10.221'
+  VERSION = '3.10.222'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.10.221
+  version: 3.10.222
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-13 00:00:00.000000000 Z
+date: 2025-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus