Class: SquareConnect::SearchOrdersSort

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

Overview

Sorting options for a query. Returned Orders will always be sorted on a timestamp.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SearchOrdersSort

Initializes the object

Parameters:

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

    Model attributes in the form of hash



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/square_connect/models/search_orders_sort.rb', line 61

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

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

end

Instance Attribute Details

#sort_field ⇒ Object

The field to sort by. Important: When using a [DateTimeFilter](#type-searchordersfilter), ‘sort_field` must match the set time range field. If this field does not match the time range field in `DateTimeFilter`, SearchOrder will return an error. Default: `CREATED_AT`. See [SearchOrdersSortField](#type-searchorderssortfield) for possible values



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

def sort_field
  @sort_field
end

#sort_order ⇒ Object

The order in which results are returned. Defaults to ‘DESC`. See [SortOrder](#type-sortorder) for possible values



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

def sort_order
  @sort_order
end

Class Method Details

.attribute_map ⇒ Object

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



44
45
46
47
48
49
 
# File 'lib/square_connect/models/search_orders_sort.rb', line 44

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

.swagger_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
 
# File 'lib/square_connect/models/search_orders_sort.rb', line 52

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



121
122
123
124
125
126
 
# File 'lib/square_connect/models/search_orders_sort.rb', line 121

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



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/square_connect/models/search_orders_sort.rb', line 164

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



230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/square_connect/models/search_orders_sort.rb', line 230

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



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/square_connect/models/search_orders_sort.rb', line 143

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


130
131
132
 
# File 'lib/square_connect/models/search_orders_sort.rb', line 130

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



136
137
138
 
# File 'lib/square_connect/models/search_orders_sort.rb', line 136

def hash
  [sort_field, 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



79
80
81
82
83
84
85
86
 
# File 'lib/square_connect/models/search_orders_sort.rb', line 79

def list_invalid_properties
  invalid_properties = Array.new
  if @sort_field.nil?
    invalid_properties.push("invalid value for 'sort_field', sort_field cannot be nil.")
  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



210
211
212
 
# File 'lib/square_connect/models/search_orders_sort.rb', line 210

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



216
217
218
219
220
221
222
223
224
 
# File 'lib/square_connect/models/search_orders_sort.rb', line 216

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



204
205
206
 
# File 'lib/square_connect/models/search_orders_sort.rb', line 204

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



90
91
92
93
94
95
96
97
 
# File 'lib/square_connect/models/search_orders_sort.rb', line 90

def valid?
  return false if @sort_field.nil?
  sort_field_validator = EnumAttributeValidator.new('String', ["CREATED_AT", "UPDATED_AT", "CLOSED_AT"])
  return false unless sort_field_validator.valid?(@sort_field)
  sort_order_validator = EnumAttributeValidator.new('String', ["DESC", "ASC"])
  return false unless sort_order_validator.valid?(@sort_order)
  return true
end