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

Inherits:

BaseModel

• Object
• FinchAPI::Models::HRIS::DocumentResponse

Defined in:

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

Defined Under Namespace

Modules: Type

Instance Attribute Summary

• #id ⇒ String^?

  A stable Finch id for the document.

• #individual_id ⇒ String^?

  The ID of the individual associated with the document.

• #type ⇒ Symbol, ...

  The type of document.

• #url ⇒ String^?

  A URL to access the document.

• #year ⇒ Float^?

  The year the document applies to, if available.

Instance Method Summary

• #initialize(id: nil, individual_id: nil, type: nil, url: nil, year: nil) ⇒ DocumentResponse constructor

  A new instance of DocumentResponse.

Constructor Details

#initialize(id: nil, individual_id: nil, type: nil, url: nil, year: nil) ⇒ DocumentResponse

Returns a new instance of DocumentResponse.

Parameters:

• id (String) (defaults to: nil)
• individual_id (String, nil) (defaults to: nil)
• type (Symbol, FinchAPI::Models::HRIS::DocumentResponse::Type) (defaults to: nil)
• url (String) (defaults to: nil)
• year (Float, nil) (defaults to: nil)

# File 'lib/finch-api/models/hris/document_response.rb', line 7

def initialize(id: nil, individual_id: nil, type: nil, url: nil, year: nil, **) = super

Instance Attribute Details

#id ⇒ String^?

A stable Finch id for the document.

Returns:

• (String, nil)

# File 'lib/finch-api/models/hris/document_response.rb', line 11

optional :id, String

#individual_id ⇒ String^?

The ID of the individual associated with the document. This will be null for

employer-level documents.

Returns:

• (String, nil)

# File 'lib/finch-api/models/hris/document_response.rb', line 22

optional :individual_id, String, nil?: true

#type ⇒ Symbol, ...

The type of document.

Returns:

• (Symbol, FinchAPI::Models::HRIS::DocumentResponse::Type, nil)

# File 'lib/finch-api/models/hris/document_response.rb', line 28

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

#url ⇒ String^?

A URL to access the document. Format:

`https://api.tryfinch.com/employer/documents/:document_id`.

Returns:

• (String, nil)

# File 'lib/finch-api/models/hris/document_response.rb', line 39

optional :url, String

#year ⇒ Float^?

The year the document applies to, if available.

Returns:

• (Float, nil)

# File 'lib/finch-api/models/hris/document_response.rb', line 49

optional :year, Float, nil?: true