Class: XeroRuby::PayrollAu::SuperFund

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SuperFund

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
# File 'lib/xero-ruby/models/payroll_au/super_fund.rb', line 98

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#abnObject

ABN of the self managed super fund


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

def abn
  @abn
end

#account_nameObject

The account name for the self managed super fund.


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

def 
  @account_name
end

#account_numberObject

The account number for the self managed super fund.


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

def 
  @account_number
end

#bsbObject

BSB of the self managed super fund


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

def bsb
  @bsb
end

#electronic_service_addressObject

The electronic service address for the self managed super fund.


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

def electronic_service_address
  @electronic_service_address
end

#employer_numberObject

Some funds assign a unique number to each employer


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

def employer_number
  @employer_number
end

#nameObject

Name of the super fund


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

def name
  @name
end

#spinObject

The SPIN of the Regulated SuperFund. This field has been deprecated. It will only be present for legacy superfunds. New superfunds will not have a SPIN value. The USI field should be used instead of SPIN.


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

def spin
  @spin
end

#super_fund_idObject

Xero identifier for a super fund


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

def super_fund_id
  @super_fund_id
end

#typeObject

Returns the value of attribute type


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

def type
  @type
end

#updated_date_utcObject

Last modified timestamp


53
54
55
# File 'lib/xero-ruby/models/payroll_au/super_fund.rb', line 53

def updated_date_utc
  @updated_date_utc
end

#usiObject

The USI of the Regulated SuperFund


50
51
52
# File 'lib/xero-ruby/models/payroll_au/super_fund.rb', line 50

def usi
  @usi
end

#validation_errorsObject

Displays array of validation error messages from the API


56
57
58
# File 'lib/xero-ruby/models/payroll_au/super_fund.rb', line 56

def validation_errors
  @validation_errors
end

Class Method Details

.attribute_mapObject

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


59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
# File 'lib/xero-ruby/models/payroll_au/super_fund.rb', line 59

def self.attribute_map
  {
    :'super_fund_id' => :'SuperFundID',
    :'type' => :'Type',
    :'name' => :'Name',
    :'abn' => :'ABN',
    :'bsb' => :'BSB',
    :'account_number' => :'AccountNumber',
    :'account_name' => :'AccountName',
    :'electronic_service_address' => :'ElectronicServiceAddress',
    :'employer_number' => :'EmployerNumber',
    :'spin' => :'SPIN',
    :'usi' => :'USI',
    :'updated_date_utc' => :'UpdatedDateUTC',
    :'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


219
220
221
# File 'lib/xero-ruby/models/payroll_au/super_fund.rb', line 219

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

.openapi_typesObject

Attribute type mapping.


78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
# File 'lib/xero-ruby/models/payroll_au/super_fund.rb', line 78

def self.openapi_types
  {
    :'super_fund_id' => :'String',
    :'type' => :'SuperFundType',
    :'name' => :'String',
    :'abn' => :'String',
    :'bsb' => :'String',
    :'account_number' => :'String',
    :'account_name' => :'String',
    :'electronic_service_address' => :'String',
    :'employer_number' => :'String',
    :'spin' => :'String',
    :'usi' => :'String',
    :'updated_date_utc' => :'DateTime',
    :'validation_errors' => :'Array<ValidationError>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
# File 'lib/xero-ruby/models/payroll_au/super_fund.rb', line 186

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      super_fund_id == o.super_fund_id &&
      type == o.type &&
      name == o.name &&
      abn == o.abn &&
      bsb == o.bsb &&
       == o. &&
       == o. &&
      electronic_service_address == o.electronic_service_address &&
      employer_number == o.employer_number &&
      spin == o.spin &&
      usi == o.usi &&
      updated_date_utc == o.updated_date_utc &&
      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


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
279
280
281
282
283
284
# File 'lib/xero-ruby/models/payroll_au/super_fund.rb', line 247

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


320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
# File 'lib/xero-ruby/models/payroll_au/super_fund.rb', line 320

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


226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
# File 'lib/xero-ruby/models/payroll_au/super_fund.rb', line 226

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

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

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


212
213
214
# File 'lib/xero-ruby/models/payroll_au/super_fund.rb', line 212

def hash
  [super_fund_id, type, name, abn, bsb, , , electronic_service_address, employer_number, spin, usi, updated_date_utc, validation_errors].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


168
169
170
171
172
173
174
175
# File 'lib/xero-ruby/models/payroll_au/super_fund.rb', line 168

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

  invalid_properties
end

#parse_date(datestring) ⇒ Object


336
337
338
339
340
341
342
343
344
345
# File 'lib/xero-ruby/models/payroll_au/super_fund.rb', line 336

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


312
313
314
# File 'lib/xero-ruby/models/payroll_au/super_fund.rb', line 312

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


294
295
296
# File 'lib/xero-ruby/models/payroll_au/super_fund.rb', line 294

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


300
301
302
303
304
305
306
307
308
309
# File 'lib/xero-ruby/models/payroll_au/super_fund.rb', line 300

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


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

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


179
180
181
182
# File 'lib/xero-ruby/models/payroll_au/super_fund.rb', line 179

def valid?
  return false if @type.nil?
  true
end