ultracart_api 4.1.121 → 4.1.124

data/lib/ultracart_api/models/email_suppression_surfaces.rb

@@ -0,0 +1,240 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+The version of the OpenAPI document: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.1-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module UltracartClient
+  class EmailSuppressionSurfaces
+    # Outcome of removing the address from the central cross-account ses_suppression table
+    attr_accessor :central_ses_suppression
+
+    # Outcome of clearing the per-customer send gates on esp_customer
+    attr_accessor :esp_customer_flags
+
+    # Outcome of removing the address from the SES-native account-level suppression list
+    attr_accessor :ses_account_suppression
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'central_ses_suppression' => :'central_ses_suppression',
+        :'esp_customer_flags' => :'esp_customer_flags',
+        :'ses_account_suppression' => :'ses_account_suppression'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'central_ses_suppression' => :'String',
+        :'esp_customer_flags' => :'String',
+        :'ses_account_suppression' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::EmailSuppressionSurfaces` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::EmailSuppressionSurfaces`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'central_ses_suppression')
+        self.central_ses_suppression = attributes[:'central_ses_suppression']
+      end
+
+      if attributes.key?(:'esp_customer_flags')
+        self.esp_customer_flags = attributes[:'esp_customer_flags']
+      end
+
+      if attributes.key?(:'ses_account_suppression')
+        self.ses_account_suppression = attributes[:'ses_account_suppression']
+      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 &&
+          central_ses_suppression == o.central_ses_suppression &&
+          esp_customer_flags == o.esp_customer_flags &&
+          ses_account_suppression == o.ses_account_suppression
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [central_ses_suppression, esp_customer_flags, ses_account_suppression].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    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)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif 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
+      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 :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = UltracartClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        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

data/lib/ultracart_api/models/tax_country.rb

@@ -42,6 +42,12 @@ module UltracartClient
     # True if taxation within this jurisdiction should charge tax on shipping
     attr_accessor :tax_shipping
 
+    # VAT collection threshold for this country. Blank means no threshold, 0 always collects VAT, a positive value collects at or below that order subtotal.
+    attr_accessor :vat_threshold
+
+    # Currency code the vat_threshold amount is expressed in (USD, EUR or GBP).
+    attr_accessor :vat_threshold_currency
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -53,7 +59,9 @@ module UltracartClient
         :'tax_gift_wrap' => :'tax_gift_wrap',
         :'tax_rate' => :'tax_rate',
         :'tax_rate_formatted' => :'tax_rate_formatted',
-        :'tax_shipping' => :'tax_shipping'
+        :'tax_shipping' => :'tax_shipping',
+        :'vat_threshold' => :'vat_threshold',
+        :'vat_threshold_currency' => :'vat_threshold_currency'
       }
     end
 
@@ -73,7 +81,9 @@ module UltracartClient
         :'tax_gift_wrap' => :'Boolean',
         :'tax_rate' => :'Float',
         :'tax_rate_formatted' => :'String',
-        :'tax_shipping' => :'Boolean'
+        :'tax_shipping' => :'Boolean',
+        :'vat_threshold' => :'Float',
+        :'vat_threshold_currency' => :'String'
       }
     end
 
@@ -135,6 +145,14 @@ module UltracartClient
       if attributes.key?(:'tax_shipping')
         self.tax_shipping = attributes[:'tax_shipping']
       end
+
+      if attributes.key?(:'vat_threshold')
+        self.vat_threshold = attributes[:'vat_threshold']
+      end
+
+      if attributes.key?(:'vat_threshold_currency')
+        self.vat_threshold_currency = attributes[:'vat_threshold_currency']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -163,7 +181,9 @@ module UltracartClient
           tax_gift_wrap == o.tax_gift_wrap &&
           tax_rate == o.tax_rate &&
           tax_rate_formatted == o.tax_rate_formatted &&
-          tax_shipping == o.tax_shipping
+          tax_shipping == o.tax_shipping &&
+          vat_threshold == o.vat_threshold &&
+          vat_threshold_currency == o.vat_threshold_currency
     end
 
     # @see the `==` method
@@ -175,7 +195,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [accounting_code, country_code, country_oid, states, tax_gift_charge, tax_gift_wrap, tax_rate, tax_rate_formatted, tax_shipping].hash
+      [accounting_code, country_code, country_oid, states, tax_gift_charge, tax_gift_wrap, tax_rate, tax_rate_formatted, tax_shipping, vat_threshold, vat_threshold_currency].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/tax_state.rb

