Class: XeroRuby::Accounting::RepeatingInvoice

Inherits:
Object
  • Object
show all
Defined in:
lib/xero-ruby/models/accounting/repeating_invoice.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RepeatingInvoice

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 160

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#approved_for_sending ⇒ Object

Boolean to indicate whether the invoice has been approved for sending



73
74
75
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 73

def approved_for_sending
  @approved_for_sending
end

#attachments ⇒ Object

Displays array of attachments from the API



70
71
72
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 70

def attachments
  @attachments
end

#branding_theme_id ⇒ Object

See BrandingThemes



40
41
42
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 40

def branding_theme_id
  @branding_theme_id
end

#contact ⇒ Object

Returns the value of attribute contact.



25
26
27
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 25

def contact
  @contact
end

#currency_code ⇒ Object

Returns the value of attribute currency_code.



43
44
45
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 43

def currency_code
  @currency_code
end

#has_attachments ⇒ Object

Boolean to indicate if an invoice has an attachment



67
68
69
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 67

def has_attachments
  @has_attachments
end

#id ⇒ Object

Xero generated unique identifier for repeating invoice template



64
65
66
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 64

def id
  @id
end

#include_pdf ⇒ Object

Boolean to indicate whether to include PDF attachment



82
83
84
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 82

def include_pdf
  @include_pdf
end

#line_amount_types ⇒ Object

Returns the value of attribute line_amount_types.



34
35
36
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 34

def line_amount_types
  @line_amount_types
end

#line_items ⇒ Object

See LineItems



31
32
33
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 31

def line_items
  @line_items
end

#mark_as_sent ⇒ Object

Boolean to indicate whether the invoice in the Xero app displays as "sent"



79
80
81
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 79

def mark_as_sent
  @mark_as_sent
end

#reference ⇒ Object

ACCREC only – additional reference number



37
38
39
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 37

def reference
  @reference
end

#repeating_invoice_id ⇒ Object

Xero generated unique identifier for repeating invoice template



61
62
63
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 61

def repeating_invoice_id
  @repeating_invoice_id
end

#schedule ⇒ Object

Returns the value of attribute schedule.



28
29
30
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 28

def schedule
  @schedule
end

#send_copy ⇒ Object

Boolean to indicate whether a copy is sent to sender’s email



76
77
78
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 76

def send_copy
  @send_copy
end

#status ⇒ Object

One of the following - DRAFT or AUTHORISED – See Invoice Status Codes



46
47
48
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 46

def status
  @status
end

#sub_total ⇒ Object

Total of invoice excluding taxes



52
53
54
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 52

def sub_total
  @sub_total
end

#total ⇒ Object

Total of Invoice tax inclusive (i.e. SubTotal + TotalTax)



58
59
60
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 58

def total
  @total
end

#total_tax ⇒ Object

Total tax on invoice



55
56
57
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 55

def total_tax
  @total_tax
end

#type ⇒ Object

See Invoice Types



20
21
22
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 20

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 107

def self.attribute_map
  {
    :'type' => :'Type',
    :'contact' => :'Contact',
    :'schedule' => :'Schedule',
    :'line_items' => :'LineItems',
    :'line_amount_types' => :'LineAmountTypes',
    :'reference' => :'Reference',
    :'branding_theme_id' => :'BrandingThemeID',
    :'currency_code' => :'CurrencyCode',
    :'status' => :'Status',
    :'sub_total' => :'SubTotal',
    :'total_tax' => :'TotalTax',
    :'total' => :'Total',
    :'repeating_invoice_id' => :'RepeatingInvoiceID',
    :'id' => :'ID',
    :'has_attachments' => :'HasAttachments',
    :'attachments' => :'Attachments',
    :'approved_for_sending' => :'ApprovedForSending',
    :'send_copy' => :'SendCopy',
    :'mark_as_sent' => :'MarkAsSent',
    :'include_pdf' => :'IncludePDF'
  }
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



347
348
349
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 347

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

.openapi_types ⇒ Object

Attribute type mapping.



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 133

