Class: TripletexApi::Product

Inherits:
Object
  • Object
show all
Defined in:
lib/tripletex_api/models/product.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Product

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/tripletex_api/models/product.rb', line 124

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

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

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

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

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

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

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

  if attributes.has_key?(:'isStockItem')
    self.is_stock_item = attributes[:'isStockItem']
  else
    self.is_stock_item = false
  end

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#account ⇒ Object

Returns the value of attribute account.



57
58
59
 
# File 'lib/tripletex_api/models/product.rb', line 57

def 
  @account
end

#changes ⇒ Object

Returns the value of attribute changes.



22
23
24
 
# File 'lib/tripletex_api/models/product.rb', line 22

def changes
  @changes
end

#cost_excluding_vat_currency ⇒ Object

Price purchase (cost) excluding VAT in the product’s currency



35
36
37
 
# File 'lib/tripletex_api/models/product.rb', line 35

def cost_excluding_vat_currency
  @cost_excluding_vat_currency
end

#currency ⇒ Object

Returns the value of attribute currency.



53
54
55
 
# File 'lib/tripletex_api/models/product.rb', line 53

def currency
  @currency
end

#department ⇒ Object

Returns the value of attribute department.



55
56
57
 
# File 'lib/tripletex_api/models/product.rb', line 55

def department
  @department
end

#discount_price ⇒ Object

Returns the value of attribute discount_price.



59
60
61
 
# File 'lib/tripletex_api/models/product.rb', line 59

def discount_price
  @discount_price
end

#el_number ⇒ Object

Returns the value of attribute el_number.



30
31
32
 
# File 'lib/tripletex_api/models/product.rb', line 30

def el_number
  @el_number
end

#id ⇒ Object

Returns the value of attribute id.



18
19
20
 
# File 'lib/tripletex_api/models/product.rb', line 18

def id
  @id
end

#is_inactive ⇒ Object

Returns the value of attribute is_inactive.



43
44
45
 
# File 'lib/tripletex_api/models/product.rb', line 43

def is_inactive
  @is_inactive
end

#is_stock_item ⇒ Object

Returns the value of attribute is_stock_item.



47
48
49
 
# File 'lib/tripletex_api/models/product.rb', line 47

def is_stock_item
  @is_stock_item
end

#name ⇒ Object

Returns the value of attribute name.



26
27
28
 
# File 'lib/tripletex_api/models/product.rb', line 26

def name
  @name
end

#nrf_number ⇒ Object

Returns the value of attribute nrf_number.



32
33
34
 
# File 'lib/tripletex_api/models/product.rb', line 32

def nrf_number
  @nrf_number
end

#number ⇒ Object

Returns the value of attribute number.



28
29
30
 
# File 'lib/tripletex_api/models/product.rb', line 28

def number
  @number
end

#price_excluding_vat_currency ⇒ Object

Price of purchase excluding VAT in the product’s currency



38
39
40
 
# File 'lib/tripletex_api/models/product.rb', line 38

def price_excluding_vat_currency
  @price_excluding_vat_currency
end

#price_including_vat_currency ⇒ Object

Price of purchase including VAT in the product’s currency



41
42
43
 
# File 'lib/tripletex_api/models/product.rb', line 41

def price_including_vat_currency
  @price_including_vat_currency
end

#product_unit ⇒ Object

Returns the value of attribute product_unit.



45
46
47
 
# File 'lib/tripletex_api/models/product.rb', line 45

def product_unit
  @product_unit
end

#resale_product ⇒ Object

Returns the value of attribute resale_product.



63
64
65
 
# File 'lib/tripletex_api/models/product.rb', line 63

def resale_product
  @resale_product
end

#stock_of_goods ⇒ Object

Returns the value of attribute stock_of_goods.



49
50
51
 
# File 'lib/tripletex_api/models/product.rb', line 49

def stock_of_goods
  @stock_of_goods
end

#supplier ⇒ Object

Returns the value of attribute supplier.



61
62
63
 
# File 'lib/tripletex_api/models/product.rb', line 61

def supplier
  @supplier
end

#url ⇒ Object

Returns the value of attribute url.



24
25
26
 
# File 'lib/tripletex_api/models/product.rb', line 24

def url
  @url
end

#vat_type ⇒ Object

Returns the value of attribute vat_type.



51
52
53
 
# File 'lib/tripletex_api/models/product.rb', line 51

def vat_type
  @vat_type
end

#version ⇒ Object

Returns the value of attribute version.



20
21
22
 
