ultracart_api 4.1.200 → 4.1.202

data/lib/ultracart_api/models/sfvb_item_multimedia.rb

@@ -24,9 +24,15 @@ module UltracartClient
     # True for the image an itemimage element with no code renders.  Default is per media type, so an item may have one default image and one default PDF at the same time.
     attr_accessor :default
 
-    # Stored with the image and rendered as its alt text.  When it is empty the render falls back to the item's own description, so an empty value here is not an empty alt attribute.
+    # The merchant's description, stored with the image and rendered as its alt text.  When it is empty the render falls back to rekognition_description or to text built from the item's title, depending on the element, so an empty value here is not an empty alt attribute.
     attr_accessor :description
 
+    # SHA-256 of description (empty when there is none).  Send it as current_sha256 when changing the description so a change made since you read it is not overwritten.
+    attr_accessor :description_sha256
+
+    # Where the alt text comes from now.  merchant when description is set, rekognition when only rekognition_description is, none otherwise.
+    attr_accessor :description_source
+
     # Width x height in pixels, when the storage measured the file.
     attr_accessor :dimensions
 
@@ -36,6 +42,12 @@ module UltracartClient
     # The stored file's name.  Empty when the slot is declared and nothing is attached.
     attr_accessor :filename
 
+    # The stored image's id.  Name it to change this image's description when it has no code.
+    attr_accessor :merchant_item_multimedia_oid
+
+    # The machine description image recognition produced for the stored image, if any.  It is used only while description is empty, and a description written here or in the admin always takes its place.
+    attr_accessor :rekognition_description
+
     # The media type the storage recorded.
     attr_accessor :type
 
@@ -71,9 +83,13 @@ module UltracartClient
         :'declared' => :'declared',
         :'default' => :'default',
         :'description' => :'description',
+        :'description_sha256' => :'description_sha256',
+        :'description_source' => :'description_source',
         :'dimensions' => :'dimensions',
         :'exclude_from_gallery' => :'exclude_from_gallery',
         :'filename' => :'filename',
+        :'merchant_item_multimedia_oid' => :'merchant_item_multimedia_oid',
+        :'rekognition_description' => :'rekognition_description',
         :'type' => :'type',
         :'view_url' => :'view_url'
       }
@@ -91,9 +107,13 @@ module UltracartClient
         :'declared' => :'Boolean',
         :'default' => :'Boolean',
         :'description' => :'String',
+        :'description_sha256' => :'String',
+        :'description_source' => :'String',
         :'dimensions' => :'String',
         :'exclude_from_gallery' => :'Boolean',
         :'filename' => :'String',
+        :'merchant_item_multimedia_oid' => :'Integer',
+        :'rekognition_description' => :'String',
         :'type' => :'String',
         :'view_url' => :'String'
       }
@@ -136,6 +156,14 @@ module UltracartClient
         self.description = attributes[:'description']
       end
 
+      if attributes.key?(:'description_sha256')
+        self.description_sha256 = attributes[:'description_sha256']
+      end
+
+      if attributes.key?(:'description_source')
+        self.description_source = attributes[:'description_source']
+      end
+
       if attributes.key?(:'dimensions')
         self.dimensions = attributes[:'dimensions']
       end
@@ -148,6 +176,14 @@ module UltracartClient
         self.filename = attributes[:'filename']
       end
 
+      if attributes.key?(:'merchant_item_multimedia_oid')
+        self.merchant_item_multimedia_oid = attributes[:'merchant_item_multimedia_oid']
+      end
+
+      if attributes.key?(:'rekognition_description')
+        self.rekognition_description = attributes[:'rekognition_description']
+      end
+
       if attributes.key?(:'type')
         self.type = attributes[:'type']
       end
@@ -167,11 +203,23 @@ module UltracartClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      description_source_validator = EnumAttributeValidator.new('String', ["merchant", "rekognition", "none"])
+      return false unless description_source_validator.valid?(@description_source)
       type_validator = EnumAttributeValidator.new('String', ["Image", "Video", "PDF", "Text", "Unknown"])
       return false unless type_validator.valid?(@type)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] description_source Object to be assigned
