Class: DearInventoryRuby::SaleInvoice

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SaleInvoice

Initializes the object

Parameters:

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

    Model attributes in the form of hash



119
120
121
122
123
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
 
# File 'lib/dear-inventory-ruby/models/sale_invoice.rb', line 119

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'linked_fulfillment_number')
    self.linked_fulfillment_number = attributes[:'linked_fulfillment_number']
  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?(:'payments')
    if (value = attributes[:'payments']).is_a?(Array)
      self.payments = 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

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

Instance Attribute Details

#additional_charges ⇒ Object

Returns the value of attribute additional_charges.



49
50
51
 
# File 'lib/dear-inventory-ruby/models/sale_invoice.rb', line 49

def additional_charges
  @additional_charges
end

#billing_address_line1 ⇒ Object

Billing Address Line 1



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

def billing_address_line1
  @billing_address_line1
end

#billing_address_line2 ⇒ Object

Billing Address Line 2



42
43
44
 
# File 'lib/dear-inventory-ruby/models/sale_invoice.rb', line 42

def billing_address_line2
  @billing_address_line2
end

#currency_conversion_rate ⇒ Object

Decimal with up to 4 decimal places



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

def currency_conversion_rate
  @currency_conversion_rate
end

#invoice_date ⇒ Object

Invoice Date.



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

def invoice_date
  @invoice_date
end

#invoice_due_date ⇒ Object

Invoice Due Date.



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

def invoice_due_date
  @invoice_due_date
end

#invoice_number ⇒ Object

Invoice Number (auto-generated)



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

def invoice_number
  @invoice_number
end

#lines ⇒ Object

Returns the value of attribute lines.



47
48
49
 
# File 'lib/dear-inventory-ruby/models/sale_invoice.rb', line 47

def lines
  @lines
end

#linked_fulfillment_number ⇒ Object

Number of Fulfilment linked to this invoice



45
46
47
 
# File 'lib/dear-inventory-ruby/models/sale_invoice.rb', line 45

def linked_fulfillment_number
  @linked_fulfillment_number
end

#memo ⇒ Object

Additional information for Invoice.



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

def memo
  @memo
end

Decimal with up to 4 decimal places. Sum of payments.



63
64
65
 
# File 'lib/dear-inventory-ruby/models/sale_invoice.rb', line 63

def paid
  @paid
end

#payments ⇒ Object

Returns the value of attribute payments.



51
52
53
 
# File 'lib/dear-inventory-ruby/models/sale_invoice.rb', line 51

def payments
  @payments
end

#status ⇒ Object

Invoice status. Possible Values are values. For POST available values are DRAFT, AUTHORISED



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

def status
  @status
end

#task_id ⇒ Object

Identifier of sale Invoice task



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

def task_id
  @task_id
end

#tax ⇒ Object

Decimal with up to 4 decimal places. Sum of Invoice lines and additional charges taxes.



57
58
59
 
# File 'lib/dear-inventory-ruby/models/sale_invoice.rb', line 57

def tax
  @tax
end

#total ⇒ Object

Decimal with up to 4 decimal places. Sum of Invoice lines and additional charges with taxes.



60
61
62
 
# File 'lib/dear-inventory-ruby/models/sale_invoice.rb', line 60

def total
  @total
end

#total_before_tax ⇒ Object

Decimal with up to 4 decimal places. Sum of Invoice lines and additional charges without taxes.



54
55
56
 
# File 'lib/dear-inventory-ruby/models/sale_invoice.rb', line 54

def total_before_tax
  @total_before_tax
end

Class Method Details

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/dear-inventory-ruby/models/sale_invoice.rb', line 66

