Class: TripletexRubyClient::Inventory

Inherits:
Object
  • Object
show all
Defined in:
lib/tripletex_ruby_client/models/inventory.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Inventory

Initializes the object

Parameters:

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

    Model attributes in the form of hash



107
108
109
110
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
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
 
# File 'lib/tripletex_ruby_client/models/inventory.rb', line 107

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#address ⇒ Object

Returns the value of attribute address.



43
44
45
 
# File 'lib/tripletex_ruby_client/models/inventory.rb', line 43

def address
  @address
end

#changes ⇒ Object

Returns the value of attribute changes.



21
22
23
 
# File 'lib/tripletex_ruby_client/models/inventory.rb', line 21

def changes
  @changes
end

#deletable ⇒ Object

Returns the value of attribute deletable.



41
42
43
 
# File 'lib/tripletex_ruby_client/models/inventory.rb', line 41

def deletable
  @deletable
end

#description ⇒ Object

Returns the value of attribute description.



35
36
37
 
# File 'lib/tripletex_ruby_client/models/inventory.rb', line 35

def description
  @description
end

#display_name ⇒ Object

Returns the value of attribute display_name.



29
30
31
 
# File 'lib/tripletex_ruby_client/models/inventory.rb', line 29

def display_name
  @display_name
end

#email ⇒ Object

Returns the value of attribute email.



37
38
39
 
# File 'lib/tripletex_ruby_client/models/inventory.rb', line 37

def email
  @email
end

#has_locations ⇒ Object

Returns the value of attribute has_locations.



49
50
51
 
# File 'lib/tripletex_ruby_client/models/inventory.rb', line 49

def has_locations
  @has_locations
end

#id ⇒ Object

Returns the value of attribute id.



17
18
19
 
# File 'lib/tripletex_ruby_client/models/inventory.rb', line 17

def id
  @id
end

#inactive ⇒ Object

Returns the value of attribute inactive.



53
54
55
 
# File 'lib/tripletex_ruby_client/models/inventory.rb', line 53

def inactive
  @inactive
end

#is_inactive ⇒ Object

Returns the value of attribute is_inactive.



33
34
35
 
# File 'lib/tripletex_ruby_client/models/inventory.rb', line 33

def is_inactive
  @is_inactive
end

#is_main_inventory ⇒ Object

Returns the value of attribute is_main_inventory.



31
32
33
 
# File 'lib/tripletex_ruby_client/models/inventory.rb', line 31

def is_main_inventory
  @is_main_inventory
end

#last_stocking ⇒ Object

Returns the value of attribute last_stocking.



45
46
47
 
# File 'lib/tripletex_ruby_client/models/inventory.rb', line 45

def last_stocking
  @last_stocking
end

#main_inventory ⇒ Object

Returns the value of attribute main_inventory.



51
52
53
 
# File 'lib/tripletex_ruby_client/models/inventory.rb', line 51

def main_inventory
  @main_inventory
end

#name ⇒ Object

Returns the value of attribute name.



25
26
27
 
# File 'lib/tripletex_ruby_client/models/inventory.rb', line 25

def name
  @name
end

#number ⇒ Object

Returns the value of attribute number.



27
28
29
 
# File 'lib/tripletex_ruby_client/models/inventory.rb', line 27

def number
  @number
end

#phone ⇒ Object

Returns the value of attribute phone.



39
40
41
 
# File 'lib/tripletex_ruby_client/models/inventory.rb', line 39

def phone
  @phone
end

#status ⇒ Object

Returns the value of attribute status.



47
48
49
 
# File 'lib/tripletex_ruby_client/models/inventory.rb', line 47

def status
  @status
end

#url ⇒ Object

Returns the value of attribute url.



23
24
25
 
# File 'lib/tripletex_ruby_client/models/inventory.rb', line 23

def url
  @url
end

#version ⇒ Object

Returns the value of attribute version.



19
20
21
 
# File 'lib/tripletex_ruby_client/models/inventory.rb', line 19

def version
  @version
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
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/tripletex_ruby_client/models/inventory.rb', line 56

