Class: VitableConnect::Resources::BenefitEligibilityPolicies

Inherits:
Object
  • Object
show all
Defined in:
lib/vitable_connect/resources/benefit_eligibility_policies.rb

Overview

Define rules that determine which employees qualify for benefits

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ BenefitEligibilityPolicies

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of BenefitEligibilityPolicies.

Parameters:



30
31
32
 
# File 'lib/vitable_connect/resources/benefit_eligibility_policies.rb', line 30

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve(policy_id, request_options: {}) ⇒ VitableConnect::Models::BenefitEligibilityPolicyResponse

Retrieves a benefit eligibility policy by ID.

Parameters:

  • policy_id (String) —

    Unique benefit eligibility policy identifier (epol_*)

  • request_options (VitableConnect::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



18
19
20
21
22
23
24
25
 
# File 'lib/vitable_connect/resources/benefit_eligibility_policies.rb', line 18

def retrieve(policy_id, params = {})
  @client.request(
    method: :get,
    path: ["v1/benefit-eligibility-policies/%1$s", policy_id],
    model: VitableConnect::BenefitEligibilityPolicyResponse,
    options: params[:request_options]
  )
end