Class: SquareConnect::SearchOrdersResponse

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

Overview

Only one of ‘order_entries` or `orders` fields will be set, depending on whether `return_entries` was set on the [SearchOrdersRequest](#type-searchorderrequest).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SearchOrdersResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/square_connect/models/search_orders_response.rb', line 55

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?(:'order_entries')
    if (value = attributes[:'order_entries']).is_a?(Array)
      self.order_entries = value
    end
  end

  if attributes.has_key?(:'orders')
    if (value = attributes[:'orders']).is_a?(Array)
      self.orders = value
    end
  end

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

  if attributes.has_key?(:'errors')
    if (value = attributes[:'errors']).is_a?(Array)
      self.errors = value
    end
  end

  if attributes.has_key?(:'unconvertible_transaction_ids')
    if (value = attributes[:'unconvertible_transaction_ids']).is_a?(Array)
      self.unconvertible_transaction_ids = value
    end
  end

end

Instance Attribute Details

#cursor ⇒ Object

The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](/basics/api101/pagination) for more information.



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

def cursor
  @cursor
end

#errors ⇒ Object

[Errors](#type-error) encountered during the search.



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

def errors
  @errors
end

#order_entries ⇒ Object

List of [OrderEntries](#type-orderentry) that fit the query conditions. Populated only if ‘order_entries` was set to `true` in the request.



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

def order_entries
  @order_entries
end

#orders ⇒ Object

List of [Orders](#type-order) that match query conditions. Populated only if ‘return_entries` in the request is set to `false`.



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

def orders
  @orders
end

#unconvertible_transaction_ids ⇒ Object

List of transaction IDs identifying transactions that could not be converted to an ‘Order`. Empty if `return_entries` is true, however, attempts to retrieve those orders may encounter subsequent `unconvertible_transcation_ids` Note that this field will not be present after SearchOrders moves from BETA to GA.



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

def unconvertible_transaction_ids
  @unconvertible_transaction_ids
end

Class Method Details

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
40
 
# File 'lib/square_connect/models/search_orders_response.rb', line 32

def self.attribute_map
  {
    :'order_entries' => :'order_entries',
    :'orders' => :'orders',
    :'cursor' => :'cursor',
    :'errors' => :'errors',
    :'unconvertible_transaction_ids' => :'unconvertible_transaction_ids'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
49
50
51
 
# File 'lib/square_connect/models/search_orders_response.rb', line 43

def self.swagger_types
  {
    :'order_entries' => :'Array<OrderEntry>',
    :'orders' => :'Array<Order>',
    :'cursor' => :'String',
    :'errors' => :'Array<Error>',
    :'unconvertible_transaction_ids' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



106
107
108
109
110
111
112
113
114
 
# File 'lib/square_connect/models/search_orders_response.rb', line 106

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      order_entries == o.order_entries &&
      orders == o.orders &&
      cursor == o.cursor &&
      errors == o.errors &&
      unconvertible_transaction_ids == o.unconvertible_transaction_ids
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



152
153
154
155
156
157
158
159
160
161
162
163
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
 
# File 'lib/square_connect/models/search_orders_response.rb', line 152

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



218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/square_connect/models/search_orders_response.rb', line 218

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



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/square_connect/models/search_orders_response.rb', line 131

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


118
119
120
 
# File 'lib/square_connect/models/search_orders_response.rb', line 118

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



124
125
126
 
# File 'lib/square_connect/models/search_orders_response.rb', line 124

def hash
  [order_entries, orders, cursor, errors, unconvertible_transaction_ids].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



93
94
95
96
 
# File 'lib/square_connect/models/search_orders_response.rb', line 93

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



198
199
200
 
# File 'lib/square_connect/models/search_orders_response.rb', line 198

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



204
205
206
207
208
209
210
211
212
 
# File 'lib/square_connect/models/search_orders_response.rb', line 204

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



192
193
194
 
# File 'lib/square_connect/models/search_orders_response.rb', line 192

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



100
101
102
 
# File 'lib/square_connect/models/search_orders_response.rb', line 100

def valid?
  return true
end