ultracart_api 3.1.0 → 3.1.5

data/docs/EmailVerifyTokenResponse.md

@@ -0,0 +1,12 @@
+# UltracartClient::EmailVerifyTokenResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | [**Error**](Error.md) |  | [optional] 
+**metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
+**success** | **BOOLEAN** | Indicates if API call was successful | [optional] 
+**token** | **String** | token | [optional] 
+**warning** | [**Warning**](Warning.md) |  | [optional] 
+
+

data/docs/EmailVerifyTokenValidateRequest.md

@@ -0,0 +1,8 @@
+# UltracartClient::EmailVerifyTokenValidateRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**token** | **String** | token | [optional] 
+
+

data/docs/EmailVerifyTokenValidateResponse.md

@@ -0,0 +1,11 @@
+# UltracartClient::EmailVerifyTokenValidateResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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/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/docs/ScreenRecording.md

@@ -11,7 +11,8 @@ Name | Type | Description | Notes
 **esp_customer_uuid** | **String** |  | [optional] 
 **events_gz_size** | **Integer** |  | [optional] 
 **events_json_key** | **String** |  | [optional] 
-**favorites** | **Array<Integer>** |  | [optional] 
+**favorite** | **BOOLEAN** | True if the user calling the API has favorited this particular screen recording. | [optional] 
+**favorites** | **Array<Integer>** | Array of user ids that favorited this particular screen recording. | [optional] 
 **geolocation** | [**GeoPoint**](GeoPoint.md) |  | [optional] 
 **geolocation_country** | **String** |  | [optional] 
 **geolocation_state** | **String** |  | [optional] 

data/lib/ultracart_api.rb

@@ -303,6 +303,10 @@ require 'ultracart_api/models/email_third_party_list'
 require 'ultracart_api/models/email_third_party_list_import_request'
 require 'ultracart_api/models/email_third_party_provider'
 require 'ultracart_api/models/email_third_party_providers_response'
+require 'ultracart_api/models/email_verify_token_request'
+require 'ultracart_api/models/email_verify_token_response'
+require 'ultracart_api/models/email_verify_token_validate_request'
+require 'ultracart_api/models/email_verify_token_validate_response'
 require 'ultracart_api/models/error'
 require 'ultracart_api/models/error_response'
 require 'ultracart_api/models/experiment'

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/coupon_api.rb

@@ -1034,7 +1034,7 @@ module UltracartClient
     end
     # Update multiple coupons
     # Update multiple coupon on the UltraCart account. 
-    # @param coupons_request Coupons to update (synchronous maximum 20 / asynchronous maximum 100)
+    # @param coupons_request Coupons to update (synchronous maximum 50 / asynchronous maximum 100)
     # @param [Hash] opts the optional parameters
     # @option opts [String] :_expand The object expansion to perform on the result.  See documentation for examples
     # @option opts [BOOLEAN] :_placeholders Whether or not placeholder values should be returned in the result.  Useful for UIs that consume this REST API.
@@ -1047,7 +1047,7 @@ module UltracartClient
 
     # Update multiple coupons
     # Update multiple coupon on the UltraCart account. 
-    # @param coupons_request Coupons to update (synchronous maximum 20 / asynchronous maximum 100)
+    # @param coupons_request Coupons to update (synchronous maximum 50 / asynchronous maximum 100)
     # @param [Hash] opts the optional parameters
     # @option opts [String] :_expand The object expansion to perform on the result.  See documentation for examples
     # @option opts [BOOLEAN] :_placeholders Whether or not placeholder values should be returned in the result.  Useful for UIs that consume this REST API.

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
@@ -510,6 +568,61 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Create a token that can be used to verify a customer email address
+    # Create a token that can be used to verify a customer email address.  The implementation of how a customer interacts with this token is left to the merchant. 
+    # @param token_request Token request
+    # @param [Hash] opts the optional parameters
+    # @return [EmailVerifyTokenResponse]
+    def get_email_verification_token(token_request, opts = {})
+      data, _status_code, _headers = get_email_verification_token_with_http_info(token_request, opts)
+      data
+    end
+
+    # Create a token that can be used to verify a customer email address
+    # Create a token that can be used to verify a customer email address.  The implementation of how a customer interacts with this token is left to the merchant. 
+    # @param token_request Token request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EmailVerifyTokenResponse, Fixnum, Hash)>] EmailVerifyTokenResponse data, response status code and response headers
+    def get_email_verification_token_with_http_info(token_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CustomerApi.get_email_verification_token ...'
+      end
+      # verify the required parameter 'token_request' is set
+      if @api_client.config.client_side_validation && token_request.nil?
+        fail ArgumentError, "Missing the required parameter 'token_request' when calling CustomerApi.get_email_verification_token"
+      end
+      # resource path
+      local_var_path = '/customer/customers/email_verify/get_token'
+
+      # query parameters
+      query_params = {}
+
+      # 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 = @api_client.object_to_http_body(token_request)
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'EmailVerifyTokenResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CustomerApi#get_email_verification_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Insert a customer
     # Insert a customer on the UltraCart account. 
     # @param customer Customer to insert
@@ -693,5 +806,60 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Validate a token that can be used to verify a customer email address
+    # Validate a token that can be used to verify a customer email address.  The implementation of how a customer interacts with this token is left to the merchant. 
+    # @param validation_request Token validation request
+    # @param [Hash] opts the optional parameters
+    # @return [EmailVerifyTokenValidateResponse]
+    def validate_email_verification_token(validation_request, opts = {})
+      data, _status_code, _headers = validate_email_verification_token_with_http_info(validation_request, opts)
+      data
+    end
+
+    # Validate a token that can be used to verify a customer email address
+    # Validate a token that can be used to verify a customer email address.  The implementation of how a customer interacts with this token is left to the merchant. 
+    # @param validation_request Token validation request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EmailVerifyTokenValidateResponse, Fixnum, Hash)>] EmailVerifyTokenValidateResponse data, response status code and response headers
+    def validate_email_verification_token_with_http_info(validation_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CustomerApi.validate_email_verification_token ...'
+      end
+      # verify the required parameter 'validation_request' is set
+      if @api_client.config.client_side_validation && validation_request.nil?
+        fail ArgumentError, "Missing the required parameter 'validation_request' when calling CustomerApi.validate_email_verification_token"
+      end
+      # resource path
+      local_var_path = '/customer/customers/email_verify/validate_token'
+
+      # query parameters
+      query_params = {}
+
+      # 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 = @api_client.object_to_http_body(validation_request)
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'EmailVerifyTokenValidateResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CustomerApi#validate_email_verification_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

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