ultracart_api 3.4.8 → 3.4.12

data/docs/PaymentsConfigurationSezzle.md

@@ -3,13 +3,14 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**accept_sezzle** | **BOOLEAN** |  | [optional] 
+**accept_sezzle** | **BOOLEAN** | Master flag for this merchant accepting Sezzle payments | [optional] 
+**accounting_code** | **String** | Optional Quickbooks code for this payment method | [optional] 
+**business_id** | **String** | Business ID | [optional] 
+**deposit_to_account** | **String** | Optional Quickbooks Deposit to Account value | [optional] 
+**environment** | **String** | Sezzle environment | [optional] 
+**environments** | **Array<String>** | List of environments possible | [optional] 
+**private_api_key** | **String** | Private API key | [optional] 
+**public_api_key** | **String** | Public API key | [optional] 
 **restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) |  | [optional] 
-**sezzle_accounting_code** | **String** |  | [optional] 
-**sezzle_business_id** | **String** |  | [optional] 
-**sezzle_deposit_to_account** | **String** |  | [optional] 
-**sezzle_environment** | **String** |  | [optional] 
-**sezzle_private_api_key** | **String** |  | [optional] 
-**sezzle_public_api_key** | **String** |  | [optional] 
 
 

data/docs/PaymentsConfigurationTestMethod.md

@@ -0,0 +1,18 @@
+# UltracartClient::PaymentsConfigurationTestMethod
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**bank_account_number** | **String** | Bank account number | [optional] 
+**bank_routing_number** | **String** | Bank routing number | [optional] 
+**credit_card_number** | **String** | Credit card number | [optional] 
+**credit_card_number_existing** | **String** | The existing credit card number | [optional] 
+**description** | **String** | Description | [optional] 
+**payment_action** | **String** | Payment action | [optional] 
+**payment_method** | **String** | Payment method | [optional] 
+**payment_method_test_oid** | **Integer** | Payment method test oid | [optional] 
+**skip_affiliate_transaction** | **BOOLEAN** | Skip affiliate transaction | [optional] 
+**skip_conversion_pixels** | **BOOLEAN** | If true, skips recording any conversion pixels to avoid sending test orders to your analysis sites | [optional] 
+**skip_fraud_filter** | **BOOLEAN** | Skip fraud filter | [optional] 
+
+

data/docs/PaymentsConfigurationWePay.md

@@ -3,33 +3,33 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**accept_wepay** | **BOOLEAN** |  | [optional] 
-**hide_credit_cards_non_ultra_cart_payments** | **BOOLEAN** |  | [optional] 
-**hide_surcharge_content** | **BOOLEAN** |  | [optional] 
+**accept_wepay** | **BOOLEAN** | Master flag indicating this merchant accepts UltraCart Payments WePay | [optional] 
+**account_update_uri** | **String** | URI for updating the WePay account | [optional] 
+**address1** | **String** | Address line 1 | [optional] 
+**address2** | **String** | Address line 2 | [optional] 
+**canada_accept_debit_cards** | **BOOLEAN** | For Canadian merchants, true if they wish to accept debit cards | [optional] 
+**city** | **String** | City | [optional] 
+**company** | **String** | Company | [optional] 
+**company_description** | **String** | Company description | [optional] 
+**console_hostname** | **String** | Console hostname | [optional] 
+**country** | **String** | Country | [optional] 
+**currency** | **String** | Base currency for transactions | [optional] 
+**expected_revenue** | **String** | Expected Revenue | [optional] 
+**hide_credit_card_non_ultracart_payments** | **BOOLEAN** | Internal flag to aid UI | [optional] 
+**hide_surcharge_amount** | **BOOLEAN** | Internal flag to aid UI | [optional] 
+**industry** | **String** | Industry | [optional] 
+**owner_email** | **String** | Owner email | [optional] 
+**owner_name** | **String** | Owner name | [optional] 
+**owner_phone** | **String** | Owner phone | [optional] 
+**postal_code** | **String** | Postal code | [optional] 
 **remove_pay_pal_pro** | **BOOLEAN** |  | [optional] 
 **restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) |  | [optional] 