# File 'lib/tripletex_api/models/product.rb', line 20

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/tripletex_api/models/product.rb', line 67

def self.attribute_map
  {
    :'id' => :'id',
    :'version' => :'version',
    :'changes' => :'changes',
    :'url' => :'url',
    :'name' => :'name',
    :'number' => :'number',
    :'el_number' => :'elNumber',
    :'nrf_number' => :'nrfNumber',
    :'cost_excluding_vat_currency' => :'costExcludingVatCurrency',
    :'price_excluding_vat_currency' => :'priceExcludingVatCurrency',
    :'price_including_vat_currency' => :'priceIncludingVatCurrency',
    :'is_inactive' => :'isInactive',
    :'product_unit' => :'productUnit',
    :'is_stock_item' => :'isStockItem',
    :'stock_of_goods' => :'stockOfGoods',
    :'vat_type' => :'vatType',
    :'currency' => :'currency',
    :'department' => :'department',
    :'account' => :'account',
    :'discount_price' => :'discountPrice',
    :'supplier' => :'supplier',
    :'resale_product' => :'resaleProduct'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/tripletex_api/models/product.rb', line 95

def self.swagger_types
  {
    :'id' => :'Integer',
    :'version' => :'Integer',
    :'changes' => :'Array<Change>',
    :'url' => :'String',
    :'name' => :'String',
    :'number' => :'String',
    :'el_number' => :'String',
    :'nrf_number' => :'String',
    :'cost_excluding_vat_currency' => :'Float',
    :'price_excluding_vat_currency' => :'Float',
    :'price_including_vat_currency' => :'Float',
    :'is_inactive' => :'BOOLEAN',
    :'product_unit' => :'ProductUnit',
    :'is_stock_item' => :'BOOLEAN',
    :'stock_of_goods' => :'Float',
    :'vat_type' => :'VatType',
    :'currency' => :'Currency',
    :'department' => :'Department',
    :'account' => :'Account',
    :'discount_price' => :'Float',
    :'supplier' => :'Supplier',
    :'resale_product' => :'Product'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/tripletex_api/models/product.rb', line 305

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 &&
      el_number == o.el_number &&
      nrf_number == o.nrf_number &&
      cost_excluding_vat_currency == o.cost_excluding_vat_currency &&
      price_excluding_vat_currency == o.price_excluding_vat_currency &&
      price_including_vat_currency == o.price_including_vat_currency &&
      is_inactive == o.is_inactive &&
      product_unit == o.product_unit &&
      is_stock_item == o.is_stock_item &&
      stock_of_goods == o.stock_of_goods &&
      vat_type == o.vat_type &&
      currency == o.currency &&
      department == o.department &&
       == o. &&
      discount_price == o.discount_price &&
      supplier == o.supplier &&
      resale_product == o.resale_product
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



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/tripletex_api/models/product.rb', line 368

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



434
435
436
437
438
439
440
441
442
443
444
445
446
 
# File 'lib/tripletex_api/models/product.rb', line 434

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



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/tripletex_api/models/product.rb', line 347

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


334
335
336
 
# File 'lib/tripletex_api/models/product.rb', line 334

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



340
341
342
 
# File 'lib/tripletex_api/models/product.rb', line 340

def hash
  [id, version, changes, url, name, number, el_number, nrf_number, cost_excluding_vat_currency, price_excluding_vat_currency, price_including_vat_currency, is_inactive, product_unit, is_stock_item, stock_of_goods, vat_type, currency, department, , discount_price, supplier, resale_product].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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/tripletex_api/models/product.rb', line 228

def list_invalid_properties
  invalid_properties = Array.new
  if !@name.nil? && @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 !@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 !@el_number.nil? && @el_number.to_s.length > 14
    invalid_properties.push("invalid value for 'el_number', the character length must be smaller than or equal to 14.")
  end

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

  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



414
415
416
 
# File 'lib/tripletex_api/models/product.rb', line 414

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



420
421
422
423
424
425
426
427
428
 
# File 'lib/tripletex_api/models/product.rb', line 420

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



408
409
410
 
# File 'lib/tripletex_api/models/product.rb', line 408

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



251
252
253
254
255
256
257
 
# File 'lib/tripletex_api/models/product.rb', line 251

def valid?
  return false if !@name.nil? && @name.to_s.length > 255
  return false if !@number.nil? && @number.to_s.length > 100
  return false if !@el_number.nil? && @el_number.to_s.length > 14
  return false if !@nrf_number.nil? && @nrf_number.to_s.length > 14
  return true
end