ultracart_api 4.1.169 → 4.1.170

data/lib/ultracart_api/models/sfvb_item_response.rb

@@ -0,0 +1,295 @@
+=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 SfvbItemResponse
+    # Every attribute a template declares for this item plus every one stored on it, so the list answers what can be set as well as what is set.
+    attr_accessor :attributes
+
+    # What an itemdescription element renders, the item's extended description.  Like title this is the catalog's own field rather than a storefront copy of it.
+    attr_accessor :description
+
+    # The page paths this item is assigned to on this storefront.  The templates behind those pages are what the attribute and image declarations were reconciled against, so an empty list is why an item can report no declared attributes at all.
+    attr_accessor :groups
+
+    # The item id a storefront carries, and the one data-context-item-id holds.
+    attr_accessor :merchant_item_id
+
+    # The item's internal oid, which appears nowhere on a rendered storefront.
+    attr_accessor :merchant_item_oid
+
+    # Every image slot a template declares plus every image attached to the item.
+    attr_accessor :multimedia
+
+    attr_accessor :seo
+
+    # What an itemtitle element renders.  This is the item's short description in the catalog, not a storefront only field, so changing it changes the item everywhere.
+    attr_accessor :title
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'attributes' => :'attributes',
+        :'description' => :'description',
+        :'groups' => :'groups',
+        :'merchant_item_id' => :'merchant_item_id',
+        :'merchant_item_oid' => :'merchant_item_oid',
+        :'multimedia' => :'multimedia',
+        :'seo' => :'seo',
+        :'title' => :'title'
+      }
+    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
+      {
+        :'attributes' => :'Array<SfvbItemAttribute>',
+        :'description' => :'String',
+        :'groups' => :'Array<String>',
+        :'merchant_item_id' => :'String',
+        :'merchant_item_oid' => :'Integer',
+        :'multimedia' => :'Array<SfvbItemMultimedia>',
+        :'seo' => :'SfvbItemSeo',
+        :'title' => :'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::SfvbItemResponse` 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::SfvbItemResponse`. 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?(:'attributes')
+        if (value = attributes[:'attributes']).is_a?(Array)
+          self.attributes = value
+        end
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'groups')
+        if (value = attributes[:'groups']).is_a?(Array)
+          self.groups = value
+        end
+      end
+
+      if attributes.key?(:'merchant_item_id')
+        self.merchant_item_id = attributes[:'merchant_item_id']
+      end
+
+      if attributes.key?(:'merchant_item_oid')
+        self.merchant_item_oid = attributes[:'merchant_item_oid']
+      end
+
+      if attributes.key?(:'multimedia')
+        if (value = attributes[:'multimedia']).is_a?(Array)
+          self.multimedia = value
+        end
+      end
+
+      if attributes.key?(:'seo')
+        self.seo = attributes[:'seo']
+      end
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      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 &&
+          attributes == o.attributes &&
+          description == o.description &&
+          groups == o.groups &&
+          merchant_item_id == o.merchant_item_id &&
+          merchant_item_oid == o.merchant_item_oid &&
+          multimedia == o.multimedia &&
+          seo == o.seo &&
+          title == o.title
+    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
+      [attributes, description, groups, merchant_item_id, merchant_item_oid, multimedia, seo, title].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_seo.rb

@@ -0,0 +1,358 @@
+=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 SfvbItemSeo
+    # storefrontSEODescription as stored on this item.  Empty when it has never been set.
+    attr_accessor :description
+
+    # Where effective_description comes from.
+    attr_accessor :description_source
+
+    # What the meta description renders as, after the item to page to site fallback.
+    attr_accessor :effective_description
+
+    # What the meta keywords render as, after the item to page to site fallback.
+    attr_accessor :effective_keywords
+
+    # What the document title renders as.
+    attr_accessor :effective_title
+
+    # storefrontSEOKeywords as stored on this item.  Empty when it has never been set.
+    attr_accessor :keywords
+
+    # Where effective_keywords comes from.
+    attr_accessor :keywords_source
+
+    # storefrontSEOTitle as stored on this item.  Empty when it has never been set.
+    attr_accessor :title
+
+    # Where effective_title comes from.  item_description means nothing is set here and the item's own description is being used.
+    attr_accessor :title_source
+
+    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
+      {
+        :'description' => :'description',
+        :'description_source' => :'description_source',
+        :'effective_description' => :'effective_description',
+        :'effective_keywords' => :'effective_keywords',
+        :'effective_title' => :'effective_title',
+        :'keywords' => :'keywords',
+        :'keywords_source' => :'keywords_source',
+        :'title' => :'title',
+        :'title_source' => :'title_source'
+      }
+    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
+      {
+        :'description' => :'String',
+        :'description_source' => :'String',
+        :'effective_description' => :'String',
+        :'effective_keywords' => :'String',
+        :'effective_title' => :'String',
+        :'keywords' => :'String',
+        :'keywords_source' => :'String',
+        :'title' => :'String',
+        :'title_source' => :'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::SfvbItemSeo` 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::SfvbItemSeo`. 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?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'description_source')
+        self.description_source = attributes[:'description_source']
+      end
+
+      if attributes.key?(:'effective_description')
+        self.effective_description = attributes[:'effective_description']
+      end
+
+      if attributes.key?(:'effective_keywords')
+        self.effective_keywords = attributes[:'effective_keywords']
+      end
+
+      if attributes.key?(:'effective_title')
+        self.effective_title = attributes[:'effective_title']
+      end
+
+      if attributes.key?(:'keywords')
+        self.keywords = attributes[:'keywords']
+      end
+
+      if attributes.key?(:'keywords_source')
+        self.keywords_source = attributes[:'keywords_source']
+      end
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      end
+
+      if attributes.key?(:'title_source')
+        self.title_source = attributes[:'title_source']
+      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?
+      description_source_validator = EnumAttributeValidator.new('String', ["item", "group", "site", "none"])
+      return false unless description_source_validator.valid?(@description_source)
+      keywords_source_validator = EnumAttributeValidator.new('String', ["item", "group", "site", "none"])
+      return false unless keywords_source_validator.valid?(@keywords_source)
+      title_source_validator = EnumAttributeValidator.new('String', ["item", "item_description", "none"])
+      return false unless title_source_validator.valid?(@title_source)
+      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', ["item", "group", "site", "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] keywords_source Object to be assigned
+    def keywords_source=(keywords_source)
+      validator = EnumAttributeValidator.new('String', ["item", "group", "site", "none"])
+      unless validator.valid?(keywords_source)
+        fail ArgumentError, "invalid value for \"keywords_source\", must be one of #{validator.allowable_values}."
+      end
+      @keywords_source = keywords_source
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] title_source Object to be assigned
+    def title_source=(title_source)
+      validator = EnumAttributeValidator.new('String', ["item", "item_description", "none"])
+      unless validator.valid?(title_source)
+        fail ArgumentError, "invalid value for \"title_source\", must be one of #{validator.allowable_values}."
+      end
+      @title_source = title_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 &&
+          description == o.description &&
+          description_source == o.description_source &&
+          effective_description == o.effective_description &&
+          effective_keywords == o.effective_keywords &&
+          effective_title == o.effective_title &&
+          keywords == o.keywords &&
+          keywords_source == o.keywords_source &&
+          title == o.title &&
+          title_source == o.title_source
+    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
+      [description, description_source, effective_description, effective_keywords, effective_title, keywords, keywords_source, title, title_source].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