Class: Merge::Hris::EmployerBenefit

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

Overview

# The EmployerBenefit Object

### Description
The `Employer Benefit` object is used to represent a benefit plan offered by a
company.
### Usage Example
Fetch from the `LIST EmployerBenefits` endpoint and filter by `ID` to show all
EmployerBenefits.

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, benefit_plan_type: OMIT, name: OMIT, description: OMIT, deduction_code: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil) ⇒ Merge::Hris::EmployerBenefit

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.

  • benefit_plan_type (Merge::Hris::BenefitPlanTypeEnum) (defaults to: OMIT) —

    The type of benefit plan.

    • ‘MEDICAL` - MEDICAL

    • ‘HEALTH_SAVINGS` - HEALTH_SAVINGS

    • ‘INSURANCE` - INSURANCE

    • ‘RETIREMENT` - RETIREMENT

    • ‘OTHER` - OTHER

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

    The employer benefit’s name - typically the carrier or network name.

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

    The employer benefit’s description.

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

    The employer benefit’s deduction code.

  • 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



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

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, benefit_plan_type: OMIT,
               name: OMIT, description: OMIT, deduction_code: 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
  @benefit_plan_type = benefit_plan_type if benefit_plan_type != OMIT
  @name = name if name != OMIT
  @description = description if description != OMIT
  @deduction_code = deduction_code if deduction_code != 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,
    "benefit_plan_type": benefit_plan_type,
    "name": name,
    "description": description,
    "deduction_code": deduction_code,
    "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



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

def additional_properties
  @additional_properties
end

#benefit_plan_type ⇒ Merge::Hris::BenefitPlanTypeEnum (readonly)

Returns The type of benefit plan.

  • ‘MEDICAL` - MEDICAL

  • ‘HEALTH_SAVINGS` - HEALTH_SAVINGS

  • ‘INSURANCE` - INSURANCE

  • ‘RETIREMENT` - RETIREMENT

  • ‘OTHER` - OTHER.

Returns:

  • (Merge::Hris::BenefitPlanTypeEnum) —

    The type of benefit plan.

    • ‘MEDICAL` - MEDICAL

    • ‘HEALTH_SAVINGS` - HEALTH_SAVINGS

    • ‘INSURANCE` - INSURANCE

    • ‘RETIREMENT` - RETIREMENT

    • ‘OTHER` - OTHER



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

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



24
25
26
 
# File 'lib/merge_ruby_client/hris/types/employer_benefit.rb', line 24

def created_at
  @created_at
end

#deduction_code ⇒ String (readonly)

Returns The employer benefit’s deduction code.

Returns:

  • (String) —

    The employer benefit’s deduction code.



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

def deduction_code
  @deduction_code
end

#description ⇒ String (readonly)

Returns The employer benefit’s description.

Returns:

  • (String) —

    The employer benefit’s description.



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

def description
  @description
end

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

Returns:

  • (Hash{String => Object}) 


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

def field_mappings
  @field_mappings
end

#id ⇒ String (readonly)

Returns:

  • (String) 


20
21
22
 
# File 'lib/merge_ruby_client/hris/types/employer_benefit.rb', line 20

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.



26
27
28
 
# File 'lib/merge_ruby_client/hris/types/employer_benefit.rb', line 26

def modified_at
  @modified_at
end

#name ⇒ String (readonly)

Returns The employer benefit’s name - typically the carrier or network name.

Returns:

  • (String) —

    The employer benefit’s name - typically the carrier or network name.



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

def name
  @name
end

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

Returns:



48
49
50
 
# File 'lib/merge_ruby_client/hris/types/employer_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.



22
23
24
 
# File 'lib/merge_ruby_client/hris/types/employer_benefit.rb', line 22

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/).



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

def remote_was_deleted
  @remote_was_deleted
end

Class Method Details

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

Deserialize a JSON object to an instance of EmployerBenefit

Parameters:

  • json_object (String)

Returns:



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

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?)
  benefit_plan_type = parsed_json["benefit_plan_type"]
  name = parsed_json["name"]
  description = parsed_json["description"]
  deduction_code = parsed_json["deduction_code"]
  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,
    benefit_plan_type: benefit_plan_type,
    name: name,
    description: description,
    deduction_code: deduction_code,
    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) 


159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/merge_ruby_client/hris/types/employer_benefit.rb', line 159

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.benefit_plan_type&.is_a?(Merge::Hris::BenefitPlanTypeEnum) != false || raise("Passed value for field obj.benefit_plan_type is not the expected type, validation failed.")
  obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
  obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
  obj.deduction_code&.is_a?(String) != false || raise("Passed value for field obj.deduction_code 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 EmployerBenefit to a JSON object

Returns:

  • (String) 


149
150
151
 
# File 'lib/merge_ruby_client/hris/types/employer_benefit.rb', line 149

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