Class: FattureInCloud_Ruby_Sdk::Product

Inherits:
Object
  • Object
show all
Defined in:
lib/fattureincloud_ruby_sdk/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



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
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/fattureincloud_ruby_sdk/models/product.rb', line 154

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `FattureInCloud_Ruby_Sdk::Product` 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 `FattureInCloud_Ruby_Sdk::Product`. 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?(:'code')
    self.code = attributes[:'code']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#average_cost ⇒ Object

Product average cost.



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

def average_cost
  @average_cost
end

#average_price ⇒ Object

Product average price.



66
67
68
 
# File 'lib/fattureincloud_ruby_sdk/models/product.rb', line 66

def average_price
  @average_price
end

#category ⇒ Object

Product category.



48
49
50
 
# File 'lib/fattureincloud_ruby_sdk/models/product.rb', line 48

def category
  @category
end

#code ⇒ Object

Product code.



25
26
27
 
# File 'lib/fattureincloud_ruby_sdk/models/product.rb', line 25

def code
  @code
end

#created_at ⇒ Object

Returns the value of attribute created_at.



68
69
70
 
# File 'lib/fattureincloud_ruby_sdk/models/product.rb', line 68

def created_at
  @created_at
end

#default_vat ⇒ Object

Returns the value of attribute default_vat.



36
37
38
 
# File 'lib/fattureincloud_ruby_sdk/models/product.rb', line 36

def default_vat
  @default_vat
end

#description ⇒ Object

Product description.



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

def description
  @description
end

#gross_price ⇒ Object

Gross sale price (used if use_gross_price is false, otherwise it’s competed automatically).



31
32
33
 
# File 'lib/fattureincloud_ruby_sdk/models/product.rb', line 31

def gross_price
  @gross_price
end

#id ⇒ Object

Unique identifier.



19
20
21
 
# File 'lib/fattureincloud_ruby_sdk/models/product.rb', line 19

def id
  @id
end

#in_stock ⇒ Object

Determine if the product is in stock.



54
55
56
 
# File 'lib/fattureincloud_ruby_sdk/models/product.rb', line 54

def in_stock
  @in_stock
end

#measure ⇒ Object

Unit of measure.



42
43
44
 
# File 'lib/fattureincloud_ruby_sdk/models/product.rb', line 42

def measure
  @measure
end

#name ⇒ Object

Product name.



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

def name
  @name
end

#net_cost ⇒ Object

Net cost of the product (used for received documents).



39
40
41
 
# File 'lib/fattureincloud_ruby_sdk/models/product.rb', line 39

def net_cost
  @net_cost
end

#net_price ⇒ Object

Net sale price (used if use_gross_price is false, otherwise it’s competed automatically).



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

def net_price
  @net_price
end

#notes ⇒ Object

Extra notes.



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

def notes
  @notes
end

#stock_current ⇒ Object

Read Only

Product current stock.



60
61
62
 
# File 'lib/fattureincloud_ruby_sdk/models/product.rb', line 60

def stock_current
  @stock_current
end

#stock_initial ⇒ Object

Product initial stock.



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

def stock_initial
  @stock_initial
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



70
71
72
 
# File 'lib/fattureincloud_ruby_sdk/models/product.rb', line 70

def updated_at
  @updated_at
end

#use_gross_price ⇒ Object

Determine which price to use for calculations.



34
35
36
 
# File 'lib/fattureincloud_ruby_sdk/models/product.rb', line 34

def use_gross_price
  @use_gross_price
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



98
99
100
 
# File 'lib/fattureincloud_ruby_sdk/models/product.rb', line 98

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/fattureincloud_ruby_sdk/models/product.rb', line 73

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'code' => :'code',
    :'net_price' => :'net_price',
    :'gross_price' => :'gross_price',
    :'use_gross_price' => :'use_gross_price',
    :'default_vat' => :'default_vat',
    :'net_cost' => :'net_cost',
    :'measure' => :'measure',
    :'description' => :'description',
    :'category' => :'category',
    :'notes' => :'notes',
    :'in_stock' => :'in_stock',
    :'stock_initial' => :'stock_initial',
    :'stock_current' => :'stock_current',
    :'average_cost' => :'average_cost',
    :'average_price' => :'average_price',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at'
  }
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



298
299
300
 
# File 'lib/fattureincloud_ruby_sdk/models/product.rb', line 298

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/fattureincloud_ruby_sdk/models/product.rb', line 128

def self.openapi_nullable
  Set.new([
    :'id',
    :'name',
    :'code',
    :'net_price',
    :'gross_price',
    :'use_gross_price',
    :'default_vat',
    :'net_cost',
    :'measure',
    :'description',
    :'category',
    :'notes',
    :'in_stock',
    :'stock_initial',
    :'stock_current',
    :'average_cost',
    :'average_price',
    :'created_at',
    :'updated_at'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/fattureincloud_ruby_sdk/models/product.rb', line 103

def self.openapi_types
  {
    :'id' => :'Integer',
    :'name' => :'String',
    :'code' => :'String',
    :'net_price' => :'Float',
    :'gross_price' => :'Float',
    :'use_gross_price' => :'Boolean',
    :'default_vat' => :'VatType',
    :'net_cost' => :'Float',
    :'measure' => :'String',
    :'description' => :'String',
    :'category' => :'String',
    :'notes' => :'String',
    :'in_stock' => :'Boolean',
    :'stock_initial' => :'Float',
    :'stock_current' => :'Float',
    :'average_cost' => :'Float',
    :'average_price' => :'Float',
    :'created_at' => :'String',
    :'updated_at' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/fattureincloud_ruby_sdk/models/product.rb', line 259

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      code == o.code &&
      net_price == o.net_price &&
      gross_price == o.gross_price &&
      use_gross_price == o.use_gross_price &&
      default_vat == o.default_vat &&
      net_cost == o.net_cost &&
      measure == o.measure &&
      description == o.description &&
      category == o.category &&
      notes == o.notes &&
      in_stock == o.in_stock &&
      stock_initial == o.stock_initial &&
      stock_current == o.stock_current &&
      average_cost == o.average_cost &&
      average_price == o.average_price &&
      created_at == o.created_at &&
      updated_at == o.updated_at
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



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/fattureincloud_ruby_sdk/models/product.rb', line 329

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
  when :Hash
    value
  else # model
    # models (e.g. Pet) or oneOf
    klass = FattureInCloud_Ruby_Sdk.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/fattureincloud_ruby_sdk/models/product.rb', line 402

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



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/fattureincloud_ruby_sdk/models/product.rb', line 305

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


285
286
287
 
# File 'lib/fattureincloud_ruby_sdk/models/product.rb', line 285

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



291
292
293
 
# File 'lib/fattureincloud_ruby_sdk/models/product.rb', line 291

def hash
  [id, name, code, net_price, gross_price, use_gross_price, default_vat, net_cost, measure, description, category, notes, in_stock, stock_initial, stock_current, average_cost, average_price, created_at, updated_at].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



246
247
248
249
 
# File 'lib/fattureincloud_ruby_sdk/models/product.rb', line 246

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



378
379
380
 
# File 'lib/fattureincloud_ruby_sdk/models/product.rb', line 378

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



384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/fattureincloud_ruby_sdk/models/product.rb', line 384

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



372
373
374
 
# File 'lib/fattureincloud_ruby_sdk/models/product.rb', line 372

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



253
254
255
 
# File 'lib/fattureincloud_ruby_sdk/models/product.rb', line 253

def valid?
  true
end