def self.attribute_map
  {
    :'id' => :'id',
    :'version' => :'version',
    :'changes' => :'changes',
    :'url' => :'url',
    :'name' => :'name',
    :'number' => :'number',
    :'display_name' => :'displayName',
    :'is_main_inventory' => :'isMainInventory',
    :'is_inactive' => :'isInactive',
    :'description' => :'description',
    :'email' => :'email',
    :'phone' => :'phone',
    :'deletable' => :'deletable',
    :'address' => :'address',
    :'last_stocking' => :'lastStocking',
    :'status' => :'status',
    :'has_locations' => :'hasLocations',
    :'main_inventory' => :'mainInventory',
    :'inactive' => :'inactive'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/tripletex_ruby_client/models/inventory.rb', line 81

def self.swagger_types
  {
    :'id' => :'Integer',
    :'version' => :'Integer',
    :'changes' => :'Array<Change>',
    :'url' => :'String',
    :'name' => :'String',
    :'number' => :'String',
    :'display_name' => :'String',
    :'is_main_inventory' => :'BOOLEAN',
    :'is_inactive' => :'BOOLEAN',
    :'description' => :'String',
    :'email' => :'String',
    :'phone' => :'String',
    :'deletable' => :'BOOLEAN',
    :'address' => :'Address',
    :'last_stocking' => :'String',
    :'status' => :'String',
    :'has_locations' => :'BOOLEAN',
    :'main_inventory' => :'BOOLEAN',
    :'inactive' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/tripletex_ruby_client/models/inventory.rb', line 327

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      version == o.version &&
      changes == o.changes &&
      url == o.url &&
      name == o.name &&
      number == o.number &&
      display_name == o.display_name &&
      is_main_inventory == o.is_main_inventory &&
      is_inactive == o.is_inactive &&
      description == o.description &&
      email == o.email &&
      phone == o.phone &&
      deletable == o.deletable &&
      address == o.address &&
      last_stocking == o.last_stocking &&
      status == o.status &&
      has_locations == o.has_locations &&
      main_inventory == o.main_inventory &&
      inactive == o.inactive
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



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/tripletex_ruby_client/models/inventory.rb', line 387

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 = TripletexRubyClient.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



453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/tripletex_ruby_client/models/inventory.rb', line 453

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



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/tripletex_ruby_client/models/inventory.rb', line 366

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 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


353
354
355
 
# File 'lib/tripletex_ruby_client/models/inventory.rb', line 353

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



359
360
361
 
# File 'lib/tripletex_ruby_client/models/inventory.rb', line 359

def hash
  [id, version, changes, url, name, number, display_name, is_main_inventory, is_inactive, description, email, phone, deletable, address, last_stocking, status, has_locations, main_inventory, inactive].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



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
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/tripletex_ruby_client/models/inventory.rb', line 194

def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @name.to_s.length > 255
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 255.')
  end

  if @name.to_s.length < 1
    invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
  end

  if !@number.nil? && @number.to_s.length > 100
    invalid_properties.push('invalid value for "number", the character length must be smaller than or equal to 100.')
  end

  if !@number.nil? && @number.to_s.length < 0
    invalid_properties.push('invalid value for "number", the character length must be great than or equal to 0.')
  end

  if !@description.nil? && @description.to_s.length > 255
    invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 255.')
  end

  if !@email.nil? && @email.to_s.length > 255
    invalid_properties.push('invalid value for "email", the character length must be smaller than or equal to 255.')
  end

  if !@email.nil? && @email.to_s.length < 0
    invalid_properties.push('invalid value for "email", the character length must be great than or equal to 0.')
  end

  if !@phone.nil? && @phone.to_s.length > 255
    invalid_properties.push('invalid value for "phone", the character length must be smaller than or equal to 255.')
  end

  if !@phone.nil? && @phone.to_s.length < 0
    invalid_properties.push('invalid value for "phone", the character length must be great than or equal to 0.')
  end

  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



433
434
435
 
# File 'lib/tripletex_ruby_client/models/inventory.rb', line 433

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



439
440
441
442
443
444
445
446
447
 
# File 'lib/tripletex_ruby_client/models/inventory.rb', line 439

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



427
428
429
 
# File 'lib/tripletex_ruby_client/models/inventory.rb', line 427

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



241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/tripletex_ruby_client/models/inventory.rb', line 241

def valid?
  return false if @name.nil?
  return false if @name.to_s.length > 255
  return false if @name.to_s.length < 1
  return false if !@number.nil? && @number.to_s.length > 100
  return false if !@number.nil? && @number.to_s.length < 0
  return false if !@description.nil? && @description.to_s.length > 255
  return false if !@email.nil? && @email.to_s.length > 255
  return false if !@email.nil? && @email.to_s.length < 0
  return false if !@phone.nil? && @phone.to_s.length > 255
  return false if !@phone.nil? && @phone.to_s.length < 0
  true
end