Class: DearInventoryRuby::SaleQuote

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SaleQuote

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/dear-inventory-ruby/models/sale_quote.rb', line 80

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

  if attributes.key?(:'combine_additional_charges')
    self.combine_additional_charges = attributes[:'combine_additional_charges']
  else
    self.combine_additional_charges = false
  end

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

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

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

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

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

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

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

Instance Attribute Details

#additional_charges ⇒ Object

Returns the value of attribute additional_charges.



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

def additional_charges
  @additional_charges
end

#combine_additional_charges ⇒ Object

If ‘true` then `additional charges` lines displayed in `Lines` array



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

def combine_additional_charges
  @combine_additional_charges
end

#lines ⇒ Object

Returns the value of attribute lines.



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

def lines
  @lines
end

#memo ⇒ Object

Additional information for Quote.



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

def memo
  @memo
end

#sale_id ⇒ Object

Unique DEAR Sale ID



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

def sale_id
  @sale_id
end

#status ⇒ Object

Quote Status. Possible Values are values. For POST only ‘DRAFT` and `AUTHORISED` values accepted



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

def status
  @status
end

#tax ⇒ Object

Decimal with up to 4 decimal places. Sum of quote lines and additional charges taxes. Not required for POST.



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

def tax
  @tax
end

#total ⇒ Object

Decimal with up to 4 decimal places. Sum of quote lines and additional charges with taxes. Not required for POST.



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

def total
  @total
end

#total_before_tax ⇒ Object

Decimal with up to 4 decimal places. Sum of quote lines and additional charges without taxes. Not required for POST.



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

def total_before_tax
  @total_before_tax
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'sale_id' => :'SaleID',
    :'combine_additional_charges' => :'CombineAdditionalCharges',
    :'memo' => :'Memo',
    :'status' => :'Status',
    :'lines' => :'Lines',
    :'additional_charges' => :'AdditionalCharges',
    :'total_before_tax' => :'TotalBeforeTax',
    :'tax' => :'Tax',
    :'total' => :'Total'
  }
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



215
216
217
 
# File 'lib/dear-inventory-ruby/models/sale_quote.rb', line 215

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



73
74
75
76
 
# File 'lib/dear-inventory-ruby/models/sale_quote.rb', line 73

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

.openapi_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/dear-inventory-ruby/models/sale_quote.rb', line 58

def self.openapi_types
  {
    :'sale_id' => :'String',
    :'combine_additional_charges' => :'Boolean',
    :'memo' => :'String',
    :'status' => :'String',
    :'lines' => :'Array<SaleQuoteLine>',
    :'additional_charges' => :'Array<SaleAdditionalCharge>',
    :'total_before_tax' => :'Float',
    :'tax' => :'Float',
    :'total' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/dear-inventory-ruby/models/sale_quote.rb', line 186

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      sale_id == o.sale_id &&
      combine_additional_charges == o.combine_additional_charges &&
      memo == o.memo &&
      status == o.status &&
      lines == o.lines &&
      additional_charges == o.additional_charges &&
      total_before_tax == o.total_before_tax &&
      tax == o.tax &&
      total == o.total
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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/dear-inventory-ruby/models/sale_quote.rb', line 243

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



312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/dear-inventory-ruby/models/sale_quote.rb', line 312

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



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/dear-inventory-ruby/models/sale_quote.rb', line 222

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


202
203
204
 
# File 'lib/dear-inventory-ruby/models/sale_quote.rb', line 202

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



208
209
210
 
# File 'lib/dear-inventory-ruby/models/sale_quote.rb', line 208

def hash
  [sale_id, combine_additional_charges, memo, status, lines, additional_charges, total_before_tax, tax, total].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



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
 
# File 'lib/dear-inventory-ruby/models/sale_quote.rb', line 138

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

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

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

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

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

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

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



288
289
290
 
# File 'lib/dear-inventory-ruby/models/sale_quote.rb', line 288

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



294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/dear-inventory-ruby/models/sale_quote.rb', line 294

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



282
283
284
 
# File 'lib/dear-inventory-ruby/models/sale_quote.rb', line 282

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



173
174
175
176
177
178
179
180
181
182
 
# File 'lib/dear-inventory-ruby/models/sale_quote.rb', line 173

def valid?
  return false if @sale_id.nil?
  return false if @combine_additional_charges.nil?
  return false if @memo.nil?
  return false if @status.nil?
  return false if @total_before_tax.nil?
  return false if @tax.nil?
  return false if @total.nil?
  true
end