Module: FinchAPI

Defined in:

lib/finch-api/page.rb,
lib/finch-api/type.rb,
lib/finch-api/util.rb,
lib/finch-api/client.rb,
lib/finch-api/errors.rb,
lib/finch-api/version.rb,
lib/finch-api/type/enum.rb,
lib/finch-api/type/union.rb,
lib/finch-api/single_page.rb,
lib/finch-api/models/money.rb,
lib/finch-api/type/hash_of.rb,
lib/finch-api/type/unknown.rb,
lib/finch-api/models/income.rb,
lib/finch-api/models/paging.rb,
lib/finch-api/type/array_of.rb,
lib/finch-api/resources/hris.rb,
lib/finch-api/resources/jobs.rb,
lib/finch-api/responses_page.rb,
lib/finch-api/type/base_page.rb,
lib/finch-api/type/converter.rb,
lib/finch-api/models/location.rb,
lib/finch-api/models/provider.rb,
lib/finch-api/request_options.rb,
lib/finch-api/type/base_model.rb,
lib/finch-api/individuals_page.rb,
lib/finch-api/resources/account.rb,
lib/finch-api/resources/connect.rb,
lib/finch-api/resources/payroll.rb,
lib/finch-api/resources/sandbox.rb,
lib/finch-api/models/hris/w42005.rb,
lib/finch-api/models/hris/w42020.rb,
lib/finch-api/resources/webhooks.rb,
lib/finch-api/type/boolean_model.rb,
lib/finch-api/models/hris/company.rb,
lib/finch-api/models/hris/payment.rb,
lib/finch-api/resources/providers.rb,
lib/finch-api/models/company_event.rb,
lib/finch-api/models/introspection.rb,
lib/finch-api/models/payment_event.rb,
lib/finch-api/models/webhook_event.rb,
lib/finch-api/resources/jobs/manual.rb,
lib/finch-api/transport/base_client.rb,
lib/finch-api/models/directory_event.rb,
lib/finch-api/models/hris/individual.rb,
lib/finch-api/resources/hris/company.rb,
lib/finch-api/resources/sandbox/jobs.rb,
lib/finch-api/models/employment_event.rb,
lib/finch-api/models/individual_event.rb,
lib/finch-api/resources/access_tokens.rb,
lib/finch-api/resources/hris/benefits.rb,
lib/finch-api/resources/hris/payments.rb,
lib/finch-api/type/request_parameters.rb,
lib/finch-api/models/hris/benefit_type.rb,
lib/finch-api/models/operation_support.rb,
lib/finch-api/resources/hris/directory.rb,
lib/finch-api/resources/hris/documents.rb,
lib/finch-api/resources/jobs/automated.rb,
lib/finch-api/models/base_webhook_event.rb,
lib/finch-api/models/hris/pay_statement.rb,
lib/finch-api/resources/sandbox/company.rb,
lib/finch-api/resources/sandbox/payment.rb,
lib/finch-api/models/disconnect_response.rb,
lib/finch-api/models/pay_statement_event.rb,
lib/finch-api/resources/connect/sessions.rb,
lib/finch-api/resources/hris/employments.rb,
lib/finch-api/resources/hris/individuals.rb,
lib/finch-api/models/account_update_event.rb,
lib/finch-api/models/hris/company_benefit.rb,
lib/finch-api/models/hris/employment_data.rb,
lib/finch-api/models/job_completion_event.rb,
lib/finch-api/models/provider_list_params.rb,
lib/finch-api/resources/sandbox/directory.rb,
lib/finch-api/models/hris/benefits_support.rb,
lib/finch-api/models/jobs/manual_async_job.rb,
lib/finch-api/resources/payroll/pay_groups.rb,
lib/finch-api/resources/request_forwarding.rb,
lib/finch-api/resources/sandbox/employment.rb,
lib/finch-api/resources/sandbox/individual.rb,
lib/finch-api/models/connection_status_type.rb,
lib/finch-api/models/hris/benefit_frequency.rb,
lib/finch-api/models/hris/document_response.rb,
lib/finch-api/models/hris/supported_benefit.rb,
lib/finch-api/resources/hris/pay_statements.rb,
lib/finch-api/resources/sandbox/connections.rb,
lib/finch-api/transport/pooled_net_requester.rb,
lib/finch-api/models/hris/benefit_list_params.rb,
lib/finch-api/models/hris/benfit_contribution.rb,
lib/finch-api/models/hris/individual_response.rb,
lib/finch-api/models/hris/payment_list_params.rb,
lib/finch-api/models/jobs/automated_async_job.rb,
lib/finch-api/models/operation_support_matrix.rb,
lib/finch-api/models/account_disconnect_params.rb,
lib/finch-api/models/account_introspect_params.rb,
lib/finch-api/models/hris/benefit_contribution.rb,
lib/finch-api/models/hris/document_list_params.rb,
lib/finch-api/models/sandbox/job_create_params.rb,
lib/finch-api/models/access_token_create_params.rb,
lib/finch-api/models/connect/session_new_params.rb,
lib/finch-api/models/hris/benefit_create_params.rb,
lib/finch-api/models/hris/benefit_update_params.rb,
lib/finch-api/models/hris/directory_list_params.rb,
lib/finch-api/models/jobs/automated_list_params.rb,
lib/finch-api/models/hris/document_list_response.rb,
lib/finch-api/models/hris/pay_statement_response.rb,
lib/finch-api/models/jobs/manual_retrieve_params.rb,
lib/finch-api/models/sandbox/job_create_response.rb,
lib/finch-api/models/connect/session_new_response.rb,
lib/finch-api/models/create_access_token_response.rb,
lib/finch-api/models/hris/benefit_retrieve_params.rb,
lib/finch-api/models/hris/company_retrieve_params.rb,
lib/finch-api/models/hris/individual_in_directory.rb,
lib/finch-api/models/jobs/automated_create_params.rb,
lib/finch-api/models/jobs/automated_list_response.rb,
lib/finch-api/resources/hris/benefits/individuals.rb,
lib/finch-api/models/hris/document_retreive_params.rb,
lib/finch-api/models/hris/employment_data_response.rb,
lib/finch-api/models/hris/support_per_benefit_type.rb,
lib/finch-api/models/payroll/pay_group_list_params.rb,
lib/finch-api/models/sandbox/company_update_params.rb,
lib/finch-api/models/sandbox/payment_create_params.rb,
lib/finch-api/resources/sandbox/jobs/configuration.rb,
lib/finch-api/models/jobs/automated_create_response.rb,
lib/finch-api/models/jobs/automated_retrieve_params.rb,
lib/finch-api/models/hris/document_retreive_response.rb,
lib/finch-api/models/payroll/pay_group_list_response.rb,
lib/finch-api/models/sandbox/company_update_response.rb,
lib/finch-api/models/sandbox/directory_create_params.rb,
lib/finch-api/models/sandbox/payment_create_response.rb,
lib/finch-api/resources/sandbox/connections/accounts.rb,
lib/finch-api/models/hris/benefits/individual_benefit.rb,
lib/finch-api/models/hris/pay_statement_response_body.rb,
lib/finch-api/models/sandbox/connection_create_params.rb,
lib/finch-api/models/sandbox/employment_update_params.rb,
lib/finch-api/models/sandbox/individual_update_params.rb,
lib/finch-api/models/hris/benefits/enrolled_individual.rb,
lib/finch-api/models/payroll/pay_group_retrieve_params.rb,
lib/finch-api/models/request_forwarding_forward_params.rb,
lib/finch-api/models/sandbox/directory_create_response.rb,
lib/finch-api/models/sandbox/connection_create_response.rb,
lib/finch-api/models/sandbox/employment_update_response.rb,
lib/finch-api/models/sandbox/individual_update_response.rb,
lib/finch-api/models/hris/benefits/unenrolled_individual.rb,
lib/finch-api/models/payroll/pay_group_retrieve_response.rb,
lib/finch-api/models/request_forwarding_forward_response.rb,
lib/finch-api/models/hris/benefit_features_and_operations.rb,
lib/finch-api/models/hris/employment_retrieve_many_params.rb,
lib/finch-api/models/hris/individual_retrieve_many_params.rb,
lib/finch-api/models/hris/update_company_benefit_response.rb,
lib/finch-api/models/connect/session_reauthenticate_params.rb,
lib/finch-api/models/hris/create_company_benefits_response.rb,
lib/finch-api/models/hris/directory_list_individuals_params.rb,
lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rb,
lib/finch-api/models/connect/session_reauthenticate_response.rb,
lib/finch-api/models/hris/pay_statement_retrieve_many_params.rb,
lib/finch-api/models/sandbox/jobs/configuration_update_params.rb,
lib/finch-api/models/sandbox/connections/account_create_params.rb,
lib/finch-api/models/sandbox/connections/account_update_params.rb,
lib/finch-api/models/sandbox/jobs/configuration_retrieve_params.rb,
lib/finch-api/models/hris/benefit_list_supported_benefits_params.rb,
lib/finch-api/models/hris/benefits/individual_enroll_many_params.rb,
lib/finch-api/models/sandbox/connections/account_create_response.rb,
lib/finch-api/models/sandbox/connections/account_update_response.rb,
lib/finch-api/models/hris/benefits/individual_enrolled_ids_params.rb,
lib/finch-api/models/sandbox/jobs/configuration_retrieve_response.rb,
lib/finch-api/models/hris/benefits/individual_unenroll_many_params.rb,
lib/finch-api/models/hris/benefits/individual_enrolled_ids_response.rb,
lib/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rb

Defined Under Namespace

Modules: Models, Resources, Transport, Type, Util Classes: APIConnectionError, APIError, APIStatusError, APITimeoutError, AuthenticationError, BadRequestError, Client, ConflictError, ConversionError, Error, IndividualsPage, InternalServerError, NotFoundError, Page, PermissionDeniedError, RateLimitError, RequestOptions, ResponsesPage, SinglePage, UnprocessableEntityError

Constant Summary

Unknown =

FinchAPI::Type::Unknown

BooleanModel =

FinchAPI::Type::BooleanModel

Enum =

FinchAPI::Type::Enum

Union =

FinchAPI::Type::Union

ArrayOf =

FinchAPI::Type::ArrayOf

HashOf =

FinchAPI::Type::HashOf

BaseModel =

FinchAPI::Type::BaseModel

RequestParameters =

FinchAPI::Type::RequestParameters

VERSION =

"0.1.0-alpha.5"

Instance Attribute Summary

• #cause ⇒ StandardError^?

Instance Attribute Details

#cause ⇒ StandardError^?

Returns:

• (StandardError, nil)

# File 'lib/finch-api/errors.rb', line 2

def cause
  @cause
end