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



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
206
207
208
209
210
211
212
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 130

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

#attachments ⇒ Object

Displays array of attachments from the API



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

def attachments
  @attachments
end

#branding_theme_id ⇒ Object

See BrandingThemes



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

def branding_theme_id
  @branding_theme_id
end

#contact ⇒ Object

Returns the value of attribute contact.



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

def contact
  @contact
end

#currency_code ⇒ Object

Returns the value of attribute currency_code.



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

def currency_code
  @currency_code
end

#has_attachments ⇒ Object

boolean to indicate if an invoice has an attachment



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

def has_attachments
  @has_attachments
end

#id ⇒ Object

Xero generated unique identifier for repeating invoice template



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

def id
  @id
end

#line_amount_types ⇒ Object

Returns the value of attribute line_amount_types.



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

def line_amount_types
  @line_amount_types
end

#line_items ⇒ Object

See LineItems



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

def line_items
  @line_items
end

#reference ⇒ Object

ACCREC only – additional reference number



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

def reference
  @reference
end

#repeating_invoice_id ⇒ Object

Xero generated unique identifier for repeating invoice template



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

def repeating_invoice_id
  @repeating_invoice_id
end

#schedule ⇒ Object

Returns the value of attribute schedule.



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

def schedule
  @schedule
end

#status ⇒ Object

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



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

def status
  @status
end

#sub_total ⇒ Object

Total of invoice excluding taxes



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

def sub_total
  @sub_total
end

#total ⇒ Object

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



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

def total
  @total
end

#total_tax ⇒ Object

Total tax on invoice



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

def total_tax
  @total_tax
end

#type ⇒ Object

See Invoice Types



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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 85

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



289
290
291
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 289

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

.openapi_types ⇒ Object

Attribute type mapping.



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

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' => :'Float',
    :'total_tax' => :'Float',
    :'total' => :'Float',
    :'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



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 253

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



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
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 317

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 :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) ⇒ 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



382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 382

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



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 296

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


276
277
278
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 276

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



282
283
284
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 282

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_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



216
217
218
219
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 216

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object

customized data_parser



397
398
399
400
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 397

def parse_date(datestring)
  seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0
  return Time.at(seconds_since_epoch).to_s
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



362
363
364
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 362

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



368
369
370
371
372
373
374
375
376
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 368

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



356
357
358
 
# File 'lib/xero-ruby/models/accounting/repeating_invoice.rb', line 356

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



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

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