ultracart_api 4.1.199 → 4.1.201

data/lib/ultracart_api/models/sfvb_item_related_request.rb

@@ -0,0 +1,242 @@
+=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 SfvbItemRelatedRequest
+    # Left out keeps the stored value.
+    attr_accessor :no_system_calculated_related_items
+
+    # Left out keeps the stored value.
+    attr_accessor :not_relatable
+
+    # The merchant's related items, in order, up to 50.  An empty list removes them all.  The calculated (system) ones are kept.
+    attr_accessor :related_items
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'no_system_calculated_related_items' => :'no_system_calculated_related_items',
+        :'not_relatable' => :'not_relatable',
+        :'related_items' => :'related_items'
+      }
+    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
+      {
+        :'no_system_calculated_related_items' => :'Boolean',
+        :'not_relatable' => :'Boolean',
+        :'related_items' => :'Array<SfvbItemRelatedItem>'
+      }
+    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::SfvbItemRelatedRequest` 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::SfvbItemRelatedRequest`. 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?(:'no_system_calculated_related_items')
+        self.no_system_calculated_related_items = attributes[:'no_system_calculated_related_items']
+      end
+
+      if attributes.key?(:'not_relatable')
+        self.not_relatable = attributes[:'not_relatable']
+      end
+
+      if attributes.key?(:'related_items')
+        if (value = attributes[:'related_items']).is_a?(Array)
+          self.related_items = value
+        end
+      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 &&
+          no_system_calculated_related_items == o.no_system_calculated_related_items &&
+          not_relatable == o.not_relatable &&
+          related_items == o.related_items
+    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
+      [no_system_calculated_related_items, not_relatable, related_items].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/sfvb_item_volume_discount.rb

@@ -0,0 +1,230 @@
+=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 SfvbItemVolumeDiscount
+    # The unit price at that quantity, in the item's currency.
+    attr_accessor :cost
+
+    # The quantity from which this unit price applies.  2 or more.
+    attr_accessor :quantity
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'cost' => :'cost',
+        :'quantity' => :'quantity'
+      }
+    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
+      {
+        :'cost' => :'Float',
+        :'quantity' => :'Integer'
+      }
+    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::SfvbItemVolumeDiscount` 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::SfvbItemVolumeDiscount`. 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?(:'cost')
+        self.cost = attributes[:'cost']
+      end
+
+      if attributes.key?(:'quantity')
+        self.quantity = attributes[:'quantity']
+      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 &&
+          cost == o.cost &&
+          quantity == o.quantity
+    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
+      [cost, quantity].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/sfvb_theme_job_response.rb

@@ -24,7 +24,7 @@ module UltracartClient
     # What to do next when the job did not produce a theme.  The internal cause is not returned; it is recorded against the job id in the server log.
     attr_accessor :error_message
 
-    # When the job stopped.  Null until it does.
+    # When the job stopped, ISO 8601 UTC.  Null until it does.
     attr_accessor :finished_dts
 
     # Job handle.  Poll getSfvbThemeJob with this.
@@ -36,13 +36,13 @@ module UltracartClient
     # What the job is doing right now, for example 'Duplicating locale text'.
     attr_accessor :progress_description
 
-    # When the job started running.  Null until it does.
+    # When the job started running, ISO 8601 UTC.  Null until it does.
     attr_accessor :started_dts
 
     # Raw job status.
     attr_accessor :status
 
-    # When the job was queued.
+    # When the job was queued, ISO 8601 UTC.
     attr_accessor :submitted_dts
 
     # True only when the job finished successfully.  Check complete first.

data/lib/ultracart_api/version.rb

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

data/lib/ultracart_api.rb

@@ -1007,6 +1007,10 @@ require 'ultracart_api/models/sfvb_element'
 require 'ultracart_api/models/sfvb_element_schema_response'
 require 'ultracart_api/models/sfvb_elements_response'
 require 'ultracart_api/models/sfvb_error_detail'
+require 'ultracart_api/models/sfvb_event'
+require 'ultracart_api/models/sfvb_events_auth_request'
+require 'ultracart_api/models/sfvb_events_auth_response'
+require 'ultracart_api/models/sfvb_events_response'
 require 'ultracart_api/models/sfvb_experiment'
 require 'ultracart_api/models/sfvb_experiment_end_request'
 require 'ultracart_api/models/sfvb_experiment_objective'
@@ -1040,6 +1044,10 @@ require 'ultracart_api/models/sfvb_i18n_messages_response'
 require 'ultracart_api/models/sfvb_i18n_reset_response'
 require 'ultracart_api/models/sfvb_i18n_translation'
 require 'ultracart_api/models/sfvb_item_attribute'
+require 'ultracart_api/models/sfvb_item_attribute_batch_request'
+require 'ultracart_api/models/sfvb_item_attribute_batch_response'
+require 'ultracart_api/models/sfvb_item_attribute_batch_row'
+require 'ultracart_api/models/sfvb_item_attribute_batch_row_result'
 require 'ultracart_api/models/sfvb_item_attribute_update'
 require 'ultracart_api/models/sfvb_item_attribute_update_request'
 require 'ultracart_api/models/sfvb_item_container'
@@ -1047,9 +1055,15 @@ require 'ultracart_api/models/sfvb_item_containers_response'
 require 'ultracart_api/models/sfvb_item_content_request'
 require 'ultracart_api/models/sfvb_item_multimedia'
 require 'ultracart_api/models/sfvb_item_multimedia_request'