+    def description_source=(description_source)
+      validator = EnumAttributeValidator.new('String', ["merchant", "rekognition", "none"])
+      unless validator.valid?(description_source)
+        fail ArgumentError, "invalid value for \"description_source\", must be one of #{validator.allowable_values}."
+      end
+      @description_source = description_source
+    end
+
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
@@ -191,9 +239,13 @@ module UltracartClient
           declared == o.declared &&
           default == o.default &&
           description == o.description &&
+          description_sha256 == o.description_sha256 &&
+          description_source == o.description_source &&
           dimensions == o.dimensions &&
           exclude_from_gallery == o.exclude_from_gallery &&
           filename == o.filename &&
+          merchant_item_multimedia_oid == o.merchant_item_multimedia_oid &&
+          rekognition_description == o.rekognition_description &&
           type == o.type &&
           view_url == o.view_url
     end
@@ -207,7 +259,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [code, declared, default, description, dimensions, exclude_from_gallery, filename, type, view_url].hash
+      [code, declared, default, description, description_sha256, description_source, dimensions, exclude_from_gallery, filename, merchant_item_multimedia_oid, rekognition_description, type, view_url].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/sfvb_item_multimedia_description_request.rb

@@ -0,0 +1,260 @@
+=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 SfvbItemMultimediaDescriptionRequest
+    # The image code, the value an itemimage element's itemImageCode names.
+    attr_accessor :code
+
+    # The description_sha256 you read.  When it is sent and the description has changed since, nothing is written and the call fails with a version conflict.
+    attr_accessor :current_sha256
+
+    # The item's default image, which an itemimage element with no code renders.
+    attr_accessor :default
+
+    # The new description, rendered as the image's alt text.  An empty string clears it, so the image falls back to the machine description or the element's own fallback.  Longer text is cut to 500 characters.
+    attr_accessor :description
+
+    # The stored image's id, as an item read reports it.  Name this, or one of code or default.
+    attr_accessor :merchant_item_multimedia_oid
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'code' => :'code',
+        :'current_sha256' => :'current_sha256',
+        :'default' => :'default',
+        :'description' => :'description',
+        :'merchant_item_multimedia_oid' => :'merchant_item_multimedia_oid'
+      }
+    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
+      {
+        :'code' => :'String',
+        :'current_sha256' => :'String',
+        :'default' => :'Boolean',
+        :'description' => :'String',
+        :'merchant_item_multimedia_oid' => :'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::SfvbItemMultimediaDescriptionRequest` 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::SfvbItemMultimediaDescriptionRequest`. 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?(:'code')
+        self.code = attributes[:'code']
+      end
+
+      if attributes.key?(:'current_sha256')
+        self.current_sha256 = attributes[:'current_sha256']
+      end
+
+      if attributes.key?(:'default')
+        self.default = attributes[:'default']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'merchant_item_multimedia_oid')
+        self.merchant_item_multimedia_oid = attributes[:'merchant_item_multimedia_oid']
+      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 &&
+          code == o.code &&
+          current_sha256 == o.current_sha256 &&
+          default == o.default &&
+          description == o.description &&
+          merchant_item_multimedia_oid == o.merchant_item_multimedia_oid
+    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
+      [code, current_sha256, default, description, merchant_item_multimedia_oid].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.200'
+  VERSION = '4.1.202'
 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'
@@ -1050,6 +1054,7 @@ require 'ultracart_api/models/sfvb_item_container'
 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_description_request'
 require 'ultracart_api/models/sfvb_item_multimedia_request'
 require 'ultracart_api/models/sfvb_item_pricing'
 require 'ultracart_api/models/sfvb_item_pricing_request'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.1.200
+  version: 4.1.202
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-10-09 00:00:00.000000000 Z
+date: 2026-10-13 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
@@ -1112,6 +1116,7 @@ files:
 - docs/SfvbItemContainersResponse.md
 - docs/SfvbItemContentRequest.md
 - docs/SfvbItemMultimedia.md
+- docs/SfvbItemMultimediaDescriptionRequest.md
 - docs/SfvbItemMultimediaRequest.md
 - docs/SfvbItemPricing.md
 - docs/SfvbItemPricingRequest.md
@@ -2373,6 +2378,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
@@ -2416,6 +2425,7 @@ files:
 - lib/ultracart_api/models/sfvb_item_containers_response.rb
 - lib/ultracart_api/models/sfvb_item_content_request.rb
 - lib/ultracart_api/models/sfvb_item_multimedia.rb
+- lib/ultracart_api/models/sfvb_item_multimedia_description_request.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