def self.openapi_types
  {
    :'type' => :'String',
    :'contact' => :'Contact',
    :'schedule' => :'Schedule',
    :'line_items' => :'Array<LineItem>',
    :'line_amount_types' => :'LineAmountTypes',
    :'reference' => :'String',
    :'branding_theme_id' => :'String',
    :'currency_code' => :'CurrencyCode',
    :'status' => :'String',
    :'sub_total' => :'BigDecimal',
    :'total_tax' => :'BigDecimal',
    :'total' => :'BigDecimal',
    :'repeating_invoice_id' => :'String',
    :'id' => :'String',
    :'has_attachments' => :'Boolean',
    :'attachments' => :'Array<Attachment>',
    :'approved_for_sending' => :'Boolean',
    :'send_copy' => :'Boolean',
    :'mark_as_sent' => :'Boolean',
    :'include_pdf' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 307

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      contact == o.contact &&
      schedule == o.schedule &&
      line_items == o.line_items &&
      line_amount_types == o.line_amount_types &&
      reference == o.reference &&
      branding_theme_id == o.branding_theme_id &&
      currency_code == o.currency_code &&
      status == o.status &&
      sub_total == o.sub_total &&
      total_tax == o.total_tax &&
      total == o.total &&
      repeating_invoice_id == o.repeating_invoice_id &&
      id == o.id &&
      has_attachments == o.has_attachments &&
      attachments == o.attachments &&
      approved_for_sending == o.approved_for_sending &&
      send_copy == o.send_copy &&
      mark_as_sent == o.mark_as_sent &&
      include_pdf == o.include_pdf
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



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
410
411
412
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 375

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(parse_date(value))
  when :Date
    Date.parse(parse_date(value))
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BigDecimal
    BigDecimal(value.to_s)
  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
    XeroRuby::Accounting.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value, downcase: false) ⇒ 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



448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 448

def _to_hash(value, downcase: false)
  if value.is_a?(Array)
    value.map do |v|
      v.to_hash(downcase: downcase)
    end
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.map { |k, v| hash[k] = _to_hash(v, downcase: downcase) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash(downcase: downcase)
  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



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 354

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


334
335
336
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 334

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



340
341
342
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 340

def hash
  [type, contact, schedule, line_items, line_amount_types, reference, branding_theme_id, currency_code, status, sub_total, total_tax, total, repeating_invoice_id, id, has_attachments, attachments, approved_for_sending, send_copy, mark_as_sent, include_pdf].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



270
271
272
273
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 270

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object 



464
465
466
467
468
469
470
471
472
473
474
475
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 464

def parse_date(datestring)
  if datestring.include?('Date')
    date_pattern = /\/Date\((-?\d+)(\+\d+)?\)\//
    original, date, timezone = *date_pattern.match(datestring)
    date = (date.to_i / 1000)
    Time.at(date).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
  elsif /(\d\d\d\d)-(\d\d)/.match(datestring) # handles dates w/out Days: YYYY-MM*-DD
    Time.parse(datestring + '-01').strftime('%Y-%m-%dT%H:%M:%S').to_s
  else # handle date 'types' for small subset of payroll API's
    Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s
  end
end

#to_attributes ⇒ Object

Returns the object in the form of hash with snake_case



440
441
442
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 440

def to_attributes
  to_hash(downcase: true)
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



422
423
424
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 422

def to_body
  to_hash
end

#to_hash(downcase: false) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



428
429
430
431
432
433
434
435
436
437
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 428

def to_hash(downcase: false)
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    key = downcase ? attr : param
    hash[key] = _to_hash(value, downcase: downcase)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



416
417
418
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 416

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



277
278
279
280
281
282
283
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 277

def valid?
  type_validator = EnumAttributeValidator.new('String', ["ACCPAY", "ACCREC"])
  return false unless type_validator.valid?(@type)
  status_validator = EnumAttributeValidator.new('String', ["DRAFT", "AUTHORISED", "DELETED"])
  return false unless status_validator.valid?(@status)
  true
end