Class: Merge::Hris::Benefit

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

Overview

# The Benefit Object

### Description
The `Benefit` object is used to represent a benefit that an employee has
enrolled in.
### Usage Example
Fetch from the `LIST Benefits` endpoint and filter by `ID` to show all benefits.

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, provider_name: OMIT, benefit_plan_type: OMIT, employee_contribution: OMIT, company_contribution: OMIT, start_date: OMIT, end_date: OMIT, remote_was_deleted: OMIT, employer_benefit: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil) ⇒ Merge::Hris::Benefit

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::BenefitEmployee) (defaults to: OMIT) —

    The employee on the plan.

  • provider_name (String) (defaults to: OMIT) —

    The name of the benefit provider.

  • benefit_plan_type (String) (defaults to: OMIT) —

    The type of benefit plan

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

    The employee’s contribution.

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

    The company’s contribution.

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

    The day and time the benefit started.

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

    The day and time the benefit ended.

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

    Indicates whether or not this object has been deleted in the third party platform.

  • employer_benefit (String) (defaults to: OMIT) —

    The employer benefit plan the employee is enrolled in.

  • 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



75
76
77
78
79
80
81
82
83
84
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
 
# File 'lib/merge_ruby_client/hris/types/benefit.rb', line 75

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, employee: OMIT,
               provider_name: OMIT, benefit_plan_type: OMIT, employee_contribution: OMIT, company_contribution: OMIT, start_date: OMIT, end_date: OMIT, remote_was_deleted: OMIT, employer_benefit: 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
  @provider_name = provider_name if provider_name != OMIT
  @benefit_plan_type = benefit_plan_type if benefit_plan_type != OMIT
  @employee_contribution = employee_contribution if employee_contribution != OMIT
  @company_contribution = company_contribution if company_contribution != OMIT
  @start_date = start_date if start_date != OMIT
  @end_date = end_date if end_date != OMIT
  @remote_was_deleted = remote_was_deleted if remote_was_deleted != OMIT
  @employer_benefit = employer_benefit if employer_benefit != 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,
    "provider_name": provider_name,
    "benefit_plan_type": benefit_plan_type,
    "employee_contribution": employee_contribution,
    "company_contribution": company_contribution,
    "start_date": start_date,
    "end_date": end_date,
    "remote_was_deleted": remote_was_deleted,
    "employer_benefit": employer_benefit,
    "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



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

def additional_properties
  @additional_properties
end

#benefit_plan_type ⇒ String (readonly)

Returns The type of benefit plan.

Returns:

  • (String) —

    The type of benefit plan



31
32
33
 
# File 'lib/merge_ruby_client/hris/types/benefit.rb', line 31

def benefit_plan_type
  @benefit_plan_type
end

#company_contribution ⇒ Float (readonly)

Returns The company’s contribution.

Returns:

  • (Float) —

    The company’s contribution.



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

def company_contribution
  @company_contribution
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.



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

def created_at
  @created_at
end

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

Returns The employee on the plan.

Returns:



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

def employee
  @employee
end

#employee_contribution ⇒ Float (readonly)

Returns The employee’s contribution.

Returns:

  • (Float) —

    The employee’s contribution.



33
34
35
 
# File 'lib/merge_ruby_client/hris/types/benefit.rb', line 33

def employee_contribution
  @employee_contribution
end

#employer_benefit ⇒ String (readonly)

Returns The employer benefit plan the employee is enrolled in.

Returns:

  • (String) —

    The employer benefit plan the employee is enrolled in.



44
45
46
 
# File 'lib/merge_ruby_client/hris/types/benefit.rb', line 44

def employer_benefit
  @employer_benefit
end

#end_date ⇒ DateTime (readonly)

Returns The day and time the benefit ended.

Returns:

  • (DateTime) —

    The day and time the benefit ended.



39
40
41
 
# File 'lib/merge_ruby_client/hris/types/benefit.rb', line 39

def end_date
  @end_date
end

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

Returns:

  • (Hash{String => Object}) 


46
47
48
 
# File 'lib/merge_ruby_client/hris/types/benefit.rb', line 46

def field_mappings
  @field_mappings
end

#id ⇒ String (readonly)

Returns:

  • (String) 


19
20
21
 
# File 'lib/merge_ruby_client/hris/types/benefit.rb', line 19

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.



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

def modified_at
  @modified_at
end

#provider_name ⇒ String (readonly)

Returns The name of the benefit provider.

Returns:

  • (String) —

    The name of the benefit provider.



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

def provider_name
  @provider_name
end

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

Returns:



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

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.



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

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.

Returns:

  • (Boolean) —

    Indicates whether or not this object has been deleted in the third party platform.



42
43
44
 
# File 'lib/merge_ruby_client/hris/types/benefit.rb', line 42

def remote_was_deleted
  @remote_was_deleted
end

#start_date ⇒ DateTime (readonly)

Returns The day and time the benefit started.

Returns:

  • (DateTime) —

    The day and time the benefit started.



37
38
39
 
# File 'lib/merge_ruby_client/hris/types/benefit.rb', line 37

def start_date
  @start_date
end

Class Method Details

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

Deserialize a JSON object to an instance of Benefit

Parameters:

  • json_object (String)

Returns:



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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/merge_ruby_client/hris/types/benefit.rb', line 118

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::BenefitEmployee.from_json(json_object: employee)
  end
  provider_name = parsed_json["provider_name"]
  benefit_plan_type = parsed_json["benefit_plan_type"]
  employee_contribution = parsed_json["employee_contribution"]
  company_contribution = parsed_json["company_contribution"]
  start_date = (DateTime.parse(parsed_json["start_date"]) unless parsed_json["start_date"].nil?)
  end_date = (DateTime.parse(parsed_json["end_date"]) unless parsed_json["end_date"].nil?)
  remote_was_deleted = parsed_json["remote_was_deleted"]
  employer_benefit = parsed_json["employer_benefit"]
  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,
    provider_name: provider_name,
    benefit_plan_type: benefit_plan_type,
    employee_contribution: employee_contribution,
    company_contribution: company_contribution,
    start_date: start_date,
    end_date: end_date,
    remote_was_deleted: remote_was_deleted,
    employer_benefit: employer_benefit,
    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) 


177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/merge_ruby_client/hris/types/benefit.rb', line 177

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::BenefitEmployee.validate_raw(obj: obj.employee)
  obj.provider_name&.is_a?(String) != false || raise("Passed value for field obj.provider_name is not the expected type, validation failed.")
  obj.benefit_plan_type&.is_a?(String) != false || raise("Passed value for field obj.benefit_plan_type is not the expected type, validation failed.")
  obj.employee_contribution&.is_a?(Float) != false || raise("Passed value for field obj.employee_contribution is not the expected type, validation failed.")
  obj.company_contribution&.is_a?(Float) != false || raise("Passed value for field obj.company_contribution is not the expected type, validation failed.")
  obj.start_date&.is_a?(DateTime) != false || raise("Passed value for field obj.start_date is not the expected type, validation failed.")
  obj.end_date&.is_a?(DateTime) != false || raise("Passed value for field obj.end_date 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.employer_benefit&.is_a?(String) != false || raise("Passed value for field obj.employer_benefit 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 Benefit to a JSON object

Returns:

  • (String) 


167
168
169
 
# File 'lib/merge_ruby_client/hris/types/benefit.rb', line 167

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