ultracart_api 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d8ed11c26303904351ebb73fc3889cbcb03667c6a2cd4831a405e568c0e2f12
-  data.tar.gz: 3b2202a5d4b64dfffe5cb5985b36826ddc3acd92265d3d98aba743f87d9261c1
+  metadata.gz: da904755712348aef88524f42be74fff7f1aebdb44f77f22363b69d437e26ef9
+  data.tar.gz: 5c06284a9d8a449d7e05d78183991c7b1f74c2c5f171e3160896b5a78b85df2d
 SHA512:
-  metadata.gz: ed12aa7f751502328558a95bf569d8debfa888418638a1278936f3fac8c5b16933ee6ed706a024a74d20c63673cf2362323428747a9b7b99600362522e016ade
-  data.tar.gz: 149da6b85726eaa7ab9536c4cca7623add353b01c399c3927639308d6f85fb6ef6ddee5a2cfe95e94feb6fa08002ec3f9f19f9974033e0e2c38afcb06107fd6a
+  metadata.gz: 4e497b1114baa530a20a297d5e50eb66abb9ef27221e281adc87ab1d0afb6cd7a5fdfd6fb0646747cabb53053bd5eeda9d9e287bbf13abcc9b6083aabf5788b0
+  data.tar.gz: 8262dca0a773add49b58c84fc091c3036b0997e77a34b5b0d687c634bab4894da37618bd743b57e3e9ea3604e5716b4ac7e36c452c6605a6d8d0329427e85205

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.1.0
+- Package version: 3.1.1
 - 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.1.0.gem
+gem install ./ultracart_api-3.1.1.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.1.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.1.1.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.1.0'
+    gem 'ultracart_api', '~> 3.1.1'
 
 ### Install from Git
 
