Class: SquareConnect::InventoryCount

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

Overview

Represents the estimated quantity of items in a particular state at a particular location based on the known history of physical counts and inventory adjustments.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InventoryCount

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
108
109
110
111
 
# File 'lib/square_connect/models/inventory_count.rb', line 81

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_id')
    self.catalog_object_id = attributes[:'catalog_object_id']
  end

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

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

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

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

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

end

Instance Attribute Details

#calculated_at ⇒ Object

A read-only timestamp in RFC 3339 format that indicates when Square received the most recent physical count or adjustment that had an affect on the estimated count.



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

def calculated_at
  @calculated_at
end

#catalog_object_id ⇒ Object

The Square generated ID of the [CatalogObject](#type-catalogobject) being tracked.



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

def catalog_object_id
  @catalog_object_id
end

#catalog_object_type ⇒ Object

The [CatalogObjectType](#type-catalogobjecttype) of the [CatalogObject](#type-catalogobject) being tracked. Tracking is only supported for the ‘ITEM_VARIATION` type.



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

def catalog_object_type
  @catalog_object_type
end

#location_id ⇒ Object

The Square ID of the [Location](#type-location) where the related quantity of items are being tracked.



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

def location_id
  @location_id
end

#quantity ⇒ Object

The number of items in the count as a decimal string. Fractional quantities are not supported.



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

def quantity
  @quantity
end

#state ⇒ Object

The current [InventoryState](#type-inventorystate) for the related quantity of items.



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

def state
  @state
end

Class Method Details

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
 
# File 'lib/square_connect/models/inventory_count.rb', line 56

def self.attribute_map
  {
    :'catalog_object_id' => :'catalog_object_id',
    :'catalog_object_type' => :'catalog_object_type',
    :'state' => :'state',
    :'location_id' => :'location_id',
    :'quantity' => :'quantity',
    :'calculated_at' => :'calculated_at'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
 
# File 'lib/square_connect/models/inventory_count.rb', line 68

def self.swagger_types
  {
    :'catalog_object_id' => :'String',
    :'catalog_object_type' => :'String',
    :'state' => :'String',
    :'location_id' => :'String',
    :'quantity' => :'String',
    :'calculated_at' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



140
141
142
143
144
145
146
147
148
149
 
# File 'lib/square_connect/models/inventory_count.rb', line 140

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      catalog_object_id == o.catalog_object_id &&
      catalog_object_type == o.catalog_object_type &&
      state == o.state &&
      location_id == o.location_id &&
      quantity == o.quantity &&
      calculated_at == o.calculated_at
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



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
218
219
220
221
222
223
 
# File 'lib/square_connect/models/inventory_count.rb', line 187

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



253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/square_connect/models/inventory_count.rb', line 253

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



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/square_connect/models/inventory_count.rb', line 166

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


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

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



159
160
161
 
# File 'lib/square_connect/models/inventory_count.rb', line 159

def hash
  [catalog_object_id, catalog_object_type, state, location_id, quantity, calculated_at].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



115
116
117
118
 
# File 'lib/square_connect/models/inventory_count.rb', line 115

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



233
234
235
 
# File 'lib/square_connect/models/inventory_count.rb', line 233

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



239
240
241
242
243
244
245
246
247
 
# File 'lib/square_connect/models/inventory_count.rb', line 239

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



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

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



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

def valid?
  state_validator = EnumAttributeValidator.new('String', ["CUSTOM", "IN_STOCK", "SOLD", "RETURNED_BY_CUSTOMER", "RESERVED_FOR_SALE", "SOLD_ONLINE", "ORDERED_FROM_VENDOR", "RECEIVED_FROM_VENDOR", "IN_TRANSIT_TO", "NONE", "WASTE", "UNLINKED_RETURN"])
  return false unless state_validator.valid?(@state)
  return true
end