Class: XeroRuby::PayrollUk::NICategory

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NICategory

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

Instance Attribute Details

#date_first_employed_as_civilian ⇒ Object

The date in which the employee was first employed as a civilian (YYYY-MM-DD)



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

def date_first_employed_as_civilian
  @date_first_employed_as_civilian
end

#ni_category ⇒ Object

Returns the value of attribute ni_category.



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

def ni_category
  @ni_category
end

#ni_category_id ⇒ Object

Xero unique identifier for the NI category



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

def ni_category_id
  @ni_category_id
end

#start_date ⇒ Object

The start date of the NI category (YYYY-MM-DD)



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

def start_date
  @start_date
end

#workplace_postcode ⇒ Object

The workplace postcode



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

def workplace_postcode
  @workplace_postcode
end

Class Method Details

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
 
# File 'lib/xero-ruby/models/payroll_uk/ni_category.rb', line 57

def self.attribute_map
  {
    :'start_date' => :'startDate',
    :'ni_category' => :'niCategory',
    :'ni_category_id' => :'niCategoryID',
    :'date_first_employed_as_civilian' => :'dateFirstEmployedAsCivilian',
    :'workplace_postcode' => :'workplacePostcode'
  }
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



188
189
190
 
# File 'lib/xero-ruby/models/payroll_uk/ni_category.rb', line 188

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

.openapi_one_of ⇒ Object

List of class defined in oneOf (OpenAPI v3)



79
80
81
82
83
84
 
# File 'lib/xero-ruby/models/payroll_uk/ni_category.rb', line 79

def self.openapi_one_of
  [
  :'NICategoryOneOf',
  :'NICategoryOneOf1'
  ]
end

.openapi_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
 
# File 'lib/xero-ruby/models/payroll_uk/ni_category.rb', line 68

def self.openapi_types
  {
    :'start_date' => :'Date',
    :'ni_category' => :'NICategoryLetter',
    :'ni_category_id' => :'Float',
    :'date_first_employed_as_civilian' => :'Date',
    :'workplace_postcode' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      start_date == o.start_date &&
      ni_category == o.ni_category &&
      ni_category_id == o.ni_category_id &&
      date_first_employed_as_civilian == o.date_first_employed_as_civilian &&
      workplace_postcode == o.workplace_postcode
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



216
217
218
219
220
221
222
223
224
225
226
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
 
# File 'lib/xero-ruby/models/payroll_uk/ni_category.rb', line 216

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, 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



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/xero-ruby/models/payroll_uk/ni_category.rb', line 289

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



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/xero-ruby/models/payroll_uk/ni_category.rb', line 195

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


175
176
177
 
# File 'lib/xero-ruby/models/payroll_uk/ni_category.rb', line 175

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



181
182
183
 
# File 'lib/xero-ruby/models/payroll_uk/ni_category.rb', line 181

def hash
  [start_date, ni_category, ni_category_id, date_first_employed_as_civilian, workplace_postcode].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



124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/xero-ruby/models/payroll_uk/ni_category.rb', line 124

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

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

  invalid_properties
end

#parse_date(datestring) ⇒ Object 



305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/xero-ruby/models/payroll_uk/ni_category.rb', line 305

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



281
282
283
 
# File 'lib/xero-ruby/models/payroll_uk/ni_category.rb', line 281

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



263
264
265
 
# File 'lib/xero-ruby/models/payroll_uk/ni_category.rb', line 263

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



269
270
271
272
273
274
275
276
277
278
 
# File 'lib/xero-ruby/models/payroll_uk/ni_category.rb', line 269

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



257
258
259
 
# File 'lib/xero-ruby/models/payroll_uk/ni_category.rb', line 257

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



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/xero-ruby/models/payroll_uk/ni_category.rb', line 139

def valid?
  return false if @ni_category.nil?
  return false if @workplace_postcode.nil?
  _one_of_found = false
  self.class.openapi_one_of.each do |_class|
    _one_of = XeroRuby::PayrollUk.const_get(_class).build_from_hash(self.to_hash)
    if _one_of.valid?
      if _one_of_found
        return false
      else
        _one_of_found = true
      end
    end
  end

  if !_one_of_found
    return false
  end

  true
end