Class: XeroRuby::PayrollNz::BankAccount

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

Defined Under Namespace

Classes: EnumAttributeValidator

Constant Summary collapse

FIXED_AMOUNT = 
"FixedAmount".freeze
BALANCE = 
"Balance".freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BankAccount

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
138
139
140
141
 
# File 'lib/xero-ruby/models/payroll_nz/bank_account.rb', line 97

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_name ⇒ Object

Bank account name (max length = 32)



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

def 
  @account_name
end

#account_number ⇒ Object

Bank account number (digits only; max length = 8)



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

def 
  @account_number
end

#calculation_type ⇒ Object

Calculation type for the transaction can be ‘Fixed Amount’ or ‘Balance’



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

def calculation_type
  @calculation_type
end

#code ⇒ Object

Code of a transaction that appear on the statement.



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

def code
  @code
end

#dollar_amount ⇒ Object

Dollar amount of a transaction.



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

def dollar_amount
  @dollar_amount
end

#particulars ⇒ Object

Particulars that appear on the statement.



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

def particulars
  @particulars
end

#reference ⇒ Object

Statement Text/reference for a transaction that appear on the statement.



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

def reference
  @reference
end

#sort_code ⇒ Object

Bank account sort code (6 digits)



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

def sort_code
  @sort_code
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'account_name' => :'accountName',
    :'account_number' => :'accountNumber',
    :'sort_code' => :'sortCode',
    :'particulars' => :'particulars',
    :'code' => :'code',
    :'dollar_amount' => :'dollarAmount',
    :'reference' => :'reference',
    :'calculation_type' => :'calculationType'
  }
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



213
214
215
 
# File 'lib/xero-ruby/models/payroll_nz/bank_account.rb', line 213

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

.openapi_types ⇒ Object

Attribute type mapping.



82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/xero-ruby/models/payroll_nz/bank_account.rb', line 82

def self.openapi_types
  {
    :'account_name' => :'String',
    :'account_number' => :'String',
    :'sort_code' => :'String',
    :'particulars' => :'String',
    :'code' => :'String',
    :'dollar_amount' => :'BigDecimal',
    :'reference' => :'String',
    :'calculation_type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/xero-ruby/models/payroll_nz/bank_account.rb', line 185

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
       == o. &&
      sort_code == o.sort_code &&
      particulars == o.particulars &&
      code == o.code &&
      dollar_amount == o.dollar_amount &&
      reference == o.reference &&
      calculation_type == o.calculation_type
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



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
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/xero-ruby/models/payroll_nz/bank_account.rb', line 241

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::PayrollNz.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



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/xero-ruby/models/payroll_nz/bank_account.rb', line 314

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



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/xero-ruby/models/payroll_nz/bank_account.rb', line 220

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


200
201
202
 
# File 'lib/xero-ruby/models/payroll_nz/bank_account.rb', line 200

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



206
207
208
 
# File 'lib/xero-ruby/models/payroll_nz/bank_account.rb', line 206

def hash
  [, , sort_code, particulars, code, dollar_amount, reference, calculation_type].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



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/xero-ruby/models/payroll_nz/bank_account.rb', line 145

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

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

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

  invalid_properties
end

#parse_date(datestring) ⇒ Object 



330
331
332
333
334
335
336
337
338
339
 
# File 'lib/xero-ruby/models/payroll_nz/bank_account.rb', line 330

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

Returns the object in the form of hash with snake_case



306
307
308
 
# File 'lib/xero-ruby/models/payroll_nz/bank_account.rb', line 306

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



288
289
290
 
# File 'lib/xero-ruby/models/payroll_nz/bank_account.rb', line 288

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



294
295
296
297
298
299
300
301
302
303
 
# File 'lib/xero-ruby/models/payroll_nz/bank_account.rb', line 294

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



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

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



164
165
166
167
168
169
170
171
 
# File 'lib/xero-ruby/models/payroll_nz/bank_account.rb', line 164

def valid?
  return false if @account_name.nil?
  return false if @account_number.nil?
  return false if @sort_code.nil?
  calculation_type_validator = EnumAttributeValidator.new('String', ["FixedAmount", "Balance"])
  return false unless calculation_type_validator.valid?(@calculation_type)
  true
end