Class: SquareConnect::InventoryTransfer

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

Overview

Represents the transfer of a quantity of product inventory at a particular time from one location to another.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InventoryTransfer

Initializes the object

Parameters:

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

    Model attributes in the form of hash



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/square_connect/models/inventory_transfer.rb', line 111

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#catalog_object_id ⇒ Object

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



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

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.



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

def catalog_object_type
  @catalog_object_type
end

#created_at ⇒ Object

A read-only timestamp in RFC 3339 format that indicates when Square received the transfer request.



43
44
45
 
# File 'lib/square_connect/models/inventory_transfer.rb', line 43

def created_at
  @created_at
end

#employee_id ⇒ Object

The Square ID of the [Employee](#type-employee) responsible for the inventory transfer.



49
50
51
 
# File 'lib/square_connect/models/inventory_transfer.rb', line 49

def employee_id
  @employee_id
end

#from_location_id ⇒ Object

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



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

def from_location_id
  @from_location_id
end

#id ⇒ Object

A unique ID generated by Square for the [InventoryTransfer](#type-inventorytransfer).



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

def id
  @id
end

#occurred_at ⇒ Object

A client-generated timestamp in RFC 3339 format that indicates when the transfer took place. For write actions, the ‘occurred_at` timestamp cannot be older than 24 hours or in the future relative to the time of the request.



40
41
42
 
# File 'lib/square_connect/models/inventory_transfer.rb', line 40

def occurred_at
  @occurred_at
end

#quantity ⇒ Object

The number of items affected by the transfer as a decimal string. Fractional quantities are not supported.



37
38
39
 
# File 'lib/square_connect/models/inventory_transfer.rb', line 37

def quantity
  @quantity
end

#reference_id ⇒ Object

An optional ID provided by the application to tie the [InventoryTransfer](#type-inventorytransfer) to an external system.



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

def reference_id
  @reference_id
end

#source ⇒ Object

Read-only information about the application that initiated the inventory transfer.



46
47
48
 
# File 'lib/square_connect/models/inventory_transfer.rb', line 46

def source
  @source
end

#state ⇒ Object

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



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

def state
  @state
end

#to_location_id ⇒ Object

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



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

def to_location_id
  @to_location_id
end

Class Method Details

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/square_connect/models/inventory_transfer.rb', line 74

def self.attribute_map
  {
    :'id' => :'id',
    :'reference_id' => :'reference_id',
    :'state' => :'state',
    :'from_location_id' => :'from_location_id',
    :'to_location_id' => :'to_location_id',
    :'catalog_object_id' => :'catalog_object_id',
    :'catalog_object_type' => :'catalog_object_type',
    :'quantity' => :'quantity',
    :'occurred_at' => :'occurred_at',
    :'created_at' => :'created_at',
    :'source' => :'source',
    :'employee_id' => :'employee_id'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/square_connect/models/inventory_transfer.rb', line 92

def self.swagger_types
  {
    :'id' => :'String',
    :'reference_id' => :'String',
    :'state' => :'String',
    :'from_location_id' => :'String',
    :'to_location_id' => :'String',
    :'catalog_object_id' => :'String',
    :'catalog_object_type' => :'String',
    :'quantity' => :'String',
    :'occurred_at' => :'String',
    :'created_at' => :'String',
    :'source' => :'SourceApplication',
    :'employee_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/square_connect/models/inventory_transfer.rb', line 194

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      reference_id == o.reference_id &&
      state == o.state &&
      from_location_id == o.from_location_id &&
      to_location_id == o.to_location_id &&
      catalog_object_id == o.catalog_object_id &&
      catalog_object_type == o.catalog_object_type &&
      quantity == o.quantity &&
      occurred_at == o.occurred_at &&
      created_at == o.created_at &&
      source == o.source &&
      employee_id == o.employee_id
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



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/square_connect/models/inventory_transfer.rb', line 247

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



313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/square_connect/models/inventory_transfer.rb', line 313

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



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

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


213
214
215
 
# File 'lib/square_connect/models/inventory_transfer.rb', line 213

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



219
220
221
 
# File 'lib/square_connect/models/inventory_transfer.rb', line 219

def hash
  [id, reference_id, state, from_location_id, to_location_id, catalog_object_id, catalog_object_type, quantity, occurred_at, created_at, source, employee_id].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



169
170
171
172
 
# File 'lib/square_connect/models/inventory_transfer.rb', line 169

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



293
294
295
 
# File 'lib/square_connect/models/inventory_transfer.rb', line 293

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



299
300
301
302
303
304
305
306
307
 
# File 'lib/square_connect/models/inventory_transfer.rb', line 299

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



287
288
289
 
# File 'lib/square_connect/models/inventory_transfer.rb', line 287

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



176
177
178
179
180
 
# File 'lib/square_connect/models/inventory_transfer.rb', line 176

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