@@ -88,12 +88,12 @@ Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
 *UltracartClient::AffiliateApi* | [**get_clicks_by_query**](docs/AffiliateApi.md#get_clicks_by_query) | **POST** /affiliate/clicks/query | Retrieve clicks
 *UltracartClient::AffiliateApi* | [**get_ledgers_by_query**](docs/AffiliateApi.md#get_ledgers_by_query) | **POST** /affiliate/ledgers/query | Retrieve ledger entries
-*UltracartClient::AutoOrderApi* | [**get_auto_order**](docs/AutoOrderApi.md#get_auto_order) | **GET** /auto_order/auto_orders/{auto_order_oid} | Retrieve an auto order
-*UltracartClient::AutoOrderApi* | [**get_auto_order_by_code**](docs/AutoOrderApi.md#get_auto_order_by_code) | **GET** /auto_order/auto_orders/code/{auto_order_code} | Retrieve an auto order
-*UltracartClient::AutoOrderApi* | [**get_auto_order_by_reference_order_id**](docs/AutoOrderApi.md#get_auto_order_by_reference_order_id) | **GET** /auto_order/auto_orders/reference_order_id/{reference_order_id} | Retrieve an auto order
+*UltracartClient::AutoOrderApi* | [**get_auto_order**](docs/AutoOrderApi.md#get_auto_order) | **GET** /auto_order/auto_orders/{auto_order_oid} | Retrieve an auto order by oid
+*UltracartClient::AutoOrderApi* | [**get_auto_order_by_code**](docs/AutoOrderApi.md#get_auto_order_by_code) | **GET** /auto_order/auto_orders/code/{auto_order_code} | Retrieve an auto order by code
+*UltracartClient::AutoOrderApi* | [**get_auto_order_by_reference_order_id**](docs/AutoOrderApi.md#get_auto_order_by_reference_order_id) | **GET** /auto_order/auto_orders/reference_order_id/{reference_order_id} | Retrieve an auto order by order id
 *UltracartClient::AutoOrderApi* | [**get_auto_orders**](docs/AutoOrderApi.md#get_auto_orders) | **GET** /auto_order/auto_orders | Retrieve auto orders
 *UltracartClient::AutoOrderApi* | [**get_auto_orders_batch**](docs/AutoOrderApi.md#get_auto_orders_batch) | **POST** /auto_order/auto_orders/batch | Retrieve auto order batch
-*UltracartClient::AutoOrderApi* | [**get_auto_orders_by_query**](docs/AutoOrderApi.md#get_auto_orders_by_query) | **POST** /auto_order/auto_orders/query | Retrieve auto orders
+*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::ChargebackApi* | [**delete_chargeback**](docs/ChargebackApi.md#delete_chargeback) | **DELETE** /chargeback/chargebacks/{chargeback_dispute_oid} | Delete a chargeback
@@ -141,6 +141,7 @@ Class | Method | HTTP request | Description
 *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* | [**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
 *UltracartClient::CustomerApi* | [**get_customers**](docs/CustomerApi.md#get_customers) | **GET** /customer/customers | Retrieve customers
 *UltracartClient::CustomerApi* | [**get_customers_by_query**](docs/CustomerApi.md#get_customers_by_query) | **POST** /customer/customers/query | Retrieve customers by query
 *UltracartClient::CustomerApi* | [**get_customers_for_data_tables**](docs/CustomerApi.md#get_customers_for_data_tables) | **POST** /customer/customers/dataTables | Retrieve customers for DataTables plugin
@@ -176,7 +177,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::OrderApi* | [**get_order_by_token**](docs/OrderApi.md#get_order_by_token) | **POST** /order/orders/token | Retrieve an order using a token
 *UltracartClient::OrderApi* | [**get_orders**](docs/OrderApi.md#get_orders) | **GET** /order/orders | Retrieve orders
 *UltracartClient::OrderApi* | [**get_orders_batch**](docs/OrderApi.md#get_orders_batch) | **POST** /order/orders/batch | Retrieve order batch
-*UltracartClient::OrderApi* | [**get_orders_by_query**](docs/OrderApi.md#get_orders_by_query) | **POST** /order/orders/query | Retrieve orders
+*UltracartClient::OrderApi* | [**get_orders_by_query**](docs/OrderApi.md#get_orders_by_query) | **POST** /order/orders/query | Retrieve orders by query
 *UltracartClient::OrderApi* | [**insert_order**](docs/OrderApi.md#insert_order) | **POST** /order/orders | Insert an order
 *UltracartClient::OrderApi* | [**process_payment**](docs/OrderApi.md#process_payment) | **POST** /order/orders/{order_id}/process_payment | Process payment
 *UltracartClient::OrderApi* | [**refund_order**](docs/OrderApi.md#refund_order) | **PUT** /order/orders/{order_id}/refund | Refund an order

data/docs/AutoOrderApi.md

@@ -4,12 +4,12 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**get_auto_order**](AutoOrderApi.md#get_auto_order) | **GET** /auto_order/auto_orders/{auto_order_oid} | Retrieve an auto order
-[**get_auto_order_by_code**](AutoOrderApi.md#get_auto_order_by_code) | **GET** /auto_order/auto_orders/code/{auto_order_code} | Retrieve an auto order
-[**get_auto_order_by_reference_order_id**](AutoOrderApi.md#get_auto_order_by_reference_order_id) | **GET** /auto_order/auto_orders/reference_order_id/{reference_order_id} | Retrieve an auto order
+[**get_auto_order**](AutoOrderApi.md#get_auto_order) | **GET** /auto_order/auto_orders/{auto_order_oid} | Retrieve an auto order by oid
+[**get_auto_order_by_code**](AutoOrderApi.md#get_auto_order_by_code) | **GET** /auto_order/auto_orders/code/{auto_order_code} | Retrieve an auto order by code
+[**get_auto_order_by_reference_order_id**](AutoOrderApi.md#get_auto_order_by_reference_order_id) | **GET** /auto_order/auto_orders/reference_order_id/{reference_order_id} | Retrieve an auto order by order id
 [**get_auto_orders**](AutoOrderApi.md#get_auto_orders) | **GET** /auto_order/auto_orders | Retrieve auto orders
 [**get_auto_orders_batch**](AutoOrderApi.md#get_auto_orders_batch) | **POST** /auto_order/auto_orders/batch | Retrieve auto order batch
-[**get_auto_orders_by_query**](AutoOrderApi.md#get_auto_orders_by_query) | **POST** /auto_order/auto_orders/query | Retrieve auto orders
+[**get_auto_orders_by_query**](AutoOrderApi.md#get_auto_orders_by_query) | **POST** /auto_order/auto_orders/query | Retrieve auto orders by query
 [**update_auto_order**](AutoOrderApi.md#update_auto_order) | **PUT** /auto_order/auto_orders/{auto_order_oid} | Update an auto order
 [**update_auto_orders_batch**](AutoOrderApi.md#update_auto_orders_batch) | **PUT** /auto_order/auto_orders/batch | Update multiple auto orders
 
@@ -17,7 +17,7 @@ Method | HTTP request | Description
 # **get_auto_order**
 > AutoOrderResponse get_auto_order(auto_order_oid, opts)
 
-Retrieve an auto order
+Retrieve an auto order by oid
 
 Retrieves a single auto order using the specified auto order oid. 
 
@@ -38,7 +38,7 @@ opts = {
 }
 
 begin
-  #Retrieve an auto order
+  #Retrieve an auto order by oid
   result = api_instance.get_auto_order(auto_order_oid, opts)
   p result
 rescue UltracartClient::ApiError => e
@@ -71,7 +71,7 @@ Name | Type | Description  | Notes
 # **get_auto_order_by_code**
 > AutoOrderResponse get_auto_order_by_code(auto_order_code, opts)
 
-Retrieve an auto order
+Retrieve an auto order by code
 
 Retrieves a single auto order using the specified reference (original) order id. 
 
@@ -92,7 +92,7 @@ opts = {
 }
 
 begin
-  #Retrieve an auto order
+  #Retrieve an auto order by code
   result = api_instance.get_auto_order_by_code(auto_order_code, opts)
   p result
 rescue UltracartClient::ApiError => e
@@ -125,7 +125,7 @@ Name | Type | Description  | Notes
 # **get_auto_order_by_reference_order_id**
 > AutoOrderResponse get_auto_order_by_reference_order_id(reference_order_id, opts)
 
-Retrieve an auto order
+Retrieve an auto order by order id
 
 Retrieves a single auto order using the specified reference (original) order id. 
 
@@ -146,7 +146,7 @@ opts = {
 }
 
 begin
-  #Retrieve an auto order
+  #Retrieve an auto order by order id
   result = api_instance.get_auto_order_by_reference_order_id(reference_order_id, opts)
   p result
 rescue UltracartClient::ApiError => e
@@ -328,7 +328,7 @@ Name | Type | Description  | Notes
 # **get_auto_orders_by_query**
 > AutoOrdersResponse get_auto_orders_by_query(auto_order_query, opts)
 
-Retrieve auto orders
+Retrieve auto orders by query
 
 Retrieves a group of auto orders from the account based on a query object.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination. 
 
@@ -352,7 +352,7 @@ opts = {
 }
 
 begin
-  #Retrieve auto orders
+  #Retrieve auto orders by query
   result = api_instance.get_auto_orders_by_query(auto_order_query, opts)
   p result
 rescue UltracartClient::ApiError => e

data/docs/CheckoutApi.md

@@ -868,7 +868,7 @@ Name | Type | Description  | Notes
 
 Setup Browser Application
 
-Setup a browser key authenticated application with checkout permissions.  This REST call must be made with an authentication scheme that is not browser key.  The new application will be linked to the application that makes this call.  If this application is disabled / deleted, then so will the application setup by this call.  The purpose of this call is to allow an OAuth applicaiton, such as the Wordpress plugin, to setup the proper browser based authentication for the REST checkout API to use. 
+Setup a browser key authenticated application with checkout permissions.  This REST call must be made with an authentication scheme that is not browser key.  The new application will be linked to the application that makes this call.  If this application is disabled / deleted, then so will the application setup by this call.  The purpose of this call is to allow an OAuth application, such as the Wordpress plugin, to setup the proper browser based authentication for the REST checkout API to use. 
 
 ### Example
 ```ruby

data/docs/CouponTieredAmountOffItem.md

@@ -4,7 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **item** | **String** | The item being discounted by this coupon. | [optional] 
-**limit** | **Float** | The maximum amount of total discount by this coupon. | [optional] 
+**limit** | **Float** | The maximum number of discounted items. | [optional] 
 **tiers** | [**Array<CouponTierQuantityAmount>**](CouponTierQuantityAmount.md) | A list of discount tiers. | [optional] 
 
 

data/docs/CouponTieredPercentOffItems.md

@@ -4,7 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **items** | **Array<String>** | A list of items of which at least one must be purchased for coupon to be valid. | [optional] 
-**limit** | **Float** | The maximum amount of total discount by this coupon. | [optional] 
+**limit** | **Float** | The (optional) maximum quantity of discounted items. | [optional] 
 **tiers** | [**Array<CouponTierQuantityPercent>**](CouponTierQuantityPercent.md) | A list of discount tiers. | [optional] 
 
 

data/docs/CustomerApi.md

@@ -6,6 +6,7 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**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
 [**get_customers**](CustomerApi.md#get_customers) | **GET** /customer/customers | Retrieve customers
 [**get_customers_by_query**](CustomerApi.md#get_customers_by_query) | **POST** /customer/customers/query | Retrieve customers by query
 [**get_customers_for_data_tables**](CustomerApi.md#get_customers_for_data_tables) | **POST** /customer/customers/dataTables | Retrieve customers for DataTables plugin
@@ -120,6 +121,60 @@ Name | Type | Description  | Notes
 
 
 
+# **get_customer_by_email**
+> CustomerResponse get_customer_by_email(email, opts)
+
+Retrieve a customer by Email
+
+Retrieves a single customer using the specified customer email address. 
+
+### 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)
+
+
+email = 'email_example' # String | The email address of the customer to retrieve.
+
+opts = { 
+  _expand: '_expand_example' # String | The object expansion to perform on the result.  See documentation for examples
+}
+
+begin
+  #Retrieve a customer by Email
+  result = api_instance.get_customer_by_email(email, opts)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling CustomerApi->get_customer_by_email: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **email** | **String**| The email address of the customer to retrieve. | 
+ **_expand** | **String**| The object expansion to perform on the result.  See documentation for examples | [optional] 
+
+### Return type
+
+[**CustomerResponse**](CustomerResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **get_customers**
 > CustomersResponse get_customers(opts)
 

data/docs/EmailPlanAdditional.md

@@ -3,6 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**active** | **BOOLEAN** |  | [optional] 
 **can_downgrade** | **BOOLEAN** |  | [optional] 
 **can_upgrade** | **BOOLEAN** |  | [optional] 
 **cost** | **Float** |  | [optional] 

data/docs/OrderApi.md

@@ -15,7 +15,7 @@ Method | HTTP request | Description
 [**get_order_by_token**](OrderApi.md#get_order_by_token) | **POST** /order/orders/token | Retrieve an order using a token
 [**get_orders**](OrderApi.md#get_orders) | **GET** /order/orders | Retrieve orders
 [**get_orders_batch**](OrderApi.md#get_orders_batch) | **POST** /order/orders/batch | Retrieve order batch
-[**get_orders_by_query**](OrderApi.md#get_orders_by_query) | **POST** /order/orders/query | Retrieve orders
+[**get_orders_by_query**](OrderApi.md#get_orders_by_query) | **POST** /order/orders/query | Retrieve orders by query
 [**insert_order**](OrderApi.md#insert_order) | **POST** /order/orders | Insert an order
 [**process_payment**](OrderApi.md#process_payment) | **POST** /order/orders/{order_id}/process_payment | Process payment
 [**refund_order**](OrderApi.md#refund_order) | **PUT** /order/orders/{order_id}/refund | Refund an order
@@ -661,7 +661,7 @@ Name | Type | Description  | Notes
 # **get_orders_by_query**
 > OrdersResponse get_orders_by_query(order_query, opts)
 
-Retrieve orders
+Retrieve orders by query
 
 Retrieves a group of orders from the account based on a query object.  If no parameters are specified, the API call will fail with a bad request error.  Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination. 
 
@@ -685,7 +685,7 @@ opts = {
 }
 
 begin
-  #Retrieve orders
+  #Retrieve orders by query
   result = api_instance.get_orders_by_query(order_query, opts)
   p result
 rescue UltracartClient::ApiError => e

data/lib/ultracart_api/api/auto_order_api.rb

@@ -32,7 +32,7 @@ module UltracartClient
       UltracartClient::AutoOrderApi.new(api_client)
     end
 
-    # Retrieve an auto order
+    # Retrieve an auto order by oid
     # Retrieves a single auto order using the specified auto order oid. 
     # @param auto_order_oid The auto order oid to retrieve.
     # @param [Hash] opts the optional parameters
@@ -43,7 +43,7 @@ module UltracartClient
       data
     end
 
-    # Retrieve an auto order
+    # Retrieve an auto order by oid
     # Retrieves a single auto order using the specified auto order oid. 
     # @param auto_order_oid The auto order oid to retrieve.
     # @param [Hash] opts the optional parameters
@@ -90,7 +90,7 @@ module UltracartClient
       end
       return data, status_code, headers
     end
-    # Retrieve an auto order
+    # Retrieve an auto order by code
     # Retrieves a single auto order using the specified reference (original) order id. 
     # @param auto_order_code The auto order oid to retrieve.
     # @param [Hash] opts the optional parameters
@@ -101,7 +101,7 @@ module UltracartClient
       data
     end
 
-    # Retrieve an auto order
+    # Retrieve an auto order by code
     # Retrieves a single auto order using the specified reference (original) order id. 
     # @param auto_order_code The auto order oid to retrieve.
     # @param [Hash] opts the optional parameters
@@ -148,7 +148,7 @@ module UltracartClient
       end
       return data, status_code, headers
     end
-    # Retrieve an auto order
+    # Retrieve an auto order by order id
     # Retrieves a single auto order using the specified reference (original) order id. 
     # @param reference_order_id The auto order oid to retrieve.
     # @param [Hash] opts the optional parameters
@@ -159,7 +159,7 @@ module UltracartClient
       data
     end
 
-    # Retrieve an auto order
+    # Retrieve an auto order by order id
     # Retrieves a single auto order using the specified reference (original) order id. 
     # @param reference_order_id The auto order oid to retrieve.
     # @param [Hash] opts the optional parameters
@@ -382,7 +382,7 @@ module UltracartClient
       end
       return data, status_code, headers
     end
-    # Retrieve auto orders
+    # Retrieve auto orders by query
     # Retrieves a group of auto orders from the account based on a query object.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination. 
     # @param auto_order_query Auto order query
     # @param [Hash] opts the optional parameters
@@ -396,7 +396,7 @@ module UltracartClient
       data
     end
 
-    # Retrieve auto orders
+    # Retrieve auto orders by query
     # Retrieves a group of auto orders from the account based on a query object.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination. 
     # @param auto_order_query Auto order query
     # @param [Hash] opts the optional parameters

data/lib/ultracart_api/api/checkout_api.rb

@@ -937,7 +937,7 @@ module UltracartClient
       return data, status_code, headers
     end
     # Setup Browser Application
-    # Setup a browser key authenticated application with checkout permissions.  This REST call must be made with an authentication scheme that is not browser key.  The new application will be linked to the application that makes this call.  If this application is disabled / deleted, then so will the application setup by this call.  The purpose of this call is to allow an OAuth applicaiton, such as the Wordpress plugin, to setup the proper browser based authentication for the REST checkout API to use. 
+    # Setup a browser key authenticated application with checkout permissions.  This REST call must be made with an authentication scheme that is not browser key.  The new application will be linked to the application that makes this call.  If this application is disabled / deleted, then so will the application setup by this call.  The purpose of this call is to allow an OAuth application, such as the Wordpress plugin, to setup the proper browser based authentication for the REST checkout API to use. 
     # @param browser_key_request Setup browser key request
     # @param [Hash] opts the optional parameters
     # @return [CheckoutSetupBrowserKeyResponse]
@@ -947,7 +947,7 @@ module UltracartClient
     end
 
     # Setup Browser Application
-    # Setup a browser key authenticated application with checkout permissions.  This REST call must be made with an authentication scheme that is not browser key.  The new application will be linked to the application that makes this call.  If this application is disabled / deleted, then so will the application setup by this call.  The purpose of this call is to allow an OAuth applicaiton, such as the Wordpress plugin, to setup the proper browser based authentication for the REST checkout API to use. 
+    # Setup a browser key authenticated application with checkout permissions.  This REST call must be made with an authentication scheme that is not browser key.  The new application will be linked to the application that makes this call.  If this application is disabled / deleted, then so will the application setup by this call.  The purpose of this call is to allow an OAuth application, such as the Wordpress plugin, to setup the proper browser based authentication for the REST checkout API to use. 
     # @param browser_key_request Setup browser key request
     # @param [Hash] opts the optional parameters
     # @return [Array<(CheckoutSetupBrowserKeyResponse, Fixnum, Hash)>] CheckoutSetupBrowserKeyResponse data, response status code and response headers

data/lib/ultracart_api/api/customer_api.rb

@@ -145,6 +145,64 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Retrieve a customer by Email
+    # Retrieves a single customer using the specified customer email address. 
+    # @param email The email address of the customer to retrieve.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :_expand The object expansion to perform on the result.  See documentation for examples
+    # @return [CustomerResponse]
+    def get_customer_by_email(email, opts = {})
+      data, _status_code, _headers = get_customer_by_email_with_http_info(email, opts)
+      data
+    end
+
+    # Retrieve a customer by Email
+    # Retrieves a single customer using the specified customer email address. 
+    # @param email The email address of the customer to retrieve.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :_expand The object expansion to perform on the result.  See documentation for examples
+    # @return [Array<(CustomerResponse, Fixnum, Hash)>] CustomerResponse data, response status code and response headers
+    def get_customer_by_email_with_http_info(email, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CustomerApi.get_customer_by_email ...'
+      end
+      # verify the required parameter 'email' is set
+      if @api_client.config.client_side_validation && email.nil?
+        fail ArgumentError, "Missing the required parameter 'email' when calling CustomerApi.get_customer_by_email"
+      end
+      # resource path
+      local_var_path = '/customer/customers/by_email/{email}'.sub('{' + 'email' + '}', email.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'CustomerResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CustomerApi#get_customer_by_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Retrieve customers
     # Retrieves customers from the account.  If no parameters are specified, all customers will be returned.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination. 
     # @param [Hash] opts the optional parameters

data/lib/ultracart_api/api/order_api.rb

@@ -747,7 +747,7 @@ module UltracartClient
       end
       return data, status_code, headers
     end
-    # Retrieve orders
+    # Retrieve orders by query
     # Retrieves a group of orders from the account based on a query object.  If no parameters are specified, the API call will fail with a bad request error.  Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination. 
     # @param order_query Order query
     # @param [Hash] opts the optional parameters
@@ -761,7 +761,7 @@ module UltracartClient
       data
     end
 
-    # Retrieve orders
+    # Retrieve orders by query
     # Retrieves a group of orders from the account based on a query object.  If no parameters are specified, the API call will fail with a bad request error.  Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination. 
     # @param order_query Order query
     # @param [Hash] opts the optional parameters

data/lib/ultracart_api/models/coupon_tiered_amount_off_item.rb

@@ -17,7 +17,7 @@ module UltracartClient
     # The item being discounted by this coupon.
     attr_accessor :item
 
-    # The maximum amount of total discount by this coupon.
+    # The maximum number of discounted items.
     attr_accessor :limit
 
     # A list of discount tiers.

data/lib/ultracart_api/models/coupon_tiered_percent_off_items.rb

@@ -17,7 +17,7 @@ module UltracartClient
     # A list of items of which at least one must be purchased for coupon to be valid.
     attr_accessor :items
 
-    # The maximum amount of total discount by this coupon.
+    # The (optional) maximum quantity of discounted items.
     attr_accessor :limit
 
     # A list of discount tiers.

data/lib/ultracart_api/models/email_plan_additional.rb

@@ -14,6 +14,8 @@ require 'date'
 
 module UltracartClient
   class EmailPlanAdditional
+    attr_accessor :active
+
     attr_accessor :can_downgrade
 
     attr_accessor :can_upgrade
@@ -33,6 +35,7 @@ module UltracartClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'active' => :'active',
         :'can_downgrade' => :'can_downgrade',
         :'can_upgrade' => :'can_upgrade',
         :'cost' => :'cost',
@@ -47,6 +50,7 @@ module UltracartClient
     # Attribute type mapping.
     def self.swagger_types
       {
+        :'active' => :'BOOLEAN',
         :'can_downgrade' => :'BOOLEAN',
         :'can_upgrade' => :'BOOLEAN',
         :'cost' => :'Float',
@@ -66,6 +70,10 @@ module UltracartClient
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
+      if attributes.has_key?(:'active')
+        self.active = attributes[:'active']
+      end
+
       if attributes.has_key?(:'can_downgrade')
         self.can_downgrade = attributes[:'can_downgrade']
       end
@@ -117,6 +125,7 @@ module UltracartClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          active == o.active &&
           can_downgrade == o.can_downgrade &&
           can_upgrade == o.can_upgrade &&
           cost == o.cost &&
@@ -136,7 +145,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [can_downgrade, can_upgrade, cost, cost_change, cost_change_formatted, cost_formatted, customers, emails].hash
+      [active, can_downgrade, can_upgrade, cost, cost_change, cost_change_formatted, cost_formatted, customers, emails].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-02 00:00:00.000000000 Z
+date: 2021-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus