Class: FinchAPI::Models::HRIS::BenefitCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• FinchAPI::Models::HRIS::BenefitCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/finch_api/models/hris/benefit_create_params.rb,
sig/finch_api/models/hris/benefit_create_params.rbs

Overview

See Also:

• FinchAPI::Resources::HRIS::Benefits#create

Defined Under Namespace

Classes: CompanyContribution

Instance Attribute Summary

• #company_contribution ⇒ FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution^?

  The company match for this benefit.

• #description ⇒ String^?

  Name of the benefit as it appears in the provider and pay statements.

• #entity_ids ⇒ Array<String>^?

  The entity IDs to specify which entities' data to access.

• #frequency ⇒ Symbol, ...

  The frequency of the benefit deduction/contribution.

• #type ⇒ Symbol, ...

  Type of benefit.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize ⇒ Object constructor
• #to_hash ⇒ {

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize ⇒ Object

# File 'sig/finch_api/models/hris/benefit_create_params.rbs', line 32

def initialize: (

Instance Attribute Details

#company_contribution ⇒ FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution^?

The company match for this benefit.

Parameters:

• value (FinchAPI::HRIS::BenefitCreateParams::CompanyContribution, nil)

Returns:

• (FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution, nil)

# File 'lib/finch_api/models/hris/benefit_create_params.rb', line 21

optional :company_contribution,
-> { FinchAPI::HRIS::BenefitCreateParams::CompanyContribution },
nil?: true

#description ⇒ String^?

Name of the benefit as it appears in the provider and pay statements. Recommend limiting this to <30 characters due to limitations in specific providers (e.g. Justworks).

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/finch_api/models/hris/benefit_create_params.rb', line 31

optional :description, String

#entity_ids ⇒ Array<String>^?

The entity IDs to specify which entities' data to access.

Parameters:

• (::Array[String])

Returns:

• (Array<String>, nil)

# File 'lib/finch_api/models/hris/benefit_create_params.rb', line 15

optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

#frequency ⇒ Symbol, ...

The frequency of the benefit deduction/contribution.

Parameters:

• value (FinchAPI::Models::HRIS::benefit_frequency, nil)

Returns:

• (Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil)

# File 'lib/finch_api/models/hris/benefit_create_params.rb', line 37

optional :frequency, enum: -> { FinchAPI::HRIS::BenefitFrequency }, nil?: true

#type ⇒ Symbol, ...

Type of benefit.

Parameters:

• value (FinchAPI::Models::HRIS::benefit_type, nil)

Returns:

• (Symbol, FinchAPI::Models::HRIS::BenefitType, nil)

# File 'lib/finch_api/models/hris/benefit_create_params.rb', line 43

optional :type, enum: -> { FinchAPI::HRIS::BenefitType }, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/finch_api/models/hris/benefit_create_params.rbs', line 41

def to_hash: -> {