ultracart_api 4.0.111.rc → 4.0.112.rc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b6f43ccaab995220268888990e29fbc5fa98e123ac2bcd55705d6d0b7a76ad7
-  data.tar.gz: 7eca419c9cd26cfa6a04c5ab8b9cd80f3881f60a680a451bc9281c2f5cdd02c3
+  metadata.gz: 6f038e5716ab2e24df8c85440e2f5fbdecb61a8636e6215ce297cd440f526e92
+  data.tar.gz: 101cfafc4ffd74232b24dc787d4efd0603124d1b3aeac5789353ed6d9fd9bd19
 SHA512:
-  metadata.gz: 1ec3aa30ee07eddc3db69ac3991dcf7797cf0d1d4d8e8ab260b1ade7b97d7124b6bcd6d610427f6bcb7122aff9f1c1294341f69734429cce5cce5f34f7397f65
-  data.tar.gz: f08b55143637c4ae25bcbb6d2f4c25b00bd07aaa667f36442cc1718cc97290621cd7d6836bff63b1825b0f3f621b8b393a9c9bf4646af1d77239500c959ccc7f
+  metadata.gz: 5d6b708a6711e0d5f343d2797d6815fcba52e106411d9f62a26b5625cfbcf063d1589eb9a14fbc09d56cc1b6625dfaa7386b1bf1f6b9a0f38b1b7d0a4ef58d68
+  data.tar.gz: fc3d2339f4bcdd8cfc269c0e09ea4c43ede45eced6a17ef5753eff15f2df63a9bc2c8c8b81ccce225c86f0bc48a342ceaee2168f2563b0a856ef498d41fc8e92

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.111.rc
+- Package version: 4.0.112.rc
 - 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.111.rc.gem
+gem install ./ultracart_api-4.0.112.rc.gem
 ```
 
-(for development, run `gem install --dev ./ultracart_api-4.0.111.rc.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-4.0.112.rc.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.111.rc'
+    gem 'ultracart_api', '~> 4.0.112.rc'
 
 ### Install from Git
 
