ultracart_api 4.1.225 → 4.1.227

data/lib/ultracart_api/models/sfvb_sitemaps_response.rb

@@ -0,0 +1,273 @@
+=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 SfvbSitemapsResponse
+    # The host the sitemaps are built for.
+    attr_accessor :host
+
+    # What a person should know about these sitemaps, such as when they are rebuilt.
+    attr_accessor :notes
+
+    # True when the storefront's Prevent Indexing setting is on.  The sitemaps are still served, but every page tells search engines not to index it.
+    attr_accessor :prevent_indexing
+
+    attr_accessor :robots_txt
+
+    # The sitemaps that exist, sitemaps.org first.  Empty until the nightly build has run.
+    attr_accessor :sitemaps
+
+    # The storefront.
+    attr_accessor :storefront_oid
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'host' => :'host',
+        :'notes' => :'notes',
+        :'prevent_indexing' => :'prevent_indexing',
+        :'robots_txt' => :'robots_txt',
+        :'sitemaps' => :'sitemaps',
+        :'storefront_oid' => :'storefront_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
+      {
+        :'host' => :'String',
+        :'notes' => :'Array<String>',
+        :'prevent_indexing' => :'Boolean',
+        :'robots_txt' => :'SfvbRobotsTxt',
+        :'sitemaps' => :'Array<SfvbSitemap>',
+        :'storefront_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::SfvbSitemapsResponse` 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::SfvbSitemapsResponse`. 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?(:'host')
+        self.host = attributes[:'host']
+      end
+
+      if attributes.key?(:'notes')
+        if (value = attributes[:'notes']).is_a?(Array)
+          self.notes = value
+        end
+      end
+
+      if attributes.key?(:'prevent_indexing')
+        self.prevent_indexing = attributes[:'prevent_indexing']
+      end
+
+      if attributes.key?(:'robots_txt')
+        self.robots_txt = attributes[:'robots_txt']
+      end
+
+      if attributes.key?(:'sitemaps')
+        if (value = attributes[:'sitemaps']).is_a?(Array)
+          self.sitemaps = value
+        end
+      end
+
+      if attributes.key?(:'storefront_oid')
+        self.storefront_oid = attributes[:'storefront_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 &&
+          host == o.host &&
+          notes == o.notes &&
+          prevent_indexing == o.prevent_indexing &&
+          robots_txt == o.robots_txt &&
+          sitemaps == o.sitemaps &&
+          storefront_oid == o.storefront_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
+      [host, notes, prevent_indexing, robots_txt, sitemaps, storefront_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_tracking_provider.rb

@@ -18,6 +18,9 @@ module UltracartClient
     # Where the provider is in the admin.
     attr_accessor :admin_path
 
+    # On a dry run, whether the real write needs an approved tracking_provider.change request.
+    attr_accessor :approval_needed
+
     # On a write, each setting it changed, or would change on a dry run.  Secrets read only set or cleared.
     attr_accessor :changes
 
@@ -65,6 +68,7 @@ module UltracartClient
     def self.attribute_map
       {
         :'admin_path' => :'admin_path',
+        :'approval_needed' => :'approval_needed',
         :'changes' => :'changes',
         :'configured' => :'configured',
         :'consent' => :'consent',
@@ -92,6 +96,7 @@ module UltracartClient
     def self.openapi_types
       {
         :'admin_path' => :'String',
+        :'approval_needed' => :'Boolean',
         :'changes' => :'Array<SfvbTrackingChange>',
         :'configured' => :'Boolean',
         :'consent' => :'SfvbTrackingProviderConsent',
@@ -135,6 +140,10 @@ module UltracartClient
         self.admin_path = attributes[:'admin_path']
       end
 
+      if attributes.key?(:'approval_needed')
+        self.approval_needed = attributes[:'approval_needed']
+      end
+
       if attributes.key?(:'changes')
         if (value = attributes[:'changes']).is_a?(Array)
           self.changes = value
@@ -225,6 +234,7 @@ module UltracartClient
       return true if self.equal?(o)
       self.class == o.class &&
           admin_path == o.admin_path &&
+          approval_needed == o.approval_needed &&
           changes == o.changes &&
           configured == o.configured &&
           consent == o.consent &&
@@ -251,7 +261,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [admin_path, 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, wholesale_tiers].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/sfvb_tracking_provider_field.rb

@@ -48,6 +48,9 @@ module UltracartClient
     # id, id_list, token, url, server_url, host, host_list, bool, select, number, numeric_id or secret.  It decides what a write accepts.
     attr_accessor :type
 
+    # Present only when this storefront can't turn the field on, and why.  Turning it off still works.
+    attr_accessor :unavailable_reason
+
     # The stored value.  Booleans are true or false.  Null when blank.  Never present for a secret.
     attr_accessor :value
 
@@ -68,6 +71,7 @@ module UltracartClient
         :'set' => :'set',
         :'sink' => :'sink',
         :'type' => :'type',
+        :'unavailable_reason' => :'unavailable_reason',
         :'value' => :'value',
         :'writable' => :'writable'
       }
@@ -92,6 +96,7 @@ module UltracartClient
         :'set' => :'Boolean',
         :'sink' => :'String',
         :'type' => :'String',
+        :'unavailable_reason' => :'String',
         :'value' => :'String',
         :'writable' => :'Boolean'
       }
@@ -164,6 +169,10 @@ module UltracartClient
         self.type = attributes[:'type']
       end
 
+      if attributes.key?(:'unavailable_reason')
+        self.unavailable_reason = attributes[:'unavailable_reason']
+      end
+
       if attributes.key?(:'value')
         self.value = attributes[:'value']
       end
@@ -202,6 +211,7 @@ module UltracartClient
           set == o.set &&
           sink == o.sink &&
           type == o.type &&
+          unavailable_reason == o.unavailable_reason &&
           value == o.value &&
           writable == o.writable
     end
@@ -215,7 +225,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [allowed, key, label, mask, max, max_value, min_value, secret, set, sink, type, value, writable].hash
+      [allowed, key, label, mask, max, max_value, min_value, secret, set, sink, type, unavailable_reason, value, writable].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.225'
+  VERSION = '4.1.227'
 end

data/lib/ultracart_api.rb

@@ -1190,6 +1190,7 @@ require 'ultracart_api/models/sfvb_redirect_response'
 require 'ultracart_api/models/sfvb_redirects_response'
 require 'ultracart_api/models/sfvb_render_request'
 require 'ultracart_api/models/sfvb_render_response'
+require 'ultracart_api/models/sfvb_robots_txt'
 require 'ultracart_api/models/sfvb_secret_handle'
 require 'ultracart_api/models/sfvb_secret_kind'
 require 'ultracart_api/models/sfvb_secret_kinds_response'
@@ -1215,6 +1216,9 @@ require 'ultracart_api/models/sfvb_site_attribute'
 require 'ultracart_api/models/sfvb_site_attribute_update'
 require 'ultracart_api/models/sfvb_site_attribute_update_request'
 require 'ultracart_api/models/sfvb_site_attributes_response'
+require 'ultracart_api/models/sfvb_sitemap'
+require 'ultracart_api/models/sfvb_sitemap_file'
+require 'ultracart_api/models/sfvb_sitemaps_response'
 require 'ultracart_api/models/sfvb_smart_attribution'
 require 'ultracart_api/models/sfvb_smart_attribution_platform'
 require 'ultracart_api/models/sfvb_smart_attribution_request'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.1.225
+  version: 4.1.227
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-11-03 00:00:00.000000000 Z
+date: 2026-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -1252,6 +1252,7 @@ files:
 - docs/SfvbRedirectsResponse.md
 - docs/SfvbRenderRequest.md
 - docs/SfvbRenderResponse.md
+- docs/SfvbRobotsTxt.md
 - docs/SfvbSecretHandle.md
 - docs/SfvbSecretKind.md
 - docs/SfvbSecretKindsResponse.md
@@ -1277,6 +1278,9 @@ files:
 - docs/SfvbSiteAttributeUpdate.md
 - docs/SfvbSiteAttributeUpdateRequest.md
 - docs/SfvbSiteAttributesResponse.md
+- docs/SfvbSitemap.md
+- docs/SfvbSitemapFile.md
+- docs/SfvbSitemapsResponse.md
 - docs/SfvbSmartAttribution.md
 - docs/SfvbSmartAttributionPlatform.md
 - docs/SfvbSmartAttributionRequest.md
@@ -2641,6 +2645,7 @@ files:
 - lib/ultracart_api/models/sfvb_redirects_response.rb
 - lib/ultracart_api/models/sfvb_render_request.rb
 - lib/ultracart_api/models/sfvb_render_response.rb
+- lib/ultracart_api/models/sfvb_robots_txt.rb
 - lib/ultracart_api/models/sfvb_secret_handle.rb
 - lib/ultracart_api/models/sfvb_secret_kind.rb
 - lib/ultracart_api/models/sfvb_secret_kinds_response.rb
@@ -2666,6 +2671,9 @@ files:
 - lib/ultracart_api/models/sfvb_site_attribute_update.rb
 - lib/ultracart_api/models/sfvb_site_attribute_update_request.rb
 - lib/ultracart_api/models/sfvb_site_attributes_response.rb
+- lib/ultracart_api/models/sfvb_sitemap.rb
+- lib/ultracart_api/models/sfvb_sitemap_file.rb
+- lib/ultracart_api/models/sfvb_sitemaps_response.rb
 - lib/ultracart_api/models/sfvb_smart_attribution.rb
 - lib/ultracart_api/models/sfvb_smart_attribution_platform.rb
 - lib/ultracart_api/models/sfvb_smart_attribution_request.rb