Class: XeroRuby::PayrollUk::Address

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Address

Initializes the object

Parameters:

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

    Model attributes in the form of hash



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/xero-ruby/models/payroll_uk/address.rb', line 59

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

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

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

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

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

Instance Attribute Details

#address_line1 ⇒ Object

Address line 1 for employee home address



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

def address_line1
  @address_line1
end

#address_line2 ⇒ Object

Address line 2 for employee home address



24
25
26
 
# File 'lib/xero-ruby/models/payroll_uk/address.rb', line 24

def address_line2
  @address_line2
end

#city ⇒ Object

Suburb for employee home address



27
28
29
 
# File 'lib/xero-ruby/models/payroll_uk/address.rb', line 27

def city
  @city
end

#country_name ⇒ Object

Country of HomeAddress



33
34
35
 
# File 'lib/xero-ruby/models/payroll_uk/address.rb', line 33

def country_name
  @country_name
end

#post_code ⇒ Object

PostCode for employee home address



30
31
32
 
# File 'lib/xero-ruby/models/payroll_uk/address.rb', line 30

def post_code
  @post_code
end

Class Method Details

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
 
# File 'lib/xero-ruby/models/payroll_uk/address.rb', line 36

def self.attribute_map
  {
    :'address_line1' => :'addressLine1',
    :'address_line2' => :'addressLine2',
    :'city' => :'city',
    :'post_code' => :'postCode',
    :'country_name' => :'countryName'
  }
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



148
149
150
 
# File 'lib/xero-ruby/models/payroll_uk/address.rb', line 148

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

.openapi_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
53
54
55
 
# File 'lib/xero-ruby/models/payroll_uk/address.rb', line 47

def self.openapi_types
  {
    :'address_line1' => :'String',
    :'address_line2' => :'String',
    :'city' => :'String',
    :'post_code' => :'String',
    :'country_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



123
124
125
126
127
128
129
130
131
 
# File 'lib/xero-ruby/models/payroll_uk/address.rb', line 123

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      address_line1 == o.address_line1 &&
      address_line2 == o.address_line2 &&
      city == o.city &&
      post_code == o.post_code &&
      country_name == o.country_name
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



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
 
# File 'lib/xero-ruby/models/payroll_uk/address.rb', line 176

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



243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/xero-ruby/models/payroll_uk/address.rb', line 243

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



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/xero-ruby/models/payroll_uk/address.rb', line 155

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


135
136
137
 
# File 'lib/xero-ruby/models/payroll_uk/address.rb', line 135

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



141
142
143
 
# File 'lib/xero-ruby/models/payroll_uk/address.rb', line 141

def hash
  [address_line1, address_line2, city, post_code, country_name].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



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/xero-ruby/models/payroll_uk/address.rb', line 95

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

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

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

  invalid_properties
end

#parse_date(datestring) ⇒ Object

customized data_parser



258
259
260
261
 
# File 'lib/xero-ruby/models/payroll_uk/address.rb', line 258

def parse_date(datestring)
  seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0
  return Time.at(seconds_since_epoch).strftime('%Y-%m-%dT%l:%M:%S%z').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



223
224
225
 
# File 'lib/xero-ruby/models/payroll_uk/address.rb', line 223

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



229
230
231
232
233
234
235
236
237
 
# File 'lib/xero-ruby/models/payroll_uk/address.rb', line 229

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



217
218
219
 
# File 'lib/xero-ruby/models/payroll_uk/address.rb', line 217

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



114
115
116
117
118
119
 
# File 'lib/xero-ruby/models/payroll_uk/address.rb', line 114

def valid?
  return false if @address_line1.nil?
  return false if @city.nil?
  return false if @post_code.nil?
  true
end