Class: MergeHRISClient::Earning
- Inherits:
-
Object
- Object
- MergeHRISClient::Earning
- Defined in:
- lib/merge_hris_client/models/earning.rb
Overview
# The Earning Object ### Description The ‘Earning` object is used to represent an array of different compensations that an employee receives within specific wage categories. ### Usage Example Fetch from the `LIST Earnings` endpoint and filter by `ID` to show all earnings.
Instance Attribute Summary collapse
-
#amount ⇒ Object
The amount earned.
-
#employee_payroll_run ⇒ Object
Returns the value of attribute employee_payroll_run.
-
#field_mappings ⇒ Object
Returns the value of attribute field_mappings.
-
#id ⇒ Object
Returns the value of attribute id.
-
#modified_at ⇒ Object
This is the datetime that this object was last updated by Merge.
-
#remote_data ⇒ Object
Returns the value of attribute remote_data.
-
#remote_id ⇒ Object
The third-party API ID of the matching object.
-
#remote_was_deleted ⇒ Object
Indicates whether or not this object has been deleted by third party webhooks.
-
#type ⇒ Object
The type of earning.
Class Method Summary collapse
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.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) ⇒ 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 = {}) ⇒ Earning
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ 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 = {}) ⇒ Earning
Initializes the object
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 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 |
# File 'lib/merge_hris_client/models/earning.rb', line 91 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `MergeHRISClient::Earning` 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 `MergeHRISClient::Earning`. 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?(:'id') self.id = attributes[:'id'] end if attributes.key?(:'remote_id') self.remote_id = attributes[:'remote_id'] end if attributes.key?(:'employee_payroll_run') self.employee_payroll_run = attributes[:'employee_payroll_run'] end if attributes.key?(:'amount') self.amount = attributes[:'amount'] end if attributes.key?(:'type') self.type = attributes[:'type'] end if attributes.key?(:'remote_was_deleted') self.remote_was_deleted = attributes[:'remote_was_deleted'] end if attributes.key?(:'modified_at') self.modified_at = attributes[:'modified_at'] end if attributes.key?(:'field_mappings') if (value = attributes[:'field_mappings']).is_a?(Hash) self.field_mappings = value end end if attributes.key?(:'remote_data') if (value = attributes[:'remote_data']).is_a?(Array) self.remote_data = value end end end |
Instance Attribute Details
#amount ⇒ Object
The amount earned.
27 28 29 |
# File 'lib/merge_hris_client/models/earning.rb', line 27 def amount @amount end |
#employee_payroll_run ⇒ Object
Returns the value of attribute employee_payroll_run.
24 25 26 |
# File 'lib/merge_hris_client/models/earning.rb', line 24 def employee_payroll_run @employee_payroll_run end |
#field_mappings ⇒ Object
Returns the value of attribute field_mappings.
38 39 40 |
# File 'lib/merge_hris_client/models/earning.rb', line 38 def field_mappings @field_mappings end |
#id ⇒ Object
Returns the value of attribute id.
19 20 21 |
# File 'lib/merge_hris_client/models/earning.rb', line 19 def id @id end |
#modified_at ⇒ Object
This is the datetime that this object was last updated by Merge
36 37 38 |
# File 'lib/merge_hris_client/models/earning.rb', line 36 def modified_at @modified_at end |
#remote_data ⇒ Object
Returns the value of attribute remote_data.
40 41 42 |
# File 'lib/merge_hris_client/models/earning.rb', line 40 def remote_data @remote_data end |
#remote_id ⇒ Object
The third-party API ID of the matching object.
22 23 24 |
# File 'lib/merge_hris_client/models/earning.rb', line 22 def remote_id @remote_id end |
#remote_was_deleted ⇒ Object
Indicates whether or not this object has been deleted by third party webhooks.
33 34 35 |
# File 'lib/merge_hris_client/models/earning.rb', line 33 def remote_was_deleted @remote_was_deleted end |
#type ⇒ Object
The type of earning. * ‘SALARY` - SALARY * `REIMBURSEMENT` - REIMBURSEMENT * `OVERTIME` - OVERTIME * `BONUS` - BONUS
30 31 32 |
# File 'lib/merge_hris_client/models/earning.rb', line 30 def type @type end |
Class Method Details
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
58 59 60 |
# File 'lib/merge_hris_client/models/earning.rb', line 58 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
43 44 45 46 47 48 49 50 51 52 53 54 55 |
# File 'lib/merge_hris_client/models/earning.rb', line 43 def self.attribute_map { :'id' => :'id', :'remote_id' => :'remote_id', :'employee_payroll_run' => :'employee_payroll_run', :'amount' => :'amount', :'type' => :'type', :'remote_was_deleted' => :'remote_was_deleted', :'modified_at' => :'modified_at', :'field_mappings' => :'field_mappings', :'remote_data' => :'remote_data' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
189 190 191 |
# File 'lib/merge_hris_client/models/earning.rb', line 189 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
78 79 80 81 82 83 84 85 86 87 |
# File 'lib/merge_hris_client/models/earning.rb', line 78 def self.openapi_nullable Set.new([ :'remote_id', :'employee_payroll_run', :'amount', :'type', :'field_mappings', :'remote_data' ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
63 64 65 66 67 68 69 70 71 72 73 74 75 |
# File 'lib/merge_hris_client/models/earning.rb', line 63 def self.openapi_types { :'id' => :'String', :'remote_id' => :'String', :'employee_payroll_run' => :'String', :'amount' => :'Float', :'type' => :'EarningTypeEnum', :'remote_was_deleted' => :'Boolean', :'modified_at' => :'Time', :'field_mappings' => :'Hash<String, Object>', :'remote_data' => :'Array<RemoteData>' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
160 161 162 163 164 165 166 167 168 169 170 171 172 |
# File 'lib/merge_hris_client/models/earning.rb', line 160 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && remote_id == o.remote_id && employee_payroll_run == o.employee_payroll_run && amount == o.amount && type == o.type && remote_was_deleted == o.remote_was_deleted && modified_at == o.modified_at && field_mappings == o.field_mappings && remote_data == o.remote_data end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 254 255 256 |
# File 'lib/merge_hris_client/models/earning.rb', line 219 def _deserialize(type, value) case type.to_sym when :Time Time.parse(value) when :Date Date.parse(value) when :String value when :Integer value.to_i when :Float value.to_f 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 # models (e.g. Pet) or oneOf klass = MergeHRISClient.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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
290 291 292 293 294 295 296 297 298 299 300 301 302 |
# File 'lib/merge_hris_client/models/earning.rb', line 290 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
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 |
# File 'lib/merge_hris_client/models/earning.rb', line 196 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_types.each_pair do |key, type| if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) self.send("#{key}=", nil) elsif 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 end self end |
#eql?(o) ⇒ Boolean
176 177 178 |
# File 'lib/merge_hris_client/models/earning.rb', line 176 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
182 183 184 |
# File 'lib/merge_hris_client/models/earning.rb', line 182 def hash [id, remote_id, employee_payroll_run, amount, type, remote_was_deleted, modified_at, field_mappings, remote_data].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
147 148 149 150 |
# File 'lib/merge_hris_client/models/earning.rb', line 147 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
266 267 268 |
# File 'lib/merge_hris_client/models/earning.rb', line 266 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
272 273 274 275 276 277 278 279 280 281 282 283 284 |
# File 'lib/merge_hris_client/models/earning.rb', line 272 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
260 261 262 |
# File 'lib/merge_hris_client/models/earning.rb', line 260 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
154 155 156 |
# File 'lib/merge_hris_client/models/earning.rb', line 154 def valid? true end |