-**short_pay_pal_marketing_text** | **BOOLEAN** |  | [optional] 
-**show_ultra_cart_payments_disabled** | **BOOLEAN** |  | [optional] 
-**show_ultra_cart_payments_intro** | **BOOLEAN** |  | [optional] 
-**show_ultra_cart_payments_verification** | **BOOLEAN** |  | [optional] 
-**show_ultra_cart_payments_verified** | **BOOLEAN** |  | [optional] 
-**wepay_account_update_uri** | **String** |  | [optional] 
-**wepay_address1** | **String** |  | [optional] 
-**wepay_address2** | **String** |  | [optional] 
-**wepay_canada_accept_debit_cards** | **BOOLEAN** |  | [optional] 
-**wepay_city** | **String** |  | [optional] 
-**wepay_company** | **String** |  | [optional] 
-**wepay_company_description** | **String** |  | [optional] 
-**wepay_console_hostname** | **String** |  | [optional] 
-**wepay_country** | **String** |  | [optional] 
-**wepay_currency** | **String** |  | [optional] 
-**wepay_expected_revenue** | **String** |  | [optional] 
-**wepay_industry** | **String** |  | [optional] 
-**wepay_owner_email** | **String** |  | [optional] 
-**wepay_owner_name** | **String** |  | [optional] 
-**wepay_owner_phone** | **String** |  | [optional] 
-**wepay_state** | **String** |  | [optional] 
-**wepay_website_url** | **String** |  | [optional] 
-**wepay_zip** | **String** |  | [optional] 
+**short_paypal_marketing_text** | **BOOLEAN** | Internal UI aid | [optional] 
+**show_ultracart_payments_disabled** | **BOOLEAN** | Internal flag to aid UI | [optional] 
+**show_ultracart_payments_intro** | **BOOLEAN** | Internal flag to aid UI | [optional] 
+**show_ultracart_payments_verification** | **BOOLEAN** | Internal flag to aid UI | [optional] 
+**show_ultracart_payments_verified** | **BOOLEAN** | Internal flag to aid UI | [optional] 
+**state** | **String** | State | [optional] 
+**website_url** | **String** | Website URL | [optional] 
 
 

data/docs/PaymentsConfigurationWireTransfer.md

@@ -3,16 +3,16 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**accept_wire_transfer** | **BOOLEAN** |  | [optional] 
+**accept_wire_transfer** | **BOOLEAN** | Master flag indicating this merchant accepts wire transfers | [optional] 
+**account_number** | **String** | account_number | [optional] 
+**accounting_code** | **String** | Optional Quickbooks accounting code | [optional] 
+**bank_address** | **String** | Bank address | [optional] 
+**deposit_to_account** | **String** | Optional Quickbooks deposit to account | [optional] 
+**intermediate_routing_number** | **String** | Intermediate routing number | [optional] 
 **restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) |  | [optional] 
-**wire_transfer_accounting_code** | **String** |  | [optional] 
-**wire_transfer_account_number** | **String** |  | [optional] 
-**wire_transfer_bank_address** | **String** |  | [optional] 
-**wire_transfer_deposit_to_account** | **String** |  | [optional] 
-**wire_transfer_intermediate_routing_number** | **String** |  | [optional] 
-**wire_transfer_routing_number** | **String** |  | [optional] 
-**wire_transfer_surcharge_accounting_code** | **String** |  | [optional] 
-**wire_transfer_surcharge_fee** | **String** |  | [optional] 
-**wire_transfer_surcharge_perc** | **String** |  | [optional] 
+**routing_number** | **String** | Routing number | [optional] 
+**surcharge_accounting_code** | **String** | If a surcharge is present and this merchant is integrated with Quickbooks, this is the accounting code for the surcharge amount | [optional] 
+**surcharge_fee** | **String** | surcharge_fee | [optional] 
+**surcharge_percentage** | **String** | surcharge_percentage | [optional] 
 
 