@@ -69,6 +69,12 @@ module UltracartClient
     # If true, use UltraCart managed rates for this state
     attr_accessor :use_ultracart_managed_rates
 
+    # VAT collection threshold override for this region. Blank inherits the country threshold, 0 always collects VAT, a positive value collects at or below that order subtotal.
+    attr_accessor :vat_threshold
+
+    # Currency code the vat_threshold amount is expressed in (USD, EUR or GBP).
+    attr_accessor :vat_threshold_currency
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -89,7 +95,9 @@ module UltracartClient
         :'tax_rate' => :'tax_rate',
         :'tax_rate_formatted' => :'tax_rate_formatted',
         :'tax_shipping' => :'tax_shipping',
-        :'use_ultracart_managed_rates' => :'use_ultracart_managed_rates'
+        :'use_ultracart_managed_rates' => :'use_ultracart_managed_rates',
+        :'vat_threshold' => :'vat_threshold',
+        :'vat_threshold_currency' => :'vat_threshold_currency'
       }
     end
 
@@ -118,7 +126,9 @@ module UltracartClient
         :'tax_rate' => :'Float',
         :'tax_rate_formatted' => :'String',
         :'tax_shipping' => :'Boolean',
-        :'use_ultracart_managed_rates' => :'Boolean'
+        :'use_ultracart_managed_rates' => :'Boolean',
+        :'vat_threshold' => :'Float',
+        :'vat_threshold_currency' => :'String'
       }
     end
 
@@ -216,6 +226,14 @@ module UltracartClient
       if attributes.key?(:'use_ultracart_managed_rates')
         self.use_ultracart_managed_rates = attributes[:'use_ultracart_managed_rates']
       end
+
+      if attributes.key?(:'vat_threshold')
+        self.vat_threshold = attributes[:'vat_threshold']
+      end
+
+      if attributes.key?(:'vat_threshold_currency')
+        self.vat_threshold_currency = attributes[:'vat_threshold_currency']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -253,7 +271,9 @@ module UltracartClient
           tax_rate == o.tax_rate &&
           tax_rate_formatted == o.tax_rate_formatted &&
           tax_shipping == o.tax_shipping &&
-          use_ultracart_managed_rates == o.use_ultracart_managed_rates
+          use_ultracart_managed_rates == o.use_ultracart_managed_rates &&
+          vat_threshold == o.vat_threshold &&
+          vat_threshold_currency == o.vat_threshold_currency
     end
 
     # @see the `==` method
@@ -265,7 +285,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [accounting_code, counties, country_oid, dont_collect_city, dont_collect_county, dont_collect_postal_code, dont_collect_state, exempt_digital_items, exempt_physical_items, exempt_service_items, state_code, state_oid, tax_gift_charge, tax_gift_wrap, tax_rate, tax_rate_formatted, tax_shipping, use_ultracart_managed_rates].hash
+      [accounting_code, counties, country_oid, dont_collect_city, dont_collect_county, dont_collect_postal_code, dont_collect_state, exempt_digital_items, exempt_physical_items, exempt_service_items, state_code, state_oid, tax_gift_charge, tax_gift_wrap, tax_rate, tax_rate_formatted, tax_shipping, use_ultracart_managed_rates, vat_threshold, vat_threshold_currency].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '4.1.121'
+  VERSION = '4.1.124'
 end

data/lib/ultracart_api.rb

@@ -64,10 +64,12 @@ require 'ultracart_api/models/auto_order_item_option'
 require 'ultracart_api/models/auto_order_item_simple_schedule'
 require 'ultracart_api/models/auto_order_log'
 require 'ultracart_api/models/auto_order_management'
+require 'ultracart_api/models/auto_order_payment_update_request'
 require 'ultracart_api/models/auto_order_properties_update_request'
 require 'ultracart_api/models/auto_order_property'
 require 'ultracart_api/models/auto_order_query'
 require 'ultracart_api/models/auto_order_query_batch'
+require 'ultracart_api/models/auto_order_rebill_response'
 require 'ultracart_api/models/auto_order_response'
 require 'ultracart_api/models/auto_orders_request'
 require 'ultracart_api/models/auto_orders_response'
@@ -453,6 +455,9 @@ require 'ultracart_api/models/customer_edi'
 require 'ultracart_api/models/customer_editor_values'
 require 'ultracart_api/models/customer_email'
 require 'ultracart_api/models/customer_email_list_changes'
