Class: XeroRuby::Accounting::Allocation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Allocation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
135
136
137
 
# File 'lib/xero-ruby/models/accounting/allocation.rb', line 83

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#allocation_id ⇒ Object

Xero generated unique identifier



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

def allocation_id
  @allocation_id
end

#amount ⇒ Object

the amount being applied to the invoice



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

def amount
  @amount
end

#credit_note ⇒ Object

Returns the value of attribute credit_note.



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

def credit_note
  @credit_note
end

#date ⇒ Object

the date the allocation is applied YYYY-MM-DD.



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

def date
  @date
end

#invoice ⇒ Object

Returns the value of attribute invoice.



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

def invoice
  @invoice
end

#is_deleted ⇒ Object

A flag that returns true when the allocation is succesfully deleted



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

def is_deleted
  @is_deleted
end

#overpayment ⇒ Object

Returns the value of attribute overpayment.



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

def overpayment
  @overpayment
end

#prepayment ⇒ Object

Returns the value of attribute prepayment.



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

def prepayment
  @prepayment
end

#status_attribute_string ⇒ Object

A string to indicate if a invoice status



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

def status_attribute_string
  @status_attribute_string
end

#validation_errors ⇒ Object

Displays array of validation error messages from the API



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

def validation_errors
  @validation_errors
end

Class Method Details

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/xero-ruby/models/accounting/allocation.rb', line 50

def self.attribute_map
  {
    :'allocation_id' => :'AllocationID',
    :'invoice' => :'Invoice',
    :'overpayment' => :'Overpayment',
    :'prepayment' => :'Prepayment',
    :'credit_note' => :'CreditNote',
    :'amount' => :'Amount',
    :'date' => :'Date',
    :'is_deleted' => :'IsDeleted',
    :'status_attribute_string' => :'StatusAttributeString',
    :'validation_errors' => :'ValidationErrors'
  }
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



199
200
201
 
# File 'lib/xero-ruby/models/accounting/allocation.rb', line 199

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

.openapi_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/xero-ruby/models/accounting/allocation.rb', line 66

def self.openapi_types
  {
    :'allocation_id' => :'String',
    :'invoice' => :'Invoice',
    :'overpayment' => :'Overpayment',
    :'prepayment' => :'Prepayment',
    :'credit_note' => :'CreditNote',
    :'amount' => :'BigDecimal',
    :'date' => :'Date',
    :'is_deleted' => :'Boolean',
    :'status_attribute_string' => :'String',
    :'validation_errors' => :'Array<ValidationError>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/xero-ruby/models/accounting/allocation.rb', line 169

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      allocation_id == o.allocation_id &&
      invoice == o.invoice &&
      overpayment == o.overpayment &&
      prepayment == o.prepayment &&
      credit_note == o.credit_note &&
      amount == o.amount &&
      date == o.date &&
      is_deleted == o.is_deleted &&
      status_attribute_string == o.status_attribute_string &&
      validation_errors == o.validation_errors
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



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

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



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/xero-ruby/models/accounting/allocation.rb', line 300

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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/xero-ruby/models/accounting/allocation.rb', line 206

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


186
187
188
 
# File 'lib/xero-ruby/models/accounting/allocation.rb', line 186

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



192
193
194
 
# File 'lib/xero-ruby/models/accounting/allocation.rb', line 192

def hash
  [allocation_id, invoice, overpayment, prepayment, credit_note, amount, date, is_deleted, status_attribute_string, validation_errors].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



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/xero-ruby/models/accounting/allocation.rb', line 141

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

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

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

  invalid_properties
end

#parse_date(datestring) ⇒ Object 



316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/xero-ruby/models/accounting/allocation.rb', line 316

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



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

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



274
275
276
 
# File 'lib/xero-ruby/models/accounting/allocation.rb', line 274

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



280
281
282
283
284
285
286
287
288
289
 
# File 'lib/xero-ruby/models/accounting/allocation.rb', line 280

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



268
269
270
 
# File 'lib/xero-ruby/models/accounting/allocation.rb', line 268

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



160
161
162
163
164
165
 
# File 'lib/xero-ruby/models/accounting/allocation.rb', line 160

def valid?
  return false if @invoice.nil?
  return false if @amount.nil?
  return false if @date.nil?
  true
end