Class: DearInventoryRuby::Location

Inherits:
Object
  • Object
show all
Defined in:
lib/dear-inventory-ruby/models/location.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Location

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
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
224
225
 
# File 'lib/dear-inventory-ruby/models/location.rb', line 127

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `DearInventoryRuby::Location` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `DearInventoryRuby::Location`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'is_default')
    self.is_default = attributes[:'is_default']
  else
    self.is_default = false
  end

  if attributes.key?(:'deprecated')
    self.deprecated = attributes[:'deprecated']
  else
    self.deprecated = false
  end

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

  if attributes.key?(:'fixed_assets_location')
    self.fixed_assets_location = attributes[:'fixed_assets_location']
  else
    self.fixed_assets_location = false
  end

  if attributes.key?(:'parent_id')
    self.parent_id = attributes[:'parent_id']
  end

  if attributes.key?(:'reference_count')
    self.reference_count = attributes[:'reference_count']
  end

  if attributes.key?(:'address_line1')
    self.address_line1 = attributes[:'address_line1']
  end

  if attributes.key?(:'address_line2')
    self.address_line2 = attributes[:'address_line2']
  end

  if attributes.key?(:'address_city_suburb')
    self.address_city_suburb = attributes[:'address_city_suburb']
  end

  if attributes.key?(:'address_state_province')
    self.address_state_province = attributes[:'address_state_province']
  end

  if attributes.key?(:'address_zip_post_code')
    self.address_zip_post_code = attributes[:'address_zip_post_code']
  end

  if attributes.key?(:'address_country')
    self.address_country = attributes[:'address_country']
  end

  if attributes.key?(:'pick_zones')
    self.pick_zones = attributes[:'pick_zones']
  end

  if attributes.key?(:'is_shopfloor')
    self.is_shopfloor = attributes[:'is_shopfloor']
  else
    self.is_shopfloor = false
  end

  if attributes.key?(:'is_co_man')
    self.is_co_man = attributes[:'is_co_man']
  else
    self.is_co_man = false
  end

  if attributes.key?(:'is_staging')
    self.is_staging = attributes[:'is_staging']
  else
    self.is_staging = false
  end
end

Instance Attribute Details

#address_city_suburb ⇒ Object

City suburb



48
49
50
 
# File 'lib/dear-inventory-ruby/models/location.rb', line 48

def address_city_suburb
  @address_city_suburb
end

#address_country ⇒ Object

Country



57
58
59
 
# File 'lib/dear-inventory-ruby/models/location.rb', line 57

def address_country
  @address_country
end

#address_line1 ⇒ Object

Address line



42
43
44
 
# File 'lib/dear-inventory-ruby/models/location.rb', line 42

def address_line1
  @address_line1
end

#address_line2 ⇒ Object

Address line second



45
46
47
 
# File 'lib/dear-inventory-ruby/models/location.rb', line 45

def address_line2
  @address_line2
end

#address_state_province ⇒ Object

State province



51
52
53
 
# File 'lib/dear-inventory-ruby/models/location.rb', line 51

def address_state_province
  @address_state_province
end

#address_zip_post_code ⇒ Object

Zip post code



54
55
56
 
# File 'lib/dear-inventory-ruby/models/location.rb', line 54

def address_zip_post_code
  @address_zip_post_code
end

#bins ⇒ Object

Array (ID, Name) with related Bins



30
31
32
 
# File 'lib/dear-inventory-ruby/models/location.rb', line 30

def bins
  @bins
end

#deprecated ⇒ Object

Points that location is deprecated



27
28
29
 
# File 'lib/dear-inventory-ruby/models/location.rb', line 27

def deprecated
  @deprecated
end

#fixed_assets_location ⇒ Object

Points that location is used as Fixed Asset



33
34
35
 
# File 'lib/dear-inventory-ruby/models/location.rb', line 33

def fixed_assets_location
  @fixed_assets_location
end

#id ⇒ Object

