ultracart_api 3.0.76 → 3.1.4

data/lib/ultracart_api/api/auto_order_api.rb

@@ -19,7 +19,20 @@ module UltracartClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Retrieve an auto order
+
+    def self.new_using_api_key(simple_key, verify_ssl = true, debugging = false)
+      api_config = Configuration.new
+      api_config.api_key_prefix['x-ultracart-simple-key'] = simple_key
+      api_config.api_version = '2017-03-01'
+      api_config.verify_ssl = verify_ssl
+
+      api_client = ApiClient.new(api_config)
+      api_client.config.debugging = debugging
+
+      UltracartClient::AutoOrderApi.new(api_client)
+    end
+
+    # 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
@@ -30,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
@@ -77,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
@@ -88,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
@@ -135,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
@@ -146,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
@@ -369,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
@@ -383,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/chargeback_api.rb

@@ -19,6 +19,19 @@ module UltracartClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+
+    def self.new_using_api_key(simple_key, verify_ssl = true, debugging = false)
+      api_config = Configuration.new
+      api_config.api_key_prefix['x-ultracart-simple-key'] = simple_key
+      api_config.api_version = '2017-03-01'
+      api_config.verify_ssl = verify_ssl
+
+      api_client = ApiClient.new(api_config)
+      api_client.config.debugging = debugging
+
+      UltracartClient::ChargebackApi.new(api_client)
+    end
+
     # Delete a chargeback
     # Delete a chargeback on the UltraCart account. 
     # @param chargeback_dispute_oid The chargeback_dispute_oid to delete.

data/lib/ultracart_api/api/checkout_api.rb

@@ -19,6 +19,19 @@ module UltracartClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+
+    def self.new_using_api_key(simple_key, verify_ssl = true, debugging = false)
+      api_config = Configuration.new
+      api_config.api_key_prefix['x-ultracart-simple-key'] = simple_key
+      api_config.api_version = '2017-03-01'
+      api_config.verify_ssl = verify_ssl
+
+      api_client = ApiClient.new(api_config)
+      api_client.config.debugging = debugging
+
+      UltracartClient::CheckoutApi.new(api_client)
+    end
+
     # City/State for Zip
     # Look up the city and state for the shipping zip code.  Useful for building an auto complete for parts of the shipping address 
     # @param cart Cart
@@ -924,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]
@@ -934,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

@@ -19,6 +19,19 @@ module UltracartClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+
+    def self.new_using_api_key(simple_key, verify_ssl = true, debugging = false)
+      api_config = Configuration.new
+      api_config.api_key_prefix['x-ultracart-simple-key'] = simple_key
+      api_config.api_version = '2017-03-01'
+      api_config.verify_ssl = verify_ssl
+
+      api_client = ApiClient.new(api_config)
+      api_client.config.debugging = debugging
+
+      UltracartClient::CouponApi.new(api_client)
+    end
+
     # Delete a coupon
     # Delete a coupon on the UltraCart account. 
     # @param coupon_oid The coupon_oid to delete.
@@ -1021,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.
@@ -1034,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

@@ -19,6 +19,19 @@ module UltracartClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+
+    def self.new_using_api_key(simple_key, verify_ssl = true, debugging = false)
+      api_config = Configuration.new
+      api_config.api_key_prefix['x-ultracart-simple-key'] = simple_key
+      api_config.api_version = '2017-03-01'
+      api_config.verify_ssl = verify_ssl
+
+      api_client = ApiClient.new(api_config)
+      api_client.config.debugging = debugging
+
+      UltracartClient::CustomerApi.new(api_client)
+    end
+
     # Delete a customer
     # Delete a customer on the UltraCart account. 
     # @param customer_profile_oid The customer_profile_oid to delete.
@@ -132,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
@@ -497,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
@@ -680,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/fulfillment_api.rb

@@ -19,6 +19,19 @@ module UltracartClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+
+    def self.new_using_api_key(simple_key, verify_ssl = true, debugging = false)
+      api_config = Configuration.new
+      api_config.api_key_prefix['x-ultracart-simple-key'] = simple_key
+      api_config.api_version = '2017-03-01'
+      api_config.verify_ssl = verify_ssl
+
+      api_client = ApiClient.new(api_config)
+      api_client.config.debugging = debugging
+
+      UltracartClient::FulfillmentApi.new(api_client)
+    end
+
     # Acknowledge receipt of orders.
     # Acknowledge receipt of orders so that they are removed from the fulfillment queue.  This method must be called after receiving and order (via webhook) or retrieving (via retrieve orders method). 
     # @param distribution_center_code Distribution center code

data/lib/ultracart_api/api/item_api.rb

@@ -19,6 +19,19 @@ module UltracartClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+
+    def self.new_using_api_key(simple_key, verify_ssl = true, debugging = false)
+      api_config = Configuration.new
+      api_config.api_key_prefix['x-ultracart-simple-key'] = simple_key
+      api_config.api_version = '2017-03-01'
+      api_config.verify_ssl = verify_ssl
+
+      api_client = ApiClient.new(api_config)
+      api_client.config.debugging = debugging
+
+      UltracartClient::ItemApi.new(api_client)
+    end
+
     # Delete an item
     # Delete an item on the UltraCart account. 
     # @param merchant_item_oid The item oid to delete.

data/lib/ultracart_api/api/oauth_api.rb

@@ -19,6 +19,19 @@ module UltracartClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+
+    def self.new_using_api_key(simple_key, verify_ssl = true, debugging = false)
+      api_config = Configuration.new
+      api_config.api_key_prefix['x-ultracart-simple-key'] = simple_key
+      api_config.api_version = '2017-03-01'
+      api_config.verify_ssl = verify_ssl
+
+      api_client = ApiClient.new(api_config)
+      api_client.config.debugging = debugging
+
+      UltracartClient::OauthApi.new(api_client)
+    end
+
     # Exchange authorization code for access token.
     # The final leg in the OAuth process which exchanges the specified access token for the access code needed to make API calls. 
     # @param client_id The OAuth application client_id.

data/lib/ultracart_api/api/order_api.rb

@@ -19,6 +19,19 @@ module UltracartClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+
+    def self.new_using_api_key(simple_key, verify_ssl = true, debugging = false)
+      api_config = Configuration.new
+      api_config.api_key_prefix['x-ultracart-simple-key'] = simple_key
+      api_config.api_version = '2017-03-01'
+      api_config.verify_ssl = verify_ssl
+
+      api_client = ApiClient.new(api_config)
+      api_client.config.debugging = debugging
+
+      UltracartClient::OrderApi.new(api_client)
+    end
+
     # Adjusts an order total
     # Adjusts an order total.  Adjusts individual items appropriately and considers taxes.  Desired total should be provided in the same currency as the order.  Returns true if successful. 
     # @param order_id The order id to cancel.
@@ -734,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
@@ -748,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