Class: SquareConnect::SearchOrdersRequest

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

Overview

The request does not have any required fields. When given no query criteria, SearchOrders will return all results for all of the merchant’s locations. When fetching additional pages using a ‘cursor`, the `query` must be equal to the `query` used to fetch the first page of results.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SearchOrdersRequest

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
 
# File 'lib/square_connect/models/search_orders_request.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?(:'location_ids')
    if (value = attributes[:'location_ids']).is_a?(Array)
      self.location_ids = value
    end
  end

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

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

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

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

end

Instance Attribute Details

#cursor ⇒ Object

A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](/basics/api101/pagination) for more information.



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

def cursor
  @cursor
end

#limit ⇒ Object

Number of results to be returned in a single page. SearchOrders may use a smaller limit than specified depending on server load. If the response includes a ‘cursor` field, you can use it to retrieve the next set of results. Default: `500`



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

def limit
  @limit
end

#location_ids ⇒ Object

The location IDs for the orders to query. The caller must have access to all provided locations. Min: 1 ‘location_ids`. Max: 10 `location_ids`.



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

def location_ids
  @location_ids
end

#query ⇒ Object

Query conditions used to filter or sort the results. Note that when fetching additional pages using a ‘cursor`, the `query` must be equal to the `query` used to fetch the first page of results.



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

def query
  @query
end

#return_entries ⇒ Object

If set to ‘true`, SearchOrders will return [`OrderEntry`](#type-orderentry) objects instead of `Order` objects. `OrderEntry` objects are lightweight descriptions of orders that include `order_id`s. Default: `false`.



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

def return_entries
  @return_entries
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_request.rb', line 32

def self.attribute_map
  {
    :'location_ids' => :'location_ids',
    :'cursor' => :'cursor',
    :'query' => :'query',
    :'limit' => :'limit',
    :'return_entries' => :'return_entries'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'location_ids' => :'Array<String>',
    :'cursor' => :'String',
    :'query' => :'SearchOrdersQuery',
    :'limit' => :'Integer',
    :'return_entries' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



116
117
118
119
120
121
122
123
124
 
# File 'lib/square_connect/models/search_orders_request.rb', line 116

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      location_ids == o.location_ids &&
      cursor == o.cursor &&
      query == o.query &&
      limit == o.limit &&
      return_entries == o.return_entries
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



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
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/square_connect/models/search_orders_request.rb', line 162

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



228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/square_connect/models/search_orders_request.rb', line 228

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



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

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


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

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



134
135
136
 
# File 'lib/square_connect/models/search_orders_request.rb', line 134

def hash
  [location_ids, cursor, query, limit, return_entries].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



87
88
89
90
91
92
93
94
 
# File 'lib/square_connect/models/search_orders_request.rb', line 87

def list_invalid_properties
  invalid_properties = Array.new
  if !@limit.nil? && @limit < 1
    invalid_properties.push("invalid value for 'limit', must be greater 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



208
209
210
 
# File 'lib/square_connect/models/search_orders_request.rb', line 208

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



214
215
216
217
218
219
220
221
222
 
# File 'lib/square_connect/models/search_orders_request.rb', line 214

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



202
203
204
 
# File 'lib/square_connect/models/search_orders_request.rb', line 202

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



98
99
100
101
 
# File 'lib/square_connect/models/search_orders_request.rb', line 98

def valid?
  return false if !@limit.nil? && @limit < 1
  return true
end