@@ -104,9 +104,15 @@ Class | Method | HTTP request | Description
 *UltracartClient::AutoOrderApi* | [**update_auto_orders_batch**](docs/AutoOrderApi.md#update_auto_orders_batch) | **PUT** /auto_order/auto_orders/batch | Update multiple auto orders
 *UltracartClient::ChannelPartnerApi* | [**cancel_order_by_channel_partner_order_id**](docs/ChannelPartnerApi.md#cancel_order_by_channel_partner_order_id) | **DELETE** /channel_partner/cancel/by_channel_partner_order_id/{order_id} | Cancel channel partner order by channel partner order id
 *UltracartClient::ChannelPartnerApi* | [**cancel_order_by_ultra_cart_order_id**](docs/ChannelPartnerApi.md#cancel_order_by_ultra_cart_order_id) | **DELETE** /channel_partner/cancel/by_ultracart_order_id/{order_id} | Cancel channel partner order by UltraCart order id
+*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_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* | [**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
 *UltracartClient::ChargebackApi* | [**get_chargeback_disputes**](docs/ChargebackApi.md#get_chargeback_disputes) | **GET** /chargeback/chargebacks | Retrieve chargebacks
@@ -592,7 +598,11 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ChannelPartnerOrderItemOption](docs/ChannelPartnerOrderItemOption.md)
  - [UltracartClient::ChannelPartnerOrderTransaction](docs/ChannelPartnerOrderTransaction.md)
  - [UltracartClient::ChannelPartnerOrderTransactionDetail](docs/ChannelPartnerOrderTransactionDetail.md)
+ - [UltracartClient::ChannelPartnerShipToPreference](docs/ChannelPartnerShipToPreference.md)
+ - [UltracartClient::ChannelPartnerShipToPreferenceResponse](docs/ChannelPartnerShipToPreferenceResponse.md)
+ - [UltracartClient::ChannelPartnerShipToPreferencesResponse](docs/ChannelPartnerShipToPreferencesResponse.md)
  - [UltracartClient::ChannelPartnerShippingEstimate](docs/ChannelPartnerShippingEstimate.md)
+ - [UltracartClient::ChannelPartnersResponse](docs/ChannelPartnersResponse.md)
  - [UltracartClient::ChargebackDispute](docs/ChargebackDispute.md)
  - [UltracartClient::ChargebackDisputeResponse](docs/ChargebackDisputeResponse.md)
  - [UltracartClient::ChargebackDisputesResponse](docs/ChargebackDisputesResponse.md)
@@ -1279,6 +1289,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.112-RC | 01/13/2023 | channel - ops to manage ship to prefs |
 | 4.0.111-RC | 01/11/2023 | conversations - adjust search results to return multiple convo summaries |
 | 4.0.110-RC | 01/10/2023 | add method to query integration log record by oid |
 | 4.0.109-RC | 01/10/2023 | bug fix for typescript enum error due to apost |

data/docs/ChannelPartnerApi.md

@@ -6,9 +6,15 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | ------ | ------------ | ----------- |
 | [**cancel_order_by_channel_partner_order_id**](ChannelPartnerApi.md#cancel_order_by_channel_partner_order_id) | **DELETE** /channel_partner/cancel/by_channel_partner_order_id/{order_id} | Cancel channel partner order by channel partner order id |
 | [**cancel_order_by_ultra_cart_order_id**](ChannelPartnerApi.md#cancel_order_by_ultra_cart_order_id) | **DELETE** /channel_partner/cancel/by_ultracart_order_id/{order_id} | Cancel channel partner order by UltraCart order id |
+| [**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_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. |
+| [**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. |
 
 
 ## cancel_order_by_channel_partner_order_id
@@ -153,6 +159,78 @@ end
 - **Accept**: application/json
 
 
+## delete_channel_partner_ship_to_preference
+
+> delete_channel_partner_ship_to_preference(channel_partner_oid, channel_partner_ship_to_preference_oid)
+
+Delete a ship to preference record for the channel partner.
+
+Delete a ship to preference record for the channel partner. 
+
+### 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)
+channel_partner_oid = 56 # Integer | 
+channel_partner_ship_to_preference_oid = 56 # Integer | 
+
+begin
+  # Delete a ship to preference record for the channel partner.
+  api_instance.delete_channel_partner_ship_to_preference(channel_partner_oid, channel_partner_ship_to_preference_oid)
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ChannelPartnerApi->delete_channel_partner_ship_to_preference: #{e}"
+end
+```
+
+#### Using the delete_channel_partner_ship_to_preference_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_channel_partner_ship_to_preference_with_http_info(channel_partner_oid, channel_partner_ship_to_preference_oid)
+
+```ruby
+begin
+  # Delete a ship to preference record for the channel partner.
+  data, status_code, headers = api_instance.delete_channel_partner_ship_to_preference_with_http_info(channel_partner_oid, channel_partner_ship_to_preference_oid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ChannelPartnerApi->delete_channel_partner_ship_to_preference_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **channel_partner_oid** | **Integer** |  |  |
+| **channel_partner_ship_to_preference_oid** | **Integer** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## estimate_shipping_for_channel_partner_order
 
 > <ChannelPartnerEstimateShippingResponse> estimate_shipping_for_channel_partner_order(channel_partner_order)
@@ -295,6 +373,218 @@ end
 - **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)
+
+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. 
+
+### 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)
+channel_partner_oid = 56 # Integer | 
+channel_partner_ship_to_preference_oid = 56 # Integer | 
+
+begin
+  # Retrieve the ship to preference associated with the channel partner and the specific id.
+  result = api_instance.get_channel_partner_ship_to_preference(channel_partner_oid, channel_partner_ship_to_preference_oid)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ChannelPartnerApi->get_channel_partner_ship_to_preference: #{e}"
+end
+```
+
+#### Using the get_channel_partner_ship_to_preference_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ChannelPartnerShipToPreferenceResponse>, Integer, Hash)> get_channel_partner_ship_to_preference_with_http_info(channel_partner_oid, channel_partner_ship_to_preference_oid)
+
+```ruby
+begin
+  # Retrieve the ship to preference associated with the channel partner and the specific id.
+  data, status_code, headers = api_instance.get_channel_partner_ship_to_preference_with_http_info(channel_partner_oid, channel_partner_ship_to_preference_oid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ChannelPartnerShipToPreferenceResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ChannelPartnerApi->get_channel_partner_ship_to_preference_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **channel_partner_oid** | **Integer** |  |  |
+| **channel_partner_ship_to_preference_oid** | **Integer** |  |  |
+
+### Return type
+
+[**ChannelPartnerShipToPreferenceResponse**](ChannelPartnerShipToPreferenceResponse.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_preferences
+
+> <ChannelPartnerShipToPreferencesResponse> get_channel_partner_ship_to_preferences(channel_partner_oid)
+
+Retrieve the ship to preferences associated with the channel partner.
+
+Retrieve the ship to preferences associated with the channel partner. 
+
+### 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)
+channel_partner_oid = 56 # Integer | 
+
+begin
+  # Retrieve the ship to preferences associated with the channel partner.
+  result = api_instance.get_channel_partner_ship_to_preferences(channel_partner_oid)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ChannelPartnerApi->get_channel_partner_ship_to_preferences: #{e}"
+end
+```
+
+#### Using the get_channel_partner_ship_to_preferences_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ChannelPartnerShipToPreferencesResponse>, Integer, Hash)> get_channel_partner_ship_to_preferences_with_http_info(channel_partner_oid)
+
+```ruby
+begin
+  # Retrieve the ship to preferences associated with the channel partner.
+  data, status_code, headers = api_instance.get_channel_partner_ship_to_preferences_with_http_info(channel_partner_oid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ChannelPartnerShipToPreferencesResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ChannelPartnerApi->get_channel_partner_ship_to_preferences_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **channel_partner_oid** | **Integer** |  |  |
+
+### Return type
+
+[**ChannelPartnerShipToPreferencesResponse**](ChannelPartnerShipToPreferencesResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_channel_partners
+
+> <ChannelPartnersResponse> get_channel_partners
+
+Retrieve the channel partners configured on the account.
+
+Retrieve the channel partners configured on the account. 
+
+### 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)
+
+begin
+  # Retrieve the channel partners configured on the account.
+  result = api_instance.get_channel_partners
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ChannelPartnerApi->get_channel_partners: #{e}"
+end
+```
+
+#### Using the get_channel_partners_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ChannelPartnersResponse>, Integer, Hash)> get_channel_partners_with_http_info
+
+```ruby
+begin
+  # Retrieve the channel partners configured on the account.
+  data, status_code, headers = api_instance.get_channel_partners_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ChannelPartnersResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ChannelPartnerApi->get_channel_partners_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ChannelPartnersResponse**](ChannelPartnersResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## import_channel_partner_order
 
 > <ChannelPartnerImportResponse> import_channel_partner_order(channel_partner_order)
@@ -365,3 +655,151 @@ end
 - **Content-Type**: application/json; charset=UTF-8
 - **Accept**: application/json
 
+
+## insert_channel_partner_ship_to_preference
+
+> <ChannelPartnerShipToPreferenceResponse> insert_channel_partner_ship_to_preference(channel_partner_oid, ship_to_preference)
+
+Insert a ship to preference record for the channel partner.
+
+Insert a ship to preference record for the channel partner. 
+
+### 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)
+channel_partner_oid = 56 # Integer | 
+ship_to_preference = UltracartClient::ChannelPartnerShipToPreference.new # ChannelPartnerShipToPreference | Ship to preference to create
+
+begin
+  # Insert a ship to preference record for the channel partner.
+  result = api_instance.insert_channel_partner_ship_to_preference(channel_partner_oid, ship_to_preference)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ChannelPartnerApi->insert_channel_partner_ship_to_preference: #{e}"
+end
+```
+
+#### Using the insert_channel_partner_ship_to_preference_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ChannelPartnerShipToPreferenceResponse>, Integer, Hash)> insert_channel_partner_ship_to_preference_with_http_info(channel_partner_oid, ship_to_preference)
+
+```ruby
+begin
+  # Insert a ship to preference record for the channel partner.
+  data, status_code, headers = api_instance.insert_channel_partner_ship_to_preference_with_http_info(channel_partner_oid, ship_to_preference)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ChannelPartnerShipToPreferenceResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ChannelPartnerApi->insert_channel_partner_ship_to_preference_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **channel_partner_oid** | **Integer** |  |  |
+| **ship_to_preference** | [**ChannelPartnerShipToPreference**](ChannelPartnerShipToPreference.md) | Ship to preference to create |  |
+
+### Return type
+
+[**ChannelPartnerShipToPreferenceResponse**](ChannelPartnerShipToPreferenceResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **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)
+
+Update a ship to preference record for the channel partner.
+
+Update a ship to preference record for the channel partner. 
+
+### 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)
+channel_partner_oid = 56 # Integer | 
+channel_partner_ship_to_preference_oid = 56 # Integer | 
+ship_to_preference = UltracartClient::ChannelPartnerShipToPreference.new # ChannelPartnerShipToPreference | Ship to preference to create
+
+begin
+  # Update a ship to preference record for the channel partner.
+  result = api_instance.update_channel_partner_ship_to_preference(channel_partner_oid, channel_partner_ship_to_preference_oid, ship_to_preference)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ChannelPartnerApi->update_channel_partner_ship_to_preference: #{e}"
+end
+```
+
+#### Using the update_channel_partner_ship_to_preference_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ChannelPartnerShipToPreferenceResponse>, Integer, Hash)> update_channel_partner_ship_to_preference_with_http_info(channel_partner_oid, channel_partner_ship_to_preference_oid, ship_to_preference)
+
+```ruby
+begin
+  # Update a ship to preference record for the channel partner.
+  data, status_code, headers = api_instance.update_channel_partner_ship_to_preference_with_http_info(channel_partner_oid, channel_partner_ship_to_preference_oid, ship_to_preference)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ChannelPartnerShipToPreferenceResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ChannelPartnerApi->update_channel_partner_ship_to_preference_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **channel_partner_oid** | **Integer** |  |  |
+| **channel_partner_ship_to_preference_oid** | **Integer** |  |  |
+| **ship_to_preference** | [**ChannelPartnerShipToPreference**](ChannelPartnerShipToPreference.md) | Ship to preference to create |  |
+
+### Return type
+
+[**ChannelPartnerShipToPreferenceResponse**](ChannelPartnerShipToPreferenceResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/ChannelPartnerShipToPreference.md

@@ -0,0 +1,28 @@
+# UltracartClient::ChannelPartnerShipToPreference
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **additional_kit_component_item_ids** | **Array<String>** | Additional item ids to add as kit components to the order with a zero price. | [optional] |
+| **channel_partner_oid** | **Integer** | The channel partner object identifier this preference is associated with | [optional] |
+| **channel_partner_ship_to_preference_oid** | **Integer** | Object identifier for the ship to preference | [optional] |
+| **merchant_id** | **String** | The merchant id that owns the channel partner | [optional] |
+| **return_policy** | **String** | Alternate return policy to print on the packing slip. | [optional] |
+| **ship_to_edi_code** | **String** | The ship to EDI code that the preferences are for | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ChannelPartnerShipToPreference.new(
+  additional_kit_component_item_ids: null,
+  channel_partner_oid: null,
+  channel_partner_ship_to_preference_oid: null,
+  merchant_id: null,
+  return_policy: null,
+  ship_to_edi_code: null
+)
+```
+

data/docs/ChannelPartnerShipToPreferenceResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::ChannelPartnerShipToPreferenceResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **ship_to_preference** | [**ChannelPartnerShipToPreference**](ChannelPartnerShipToPreference.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ChannelPartnerShipToPreferenceResponse.new(
+  error: null,
+  metadata: null,
+  ship_to_preference: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/ChannelPartnerShipToPreferencesResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::ChannelPartnerShipToPreferencesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **ship_to_preferences** | [**Array<ChannelPartnerShipToPreference>**](ChannelPartnerShipToPreference.md) | ship_to_preferences | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ChannelPartnerShipToPreferencesResponse.new(
+  error: null,
+  metadata: null,
+  ship_to_preferences: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/ChannelPartnersResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::ChannelPartnersResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **channel_partners** | [**Array<ChannelPartner>**](ChannelPartner.md) | channel_partners | [optional] |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ChannelPartnersResponse.new(
+  channel_partners: null,
+  error: null,
+  metadata: null,
+  success: null,
+  warning: null
+)
+```
+