ultracart_api 4.1.233 → 4.1.234

data/lib/ultracart_api/models/sfvb_tracking_html_render_request.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 SfvbTrackingHtmlRenderRequest
+    # HTML to render instead of the stored slot, such as a draft about to be written.  The same checks as a write apply.  Left out, the stored slot is rendered.
+    attr_accessor :content
+
+    # A test order on this account, as sf orders test-orders lists them.  A real or unknown order is refused the same way.
+    attr_accessor :order_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'content' => :'content',
+        :'order_id' => :'order_id'
+      }
+    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
+      {
+        :'content' => :'String',
+        :'order_id' => :'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::SfvbTrackingHtmlRenderRequest` 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::SfvbTrackingHtmlRenderRequest`. 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?(:'content')
+        self.content = attributes[:'content']
+      end
+
+      if attributes.key?(:'order_id')
+        self.order_id = attributes[:'order_id']
+      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 &&
+          content == o.content &&
+          order_id == o.order_id
+    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
+      [content, order_id].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_tracking_html_render_response.rb

@@ -0,0 +1,328 @@
+=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 SfvbTrackingHtmlRenderResponse
+    # The SHA-256 of the HTML rendered, before rendering, as the slot would store it.  For a draft, the hash a tracking_html.put approval binds.
+    attr_accessor :content_sha256
+
+    # The rendered HTML, with order tokens filled and Velocity run, as the receipt would inject it.  Empty when the slot is empty.
+    attr_accessor :html
+
+    # The test order rendered against.
+    attr_accessor :order_id
+
+    # The Velocity references the render provides.  Any other reference the receipt page has is left as written.
+    attr_accessor :provides
+
+    # The size of html in UTF-8 bytes.
+    attr_accessor :size_bytes
+
+    # The slot rendered.  Always conversion.
+    attr_accessor :slot
+
+    # stored when the slot's saved HTML was rendered, draft when the request's content was.
+    attr_accessor :source
+
+    # What the render left out or could not do, such as tokens it doesn't fill.
+    attr_accessor :warnings
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'content_sha256' => :'content_sha256',
+        :'html' => :'html',
+        :'order_id' => :'order_id',
+        :'provides' => :'provides',
+        :'size_bytes' => :'size_bytes',
+        :'slot' => :'slot',
+        :'source' => :'source',
+        :'warnings' => :'warnings'
+      }
+    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
+      {
+        :'content_sha256' => :'String',
+        :'html' => :'String',
+        :'order_id' => :'String',
+        :'provides' => :'Array<String>',
+        :'size_bytes' => :'Integer',
+        :'slot' => :'String',
+        :'source' => :'String',
+        :'warnings' => :'Array<SfvbErrorDetail>'
+      }
+    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::SfvbTrackingHtmlRenderResponse` 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::SfvbTrackingHtmlRenderResponse`. 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?(:'content_sha256')
+        self.content_sha256 = attributes[:'content_sha256']
+      end
+
+      if attributes.key?(:'html')
+        self.html = attributes[:'html']
+      end
+
+      if attributes.key?(:'order_id')
+        self.order_id = attributes[:'order_id']
+      end
+
+      if attributes.key?(:'provides')
+        if (value = attributes[:'provides']).is_a?(Array)
+          self.provides = value
+        end
+      end
+
+      if attributes.key?(:'size_bytes')
+        self.size_bytes = attributes[:'size_bytes']
+      end
+
+      if attributes.key?(:'slot')
+        self.slot = attributes[:'slot']
+      end
+
+      if attributes.key?(:'source')
+        self.source = attributes[:'source']
+      end
+
+      if attributes.key?(:'warnings')
+        if (value = attributes[:'warnings']).is_a?(Array)
+          self.warnings = 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?
+      source_validator = EnumAttributeValidator.new('String', ["stored", "draft"])
+      return false unless source_validator.valid?(@source)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] source Object to be assigned
+    def source=(source)
+      validator = EnumAttributeValidator.new('String', ["stored", "draft"])
+      unless validator.valid?(source)
+        fail ArgumentError, "invalid value for \"source\", must be one of #{validator.allowable_values}."
+      end
+      @source = source
+    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 &&
+          content_sha256 == o.content_sha256 &&
+          html == o.html &&
+          order_id == o.order_id &&
+          provides == o.provides &&
+          size_bytes == o.size_bytes &&
+          slot == o.slot &&
+          source == o.source &&
+          warnings == o.warnings
+    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
+      [content_sha256, html, order_id, provides, size_bytes, slot, source, warnings].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_tracking_provider.rb

@@ -61,6 +61,9 @@ module UltracartClient
 
     attr_accessor :oauth
 
+    # What the provider also sends from UltraCart's servers.  A consent gate holds back only the browser pixel, not these.  Absent when it sends nothing server side.
+    attr_accessor :server_side
+
     # For google_analytics, the account number per wholesale pricing tier.
     attr_accessor :wholesale_tiers
 
@@ -83,6 +86,7 @@ module UltracartClient
         :'name' => :'name',
         :'notes' => :'notes',
         :'oauth' => :'oauth',
