ultracart_api 4.0.238 → 4.0.240

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a70af5cb98d0587cbecfdfc9662ba4a9c14347670f13a9a677702467a19f276f
-  data.tar.gz: 42144c4b4b82d971a51d482cd7bda59f93d8bd624a0a9dab0d6980fa48073bee
+  metadata.gz: a7055287bb92af14ebdac856bfb87c93d98a966210c215a4fb086709978b2097
+  data.tar.gz: 0d5b4e3f35092ab78c2232cf0af2daa554ee5e9aac0e8e5aa906cdef1408cded
 SHA512:
-  metadata.gz: 634982a5946314032f882d5081b47275cb57e5258da2521d665ceadfce47b56565a6215357c9b5daebdcff4cc771c271d3815c9506b558f48385cb9e3e024d19
-  data.tar.gz: f80d7b15d9a4318e15af41e0bcd63208aac7927d231a475991f6774b0c3d89abe6f53f84c20f672e7b6b7ef31e4334ceb3f2279d2762a6805a8574eed38cd811
+  metadata.gz: 9b2154411d3b54a8614d3d5d6cc5b2df34d4d7ac18b3b6bb69a0533595b685a93f80940619c947a1eab311f466b51f03c0f118f70c44ed3581063b186cad8f92
+  data.tar.gz: 3c05b656603ba51354816fc5e263fd59641dcd8341c72909aa3a3a1a9e5a48d623d8ee65cc15462e2a5b3f84af3d2a522f7018bae75df44ed10e5854d28d7cae

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.0.238
+- Package version: 4.0.240
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -24,16 +24,16 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-4.0.238.gem
+gem install ./ultracart_api-4.0.240.gem
 ```
 
-(for development, run `gem install --dev ./ultracart_api-4.0.238.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-4.0.240.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', '~> 4.0.238'
+    gem 'ultracart_api', '~> 4.0.240'
 
 ### Install from Git
 
@@ -109,11 +109,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
@@ -1520,6 +1523,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.240 | 01/09/2025 | fix for broken 4.0.39 due to incorrect query sig on getCustomers |
+| 4.0.239 | 01/09/2025 | added emails parameter to customer queries, refundOrder added to Channel partner |
 | 4.0.238 | 12/13/2024 | added user and group ids to conversation agent auth object |
 | 4.0.237 | 11/11/2024 | added seo properties to item.content object |
 | 4.0.236 | 11/07/2024 | Coupon - PercentOffWithItemsQuantityPurchase - added support for tags |

data/docs/ChannelPartnerApi.md

@@ -9,11 +9,14 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**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. |
 
 
@@ -373,6 +376,156 @@ end
 - **Accept**: application/json
 
 
