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

Inherits:

BaseModel

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

Includes:

RequestParameters

Defined in:

lib/finch-api/models/hris/benefit_create_params.rb

Instance Attribute Summary

• #description ⇒ String^?

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

• #frequency ⇒ Symbol, ...
• #type ⇒ Symbol, ...

  Type of benefit.

Attributes included from RequestParameters

#request_options

Instance Method Summary

• #initialize(description: nil, frequency: nil, type: nil, request_options: {}) ⇒ BenefitCreateParams constructor

  A new instance of BenefitCreateParams.

Methods included from RequestParameters

included

Methods inherited from BaseModel

==, #==, #[], coerce, #deconstruct_keys, dump, fields, #inspect, known_fields, optional, required, #to_h

Methods included from Converter

#coerce, coerce, #dump, dump, type_info

Constructor Details

#initialize(description: nil, frequency: nil, type: nil, request_options: {}) ⇒ BenefitCreateParams

Returns a new instance of BenefitCreateParams.

Parameters:

• description (String) (defaults to: nil)
• frequency (Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil) (defaults to: nil)
• type (Symbol, FinchAPI::Models::HRIS::BenefitType, nil) (defaults to: nil)
• request_options (FinchAPI::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/finch-api/models/hris/benefit_create_params.rb', line 6

def initialize(description: nil, frequency: nil, type: nil, request_options: {}, **) = super

Instance Attribute Details

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

Returns:

• (String, nil)

# File 'lib/finch-api/models/hris/benefit_create_params.rb', line 17

optional :description, String

#frequency ⇒ Symbol, ...

Returns:

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

# File 'lib/finch-api/models/hris/benefit_create_params.rb', line 26

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

#type ⇒ Symbol, ...

Type of benefit.

Returns:

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

# File 'lib/finch-api/models/hris/benefit_create_params.rb', line 32

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