+require 'ultracart_api/models/customer_email_suppression_request'
+require 'ultracart_api/models/customer_email_suppression_response'
+require 'ultracart_api/models/customer_email_suppression_result'
 require 'ultracart_api/models/customer_loyalty'
 require 'ultracart_api/models/customer_loyalty_ledger'
 require 'ultracart_api/models/customer_loyalty_redemption'
@@ -600,6 +605,7 @@ require 'ultracart_api/models/email_step_stat_request'
 require 'ultracart_api/models/email_step_stat_response'
 require 'ultracart_api/models/email_step_waiting_request'
 require 'ultracart_api/models/email_step_waiting_response'
+require 'ultracart_api/models/email_suppression_surfaces'
 require 'ultracart_api/models/email_template'
 require 'ultracart_api/models/email_templates_response'
 require 'ultracart_api/models/email_third_party_list'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.1.121
+  version: 4.1.124
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-07-15 00:00:00.000000000 Z
+date: 2026-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -110,10 +110,12 @@ files:
 - docs/AutoOrderItemSimpleSchedule.md
 - docs/AutoOrderLog.md
 - docs/AutoOrderManagement.md
+- docs/AutoOrderPaymentUpdateRequest.md
 - docs/AutoOrderPropertiesUpdateRequest.md
 - docs/AutoOrderProperty.md
 - docs/AutoOrderQuery.md
 - docs/AutoOrderQueryBatch.md
+- docs/AutoOrderRebillResponse.md
 - docs/AutoOrderResponse.md
 - docs/AutoOrdersRequest.md
 - docs/AutoOrdersResponse.md
@@ -506,6 +508,9 @@ files:
 - docs/CustomerEditorValues.md
 - docs/CustomerEmail.md
 - docs/CustomerEmailListChanges.md
+- docs/CustomerEmailSuppressionRequest.md
+- docs/CustomerEmailSuppressionResponse.md
+- docs/CustomerEmailSuppressionResult.md
 - docs/CustomerLoyalty.md
 - docs/CustomerLoyaltyLedger.md
 - docs/CustomerLoyaltyRedemption.md
@@ -654,6 +659,7 @@ files:
 - docs/EmailStepStatResponse.md
 - docs/EmailStepWaitingRequest.md
 - docs/EmailStepWaitingResponse.md
+- docs/EmailSuppressionSurfaces.md
 - docs/EmailTemplate.md
 - docs/EmailTemplatesResponse.md
 - docs/EmailThirdPartyList.md
@@ -1190,10 +1196,12 @@ files:
 - lib/ultracart_api/models/auto_order_item_simple_schedule.rb
 - lib/ultracart_api/models/auto_order_log.rb
 - lib/ultracart_api/models/auto_order_management.rb
+- lib/ultracart_api/models/auto_order_payment_update_request.rb
 - lib/ultracart_api/models/auto_order_properties_update_request.rb
 - lib/ultracart_api/models/auto_order_property.rb
 - lib/ultracart_api/models/auto_order_query.rb
 - lib/ultracart_api/models/auto_order_query_batch.rb
+- lib/ultracart_api/models/auto_order_rebill_response.rb
 - lib/ultracart_api/models/auto_order_response.rb
 - lib/ultracart_api/models/auto_orders_request.rb
 - lib/ultracart_api/models/auto_orders_response.rb
@@ -1579,6 +1587,9 @@ files:
 - lib/ultracart_api/models/customer_editor_values.rb
 - lib/ultracart_api/models/customer_email.rb
 - lib/ultracart_api/models/customer_email_list_changes.rb
+- lib/ultracart_api/models/customer_email_suppression_request.rb
+- lib/ultracart_api/models/customer_email_suppression_response.rb
+- lib/ultracart_api/models/customer_email_suppression_result.rb
 - lib/ultracart_api/models/customer_loyalty.rb
 - lib/ultracart_api/models/customer_loyalty_ledger.rb
 - lib/ultracart_api/models/customer_loyalty_redemption.rb
@@ -1726,6 +1737,7 @@ files:
 - lib/ultracart_api/models/email_step_stat_response.rb
 - lib/ultracart_api/models/email_step_waiting_request.rb
 - lib/ultracart_api/models/email_step_waiting_response.rb
+- lib/ultracart_api/models/email_suppression_surfaces.rb
 - lib/ultracart_api/models/email_template.rb
 - lib/ultracart_api/models/email_templates_response.rb
 - lib/ultracart_api/models/email_third_party_list.rb