+## 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. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'ultracart_api'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
+
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
+
+api = UltracartClient::ChannelPartnerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+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 "Error when calling ChannelPartnerApi->get_channel_partner_order: #{e}"
+end
+```
+
+#### Using the get_channel_partner_order_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<OrderResponse>, Integer, Hash)> get_channel_partner_order_with_http_info(order_id, opts)
+
+```ruby
+begin
+  # Retrieve a channel partner order
+  data, status_code, headers = api_instance.get_channel_partner_order_with_http_info(order_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <OrderResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ChannelPartnerApi->get_channel_partner_order_with_http_info: #{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**: Not defined
+- **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. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'ultracart_api'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
+
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
+
+api = UltracartClient::ChannelPartnerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+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 "Error when calling ChannelPartnerApi->get_channel_partner_order_by_channel_partner_order_id: #{e}"
+end
+```
+
+#### Using the get_channel_partner_order_by_channel_partner_order_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<OrderResponse>, Integer, Hash)> get_channel_partner_order_by_channel_partner_order_id_with_http_info(order_id, opts)
+
+```ruby
+begin
+  # Retrieve a channel partner order by the channel partner order id
+  data, status_code, headers = api_instance.get_channel_partner_order_by_channel_partner_order_id_with_http_info(order_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <OrderResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ChannelPartnerApi->get_channel_partner_order_by_channel_partner_order_id_with_http_info: #{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**: Not defined
+- **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)
@@ -729,6 +882,97 @@ end
 - **Accept**: application/json
 
 
+## refund_channel_partner_order
+
+> <OrderResponse> refund_channel_partner_order(order_id, order, 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. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'ultracart_api'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
+
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
+
+api = UltracartClient::ChannelPartnerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+order_id = 'order_id_example' # String | The order id to refund.
+order = UltracartClient::Order.new # Order | Order to refund
+opts = {
+  reject_after_refund: true, # Boolean | Reject order after refund
+  skip_customer_notification: true, # Boolean | Skip customer email notification
+  auto_order_cancel: true, # Boolean | Cancel associated auto orders
+  manual_refund: true, # Boolean | Consider a manual refund done externally
+  reverse_affiliate_transactions: true, # Boolean | Reverse affiliate transactions
+  issue_store_credit: true, # 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_id, order, opts)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ChannelPartnerApi->refund_channel_partner_order: #{e}"
+end
+```
+
+#### Using the refund_channel_partner_order_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<OrderResponse>, Integer, Hash)> refund_channel_partner_order_with_http_info(order_id, order, opts)
+
+```ruby
+begin
+  # Refund a channel partner order
+  data, status_code, headers = api_instance.refund_channel_partner_order_with_http_info(order_id, order, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <OrderResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ChannelPartnerApi->refund_channel_partner_order_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **order_id** | **String** | The order id to refund. |  |
+| **order** | [**Order**](Order.md) | Order 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/CustomerQuery.md

@@ -16,6 +16,7 @@
 | **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] |
@@ -52,6 +53,7 @@ instance = UltracartClient::CustomerQuery.new(
   billing_postal_code: null,
   billing_state: null,
   email: null,
+  emails: null,
   last_modified_dts_end: null,
   last_modified_dts_start: null,
   pricing_tier_name: null,

data/lib/ultracart_api/api/channel_partner_api.rb

@@ -368,6 +368,140 @@ module UltracartClient
       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 [String] 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 [String] 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, Integer, 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' + '}', CGI.escape(order_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
+
+      # header parameters
+      header_params = opts[: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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'OrderResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ChannelPartnerApi.get_channel_partner_order",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      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 [String] 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 [String] 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, Integer, 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' + '}', CGI.escape(order_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
+
+      # header parameters
+      header_params = opts[: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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'OrderResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ChannelPartnerApi.get_channel_partner_order_by_channel_partner_order_id",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      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 [Integer] 
@@ -704,6 +838,105 @@ module UltracartClient
       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_id [String] The order id to refund.
+    # @param order [Order] Order 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_id, order, opts = {})
+      data, _status_code, _headers = refund_channel_partner_order_with_http_info(order_id, order, 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_id [String] The order id to refund.
+    # @param order [Order] Order 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 [Array<(OrderResponse, Integer, Hash)>] OrderResponse data, response status code and response headers
+    def refund_channel_partner_order_with_http_info(order_id, order, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: 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
+      # 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
+      # resource path
+      local_var_path = '/channel_partner/orders/{order_id}/refund'.sub('{' + 'order_id' + '}', CGI.escape(order_id.to_s))
+
+      # query parameters
+      query_params = opts[: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 = opts[: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'
+      content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(order)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'OrderResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ChannelPartnerApi.refund_channel_partner_order",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      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 [Integer] 

data/lib/ultracart_api/models/customer_query.rb

@@ -51,6 +51,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
 
@@ -117,6 +120,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',
@@ -157,6 +161,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',
@@ -250,6 +255,12 @@ module UltracartClient
         self.email = attributes[:'email']
       end
 
+      if attributes.key?(:'emails')
+        if (value = attributes[:'emails']).is_a?(Array)
+          self.emails = value
+        end
+      end
+
       if attributes.key?(:'last_modified_dts_end')
         self.last_modified_dts_end = attributes[:'last_modified_dts_end']
       end
@@ -634,6 +645,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 &&
@@ -662,7 +674,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] 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 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '4.0.238'
+  VERSION = '4.0.240'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.0.238
+  version: 4.0.240
 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