Class: XeroRuby::PayrollNz::Deduction
- Inherits:
-
Object
- Object
- XeroRuby::PayrollNz::Deduction
- Defined in:
- lib/xero-ruby/models/payroll_nz/deduction.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Constant Summary collapse
- PAYROLL_GIVING =
"PayrollGiving".freeze
- KIWI_SAVER_VOLUNTARY_CONTRIBUTIONS =
"KiwiSaverVoluntaryContributions".freeze
- SUPERANNUATION =
"Superannuation".freeze
- NZ_OTHER =
"NzOther".freeze
Instance Attribute Summary collapse
-
#current_record ⇒ Object
Identifier of a record is active or not.
-
#deduction_category ⇒ Object
Deduction Category type.
-
#deduction_id ⇒ Object
The Xero identifier for Deduction.
-
#deduction_name ⇒ Object
Name of the deduction.
-
#liability_account_id ⇒ Object
Xero identifier for Liability Account.
-
#standard_amount ⇒ Object
Standard amount of the deduction.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value, downcase: false) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Deduction
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
- #parse_date(datestring) ⇒ Object
-
#to_attributes ⇒ Object
Returns the object in the form of hash with snake_case.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash(downcase: false) ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ Deduction
Initializes the object
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 |
# File 'lib/xero-ruby/models/payroll_nz/deduction.rb', line 89 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::PayrollNz::Deduction` 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::Deduction`. 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?(:'deduction_id') self.deduction_id = attributes[:'deduction_id'] end if attributes.key?(:'deduction_name') self.deduction_name = attributes[:'deduction_name'] end if attributes.key?(:'deduction_category') self.deduction_category = attributes[:'deduction_category'] end if attributes.key?(:'liability_account_id') self.liability_account_id = attributes[:'liability_account_id'] end if attributes.key?(:'current_record') self.current_record = attributes[:'current_record'] end if attributes.key?(:'standard_amount') self.standard_amount = attributes[:'standard_amount'] end end |
Instance Attribute Details
#current_record ⇒ Object
Identifier of a record is active or not.
36 37 38 |
# File 'lib/xero-ruby/models/payroll_nz/deduction.rb', line 36 def current_record @current_record end |
#deduction_category ⇒ Object
Deduction Category type
26 27 28 |
# File 'lib/xero-ruby/models/payroll_nz/deduction.rb', line 26 def deduction_category @deduction_category end |
#deduction_id ⇒ Object
The Xero identifier for Deduction
20 21 22 |
# File 'lib/xero-ruby/models/payroll_nz/deduction.rb', line 20 def deduction_id @deduction_id end |
#deduction_name ⇒ Object
Name of the deduction
23 24 25 |
# File 'lib/xero-ruby/models/payroll_nz/deduction.rb', line 23 def deduction_name @deduction_name end |
#liability_account_id ⇒ Object
Xero identifier for Liability Account
33 34 35 |
# File 'lib/xero-ruby/models/payroll_nz/deduction.rb', line 33 def liability_account_id @liability_account_id end |
#standard_amount ⇒ Object
Standard amount of the deduction.
39 40 41 |
# File 'lib/xero-ruby/models/payroll_nz/deduction.rb', line 39 def standard_amount @standard_amount end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
64 65 66 67 68 69 70 71 72 73 |
# File 'lib/xero-ruby/models/payroll_nz/deduction.rb', line 64 def self.attribute_map { :'deduction_id' => :'deductionId', :'deduction_name' => :'deductionName', :'deduction_category' => :'deductionCategory', :'liability_account_id' => :'liabilityAccountId', :'current_record' => :'currentRecord', :'standard_amount' => :'standardAmount' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
195 196 197 |
# File 'lib/xero-ruby/models/payroll_nz/deduction.rb', line 195 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_types ⇒ Object
Attribute type mapping.
76 77 78 79 80 81 82 83 84 85 |
# File 'lib/xero-ruby/models/payroll_nz/deduction.rb', line 76 def self.openapi_types { :'deduction_id' => :'String', :'deduction_name' => :'String', :'deduction_category' => :'String', :'liability_account_id' => :'String', :'current_record' => :'Boolean', :'standard_amount' => :'BigDecimal' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
169 170 171 172 173 174 175 176 177 178 |
# File 'lib/xero-ruby/models/payroll_nz/deduction.rb', line 169 def ==(o) return true if self.equal?(o) self.class == o.class && deduction_id == o.deduction_id && deduction_name == o.deduction_name && deduction_category == o.deduction_category && liability_account_id == o.liability_account_id && current_record == o.current_record && standard_amount == o.standard_amount end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 254 255 256 257 258 259 260 |
# File 'lib/xero-ruby/models/payroll_nz/deduction.rb', line 223 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
296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 |
# File 'lib/xero-ruby/models/payroll_nz/deduction.rb', line 296 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
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
# File 'lib/xero-ruby/models/payroll_nz/deduction.rb', line 202 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
182 183 184 |
# File 'lib/xero-ruby/models/payroll_nz/deduction.rb', line 182 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
188 189 190 |
# File 'lib/xero-ruby/models/payroll_nz/deduction.rb', line 188 def hash [deduction_id, deduction_name, deduction_category, liability_account_id, current_record, standard_amount].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 |
# File 'lib/xero-ruby/models/payroll_nz/deduction.rb', line 129 def list_invalid_properties invalid_properties = Array.new if @deduction_name.nil? invalid_properties.push('invalid value for "deduction_name", deduction_name cannot be nil.') end if @deduction_category.nil? invalid_properties.push('invalid value for "deduction_category", deduction_category cannot be nil.') end if @liability_account_id.nil? invalid_properties.push('invalid value for "liability_account_id", liability_account_id cannot be nil.') end invalid_properties end |
#parse_date(datestring) ⇒ Object
312 313 314 315 316 317 318 319 320 321 |
# File 'lib/xero-ruby/models/payroll_nz/deduction.rb', line 312 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
288 289 290 |
# File 'lib/xero-ruby/models/payroll_nz/deduction.rb', line 288 def to_attributes to_hash(downcase: true) end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
270 271 272 |
# File 'lib/xero-ruby/models/payroll_nz/deduction.rb', line 270 def to_body to_hash end |
#to_hash(downcase: false) ⇒ Hash
Returns the object in the form of hash
276 277 278 279 280 281 282 283 284 285 |
# File 'lib/xero-ruby/models/payroll_nz/deduction.rb', line 276 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
264 265 266 |
# File 'lib/xero-ruby/models/payroll_nz/deduction.rb', line 264 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
148 149 150 151 152 153 154 155 |
# File 'lib/xero-ruby/models/payroll_nz/deduction.rb', line 148 def valid? return false if @deduction_name.nil? return false if @deduction_category.nil? deduction_category_validator = EnumAttributeValidator.new('String', ["PayrollGiving", "KiwiSaverVoluntaryContributions", "Superannuation", "NzOther"]) return false unless deduction_category_validator.valid?(@deduction_category) return false if @liability_account_id.nil? true end |