Class: SquareConnect::BatchRetrieveInventoryChangesRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BatchRetrieveInventoryChangesRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/square_connect/models/batch_retrieve_inventory_changes_request.rb', line 65

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

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

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

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

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

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

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

end

Instance Attribute Details

#catalog_object_ids ⇒ Object

Filters results by [CatalogObject](#type-catalogobject) ID. Only applied when set. Default: unset.



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

def catalog_object_ids
  @catalog_object_ids
end

#cursor ⇒ Object

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



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

def cursor
  @cursor
end

#location_ids ⇒ Object

Filters results by [Location](#type-location) ID. Only applied when set. Default: unset.



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

def location_ids
  @location_ids
end

#states ⇒ Object

Filters ‘ADJUSTMENT` query results by [InventoryState](#type-inventorystate). Only applied when set. Default: unset. See [InventoryState](#type-inventorystate) for possible values



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

def states
  @states
end

#types ⇒ Object

Filters results by [InventoryChangeType](#type-inventorychangetype). Default: [‘PHYSICAL_COUNT`, `ADJUSTMENT`]. `TRANSFER` is not supported as a filter. See [InventoryChangeType](#type-inventorychangetype) for possible values



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

def types
  @types
end

#updated_after ⇒ Object

Provided as an RFC 3339 timestamp. Returns results whose ‘created_at` or `calculated_at` value is after the given time. Default: UNIX epoch (`1970-01-01T00:00:00Z`).



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

def updated_after
  @updated_after
end

#updated_before ⇒ Object

Provided as an RFC 3339 timestamp. Returns results whose ‘created_at` or `calculated_at` value is strictly before the given time. Default: UNIX epoch (`1970-01-01T00:00:00Z`).



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

def updated_before
  @updated_before
end

Class Method Details

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/square_connect/models/batch_retrieve_inventory_changes_request.rb', line 38

def self.attribute_map
  {
    :'catalog_object_ids' => :'catalog_object_ids',
    :'location_ids' => :'location_ids',
    :'types' => :'types',
    :'states' => :'states',
    :'updated_after' => :'updated_after',
    :'updated_before' => :'updated_before',
    :'cursor' => :'cursor'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/square_connect/models/batch_retrieve_inventory_changes_request.rb', line 51

def self.swagger_types
  {
    :'catalog_object_ids' => :'Array<String>',
    :'location_ids' => :'Array<String>',
    :'types' => :'Array<String>',
    :'states' => :'Array<String>',
    :'updated_after' => :'String',
    :'updated_before' => :'String',
    :'cursor' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/square_connect/models/batch_retrieve_inventory_changes_request.rb', line 124

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      catalog_object_ids == o.catalog_object_ids &&
      location_ids == o.location_ids &&
      types == o.types &&
      states == o.states &&
      updated_after == o.updated_after &&
      updated_before == o.updated_before &&
      cursor == o.cursor
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



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
201
202
203
204
205
206
207
208
 
# File 'lib/square_connect/models/batch_retrieve_inventory_changes_request.rb', line 172

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



238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/square_connect/models/batch_retrieve_inventory_changes_request.rb', line 238

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



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/square_connect/models/batch_retrieve_inventory_changes_request.rb', line 151

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


138
139
140
 
# File 'lib/square_connect/models/batch_retrieve_inventory_changes_request.rb', line 138

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



144
145
146
 
# File 'lib/square_connect/models/batch_retrieve_inventory_changes_request.rb', line 144

def hash
  [catalog_object_ids, location_ids, types, states, updated_after, updated_before, cursor].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



111
112
113
114
 
# File 'lib/square_connect/models/batch_retrieve_inventory_changes_request.rb', line 111

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



218
219
220
 
# File 'lib/square_connect/models/batch_retrieve_inventory_changes_request.rb', line 218

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



224
225
226
227
228
229
230
231
232
 
# File 'lib/square_connect/models/batch_retrieve_inventory_changes_request.rb', line 224

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



212
213
214
 
# File 'lib/square_connect/models/batch_retrieve_inventory_changes_request.rb', line 212

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



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

def valid?
  return true
end