+        :'server_side' => :'server_side',
         :'wholesale_tiers' => :'wholesale_tiers'
       }
     end
@@ -111,6 +115,7 @@ module UltracartClient
         :'name' => :'String',
         :'notes' => :'Array<String>',
         :'oauth' => :'SfvbTrackingProviderOauth',
+        :'server_side' => :'String',
         :'wholesale_tiers' => :'Array<SfvbTrackingWholesaleTier>'
       }
     end
@@ -208,6 +213,10 @@ module UltracartClient
         self.oauth = attributes[:'oauth']
       end
 
+      if attributes.key?(:'server_side')
+        self.server_side = attributes[:'server_side']
+      end
+
       if attributes.key?(:'wholesale_tiers')
         if (value = attributes[:'wholesale_tiers']).is_a?(Array)
           self.wholesale_tiers = value
@@ -249,6 +258,7 @@ module UltracartClient
           name == o.name &&
           notes == o.notes &&
           oauth == o.oauth &&
+          server_side == o.server_side &&
           wholesale_tiers == o.wholesale_tiers
     end
 
@@ -261,7 +271,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [admin_path, approval_needed, changes, configured, consent, consent_supported, cost, dry_run, events, fields, group, hash_sha256, key, name, notes, oauth, wholesale_tiers].hash
+      [admin_path, approval_needed, changes, configured, consent, consent_supported, cost, dry_run, events, fields, group, hash_sha256, key, name, notes, oauth, server_side, wholesale_tiers].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.233'
+  VERSION = '4.1.234'
 end

data/lib/ultracart_api.rb

@@ -1218,6 +1218,7 @@ require 'ultracart_api/models/sfvb_preview_access_request'
 require 'ultracart_api/models/sfvb_preview_access_response'
 require 'ultracart_api/models/sfvb_preview_session_request'
 require 'ultracart_api/models/sfvb_preview_session_response'
+require 'ultracart_api/models/sfvb_preview_tracking_html_request'
 require 'ultracart_api/models/sfvb_preview_url_response'
 require 'ultracart_api/models/sfvb_recording'
 require 'ultracart_api/models/sfvb_recording_event'
@@ -1308,6 +1309,8 @@ require 'ultracart_api/models/sfvb_tracking_advanced'
 require 'ultracart_api/models/sfvb_tracking_advanced_request'
 require 'ultracart_api/models/sfvb_tracking_change'
 require 'ultracart_api/models/sfvb_tracking_html'
+require 'ultracart_api/models/sfvb_tracking_html_render_request'
+require 'ultracart_api/models/sfvb_tracking_html_render_response'
 require 'ultracart_api/models/sfvb_tracking_html_request'
 require 'ultracart_api/models/sfvb_tracking_html_response'
 require 'ultracart_api/models/sfvb_tracking_privacy'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.1.233
+  version: 4.1.234
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-11-06 00:00:00.000000000 Z
+date: 2026-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -1280,6 +1280,7 @@ files:
 - docs/SfvbPreviewAccessResponse.md
 - docs/SfvbPreviewSessionRequest.md
 - docs/SfvbPreviewSessionResponse.md
+- docs/SfvbPreviewTrackingHtmlRequest.md
 - docs/SfvbPreviewUrlResponse.md
 - docs/SfvbRecording.md
 - docs/SfvbRecordingEvent.md
@@ -1370,6 +1371,8 @@ files:
 - docs/SfvbTrackingAdvancedRequest.md
 - docs/SfvbTrackingChange.md
 - docs/SfvbTrackingHtml.md
+- docs/SfvbTrackingHtmlRenderRequest.md
+- docs/SfvbTrackingHtmlRenderResponse.md
 - docs/SfvbTrackingHtmlRequest.md
 - docs/SfvbTrackingHtmlResponse.md
 - docs/SfvbTrackingPrivacy.md
@@ -2742,6 +2745,7 @@ files:
 - lib/ultracart_api/models/sfvb_preview_access_response.rb
 - lib/ultracart_api/models/sfvb_preview_session_request.rb
 - lib/ultracart_api/models/sfvb_preview_session_response.rb
+- lib/ultracart_api/models/sfvb_preview_tracking_html_request.rb
 - lib/ultracart_api/models/sfvb_preview_url_response.rb
 - lib/ultracart_api/models/sfvb_recording.rb
 - lib/ultracart_api/models/sfvb_recording_event.rb
@@ -2832,6 +2836,8 @@ files:
 - lib/ultracart_api/models/sfvb_tracking_advanced_request.rb
 - lib/ultracart_api/models/sfvb_tracking_change.rb
 - lib/ultracart_api/models/sfvb_tracking_html.rb
+- lib/ultracart_api/models/sfvb_tracking_html_render_request.rb
+- lib/ultracart_api/models/sfvb_tracking_html_render_response.rb
 - lib/ultracart_api/models/sfvb_tracking_html_request.rb
 - lib/ultracart_api/models/sfvb_tracking_html_response.rb
 - lib/ultracart_api/models/sfvb_tracking_privacy.rb