Required for ‘PUT` and `DELETE`, Ignored for `POST` operations



18
19
20
 
# File 'lib/dear-inventory-ruby/models/location.rb', line 18

def id
  @id
end

#is_co_man ⇒ Object

Points that location is location of co-manufacturer



66
67
68
 
# File 'lib/dear-inventory-ruby/models/location.rb', line 66

def is_co_man
  @is_co_man
end

#is_default ⇒ Object

Points that location is used as default



24
25
26
 
# File 'lib/dear-inventory-ruby/models/location.rb', line 24

def is_default
  @is_default
end

#is_shopfloor ⇒ Object

Points that location is shopfloor



63
64
65
 
# File 'lib/dear-inventory-ruby/models/location.rb', line 63

def is_shopfloor
  @is_shopfloor
end

#is_staging ⇒ Object

Points that location is staging. It is used only for Bins



69
70
71
 
# File 'lib/dear-inventory-ruby/models/location.rb', line 69

def is_staging
  @is_staging
end

#name ⇒ Object

Location name



21
22
23
 
# File 'lib/dear-inventory-ruby/models/location.rb', line 21

def name
  @name
end

#parent_id ⇒ Object

Parent ID (used for Bins)



36
37
38
 
# File 'lib/dear-inventory-ruby/models/location.rb', line 36

def parent_id
  @parent_id
end

#pick_zones ⇒ Object

Pick zones



60
61
62
 
# File 'lib/dear-inventory-ruby/models/location.rb', line 60

def pick_zones
  @pick_zones
end

#reference_count ⇒ Object

Reference linked to current location



39
40
41
 
# File 'lib/dear-inventory-ruby/models/location.rb', line 39

def reference_count
  @reference_count
end

Class Method Details

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/dear-inventory-ruby/models/location.rb', line 72

def self.attribute_map
  {
    :'id' => :'ID',
    :'name' => :'Name',
    :'is_default' => :'IsDefault',
    :'deprecated' => :'Deprecated',
    :'bins' => :'Bins',
    :'fixed_assets_location' => :'FixedAssetsLocation',
    :'parent_id' => :'ParentID',
    :'reference_count' => :'ReferenceCount',
    :'address_line1' => :'AddressLine1',
    :'address_line2' => :'AddressLine2',
    :'address_city_suburb' => :'AddressCitySuburb',
    :'address_state_province' => :'AddressStateProvince',
    :'address_zip_post_code' => :'AddressZipPostCode',
    :'address_country' => :'AddressCountry',
    :'pick_zones' => :'PickZones',
    :'is_shopfloor' => :'IsShopfloor',
    :'is_co_man' => :'IsCoMan',
    :'is_staging' => :'IsStaging'
  }
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



280
281
282
 
# File 'lib/dear-inventory-ruby/models/location.rb', line 280

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



120
121
122
123
 
# File 'lib/dear-inventory-ruby/models/location.rb', line 120

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/dear-inventory-ruby/models/location.rb', line 96

def self.openapi_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'is_default' => :'Boolean',
    :'deprecated' => :'Boolean',
    :'bins' => :'Array<Bin>',
    :'fixed_assets_location' => :'Boolean',
    :'parent_id' => :'String',
    :'reference_count' => :'Integer',
    :'address_line1' => :'String',
    :'address_line2' => :'String',
    :'address_city_suburb' => :'String',
    :'address_state_province' => :'String',
    :'address_zip_post_code' => :'String',
    :'address_country' => :'String',
    :'pick_zones' => :'String',
    :'is_shopfloor' => :'Boolean',
    :'is_co_man' => :'Boolean',
    :'is_staging' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/dear-inventory-ruby/models/location.rb', line 242

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      is_default == o.is_default &&
      deprecated == o.deprecated &&
      bins == o.bins &&
      fixed_assets_location == o.fixed_assets_location &&
      parent_id == o.parent_id &&
      reference_count == o.reference_count &&
      address_line1 == o.address_line1 &&
      address_line2 == o.address_line2 &&
      address_city_suburb == o.address_city_suburb &&
      address_state_province == o.address_state_province &&
      address_zip_post_code == o.address_zip_post_code &&
      address_country == o.address_country &&
      pick_zones == o.pick_zones &&
      is_shopfloor == o.is_shopfloor &&
      is_co_man == o.is_co_man &&
      is_staging == o.is_staging
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



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/dear-inventory-ruby/models/location.rb', line 308

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
    DearInventoryRuby.const_get(type).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



377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/dear-inventory-ruby/models/location.rb', line 377

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



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/dear-inventory-ruby/models/location.rb', line 287

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that 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


267
268
269
 
# File 'lib/dear-inventory-ruby/models/location.rb', line 267

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



273
274
275
 
# File 'lib/dear-inventory-ruby/models/location.rb', line 273

def hash
  [id, name, is_default, deprecated, bins, fixed_assets_location, parent_id, reference_count, address_line1, address_line2, address_city_suburb, address_state_province, address_zip_post_code, address_country, pick_zones, is_shopfloor, is_co_man, is_staging].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



229
230
231
232
 
# File 'lib/dear-inventory-ruby/models/location.rb', line 229

def list_invalid_properties
  invalid_properties = Array.new
  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



353
354
355
 
# File 'lib/dear-inventory-ruby/models/location.rb', line 353

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



359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/dear-inventory-ruby/models/location.rb', line 359

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end
    
    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



347
348
349
 
# File 'lib/dear-inventory-ruby/models/location.rb', line 347

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



236
237
238
 
# File 'lib/dear-inventory-ruby/models/location.rb', line 236

def valid?
  true
end