ultracart_api 3.9.6 → 3.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b24e98917ef5f54fb712aead6d1f544fe121294afac179e2181e0ef18148612
-  data.tar.gz: 01beb929c534c20da76a204106e9f5b3bd65d24576fc22be521d497356b6e8b6
+  metadata.gz: bba144b6bf988abc407bbad2e036c1100b0ea91197a8a8743e10ab7bcde5cfa9
+  data.tar.gz: 495765a6bcb4c56a0e17803557a32cc8f149fbfab7dff8dc4ca156db3f2e0bb6
 SHA512:
-  metadata.gz: 15849669dc4c8acd98804036dcdd1f29b657b42aae7ba3986c0671d91e30c1c53d148791ad074e8a6d074d87bc198cefb2d5c38014ff9f97d3ab12cf5529f47e
-  data.tar.gz: 118a3d786da54a1d1954c28c14f4eb2765fdfb65f2d15d7ff18ac7c966fc108bd9467d9dedf46a0cc01c7866e7d60a58f8dd6a6bf2031c38d6206298430b6e9d
+  metadata.gz: 6333115b29fac5c877bb018a3f634542398337ce2809ca2c752b38e430e6ff6d90c00b340028b27326f8179d446bbd6d699f86cfae1d202d18428454472f3fc8
+  data.tar.gz: c87fe3721ea2b8a2e08effd1f204e48c2f4ea32d864847de8845afcd2c60538d120721fa24123bb98ce21b7ffc24464bfa4104ee13865144999f91d275fead84

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.9.6
+- Package version: 3.10.0
 - 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.9.6.gem
+gem install ./ultracart_api-3.10.0.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.9.6.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.10.0.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.9.6'
+    gem 'ultracart_api', '~> 3.10.0'
 
 ### Install from Git
 
