Class: FinchAPI::Models::HRIS::DocumentResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/finch_api/models/hris/document_response.rb,
sig/finch_api/models/hris/document_response.rbs

Defined Under Namespace

Modules: Type

Instance Attribute Summary collapse

Instance Method Summary collapse

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(id:, individual_id:, type:, url:, year:) ⇒ Object

Some parameter documentations has been truncated, see FinchAPI::Models::HRIS::DocumentResponse for more details.

Parameters:




# File 'lib/finch_api/models/hris/document_response.rb', line 39

Instance Attribute Details

#id ⇒ String

A stable Finch id for the document.

Parameters:

  • value (String)

Returns:

  • (String) 


11
 
# File 'lib/finch_api/models/hris/document_response.rb', line 11

required :id, String

#individual_id ⇒ String?

The ID of the individual associated with the document. This will be null for employer-level documents.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


18
 
# File 'lib/finch_api/models/hris/document_response.rb', line 18

required :individual_id, String, nil?: true

#type ⇒ Symbol, FinchAPI::Models::HRIS::DocumentResponse::Type

The type of document.

Parameters:

  • value (FinchAPI::Models::HRIS::DocumentResponse::type_)

Returns:



24
 
# File 'lib/finch_api/models/hris/document_response.rb', line 24

required :type, enum: -> { FinchAPI::HRIS::DocumentResponse::Type }

#url ⇒ String

A URL to access the document. Format: https://api.tryfinch.com/employer/documents/:document_id.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :url, String

#year ⇒ Float

The year the document applies to, if available.

Parameters:

  • value (Float)

Returns:

  • (Float) 


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

required :year, Float

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


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

def to_hash: -> {