def self.attribute_map
  {
    :'task_id' => :'TaskID',
    :'invoice_number' => :'InvoiceNumber',
    :'memo' => :'Memo',
    :'status' => :'Status',
    :'invoice_date' => :'InvoiceDate',
    :'invoice_due_date' => :'InvoiceDueDate',
    :'currency_conversion_rate' => :'CurrencyConversionRate',
    :'billing_address_line1' => :'BillingAddressLine1',
    :'billing_address_line2' => :'BillingAddressLine2',
    :'linked_fulfillment_number' => :'LinkedFulfillmentNumber',
    :'lines' => :'Lines',
    :'additional_charges' => :'AdditionalCharges',
    :'payments' => :'Payments',
    :'total_before_tax' => :'TotalBeforeTax',
    :'tax' => :'Tax',
    :'total' => :'Total',
    :'paid' => :'Paid'
  }
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



279
280
281
 
# File 'lib/dear-inventory-ruby/models/sale_invoice.rb', line 279

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



112
113
114
115
 
# File 'lib/dear-inventory-ruby/models/sale_invoice.rb', line 112

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

.openapi_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/dear-inventory-ruby/models/sale_invoice.rb', line 89

def self.openapi_types
  {
    :'task_id' => :'String',
    :'invoice_number' => :'String',
    :'memo' => :'String',
    :'status' => :'String',
    :'invoice_date' => :'String',
    :'invoice_due_date' => :'String',
    :'currency_conversion_rate' => :'Float',
    :'billing_address_line1' => :'String',
    :'billing_address_line2' => :'String',
    :'linked_fulfillment_number' => :'Integer',
    :'lines' => :'Array<SaleInvoiceLine>',
    :'additional_charges' => :'Array<SaleInvoiceAdditionalCharge>',
    :'payments' => :'Array<SalePaymentLine>',
    :'total_before_tax' => :'Float',
    :'tax' => :'Float',
    :'total' => :'Float',
    :'paid' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/dear-inventory-ruby/models/sale_invoice.rb', line 242

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      task_id == o.task_id &&
      invoice_number == o.invoice_number &&
      memo == o.memo &&
      status == o.status &&
      invoice_date == o.invoice_date &&
      invoice_due_date == o.invoice_due_date &&
      currency_conversion_rate == o.currency_conversion_rate &&
      billing_address_line1 == o.billing_address_line1 &&
      billing_address_line2 == o.billing_address_line2 &&
      linked_fulfillment_number == o.linked_fulfillment_number &&
      lines == o.lines &&
      additional_charges == o.additional_charges &&
      payments == o.payments &&
      total_before_tax == o.total_before_tax &&
      tax == o.tax &&
      total == o.total &&
      paid == o.paid
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



307
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
336
337
338
339
340
341
342
 
# File 'lib/dear-inventory-ruby/models/sale_invoice.rb', line 307

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



376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/dear-inventory-ruby/models/sale_invoice.rb', line 376

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



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

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


266
267
268
 
# File 'lib/dear-inventory-ruby/models/sale_invoice.rb', line 266

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



272
273
274
 
# File 'lib/dear-inventory-ruby/models/sale_invoice.rb', line 272

def hash
  [task_id, invoice_number, memo, status, invoice_date, invoice_due_date, currency_conversion_rate, billing_address_line1, billing_address_line2, linked_fulfillment_number, lines, additional_charges, payments, total_before_tax, tax, total, paid].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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/dear-inventory-ruby/models/sale_invoice.rb', line 209

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

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

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

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



352
353
354
 
# File 'lib/dear-inventory-ruby/models/sale_invoice.rb', line 352

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



358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/dear-inventory-ruby/models/sale_invoice.rb', line 358

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



346
347
348
 
# File 'lib/dear-inventory-ruby/models/sale_invoice.rb', line 346

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



232
233
234
235
236
237
238
 
# File 'lib/dear-inventory-ruby/models/sale_invoice.rb', line 232

def valid?
  return false if @task_id.nil?
  return false if @status.nil?
  return false if @invoice_date.nil?
  return false if @invoice_due_date.nil?
  true
end