@@ -96,6 +96,10 @@ Class | Method | HTTP request | Description
 *UltracartClient::AutoOrderApi* | [**get_auto_orders_by_query**](docs/AutoOrderApi.md#get_auto_orders_by_query) | **POST** /auto_order/auto_orders/query | Retrieve auto orders by query
 *UltracartClient::AutoOrderApi* | [**update_auto_order**](docs/AutoOrderApi.md#update_auto_order) | **PUT** /auto_order/auto_orders/{auto_order_oid} | Update an auto order
 *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_channel_ultra_cart_order_id**](docs/ChannelPartnerApi.md#cancel_order_by_channel_ultra_cart_order_id) | **DELETE** /channel_partner/cancel/by_ultracart_order_id/{order_id} | Cancel channel partner order by UltraCart order id
+*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* | [**import_channel_partner_order**](docs/ChannelPartnerApi.md#import_channel_partner_order) | **POST** /channel_partner/import | Insert channel partner order
 *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
@@ -154,6 +158,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::CouponApi* | [**update_coupon**](docs/CouponApi.md#update_coupon) | **PUT** /coupon/coupons/{coupon_oid} | Update a coupon
 *UltracartClient::CouponApi* | [**update_coupons**](docs/CouponApi.md#update_coupons) | **PUT** /coupon/coupons/batch | Update multiple coupons
 *UltracartClient::CouponApi* | [**upload_coupon_codes**](docs/CouponApi.md#upload_coupon_codes) | **POST** /coupon/coupons/{coupon_oid}/upload_codes | Upload one-time codes for a coupon
+*UltracartClient::CustomerApi* | [**adjust_internal_certificate**](docs/CustomerApi.md#adjust_internal_certificate) | **POST** /customer/customers/{customer_profile_oid}/adjust_cashback_balance | Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
 *UltracartClient::CustomerApi* | [**delete_customer**](docs/CustomerApi.md#delete_customer) | **DELETE** /customer/customers/{customer_profile_oid} | Delete a customer
 *UltracartClient::CustomerApi* | [**get_customer**](docs/CustomerApi.md#get_customer) | **GET** /customer/customers/{customer_profile_oid} | Retrieve a customer
 *UltracartClient::CustomerApi* | [**get_customer_by_email**](docs/CustomerApi.md#get_customer_by_email) | **GET** /customer/customers/by_email/{email} | Retrieve a customer by Email
@@ -183,6 +188,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::GiftCertificateApi* | [**update_gift_certificate**](docs/GiftCertificateApi.md#update_gift_certificate) | **PUT** /gift_certificate/gift_certificates/{gift_certificate_oid} | Update a gift certificate
 *UltracartClient::IntegrationLogApi* | [**get_integration_log**](docs/IntegrationLogApi.md#get_integration_log) | **GET** /integration_log/query/{pk}/{sk} | Retrieve an integration log
 *UltracartClient::IntegrationLogApi* | [**get_integration_log_file**](docs/IntegrationLogApi.md#get_integration_log_file) | **GET** /integration_log/query/{pk}/{sk}/{uuid} | Retrieve an integration log file
+*UltracartClient::IntegrationLogApi* | [**get_integration_log_file_pdf**](docs/IntegrationLogApi.md#get_integration_log_file_pdf) | **GET** /integration_log/query/{pk}/{sk}/{uuid}/pdf | Retrieve an integration log file converted to PDF
 *UltracartClient::IntegrationLogApi* | [**get_integration_log_summaries_query**](docs/IntegrationLogApi.md#get_integration_log_summaries_query) | **POST** /integration_log/summary/query | Retrieve integration log summaries
 *UltracartClient::IntegrationLogApi* | [**get_integration_logs_query**](docs/IntegrationLogApi.md#get_integration_logs_query) | **POST** /integration_log/query | Retrieve integration logs
 *UltracartClient::ItemApi* | [**delete_item**](docs/ItemApi.md#delete_item) | **DELETE** /item/items/{merchant_item_oid} | Delete an item
@@ -199,6 +205,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::OrderApi* | [**adjust_order_total**](docs/OrderApi.md#adjust_order_total) | **POST** /order/orders/{order_id}/adjust_order_total/{desired_total} | Adjusts an order total
 *UltracartClient::OrderApi* | [**cancel_order**](docs/OrderApi.md#cancel_order) | **POST** /order/orders/{order_id}/cancel | Cancel an order
 *UltracartClient::OrderApi* | [**delete_order**](docs/OrderApi.md#delete_order) | **DELETE** /order/orders/{order_id} | Delete an order
+*UltracartClient::OrderApi* | [**duplicate_order**](docs/OrderApi.md#duplicate_order) | **POST** /order/orders/{order_id}/duplicate | Duplicate an order
 *UltracartClient::OrderApi* | [**format**](docs/OrderApi.md#format) | **POST** /order/orders/{order_id}/format | Format order
 *UltracartClient::OrderApi* | [**generate_order_token**](docs/OrderApi.md#generate_order_token) | **GET** /order/orders/token/{order_id} | Generate an order token for a given order id
 *UltracartClient::OrderApi* | [**generate_packing_slip_all_dc**](docs/OrderApi.md#generate_packing_slip_all_dc) | **GET** /order/orders/{order_id}/packing_slip | Generate a packing slip for this order across all distribution centers.
@@ -442,6 +449,8 @@ Class | Method | HTTP request | Description
  - [UltracartClient::AccountsReceivableRetryStatsResponse](docs/AccountsReceivableRetryStatsResponse.md)
  - [UltracartClient::Activity](docs/Activity.md)
  - [UltracartClient::AddLibraryItemRequest](docs/AddLibraryItemRequest.md)
+ - [UltracartClient::AdjustInternalCertificateRequest](docs/AdjustInternalCertificateRequest.md)
+ - [UltracartClient::AdjustInternalCertificateResponse](docs/AdjustInternalCertificateResponse.md)
  - [UltracartClient::AffiliateClick](docs/AffiliateClick.md)
  - [UltracartClient::AffiliateClickQuery](docs/AffiliateClickQuery.md)
  - [UltracartClient::AffiliateClicksResponse](docs/AffiliateClicksResponse.md)
@@ -527,6 +536,15 @@ Class | Method | HTTP request | Description
  - [UltracartClient::CartUpsellAfter](docs/CartUpsellAfter.md)
  - [UltracartClient::CartValidationRequest](docs/CartValidationRequest.md)
  - [UltracartClient::CartValidationResponse](docs/CartValidationResponse.md)
+ - [UltracartClient::ChannelPartnerCancelResponse](docs/ChannelPartnerCancelResponse.md)
+ - [UltracartClient::ChannelPartnerEstimateShippingResponse](docs/ChannelPartnerEstimateShippingResponse.md)
+ - [UltracartClient::ChannelPartnerImportResponse](docs/ChannelPartnerImportResponse.md)
+ - [UltracartClient::ChannelPartnerOrder](docs/ChannelPartnerOrder.md)
+ - [UltracartClient::ChannelPartnerOrderItem](docs/ChannelPartnerOrderItem.md)
+ - [UltracartClient::ChannelPartnerOrderItemOption](docs/ChannelPartnerOrderItemOption.md)
+ - [UltracartClient::ChannelPartnerOrderTransaction](docs/ChannelPartnerOrderTransaction.md)
+ - [UltracartClient::ChannelPartnerOrderTransactionDetail](docs/ChannelPartnerOrderTransactionDetail.md)
+ - [UltracartClient::ChannelPartnerShippingEstimate](docs/ChannelPartnerShippingEstimate.md)
  - [UltracartClient::ChargebackDispute](docs/ChargebackDispute.md)
  - [UltracartClient::ChargebackDisputeResponse](docs/ChargebackDisputeResponse.md)
  - [UltracartClient::ChargebackDisputesResponse](docs/ChargebackDisputesResponse.md)
@@ -1108,6 +1126,8 @@ Class | Method | HTTP request | Description
   - auto_order_write: Allows you to write auto order information.
   - chargeback_read: Allows you to read chargeback information.
   - chargeback_write: Allows you to write chargeback information.
+  - channel_partner_read: Allows you to read channel partner information.
+  - channel_partner_write: Allows you to write channel partner information.
   - checkout_read: Allows you to read checkout information.
   - checkout_write: Allows you to write checkout information.
   - configuration_read: Allows you to read configuration information.
@@ -1151,6 +1171,9 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.0 | 05/10/2022 | beta release of ChannelPartnerApi |
+| 3.9.8 | 04/26/2022 | OrderApi.duplicateOrder |
+| 3.9.7 | 04/25/2022 | integration logs method for zpl to pdf conversion |
 | 3.9.6 | 04/25/2022 | storefront communications email magic link setting |
 | 3.9.5 | 04/14/2022 | postcard screenshot bug fixes |
 | 3.9.4 | 04/13/2022 | Added spf DNS record to the sending domain object |

data/docs/AdjustInternalCertificateRequest.md

@@ -0,0 +1,13 @@
+# UltracartClient::AdjustInternalCertificateRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**adjustment_amount** | **Float** | The adjustment amount | [optional] 
+**description** | **String** | Description of this adjustment, 50 characters max | [optional] 
+**entry_dts** | **String** | Optional timestamp for the adjustment, defaults to current time | [optional] 
+**expiration_days** | **Integer** | Optional expiration days from the entry_dts when these adjustment becomes worthless | [optional] 
+**order_id** | **String** | Optional order id if this adjustment is related to a particular order | [optional] 
+**vesting_days** | **Integer** | Optional days required for this adjustment to vest | [optional] 
+
+

data/docs/AdjustInternalCertificateResponse.md

@@ -0,0 +1,13 @@
+# UltracartClient::AdjustInternalCertificateResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**adjustment_amount** | **Float** | The adjustment amount | [optional] 
+**balance_amount** | **Float** | The balance amount after the adjustment was made | [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] 
+
+

data/docs/CartSettingsShippingEstimate.md

@@ -14,6 +14,7 @@ Name | Type | Description | Notes
 **estimated_delivery** | **String** | Date of the estimated delivery (or range) | [optional] 
 **lift_gate_option** | **BOOLEAN** | True if a lift gate option for this method should be offered to the customer | [optional] 
 **name** | **String** | Shipping method name | [optional] 
+**pickup** | **BOOLEAN** | True if this shipping method requires customers to physically pickup product themselves | [optional] 
 **tax** | [**Currency**](Currency.md) |  | [optional] 
 **total_tax** | [**Currency**](Currency.md) |  | [optional] 
 

data/docs/ChannelPartnerApi.md

@@ -0,0 +1,212 @@
+# UltracartClient::ChannelPartnerApi
+
+All URIs are relative to *https://secure.ultracart.com/rest/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**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_channel_ultra_cart_order_id**](ChannelPartnerApi.md#cancel_order_by_channel_ultra_cart_order_id) | **DELETE** /channel_partner/cancel/by_ultracart_order_id/{order_id} | Cancel channel partner order by UltraCart order id
+[**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
+[**import_channel_partner_order**](ChannelPartnerApi.md#import_channel_partner_order) | **POST** /channel_partner/import | Insert channel partner order
+
+
+# **cancel_order_by_channel_partner_order_id**
+> ChannelPartnerCancelResponse cancel_order_by_channel_partner_order_id(order_id)
+
+Cancel channel partner order by channel partner order id
+
+Cancel channel partner order by channel partner order id 
+
+### 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 delete.
+
+
+begin
+  #Cancel channel partner order by channel partner order id
+  result = api_instance.cancel_order_by_channel_partner_order_id(order_id)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ChannelPartnerApi->cancel_order_by_channel_partner_order_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **order_id** | **String**| The channel partner order id to delete. | 
+
+### Return type
+
+[**ChannelPartnerCancelResponse**](ChannelPartnerCancelResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json; charset=UTF-8
+ - **Accept**: application/json
+
+
+
+# **cancel_order_by_channel_ultra_cart_order_id**
+> ChannelPartnerCancelResponse cancel_order_by_channel_ultra_cart_order_id(order_id)
+
+Cancel channel partner order by UltraCart order id
+
+Cancel channel partner order by UltraCart order id 
+
+### 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 UltraCart order id to delete.
+
+
+begin
+  #Cancel channel partner order by UltraCart order id
+  result = api_instance.cancel_order_by_channel_ultra_cart_order_id(order_id)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ChannelPartnerApi->cancel_order_by_channel_ultra_cart_order_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **order_id** | **String**| The UltraCart order id to delete. | 
+
+### Return type
+
+[**ChannelPartnerCancelResponse**](ChannelPartnerCancelResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json; charset=UTF-8
+ - **Accept**: application/json
+
+
+
+# **estimate_shipping_for_channel_partner_order**
+> ChannelPartnerEstimateShippingResponse estimate_shipping_for_channel_partner_order(channel_partner_order)
+
+Estimate shipping for channel partner order
+
+Estimate shipping for order from a channel partner. 
+
+### 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)
+
+
+channel_partner_order = UltracartClient::ChannelPartnerOrder.new # ChannelPartnerOrder | Order needing shipping estimate
+
+
+begin
+  #Estimate shipping for channel partner order
+  result = api_instance.estimate_shipping_for_channel_partner_order(channel_partner_order)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ChannelPartnerApi->estimate_shipping_for_channel_partner_order: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **channel_partner_order** | [**ChannelPartnerOrder**](ChannelPartnerOrder.md)| Order needing shipping estimate | 
+
+### Return type
+
+[**ChannelPartnerEstimateShippingResponse**](ChannelPartnerEstimateShippingResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json; charset=UTF-8
+ - **Accept**: application/json
+
+
+
+# **import_channel_partner_order**
+> ChannelPartnerImportResponse import_channel_partner_order(channel_partner_order)
+
+Insert channel partner order
+
+Insert order from a channel partner. 
+
+### 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)
+
+
+channel_partner_order = UltracartClient::ChannelPartnerOrder.new # ChannelPartnerOrder | Order to insert
+
+
+begin
+  #Insert channel partner order
+  result = api_instance.import_channel_partner_order(channel_partner_order)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ChannelPartnerApi->import_channel_partner_order: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **channel_partner_order** | [**ChannelPartnerOrder**](ChannelPartnerOrder.md)| Order to insert | 
+
+### Return type
+
+[**ChannelPartnerImportResponse**](ChannelPartnerImportResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json; charset=UTF-8
+ - **Accept**: application/json
+
+
+

data/docs/ChannelPartnerCancelResponse.md

@@ -0,0 +1,12 @@
+# UltracartClient::ChannelPartnerCancelResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cancel_errors** | **Array<String>** | Array of errors if errors occurred | [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] 
+
+

data/docs/ChannelPartnerEstimateShippingResponse.md

@@ -0,0 +1,12 @@
+# UltracartClient::ChannelPartnerEstimateShippingResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | [**Error**](Error.md) |  | [optional] 
+**estimates** | [**Array<ChannelPartnerShippingEstimate>**](ChannelPartnerShippingEstimate.md) | An array of shipping methods and their costs | [optional] 
+**metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
+**success** | **BOOLEAN** | Indicates if API call was successful | [optional] 
+**warning** | [**Warning**](Warning.md) |  | [optional] 
+
+

data/docs/ChannelPartnerImportResponse.md

@@ -0,0 +1,13 @@
+# UltracartClient::ChannelPartnerImportResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | [**Error**](Error.md) |  | [optional] 
+**import_errors** | **Array<String>** | Array of errors if errors occurred | [optional] 
+**import_warnings** | **Array<String>** | Array of warnings if warnings occurred | [optional] 
+**metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
+**success** | **BOOLEAN** | Indicates if API call was successful | [optional] 
+**warning** | [**Warning**](Warning.md) |  | [optional] 
+
+

data/docs/ChannelPartnerOrder.md

@@ -0,0 +1,87 @@
+# UltracartClient::ChannelPartnerOrder
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**advertising_source** | **String** | advertising_source | [optional] 
+**affiliate_id** | **String** | Affiliate Id | [optional] 
+**affiliate_sub_id** | **String** | Affiliate Sub Id | [optional] 
+**arbitrary_shipping_handling_total** | **Float** | Arbitrary shipping handling total | [optional] 
+**arbitrary_tax** | **Float** | Arbitrary tax for overriding calculated taxes | [optional] 
+**arbitrary_tax_rate** | **Float** | Arbitrary tax rate | [optional] 
+**arbitrary_taxable_subtotal** | **Float** | Arbitrary taxable subtotal | [optional] 
+**associate_with_customer_profile_if_present** | **BOOLEAN** | If true any matching customer profile based on email is associated with this order | [optional] 
+**auto_approve_purchase_order** | **BOOLEAN** | If true any purchase orders are automatically approved | [optional] 
+**billto_address1** | **String** | Billing Address line 1 | [optional] 
+**billto_address2** | **String** | Billing Address line 2 | [optional] 
+**billto_city** | **String** | Billing City | [optional] 
+**billto_company** | **String** | Billing Company | [optional] 
+**billto_country_code** | **String** | Billing ISO-3166 two letter country code | [optional] 
+**billto_day_phone** | **String** | Billing Day phone | [optional] 
+**billto_evening_phone** | **String** | Billing Evening phone | [optional] 
+**billto_first_name** | **String** | Billing First name | [optional] 
+**billto_last_name** | **String** | Billing Last name | [optional] 
+**billto_postal_code** | **String** | Billing Postal code | [optional] 
+**billto_state_region** | **String** | Billing State for United States otherwise region or province for other countries | [optional] 
+**billto_title** | **String** | Billing Title | [optional] 
+**cc_email** | **String** | CC email. | [optional] 
+**channel_partner_order_id** | **String** | The id for this order within the channel partner system. | [optional] 
+**consider_recurring** | **BOOLEAN** | If true this order is marked as an auto order (recurring) | [optional] 
+**coupons** | **Array<String>** | Array of coupon codes | [optional] 
+**credit_card_authorization_amount** | **Float** | The amount authorized externally | [optional] 
+**credit_card_authorization_dts** | **String** | Date/Time of credit card authorization in ISO8601 format | [optional] 
+**credit_card_authorization_number** | **String** | The reference number provided by an externally processed transaction | [optional] 
+**credit_card_expiration_month** | **Integer** | Credit card expiration month | [optional] 
+**credit_card_expiration_year** | **Integer** | Credit card expiration year | [optional] 
+**credit_card_type** | **String** | Credit card type | [optional] 
+**custom_field1** | **String** | Custom field 1 | [optional] 
+**custom_field2** | **String** | Custom field 2 | [optional] 
+**custom_field3** | **String** | Custom field 3 | [optional] 
+**custom_field4** | **String** | Custom field 4 | [optional] 
+**custom_field5** | **String** | Custom field 5 | [optional] 
+**custom_field6** | **String** | Custom field 6 | [optional] 
+**custom_field7** | **String** | Custom field 7 | [optional] 
+**delivery_date** | **String** | Date the customer is requesting delivery on. Typically used for perishable product delivery. | [optional] 
+**email** | **String** | Email | [optional] 
+**gift** | **BOOLEAN** | True if this order is a gift | [optional] 
+**gift_email** | **String** | Email address of the gift recipient | [optional] 
+**gift_message** | **String** | Message to the gift recipient | [optional] 
+**hosted_fields_card_token** | **String** | The token provided by UltraCart hosted fields when a credit card number is uploaded into the system.  This is the only way to provide a credit card number. | [optional] 
+**hosted_fields_cvv_token** | **String** | The token provided by UltraCart hosted fields when a credit card cvv is uploaded into the system.  This is the only way to provide a cvv number. | [optional] 
+**insurance_application_id** | **String** | Insurance application id | [optional] 
+**insurance_claim_id** | **String** | Insurance claim id | [optional] 
+**ip_address** | **String** | IP Address of the customer | [optional] 
+**items** | [**Array<ChannelPartnerOrderItem>**](ChannelPartnerOrderItem.md) | Items | [optional] 
+**least_cost_route** | **BOOLEAN** | If true the least expensive shipping method is automatically chosen during the order import | [optional] 
+**least_cost_route_shipping_methods** | **Array<String>** | An optional array of shipping methods to restict choices if least_cost_route is true | [optional] 
+**mailing_list_opt_in** | **BOOLEAN** | If true the customer is subscribed to any configured mailing lists | [optional] 
+**no_realtime_payment_processing** | **BOOLEAN** | If true no payment processing is done and the order is placed into Accounts Receivable | [optional] 
+**payment_method** | **String** | Payment method | [optional] 
+**purchase_order_number** | **String** | Purchase order number | [optional] 
+**rotating_transaction_gateway_code** | **String** | The rotating transaction gateway code for the gateway used to charge this order | [optional] 
+**screen_branding_theme_code** | **String** | Screen branding theme code | [optional] 
+**ship_on_date** | **String** | Date the customer is requesting that the order ship on.  Typically used for perishable product delivery. | [optional] 
+**ship_to_residential** | **BOOLEAN** | True if the shipping adress is residential.  Effects the methods that are available to the customer as well as the price of the shipping method. | [optional] 
+**shipping_method** | **String** | Shipping method | [optional] 
+**shipto_address1** | **String** | Shipping Address line 1 | [optional] 
+**shipto_address2** | **String** | Shipping Address line 2 | [optional] 
+**shipto_city** | **String** | Shipping City | [optional] 
+**shipto_company** | **String** | Shipping Company | [optional] 
+**shipto_country_code** | **String** | Shipping ISO-3166 two letter country code | [optional] 
+**shipto_day_phone** | **String** | Shipping Day phone | [optional] 
+**shipto_evening_phone** | **String** | Shipping Evening phone | [optional] 
+**shipto_first_name** | **String** | Shipping First name | [optional] 
+**shipto_last_name** | **String** | Shipping Last name | [optional] 
+**shipto_postal_code** | **String** | Shipping Postal code | [optional] 
+**shipto_state_region** | **String** | Shipping State for United States otherwise region or province for other countries | [optional] 
+**shipto_title** | **String** | Shipping Title | [optional] 
+**skip_payment_processing** | **BOOLEAN** | If true the order is placed directly into the shipping department | [optional] 
+**special_instructions** | **String** | Special instructions from the customer regarding shipping | [optional] 
+**store_completed** | **BOOLEAN** | If true the order bypasses shipping and is marked completed | [optional] 
+**store_if_payment_declines** | **BOOLEAN** | If true any failed payments are placed into Accounts Receivable.  If false any failed payments result in a rejected order resulting in errors thrown during the insert routine | [optional] 
+**tax_county** | **String** | The optional shipping county used to determine exact taxes | [optional] 
+**tax_exempt** | **BOOLEAN** | If true this order is marked as being tax exempt | [optional] 
+**transaction** | [**ChannelPartnerOrderTransaction**](ChannelPartnerOrderTransaction.md) |  | [optional] 
+**treat_warnings_as_errors** | **BOOLEAN** | If true all warnings are considered errors, this is true by default | [optional] 
+
+

data/docs/ChannelPartnerOrderItem.md

@@ -0,0 +1,14 @@
+# UltracartClient::ChannelPartnerOrderItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**arbitrary_unit_cost** | **Float** | Arbitrary unit cost for this item that differs from the listed price | [optional] 
+**auto_order_last_rebill_dts** | **String** | Optional date/time of the last rebill if this item is part of an auto (recurring) order | [optional] 
+**auto_order_schedule** | **String** | The frequency schedule for this item if this item is part of an auto (recurring) order | [optional] 
+**merchant_item_id** | **String** | Item ID | [optional] 
+**options** | [**Array<ChannelPartnerOrderItemOption>**](ChannelPartnerOrderItemOption.md) | Item options | [optional] 
+**quantity** | **Float** | Quantity | [optional] 
+**upsell** | **BOOLEAN** | True if this item was an upsell item. | [optional] 
+
+

data/docs/ChannelPartnerOrderItemOption.md

@@ -0,0 +1,9 @@
+# UltracartClient::ChannelPartnerOrderItemOption
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of the item option. | [optional] 
+**value** | **String** | The value of the item option. | [optional] 
+
+

data/docs/ChannelPartnerOrderTransaction.md

@@ -0,0 +1,9 @@
+# UltracartClient::ChannelPartnerOrderTransaction
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**details** | [**Array<ChannelPartnerOrderTransactionDetail>**](ChannelPartnerOrderTransactionDetail.md) | Transaction gateway details | [optional] 
+**successful** | **BOOLEAN** | True if the transaction was successfully charged | [optional] 
+
+

data/docs/ChannelPartnerOrderTransactionDetail.md

@@ -0,0 +1,9 @@
+# UltracartClient::ChannelPartnerOrderTransactionDetail
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of the item option. | [optional] 
+**value** | **String** | The value of the item option. | [optional] 
+
+

data/docs/ChannelPartnerShippingEstimate.md

@@ -0,0 +1,9 @@
+# UltracartClient::ChannelPartnerShippingEstimate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**shipping_handling_total** | **Float** | The total estimate for this shipping method based on the provided order. | [optional] 
+**shipping_method** | **String** | The name of the shipping method | [optional] 
+
+

data/docs/CustomerApi.md

@@ -4,6 +4,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**adjust_internal_certificate**](CustomerApi.md#adjust_internal_certificate) | **POST** /customer/customers/{customer_profile_oid}/adjust_cashback_balance | Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
 [**delete_customer**](CustomerApi.md#delete_customer) | **DELETE** /customer/customers/{customer_profile_oid} | Delete a customer
 [**get_customer**](CustomerApi.md#get_customer) | **GET** /customer/customers/{customer_profile_oid} | Retrieve a customer
 [**get_customer_by_email**](CustomerApi.md#get_customer_by_email) | **GET** /customer/customers/by_email/{email} | Retrieve a customer by Email
@@ -19,6 +20,59 @@ Method | HTTP request | Description
 [**validate_email_verification_token**](CustomerApi.md#validate_email_verification_token) | **POST** /customer/customers/email_verify/validate_token | Validate a token that can be used to verify a customer email address
 
 
+# **adjust_internal_certificate**
+> AdjustInternalCertificateResponse adjust_internal_certificate(customer_profile_oid, adjust_internal_certificate_request)
+
+Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
+
+Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed. 
+
+### 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::CustomerApi.new_using_api_key(simple_key, false, false)
+
+
+customer_profile_oid = 56 # Integer | The customer profile oid
+
+adjust_internal_certificate_request = UltracartClient::AdjustInternalCertificateRequest.new # AdjustInternalCertificateRequest | adjustInternalCertificateRequest
+
+
+begin
+  #Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
+  result = api_instance.adjust_internal_certificate(customer_profile_oid, adjust_internal_certificate_request)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling CustomerApi->adjust_internal_certificate: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **customer_profile_oid** | **Integer**| The customer profile oid | 
+ **adjust_internal_certificate_request** | [**AdjustInternalCertificateRequest**](AdjustInternalCertificateRequest.md)| adjustInternalCertificateRequest | 
+
+### Return type
+
+[**AdjustInternalCertificateResponse**](AdjustInternalCertificateResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json; charset=UTF-8
+ - **Accept**: application/json
+
+
+
 # **delete_customer**
 > delete_customer(customer_profile_oid)
 

data/docs/CustomerLoyalty.md

@@ -3,7 +3,8 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**current_points** | **Integer** | Current Points | [optional] 
+**current_points** | **Integer** | Current points | [optional] 
+**internal_gift_certificate** | [**GiftCertificate**](GiftCertificate.md) |  | [optional] 
 **internal_gift_certificate_balance** | **String** | Loyalty Cashback / Store credit balance (internal gift certificate balance) | [optional] 
 **internal_gift_certificate_oid** | **Integer** | Internal gift certificate oid used to tracking loyalty cashback / store credit. | [optional] 
 **ledger_entries** | [**Array<CustomerLoyaltyLedger>**](CustomerLoyaltyLedger.md) | Ledger entries | [optional]