Class: TripletexRubyClient::SupplierProduct

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SupplierProduct

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
226
227
228
229
230
231
# File 'lib/tripletex_ruby_client/models/supplier_product.rb', line 128

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

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

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

  if attributes.has_key?(:'isStockItem')
    self.is_stock_item = attributes[:'isStockItem']
  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?(:'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

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

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

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

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

Instance Attribute Details

#changesObject

Returns the value of attribute changes.



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

def changes
  @changes
end

#cost_excluding_vat_currencyObject

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



32
33
34
# File 'lib/tripletex_ruby_client/models/supplier_product.rb', line 32

def cost_excluding_vat_currency
  @cost_excluding_vat_currency
end

#currencyObject

Returns the value of attribute currency.



50
51
52
# File 'lib/tripletex_ruby_client/models/supplier_product.rb', line 50

def currency
  @currency
end

#descriptionObject

Returns the value of attribute description.



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

def description
  @description
end

#discount_priceObject

Returns the value of attribute discount_price.



52
53
54
# File 'lib/tripletex_ruby_client/models/supplier_product.rb', line 52

def discount_price
  @discount_price
end

#eanObject

Returns the value of attribute ean.



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

def ean
  @ean
end

#idObject

Returns the value of attribute id.



15
16
17
# File 'lib/tripletex_ruby_client/models/supplier_product.rb', line 15

def id
  @id
end

#is_deletableObject

Returns the value of attribute is_deletable.



58
59
60
# File 'lib/tripletex_ruby_client/models/supplier_product.rb', line 58

def is_deletable
  @is_deletable
end

#is_efo_nelfo_productObject

Returns the value of attribute is_efo_nelfo_product.



62
63
64
# File 'lib/tripletex_ruby_client/models/supplier_product.rb', line 62

def is_efo_nelfo_product
  @is_efo_nelfo_product
end

#is_inactiveObject

Returns the value of attribute is_inactive.



40
41
42
# File 'lib/tripletex_ruby_client/models/supplier_product.rb', line 40

def is_inactive
  @is_inactive
end

#is_stock_itemObject

Returns the value of attribute is_stock_item.



44
45
46
# File 'lib/tripletex_ruby_client/models/supplier_product.rb', line 44

def is_stock_item
  @is_stock_item
end

#nameObject

Returns the value of attribute name.



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

def name
  @name
end

#numberObject

Returns the value of attribute number.



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

def number
  @number
end

#price_excluding_vat_currencyObject

Price of purchase excluding VAT in the product’s currency



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

def price_excluding_vat_currency
  @price_excluding_vat_currency
end

#price_including_vat_currencyObject

Price of purchase including VAT in the product’s currency



38
39
40
# File 'lib/tripletex_ruby_client/models/supplier_product.rb', line 38

def price_including_vat_currency
  @price_including_vat_currency
end

#product_unitObject

Returns the value of attribute product_unit.



42
43
44
# File 'lib/tripletex_ruby_client/models/supplier_product.rb', line 42

def product_unit
  @product_unit
end

#resale_productObject

Returns the value of attribute resale_product.



56
57
58
# File 'lib/tripletex_ruby_client/models/supplier_product.rb', line 56

def resale_product
  @resale_product
end

#stock_of_goodsObject

Returns the value of attribute stock_of_goods.



46
47
48
# File 'lib/tripletex_ruby_client/models/supplier_product.rb', line 46

def stock_of_goods
  @stock_of_goods
end

#supplierObject

Returns the value of attribute supplier.



54
55
56
# File 'lib/tripletex_ruby_client/models/supplier_product.rb', line 54

def supplier
  @supplier
end

#urlObject

Returns the value of attribute url.



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

def url
  @url
end

#vat_typeObject

Returns the value of attribute vat_type.



48
49
50
# File 'lib/tripletex_ruby_client/models/supplier_product.rb', line 48

def vat_type
  @vat_type
end

#vendor_nameObject

Returns the value of attribute vendor_name.



60
61
62
# File 'lib/tripletex_ruby_client/models/supplier_product.rb', line 60

def vendor_name
  @vendor_name
end

#versionObject

Returns the value of attribute version.



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

def version
  @version
end

#wholesaler_idObject

Returns the value of attribute wholesaler_id.



64
65
66
# File 'lib/tripletex_ruby_client/models/supplier_product.rb', line 64

def wholesaler_id
  @wholesaler_id
end

Class Method Details

.attribute_mapObject

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
93
94
# File 'lib/tripletex_ruby_client/models/supplier_product.rb', line 67

def self.attribute_map
  {
    :'id' => :'id',
    :'version' => :'version',
    :'changes' => :'changes',
    :'url' => :'url',
    :'name' => :'name',
    :'number' => :'number',
    :'description' => :'description',
    :'ean' => :'ean',
    :'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',
    :'discount_price' => :'discountPrice',
    :'supplier' => :'supplier',
    :'resale_product' => :'resaleProduct',
    :'is_deletable' => :'isDeletable',
    :'vendor_name' => :'vendorName',
    :'is_efo_nelfo_product' => :'isEfoNelfoProduct',
    :'wholesaler_id' => :'wholesalerId'
  }
end

.swagger_typesObject

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
# File 'lib/tripletex_ruby_client/models/supplier_product.rb', line 97

def self.swagger_types
  {
    :'id' => :'Integer',
    :'version' => :'Integer',
    :'changes' => :'Array<Change>',
    :'url' => :'String',
    :'name' => :'String',
    :'number' => :'String',
    :'description' => :'String',
    :'ean' => :'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',
    :'discount_price' => :'Float',
    :'supplier' => :'Supplier',
    :'resale_product' => :'SupplierProduct',
    :'is_deletable' => :'BOOLEAN',
    :'vendor_name' => :'String',
    :'is_efo_nelfo_product' => :'BOOLEAN',
    :'wholesaler_id' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



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
# File 'lib/tripletex_ruby_client/models/supplier_product.rb', line 308

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 &&
      description == o.description &&
      ean == o.ean &&
      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 &&
      discount_price == o.discount_price &&
      supplier == o.supplier &&
      resale_product == o.resale_product &&
      is_deletable == o.is_deletable &&
      vendor_name == o.vendor_name &&
      is_efo_nelfo_product == o.is_efo_nelfo_product &&
      wholesaler_id == o.wholesaler_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



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
405
406
407
408
409
# File 'lib/tripletex_ruby_client/models/supplier_product.rb', line 373

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



439
440
441
442
443
444
445
446
447
448
449
450
451
# File 'lib/tripletex_ruby_client/models/supplier_product.rb', line 439

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



352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
# File 'lib/tripletex_ruby_client/models/supplier_product.rb', line 352

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


339
340
341
# File 'lib/tripletex_ruby_client/models/supplier_product.rb', line 339

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



345
346
347
# File 'lib/tripletex_ruby_client/models/supplier_product.rb', line 345

def hash
  [id, version, changes, url, name, number, description, ean, 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, discount_price, supplier, resale_product, is_deletable, vendor_name, is_efo_nelfo_product, wholesaler_id].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
# File 'lib/tripletex_ruby_client/models/supplier_product.rb', line 235

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

  if !@wholesaler_id.nil? && @wholesaler_id < 0
    invalid_properties.push('invalid value for "wholesaler_id", must be greater than or equal to 0.')
  end

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



419
420
421
# File 'lib/tripletex_ruby_client/models/supplier_product.rb', line 419

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



425
426
427
428
429
430
431
432
433
# File 'lib/tripletex_ruby_client/models/supplier_product.rb', line 425

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



413
414
415
# File 'lib/tripletex_ruby_client/models/supplier_product.rb', line 413

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



258
259
260
261
262
263
264
# File 'lib/tripletex_ruby_client/models/supplier_product.rb', line 258

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 !@ean.nil? && @ean.to_s.length > 14
  return false if !@wholesaler_id.nil? && @wholesaler_id < 0
  true
end