Class: Merge::Hris::TimeOffBalance

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ruby_client/hris/types/time_off_balance.rb

Overview

# The TimeOffBalance Object

### Description
The `TimeOffBalance` object is used to represent current balances for an
employee's Time Off plan.
### Usage Example
Fetch from the `LIST TimeOffBalances` endpoint and filter by `ID` to show all
time off balances.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, employee: OMIT, balance: OMIT, used: OMIT, policy_type: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil) ⇒ Merge::Hris::TimeOffBalance

Parameters:

  • id (String) (defaults to: OMIT)
  • remote_id (String) (defaults to: OMIT) —

    The third-party API ID of the matching object.

  • created_at (DateTime) (defaults to: OMIT) —

    The datetime that this object was created by Merge.

  • modified_at (DateTime) (defaults to: OMIT) —

    The datetime that this object was modified by Merge.

  • employee (Merge::Hris::TimeOffBalanceEmployee) (defaults to: OMIT) —

    The employee the balance belongs to.

  • balance (Float) (defaults to: OMIT) —

    The current remaining PTO balance, measured in hours. For integrations that return this value in days, Merge multiplies by 8 to calculate hours.

  • used (Float) (defaults to: OMIT) —

    The amount of PTO used in terms of hours. For integrations that return this value in days, Merge multiplies by 8 to calculate hours.

  • policy_type (Merge::Hris::PolicyTypeEnum) (defaults to: OMIT) —

    The policy type of this time off balance.

    • ‘VACATION` - VACATION

    • ‘SICK` - SICK

    • ‘PERSONAL` - PERSONAL

    • ‘JURY_DUTY` - JURY_DUTY

    • ‘VOLUNTEER` - VOLUNTEER

    • ‘BEREAVEMENT` - BEREAVEMENT

  • remote_was_deleted (Boolean) (defaults to: OMIT) —

    Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](docs.merge.dev/integrations/hris/supported-features/).

  • field_mappings (Hash{String => Object}) (defaults to: OMIT)
  • remote_data (Array<Merge::Hris::RemoteData>) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



85
86
87
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
 
# File 'lib/merge_ruby_client/hris/types/time_off_balance.rb', line 85

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, employee: OMIT, balance: OMIT,
               used: OMIT, policy_type: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil)
  @id = id if id != OMIT
  @remote_id = remote_id if remote_id != OMIT
  @created_at = created_at if created_at != OMIT
  @modified_at = modified_at if modified_at != OMIT
  @employee = employee if employee != OMIT
  @balance = balance if balance != OMIT
  @used = used if used != OMIT
  @policy_type = policy_type if policy_type != OMIT
  @remote_was_deleted = remote_was_deleted if remote_was_deleted != OMIT
  @field_mappings = field_mappings if field_mappings != OMIT
  @remote_data = remote_data if remote_data != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "id": id,
    "remote_id": remote_id,
    "created_at": created_at,
    "modified_at": modified_at,
    "employee": employee,
    "balance": balance,
    "used": used,
    "policy_type": policy_type,
    "remote_was_deleted": remote_was_deleted,
    "field_mappings": field_mappings,
    "remote_data": remote_data
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



54
55
56
 
# File 'lib/merge_ruby_client/hris/types/time_off_balance.rb', line 54

def additional_properties
  @additional_properties
end

#balance ⇒ Float (readonly)

The current remaining PTO balance, measured in hours. For integrations that return this value in days, Merge multiplies by 8 to calculate hours.

Returns:

  • (Float) —

    The current remaining PTO balance, measured in hours. For integrations that return this value in days, Merge multiplies by 8 to calculate hours.



32
33
34
 
# File 'lib/merge_ruby_client/hris/types/time_off_balance.rb', line 32

def balance
  @balance
end

#created_at ⇒ DateTime (readonly)

Returns The datetime that this object was created by Merge.

Returns:

  • (DateTime) —

    The datetime that this object was created by Merge.



25
26
27
 
# File 'lib/merge_ruby_client/hris/types/time_off_balance.rb', line 25

def created_at
  @created_at
end

#employee ⇒ Merge::Hris::TimeOffBalanceEmployee (readonly)

Returns The employee the balance belongs to.

Returns:



29
30
31
 
# File 'lib/merge_ruby_client/hris/types/time_off_balance.rb', line 29

def employee
  @employee
end

#field_mappings ⇒ Hash{String => Object} (readonly)

Returns:

  • (Hash{String => Object}) 


50
51
52
 
# File 'lib/merge_ruby_client/hris/types/time_off_balance.rb', line 50

def field_mappings
  @field_mappings
end

#id ⇒ String (readonly)

Returns:

  • (String) 


21
22
23
 
# File 'lib/merge_ruby_client/hris/types/time_off_balance.rb', line 21

def id
  @id
end

#modified_at ⇒ DateTime (readonly)

Returns The datetime that this object was modified by Merge.

Returns:

  • (DateTime) —

    The datetime that this object was modified by Merge.



27
28
29
 
# File 'lib/merge_ruby_client/hris/types/time_off_balance.rb', line 27

def modified_at
  @modified_at
end

#policy_type ⇒ Merge::Hris::PolicyTypeEnum (readonly)

