class SquareConnect::CatalogQuery

A query to be applied to a [SearchCatalogObjectsRequest](type-searchcatalogobjectsrequest). Only one query field may be present. Where an attribute name is required, it should be specified as the name of any field marked "searchable" from the structured data types for the desired result object type(s) ([CatalogItem](type-catalogitem), [CatalogItemVariation](type-catalogitemvariation), [CatalogCategory](type-catalogcategory), [CatalogTax](type-catalogtax), [CatalogDiscount](type-catalogdiscount), [CatalogModifierList](type-catalogmodifierlist), [CatalogModifier](type-catalogmodifier)). For example, a query that should return Items may specify attribute names from any of the searchable fields of the [CatalogItem](type-catalogitem) data type, namely `"name"`, `"description"`, and `"abbreviation"`.

Attributes

exact_query[RW]

A query that returns only objects for which the given (string-valued) attribute has the given case-insensitive value.

item_variations_for_item_option_values_query[RW]

A query that returns all [CatalogItemVariation](type-catalogitemvariations)s that have all of the given [CatalogItemOption](type-catalogitemoption) values.

items_for_item_options_query[RW]

A query that returns all [CatalogItem](type-catalogitem)s that have all of the given [CatalogItemOption](type-catalogitemoption)s.

items_for_modifier_list_query[RW]

A query that returns all [CatalogItem](type-catalogitem)s that have any of the given [CatalogModifierList](type-catalogmodifierlist)s enabled.

items_for_tax_query[RW]

A query that returns all [CatalogItem](type-catalogitem)s that have any of the given [CatalogTax](type-catalogtax)es enabled.

prefix_query[RW]

A query that returns only objects for which the given (string-valued) attribute has the given case-insensitive prefix.

range_query[RW]

A query that returns only objects for which the given (integer-valued) attribute lies in the given range.

sorted_attribute_query[RW]

A query that returns all objects, sorted by the given attribute.

text_query[RW]

A query that returns only objects whose searchable attributes contain all of the given keywords as prefixes. For example, if a [CatalogItem](type-catalogitem) contains attributes `{"name": "t-shirt"}` and `{"description": "Small, Purple"}`, it will be matched by the query `{"keywords": ["shirt", "sma", "purp"]}`.

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.rb, line 44
def self.attribute_map
  {
    :'sorted_attribute_query' => :'sorted_attribute_query',
    :'exact_query' => :'exact_query',
    :'prefix_query' => :'prefix_query',
    :'range_query' => :'range_query',
    :'text_query' => :'text_query',
    :'items_for_tax_query' => :'items_for_tax_query',
    :'items_for_modifier_list_query' => :'items_for_modifier_list_query',
    :'items_for_item_options_query' => :'items_for_item_options_query',
    :'item_variations_for_item_option_values_query' => :'item_variations_for_item_option_values_query'
  }
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.rb, line 75
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?(:'sorted_attribute_query')
    self.sorted_attribute_query = attributes[:'sorted_attribute_query']
  end

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

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

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

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

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

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

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

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

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/square_connect/models/catalog_query.rb, line 59
def self.swagger_types
  {
    :'sorted_attribute_query' => :'CatalogQuerySortedAttribute',
    :'exact_query' => :'CatalogQueryExact',
    :'prefix_query' => :'CatalogQueryPrefix',
    :'range_query' => :'CatalogQueryRange',
    :'text_query' => :'CatalogQueryText',
    :'items_for_tax_query' => :'CatalogQueryItemsForTax',
    :'items_for_modifier_list_query' => :'CatalogQueryItemsForModifierList',
    :'items_for_item_options_query' => :'CatalogQueryItemsForItemOptions',
    :'item_variations_for_item_option_values_query' => :'CatalogQueryItemVariationsForItemOptionValues'
  }
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.rb, line 134
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      sorted_attribute_query == o.sorted_attribute_query &&
      exact_query == o.exact_query &&
      prefix_query == o.prefix_query &&
      range_query == o.range_query &&
      text_query == o.text_query &&
      items_for_tax_query == o.items_for_tax_query &&
      items_for_modifier_list_query == o.items_for_modifier_list_query &&
      items_for_item_options_query == o.items_for_item_options_query &&
      item_variations_for_item_option_values_query == o.item_variations_for_item_option_values_query
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.rb, line 184
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.rb, line 250
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
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.rb, line 163
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.rb, line 150
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.rb, line 156
def hash
  [sorted_attribute_query, exact_query, prefix_query, range_query, text_query, items_for_tax_query, items_for_modifier_list_query, items_for_item_options_query, item_variations_for_item_option_values_query].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.rb, line 121
def list_invalid_properties
  invalid_properties = Array.new
  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.rb, line 230
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.rb, line 236
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.rb, line 224
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.rb, line 128
def valid?
  return true
end