Class: SquareConnect::CatalogQuerySortedAttribute

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CatalogQuerySortedAttribute

Initializes the object

Parameters:

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

    Model attributes in the form of hash



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/square_connect/models/catalog_query_sorted_attribute.rb', line 66

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?(:'initial_attribute_value')
    self.initial_attribute_value = attributes[:'initial_attribute_value']
  end

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

end

Instance Attribute Details

#attribute_name ⇒ Object

The attribute whose value should be used as the sort key.



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

def attribute_name
  @attribute_name
end

#initial_attribute_value ⇒ Object

The first attribute value to be returned by the query. Ascending sorts will return only objects with this value or greater, while descending sorts will return only objects with this value or less. If unset, start at the beginning (for ascending sorts) or end (for descending sorts).



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

def initial_attribute_value
  @initial_attribute_value
end

#sort_order ⇒ Object

The desired [SortOrder](#type-sortorder), ‘"ASC"` (ascending) or `"DESC"` (descending).



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

def sort_order
  @sort_order
end

Class Method Details

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
 
# File 'lib/square_connect/models/catalog_query_sorted_attribute.rb', line 47

def self.attribute_map
  {
    :'attribute_name' => :'attribute_name',
    :'initial_attribute_value' => :'initial_attribute_value',
    :'sort_order' => :'sort_order'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
 
# File 'lib/square_connect/models/catalog_query_sorted_attribute.rb', line 56

def self.swagger_types
  {
    :'attribute_name' => :'String',
    :'initial_attribute_value' => :'String',
    :'sort_order' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



137
138
139
140
141
142
143
 
# File 'lib/square_connect/models/catalog_query_sorted_attribute.rb', line 137

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      attribute_name == o.attribute_name &&
      initial_attribute_value == o.initial_attribute_value &&
      sort_order == o.sort_order
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



181
182
183
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
 
# File 'lib/square_connect/models/catalog_query_sorted_attribute.rb', line 181

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



247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/square_connect/models/catalog_query_sorted_attribute.rb', line 247

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



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/square_connect/models/catalog_query_sorted_attribute.rb', line 160

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


147
148
149
 
# File 'lib/square_connect/models/catalog_query_sorted_attribute.rb', line 147

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



153
154
155
 
# File 'lib/square_connect/models/catalog_query_sorted_attribute.rb', line 153

def hash
  [attribute_name, initial_attribute_value, sort_order].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



88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/square_connect/models/catalog_query_sorted_attribute.rb', line 88

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

  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



227
228
229
 
# File 'lib/square_connect/models/catalog_query_sorted_attribute.rb', line 227

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



233
234
235
236
237
238
239
240
241
 
# File 'lib/square_connect/models/catalog_query_sorted_attribute.rb', line 233

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



221
222
223
 
# File 'lib/square_connect/models/catalog_query_sorted_attribute.rb', line 221

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



103
104
105
106
107
108
109
 
# File 'lib/square_connect/models/catalog_query_sorted_attribute.rb', line 103

def valid?
  return false if @attribute_name.nil?
  return false if @attribute_name.to_s.length < 1
  sort_order_validator = EnumAttributeValidator.new('String', ["DESC", "ASC"])
  return false unless sort_order_validator.valid?(@sort_order)
  return true
end