Returns The policy type of this time off balance.

  • ‘VACATION` - VACATION

  • ‘SICK` - SICK

  • ‘PERSONAL` - PERSONAL

  • ‘JURY_DUTY` - JURY_DUTY

  • ‘VOLUNTEER` - VOLUNTEER

  • ‘BEREAVEMENT` - BEREAVEMENT.

Returns:

  • (Merge::Hris::PolicyTypeEnum) —

    The policy type of this time off balance.

    • ‘VACATION` - VACATION

    • ‘SICK` - SICK

    • ‘PERSONAL` - PERSONAL

    • ‘JURY_DUTY` - JURY_DUTY

    • ‘VOLUNTEER` - VOLUNTEER

    • ‘BEREAVEMENT` - BEREAVEMENT



43
44
45
 
# File 'lib/merge_ruby_client/hris/types/time_off_balance.rb', line 43

def policy_type
  @policy_type
end

#remote_data ⇒ Array<Merge::Hris::RemoteData> (readonly)

Returns:



52
53
54
 
# File 'lib/merge_ruby_client/hris/types/time_off_balance.rb', line 52

def remote_data
  @remote_data
end

#remote_id ⇒ String (readonly)

Returns The third-party API ID of the matching object.

Returns:

  • (String) —

    The third-party API ID of the matching object.



23
24
25
 
# File 'lib/merge_ruby_client/hris/types/time_off_balance.rb', line 23

def remote_id
  @remote_id
end

#remote_was_deleted ⇒ Boolean (readonly)

Returns Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](docs.merge.dev/integrations/hris/supported-features/).

Returns:

  • (Boolean) —

    Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](docs.merge.dev/integrations/hris/supported-features/).



48
49
50
 
# File 'lib/merge_ruby_client/hris/types/time_off_balance.rb', line 48

def remote_was_deleted
  @remote_was_deleted
end

#used ⇒ Float (readonly)

Returns The amount of PTO used in terms of hours. For integrations that return this value in days, Merge multiplies by 8 to calculate hours.

Returns:

  • (Float) —

    The amount of PTO used in terms of hours. For integrations that return this value in days, Merge multiplies by 8 to calculate hours.



35
36
37
 
# File 'lib/merge_ruby_client/hris/types/time_off_balance.rb', line 35

def used
  @used
end

Class Method Details

.from_json(json_object:) ⇒ Merge::Hris::TimeOffBalance

Deserialize a JSON object to an instance of TimeOffBalance

Parameters:

  • json_object (String)

Returns:



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
 
# File 'lib/merge_ruby_client/hris/types/time_off_balance.rb', line 120

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  id = parsed_json["id"]
  remote_id = parsed_json["remote_id"]
  created_at = (DateTime.parse(parsed_json["created_at"]) unless parsed_json["created_at"].nil?)
  modified_at = (DateTime.parse(parsed_json["modified_at"]) unless parsed_json["modified_at"].nil?)
  if parsed_json["employee"].nil?
    employee = nil
  else
    employee = parsed_json["employee"].to_json
    employee = Merge::Hris::TimeOffBalanceEmployee.from_json(json_object: employee)
  end
  balance = parsed_json["balance"]
  used = parsed_json["used"]
  policy_type = parsed_json["policy_type"]
  remote_was_deleted = parsed_json["remote_was_deleted"]
  field_mappings = parsed_json["field_mappings"]
  remote_data = parsed_json["remote_data"]&.map do |item|
    item = item.to_json
    Merge::Hris::RemoteData.from_json(json_object: item)
  end
  new(
    id: id,
    remote_id: remote_id,
    created_at: created_at,
    modified_at: modified_at,
    employee: employee,
    balance: balance,
    used: used,
    policy_type: policy_type,
    remote_was_deleted: remote_was_deleted,
    field_mappings: field_mappings,
    remote_data: remote_data,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given

hash and check each fields type against the current object's property
definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/merge_ruby_client/hris/types/time_off_balance.rb', line 171

def self.validate_raw(obj:)
  obj.id&.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
  obj.remote_id&.is_a?(String) != false || raise("Passed value for field obj.remote_id is not the expected type, validation failed.")
  obj.created_at&.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
  obj.modified_at&.is_a?(DateTime) != false || raise("Passed value for field obj.modified_at is not the expected type, validation failed.")
  obj.employee.nil? || Merge::Hris::TimeOffBalanceEmployee.validate_raw(obj: obj.employee)
  obj.balance&.is_a?(Float) != false || raise("Passed value for field obj.balance is not the expected type, validation failed.")
  obj.used&.is_a?(Float) != false || raise("Passed value for field obj.used is not the expected type, validation failed.")
  obj.policy_type&.is_a?(Merge::Hris::PolicyTypeEnum) != false || raise("Passed value for field obj.policy_type is not the expected type, validation failed.")
  obj.remote_was_deleted&.is_a?(Boolean) != false || raise("Passed value for field obj.remote_was_deleted is not the expected type, validation failed.")
  obj.field_mappings&.is_a?(Hash) != false || raise("Passed value for field obj.field_mappings is not the expected type, validation failed.")
  obj.remote_data&.is_a?(Array) != false || raise("Passed value for field obj.remote_data is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of TimeOffBalance to a JSON object

Returns:

  • (String) 


161
162
163
 
# File 'lib/merge_ruby_client/hris/types/time_off_balance.rb', line 161

def to_json(*_args)
  @_field_set&.to_json
end