Class: XeroRuby::Accounting::RepeatingInvoice

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

Defined Under Namespace

Classes: EnumAttributeValidator

Constant Summary collapse

ACCPAY =
"ACCPAY".freeze
ACCREC =
"ACCREC".freeze
DRAFT =
"DRAFT".freeze
AUTHORISED =
"AUTHORISED".freeze
DELETED =
"DELETED".freeze

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


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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 140

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
end

Instance Attribute Details

#attachmentsObject

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_idObject

See BrandingThemes


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

def branding_theme_id
  @branding_theme_id
end

#contactObject

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_codeObject

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_attachmentsObject

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

#idObject

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

#line_amount_typesObject

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_itemsObject

See LineItems


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

def line_items
  @line_items
end

#referenceObject

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_idObject

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

#scheduleObject

Returns the value of attribute schedule


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

def schedule
  @schedule
end

#statusObject

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_totalObject

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

#totalObject

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_taxObject

Total tax on invoice


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

def total_tax
  @total_tax
end

#typeObject

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_mapObject

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


95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 95

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'
  }
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


299
300
301
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 299

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

.openapi_typesObject

Attribute type mapping.


117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 117

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>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 263

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
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


327
328
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
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 327

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


400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 400

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


306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 306

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

286
287
288
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 286

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


292
293
294
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 292

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].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons


226
227
228
229
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 226

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object


416
417
418
419
420
421
422
423
424
425
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 416

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
  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_attributesObject

Returns the object in the form of hash with snake_case


392
393
394
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 392

def to_attributes
  to_hash(downcase: true)
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


374
375
376
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 374

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


380
381
382
383
384
385
386
387
388
389
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 380

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


368
369
370
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 368

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


233
234
235
236
237
238
239
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 233

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