class SquareConnect::CatalogQueryPrefix

Attributes

attribute_name[RW]

The name of the attribute to be searched.

attribute_prefix[RW]

The desired prefix of the search attribute value.

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/square_connect/models/catalog_query_prefix.rb, line 23
def self.attribute_map
  {
    :'attribute_name' => :'attribute_name',
    :'attribute_prefix' => :'attribute_prefix'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/square_connect/models/catalog_query_prefix.rb, line 40
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'attribute_name')
    self.attribute_name = attributes[:'attribute_name']
  end

  if attributes.has_key?(:'attribute_prefix')
    self.attribute_prefix = attributes[:'attribute_prefix']
  end

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/square_connect/models/catalog_query_prefix.rb, line 31
def self.swagger_types
  {
    :'attribute_name' => :'String',
    :'attribute_prefix' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/square_connect/models/catalog_query_prefix.rb, line 119
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      attribute_name == o.attribute_name &&
      attribute_prefix == o.attribute_prefix
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/square_connect/models/catalog_query_prefix.rb, line 162
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = SquareConnect.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

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

# File lib/square_connect/models/catalog_query_prefix.rb, line 228
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
attribute_name=(attribute_name) click to toggle source

Custom attribute writer method with validation @param [Object] attribute_name Value to be assigned

# File lib/square_connect/models/catalog_query_prefix.rb, line 91
def attribute_name=(attribute_name)
  if attribute_name.nil?
    fail ArgumentError, "attribute_name cannot be nil"
  end

  if attribute_name.to_s.length < 1
    fail ArgumentError, "invalid value for 'attribute_name', the character length must be great than or equal to 1."
  end

  @attribute_name = attribute_name
end
attribute_prefix=(attribute_prefix) click to toggle source

Custom attribute writer method with validation @param [Object] attribute_prefix Value to be assigned

# File lib/square_connect/models/catalog_query_prefix.rb, line 105
def attribute_prefix=(attribute_prefix)
  if attribute_prefix.nil?
    fail ArgumentError, "attribute_prefix cannot be nil"
  end

  if attribute_prefix.to_s.length < 1
    fail ArgumentError, "invalid value for 'attribute_prefix', the character length must be great than or equal to 1."
  end

  @attribute_prefix = attribute_prefix
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/square_connect/models/catalog_query_prefix.rb, line 141
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/square_connect/models/catalog_query_prefix.rb, line 128
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/square_connect/models/catalog_query_prefix.rb, line 134
def hash
  [attribute_name, attribute_prefix].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons

# File lib/square_connect/models/catalog_query_prefix.rb, line 58
def list_invalid_properties
  invalid_properties = Array.new
  if @attribute_name.nil?
    invalid_properties.push("invalid value for 'attribute_name', attribute_name cannot be nil.")
  end

  if @attribute_name.to_s.length < 1
    invalid_properties.push("invalid value for 'attribute_name', the character length must be great than or equal to 1.")
  end

  if @attribute_prefix.nil?
    invalid_properties.push("invalid value for 'attribute_prefix', attribute_prefix cannot be nil.")
  end

  if @attribute_prefix.to_s.length < 1
    invalid_properties.push("invalid value for 'attribute_prefix', the character length must be great than or equal to 1.")
  end

  return invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/square_connect/models/catalog_query_prefix.rb, line 208
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/square_connect/models/catalog_query_prefix.rb, line 214
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/square_connect/models/catalog_query_prefix.rb, line 202
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/square_connect/models/catalog_query_prefix.rb, line 81
def valid?
  return false if @attribute_name.nil?
  return false if @attribute_name.to_s.length < 1
  return false if @attribute_prefix.nil?
  return false if @attribute_prefix.to_s.length < 1
  return true
end