Class: DearInventoryRuby::SaleAdditionalCharge

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SaleAdditionalCharge

Initializes the object

Parameters:

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

    Model attributes in the form of hash



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
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
121
 
# File 'lib/dear-inventory-ruby/models/sale_additional_charge.rb', line 77

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

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

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

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

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

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

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

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

Instance Attribute Details

#comment ⇒ Object

Comment



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

def comment
  @comment
end

#description ⇒ Object

Name of Service Product referenced by this Line



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

def description
  @description
end

#discount ⇒ Object

Decimal with up to 2 decimal places. Discount. Value between 0 and 100. For free items discount is 100. Default value is 0



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

def discount
  @discount
end

#price ⇒ Object

Decimal with up to 4 decimal places. Price per unit in Customer currency



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

def price
  @price
end

#quantity ⇒ Object

Decimal with up to 4 decimal places. Product or service quantity. Minimal value is 1.



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

def quantity
  @quantity
end

#tax ⇒ Object

Decimal with up to 4 decimal places. Tax.



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

def tax
  @tax
end

#tax_rule ⇒ Object

Line Tax Rule name.



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

def tax_rule
  @tax_rule
end

#total ⇒ Object

Decimal with up to 4 decimal places. Line Total. For validation



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

def total
  @total
end

Class Method Details

.attribute_map ⇒ Object

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



42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/dear-inventory-ruby/models/sale_additional_charge.rb', line 42

def self.attribute_map
  {
    :'description' => :'Description',
    :'price' => :'Price',
    :'quantity' => :'Quantity',
    :'discount' => :'Discount',
    :'tax' => :'Tax',
    :'total' => :'Total',
    :'tax_rule' => :'TaxRule',
    :'comment' => :'Comment'
  }
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



191
192
193
 
# File 'lib/dear-inventory-ruby/models/sale_additional_charge.rb', line 191

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



70
71
72
73
 
# File 'lib/dear-inventory-ruby/models/sale_additional_charge.rb', line 70

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

.openapi_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/dear-inventory-ruby/models/sale_additional_charge.rb', line 56

def self.openapi_types
  {
    :'description' => :'String',
    :'price' => :'Float',
    :'quantity' => :'Float',
    :'discount' => :'Float',
    :'tax' => :'Float',
    :'total' => :'Float',
    :'tax_rule' => :'String',
    :'comment' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/dear-inventory-ruby/models/sale_additional_charge.rb', line 163

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      description == o.description &&
      price == o.price &&
      quantity == o.quantity &&
      discount == o.discount &&
      tax == o.tax &&
      total == o.total &&
      tax_rule == o.tax_rule &&
      comment == o.comment
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



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/dear-inventory-ruby/models/sale_additional_charge.rb', line 219

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



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

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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/dear-inventory-ruby/models/sale_additional_charge.rb', line 198

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


178
179
180
 
# File 'lib/dear-inventory-ruby/models/sale_additional_charge.rb', line 178

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



184
185
186
 
# File 'lib/dear-inventory-ruby/models/sale_additional_charge.rb', line 184

def hash
  [description, price, quantity, discount, tax, total, tax_rule, comment].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



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/dear-inventory-ruby/models/sale_additional_charge.rb', line 125

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

  if @price.nil?
    invalid_properties.push('invalid value for "price", price cannot be nil.')
  end

  if @quantity.nil?
    invalid_properties.push('invalid value for "quantity", quantity cannot be nil.')
  end

  if @tax.nil?
    invalid_properties.push('invalid value for "tax", tax cannot be nil.')
  end

  if @tax_rule.nil?
    invalid_properties.push('invalid value for "tax_rule", tax_rule cannot be nil.')
  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



264
265
266
 
# File 'lib/dear-inventory-ruby/models/sale_additional_charge.rb', line 264

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



270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/dear-inventory-ruby/models/sale_additional_charge.rb', line 270

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



258
259
260
 
# File 'lib/dear-inventory-ruby/models/sale_additional_charge.rb', line 258

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



152
153
154
155
156
157
158
159
 
# File 'lib/dear-inventory-ruby/models/sale_additional_charge.rb', line 152

def valid?
  return false if @description.nil?
  return false if @price.nil?
  return false if @quantity.nil?
  return false if @tax.nil?
  return false if @tax_rule.nil?
  true
end