data/docs/StorefrontApi.md

@@ -44,6 +44,7 @@ Method | HTTP request | Description
 [**get_email_commseq_stat_overall**](StorefrontApi.md#get_email_commseq_stat_overall) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stat | Get communication sequence stats overall
 [**get_email_commseq_step_stats**](StorefrontApi.md#get_email_commseq_step_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stepStats | Get email communication sequence step stats
 [**get_email_commseq_step_waiting**](StorefrontApi.md#get_email_commseq_step_waiting) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/waiting | Get email communication sequence customers waiting at each requested step
+[**get_email_commseq_webhook_editor_values**](StorefrontApi.md#get_email_commseq_webhook_editor_values) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/webhookEditorValues | Get email webhook editor values
 [**get_email_commseqs**](StorefrontApi.md#get_email_commseqs) | **GET** /storefront/{storefront_oid}/email/commseqs | Get email commseqs
 [**get_email_customer_editor_url**](StorefrontApi.md#get_email_customer_editor_url) | **GET** /storefront/{storefront_oid}/email/customers/{email_customer_uuid}/editor_url | Get customers editor URL
 [**get_email_customers**](StorefrontApi.md#get_email_customers) | **GET** /storefront/{storefront_oid}/email/customers | Get email customers
@@ -2193,6 +2194,57 @@ Name | Type | Description  | Notes
 
 
 
+# **get_email_commseq_webhook_editor_values**
+> EmailWebhookEditorValuesResponse get_email_commseq_webhook_editor_values(storefront_oid, commseq_uuid)
+
+Get email webhook editor values
+
+### 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::StorefrontApi.new_using_api_key(simple_key, false, false)
+
+
+storefront_oid = 56 # Integer | 
+
+commseq_uuid = 'commseq_uuid_example' # String | 
+
+
+begin
+  #Get email webhook editor values
+  result = api_instance.get_email_commseq_webhook_editor_values(storefront_oid, commseq_uuid)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling StorefrontApi->get_email_commseq_webhook_editor_values: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **storefront_oid** | **Integer**|  | 
+ **commseq_uuid** | **String**|  | 
+
+### Return type
+
+[**EmailWebhookEditorValuesResponse**](EmailWebhookEditorValuesResponse.md)
+
+### Authorization
+
+[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **get_email_commseqs**
 > EmailCommseqsResponse get_email_commseqs(storefront_oid)
 

data/lib/ultracart_api.rb

@@ -315,6 +315,7 @@ 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/email_webhook_editor_values_response'
 require 'ultracart_api/models/error'
 require 'ultracart_api/models/error_response'
 require 'ultracart_api/models/experiment'
@@ -498,6 +499,7 @@ require 'ultracart_api/models/payments_configuration_cod'
 require 'ultracart_api/models/payments_configuration_cash'
 require 'ultracart_api/models/payments_configuration_check'
 require 'ultracart_api/models/payments_configuration_credit_card'
+require 'ultracart_api/models/payments_configuration_credit_card_type'
 require 'ultracart_api/models/payments_configuration_echeck'
 require 'ultracart_api/models/payments_configuration_loan_hero'
 require 'ultracart_api/models/payments_configuration_money_order'
@@ -506,7 +508,9 @@ require 'ultracart_api/models/payments_configuration_purchase_order'
 require 'ultracart_api/models/payments_configuration_quote_request'
 require 'ultracart_api/models/payments_configuration_response'
 require 'ultracart_api/models/payments_configuration_restrictions'
+require 'ultracart_api/models/payments_configuration_restrictions_theme'
 require 'ultracart_api/models/payments_configuration_sezzle'
+require 'ultracart_api/models/payments_configuration_test_method'
 require 'ultracart_api/models/payments_configuration_we_pay'
 require 'ultracart_api/models/payments_configuration_wire_transfer'
 require 'ultracart_api/models/payments_theme_transaction_type'

data/lib/ultracart_api/api/storefront_api.rb

@@ -2369,6 +2369,65 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Get email webhook editor values
+    # @param storefront_oid 
+    # @param commseq_uuid 
+    # @param [Hash] opts the optional parameters
+    # @return [EmailWebhookEditorValuesResponse]
+    def get_email_commseq_webhook_editor_values(storefront_oid, commseq_uuid, opts = {})
+      data, _status_code, _headers = get_email_commseq_webhook_editor_values_with_http_info(storefront_oid, commseq_uuid, opts)
+      data
+    end
+
+    # Get email webhook editor values
+    # @param storefront_oid 
+    # @param commseq_uuid 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EmailWebhookEditorValuesResponse, Fixnum, Hash)>] EmailWebhookEditorValuesResponse data, response status code and response headers
+    def get_email_commseq_webhook_editor_values_with_http_info(storefront_oid, commseq_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_commseq_webhook_editor_values ...'
+      end
+      # verify the required parameter 'storefront_oid' is set
+      if @api_client.config.client_side_validation && storefront_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_commseq_webhook_editor_values"
+      end
+      # verify the required parameter 'commseq_uuid' is set
+      if @api_client.config.client_side_validation && commseq_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.get_email_commseq_webhook_editor_values"
+      end
+      # resource path
+      local_var_path = '/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/webhookEditorValues'.sub('{' + 'storefront_oid' + '}', storefront_oid.to_s).sub('{' + 'commseq_uuid' + '}', commseq_uuid.to_s)
+
+      # 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 = nil
+      auth_names = ['ultraCartBrowserApiKey', '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 => 'EmailWebhookEditorValuesResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: StorefrontApi#get_email_commseq_webhook_editor_values\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Get email commseqs
     # @param storefront_oid 
     # @param [Hash] opts the optional parameters

data/lib/ultracart_api/models/email_webhook_editor_values_response.rb

@@ -0,0 +1,243 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+OpenAPI spec version: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.15-SNAPSHOT
+
+=end
+
+require 'date'
+
+module UltracartClient
+  class EmailWebhookEditorValuesResponse
+    attr_accessor :available_expansions
+
+    attr_accessor :available_tokens
+
+    attr_accessor :error
+
+    attr_accessor :metadata
+
+    attr_accessor :rest_object_type
+
+    # Indicates if API call was successful
+    attr_accessor :success
+
+    attr_accessor :warning
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'available_expansions' => :'available_expansions',
+        :'available_tokens' => :'available_tokens',
+        :'error' => :'error',
+        :'metadata' => :'metadata',
+        :'rest_object_type' => :'rest_object_type',
+        :'success' => :'success',
+        :'warning' => :'warning'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'available_expansions' => :'Array<String>',
+        :'available_tokens' => :'Array<String>',
+        :'error' => :'Error',
+        :'metadata' => :'ResponseMetadata',
+        :'rest_object_type' => :'String',
+        :'success' => :'BOOLEAN',
+        :'warning' => :'Warning'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'available_expansions')
+        if (value = attributes[:'available_expansions']).is_a?(Array)
+          self.available_expansions = value
+        end
+      end
+
+      if attributes.has_key?(:'available_tokens')
+        if (value = attributes[:'available_tokens']).is_a?(Array)
+          self.available_tokens = value
+        end
+      end
+
+      if attributes.has_key?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.has_key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.has_key?(:'rest_object_type')
+        self.rest_object_type = attributes[:'rest_object_type']
+      end
+
+      if attributes.has_key?(:'success')
+        self.success = attributes[:'success']
+      end
+
+      if attributes.has_key?(:'warning')
+        self.warning = attributes[:'warning']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          available_expansions == o.available_expansions &&
+          available_tokens == o.available_tokens &&
+          error == o.error &&
+          metadata == o.metadata &&
+          rest_object_type == o.rest_object_type &&
+          success == o.success &&
+          warning == o.warning
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [available_expansions, available_tokens, error, metadata, rest_object_type, success, warning].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = UltracartClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end