+require 'ultracart_api/models/sfvb_item_pricing'
+require 'ultracart_api/models/sfvb_item_pricing_request'
+require 'ultracart_api/models/sfvb_item_related'
+require 'ultracart_api/models/sfvb_item_related_item'
+require 'ultracart_api/models/sfvb_item_related_request'
 require 'ultracart_api/models/sfvb_item_response'
 require 'ultracart_api/models/sfvb_item_seo'
 require 'ultracart_api/models/sfvb_item_seo_request'
+require 'ultracart_api/models/sfvb_item_volume_discount'
 require 'ultracart_api/models/sfvb_library_ai_review'
 require 'ultracart_api/models/sfvb_library_content_manifest'
 require 'ultracart_api/models/sfvb_library_delete_result'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.1.199
+  version: 4.1.201
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-10-08 00:00:00.000000000 Z
+date: 2026-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -1069,6 +1069,10 @@ files:
 - docs/SfvbElementSchemaResponse.md
 - docs/SfvbElementsResponse.md
 - docs/SfvbErrorDetail.md
+- docs/SfvbEvent.md
+- docs/SfvbEventsAuthRequest.md
+- docs/SfvbEventsAuthResponse.md
+- docs/SfvbEventsResponse.md
 - docs/SfvbExperiment.md
 - docs/SfvbExperimentEndRequest.md
 - docs/SfvbExperimentObjective.md
@@ -1102,6 +1106,10 @@ files:
 - docs/SfvbI18nResetResponse.md
 - docs/SfvbI18nTranslation.md
 - docs/SfvbItemAttribute.md
+- docs/SfvbItemAttributeBatchRequest.md
+- docs/SfvbItemAttributeBatchResponse.md
+- docs/SfvbItemAttributeBatchRow.md
+- docs/SfvbItemAttributeBatchRowResult.md
 - docs/SfvbItemAttributeUpdate.md
 - docs/SfvbItemAttributeUpdateRequest.md
 - docs/SfvbItemContainer.md
@@ -1109,9 +1117,15 @@ files:
 - docs/SfvbItemContentRequest.md
 - docs/SfvbItemMultimedia.md
 - docs/SfvbItemMultimediaRequest.md
+- docs/SfvbItemPricing.md
+- docs/SfvbItemPricingRequest.md
+- docs/SfvbItemRelated.md
+- docs/SfvbItemRelatedItem.md
+- docs/SfvbItemRelatedRequest.md
 - docs/SfvbItemResponse.md
 - docs/SfvbItemSeo.md
 - docs/SfvbItemSeoRequest.md
+- docs/SfvbItemVolumeDiscount.md
 - docs/SfvbLibraryAiReview.md
 - docs/SfvbLibraryContentManifest.md
 - docs/SfvbLibraryDeleteResult.md
@@ -2363,6 +2377,10 @@ files:
 - lib/ultracart_api/models/sfvb_element_schema_response.rb
 - lib/ultracart_api/models/sfvb_elements_response.rb
 - lib/ultracart_api/models/sfvb_error_detail.rb
+- lib/ultracart_api/models/sfvb_event.rb
+- lib/ultracart_api/models/sfvb_events_auth_request.rb
+- lib/ultracart_api/models/sfvb_events_auth_response.rb
+- lib/ultracart_api/models/sfvb_events_response.rb
 - lib/ultracart_api/models/sfvb_experiment.rb
 - lib/ultracart_api/models/sfvb_experiment_end_request.rb
 - lib/ultracart_api/models/sfvb_experiment_objective.rb
@@ -2396,6 +2414,10 @@ files:
 - lib/ultracart_api/models/sfvb_i18n_reset_response.rb
 - lib/ultracart_api/models/sfvb_i18n_translation.rb
 - lib/ultracart_api/models/sfvb_item_attribute.rb
+- lib/ultracart_api/models/sfvb_item_attribute_batch_request.rb
+- lib/ultracart_api/models/sfvb_item_attribute_batch_response.rb
+- lib/ultracart_api/models/sfvb_item_attribute_batch_row.rb
+- lib/ultracart_api/models/sfvb_item_attribute_batch_row_result.rb
 - lib/ultracart_api/models/sfvb_item_attribute_update.rb
 - lib/ultracart_api/models/sfvb_item_attribute_update_request.rb
 - lib/ultracart_api/models/sfvb_item_container.rb
@@ -2403,9 +2425,15 @@ files:
 - lib/ultracart_api/models/sfvb_item_content_request.rb
 - lib/ultracart_api/models/sfvb_item_multimedia.rb
 - lib/ultracart_api/models/sfvb_item_multimedia_request.rb
+- lib/ultracart_api/models/sfvb_item_pricing.rb
+- lib/ultracart_api/models/sfvb_item_pricing_request.rb
+- lib/ultracart_api/models/sfvb_item_related.rb
+- lib/ultracart_api/models/sfvb_item_related_item.rb
+- lib/ultracart_api/models/sfvb_item_related_request.rb
 - lib/ultracart_api/models/sfvb_item_response.rb
 - lib/ultracart_api/models/sfvb_item_seo.rb
 - lib/ultracart_api/models/sfvb_item_seo_request.rb
+- lib/ultracart_api/models/sfvb_item_volume_discount.rb
 - lib/ultracart_api/models/sfvb_library_ai_review.rb
 - lib/ultracart_api/models/sfvb_library_content_manifest.rb
 - lib/ultracart_api/models/sfvb_library_delete_result.rb