Class: FinchAPI::Models::Provider::AuthenticationMethod

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/finch-api/models/provider.rb

Overview

def initialize: (Hash | FinchAPI::BaseModel) -> void

Defined Under Namespace

Modules: Type Classes: SupportedFields

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(end_date: nil, start_date: nil) ⇒ AuthenticationMethod

Returns a new instance of AuthenticationMethod.

Parameters:

  • end_date (Boolean) (defaults to: nil)
  • start_date (Boolean) (defaults to: nil) 


5
 
# File 'lib/finch-api/models/provider.rb', line 5

def initialize(benefits_support: nil, supported_fields: nil, type: nil, **) = super

Instance Attribute Details

#benefits_support ⇒ FinchAPI::Models::HRIS::BenefitsSupport?

Each benefit type and their supported features. If the benefit type is not

supported, the property will be null

Returns:



145
 
# File 'lib/finch-api/models/provider.rb', line 145

optional :benefits_support, -> { FinchAPI::Models::HRIS::BenefitsSupport }, nil?: true

#start_date=(value) ⇒ Boolean (writeonly)

Returns:

  • (Boolean) 


2
3
4
 
# File 'lib/finch-api/models/provider.rb', line 2

def start_date=(value)
  @start_date = value
end

#supported_fields ⇒ FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields?

The supported data fields returned by our HR and payroll endpoints

Returns:



151
152
153
 
# File 'lib/finch-api/models/provider.rb', line 151

optional :supported_fields,
-> { FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields },
nil?: true

#type ⇒ Symbol, ...

The type of authentication method.

Returns:



159
 
# File 'lib/finch-api/models/provider.rb', line 159

optional :type, enum: -> { FinchAPI::Models::Provider::AuthenticationMethod::Type }