Class: SquareConnect::CatalogQuery

Inherits:
Object
  • Object
show all
Defined in:
lib/square_connect/models/catalog_query.rb

Overview

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"`.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CatalogQuery

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# 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

Instance Attribute Details

#exact_query ⇒ Object

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



19
20
21
 
# File 'lib/square_connect/models/catalog_query.rb', line 19

def exact_query
  @exact_query
end

#item_variations_for_item_option_values_query ⇒ Object

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



40
41
42
 
# File 'lib/square_connect/models/catalog_query.rb', line 40

def item_variations_for_item_option_values_query
  @item_variations_for_item_option_values_query
end

#items_for_item_options_query ⇒ Object

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



37
38
39
 
# File 'lib/square_connect/models/catalog_query.rb', line 37

def items_for_item_options_query
  @items_for_item_options_query
end

#items_for_modifier_list_query ⇒ Object

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



34
35
36
 
# File 'lib/square_connect/models/catalog_query.rb', line 34

def items_for_modifier_list_query
  @items_for_modifier_list_query
end

#items_for_tax_query ⇒ Object

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



31
32
33
 
# File 'lib/square_connect/models/catalog_query.rb', line 31

def items_for_tax_query
  @items_for_tax_query
end

#prefix_query ⇒ Object

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



22
23
24
 
# File 'lib/square_connect/models/catalog_query.rb', line 22

def prefix_query
  @prefix_query
end

#range_query ⇒ Object

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



25
26
27
 
# File 'lib/square_connect/models/catalog_query.rb', line 25

def range_query
  @range_query
end

#sorted_attribute_query ⇒ Object

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



16
17
18
 
# File 'lib/square_connect/models/catalog_query.rb', line 16

def sorted_attribute_query
  @sorted_attribute_query
end

#text_query ⇒ Object

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 ‘"t-shirt"` and `"Small, Purple"`, it will be matched by the query `["shirt", "sma", "purp"]`.



28
29
30
 
# File 'lib/square_connect/models/catalog_query.rb', line 28

def text_query
  @text_query
end

Class Method Details

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
56
 
# 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

.swagger_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
70
71
 
# 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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



134
135
136
137
138
139
140
141
142
143
144
145
146
 
# 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) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# 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) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



250
251
252
253
254
255
256
257
258
259
260
261
262
 
# 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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# 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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


150
151
152
 
# File 'lib/square_connect/models/catalog_query.rb', line 150

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



156
157
158
 
# 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 ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



121
122
123
124
 
# File 'lib/square_connect/models/catalog_query.rb', line 121

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



230
231
232
 
# File 'lib/square_connect/models/catalog_query.rb', line 230

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



236
237
238
239
240
241
242
243
244
 
# 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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



224
225
226
 
# File 'lib/square_connect/models/catalog_query.rb', line 224

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



128
129
130
 
# File 'lib/square_connect/models/catalog_query.rb', line 128

def valid?
  return true
end