finch-api 0.1.0.pre.alpha.19 → 0.1.0.pre.alpha.20
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +37 -0
- data/README.md +4 -4
- data/SECURITY.md +2 -2
- data/lib/finch_api/errors.rb +22 -0
- data/lib/finch_api/internal/individuals_page.rb +1 -1
- data/lib/finch_api/internal/page.rb +1 -1
- data/lib/finch_api/internal/type/array_of.rb +14 -1
- data/lib/finch_api/internal/type/base_model.rb +84 -25
- data/lib/finch_api/internal/type/boolean.rb +15 -1
- data/lib/finch_api/internal/type/converter.rb +42 -34
- data/lib/finch_api/internal/type/enum.rb +25 -2
- data/lib/finch_api/internal/type/file_input.rb +13 -1
- data/lib/finch_api/internal/type/hash_of.rb +14 -1
- data/lib/finch_api/internal/type/union.rb +27 -7
- data/lib/finch_api/internal/type/unknown.rb +15 -1
- data/lib/finch_api/internal/util.rb +62 -10
- data/lib/finch_api/internal.rb +3 -0
- data/lib/finch_api/models/account_update_event.rb +110 -109
- data/lib/finch_api/models/base_webhook_event.rb +1 -1
- data/lib/finch_api/models/company_event.rb +2 -2
- data/lib/finch_api/models/connect/session_new_params.rb +12 -12
- data/lib/finch_api/models/connect/session_reauthenticate_params.rb +2 -2
- data/lib/finch_api/models/create_access_token_response.rb +7 -7
- data/lib/finch_api/models/directory_event.rb +4 -4
- data/lib/finch_api/models/employment_event.rb +4 -4
- data/lib/finch_api/models/hris/benefit_contribution.rb +3 -3
- data/lib/finch_api/models/hris/benefit_create_params.rb +11 -11
- data/lib/finch_api/models/hris/benefit_features_and_operations.rb +5 -120
- data/lib/finch_api/models/hris/benefit_type.rb +10 -10
- data/lib/finch_api/models/hris/benefits/individual_benefit.rb +11 -11
- data/lib/finch_api/models/hris/benefits/individual_enroll_many_params.rb +23 -23
- data/lib/finch_api/models/hris/benefits_support.rb +24 -24
- data/lib/finch_api/models/hris/company/pay_statement_item/rule_create_params.rb +11 -11
- data/lib/finch_api/models/hris/company/pay_statement_item_list_params.rb +2 -2
- data/lib/finch_api/models/hris/company/pay_statement_item_list_response.rb +18 -18
- data/lib/finch_api/models/hris/company.rb +23 -23
- data/lib/finch_api/models/hris/company_benefit.rb +12 -12
- data/lib/finch_api/models/hris/document_list_params.rb +2 -2
- data/lib/finch_api/models/hris/document_list_response.rb +4 -4
- data/lib/finch_api/models/hris/document_response.rb +4 -4
- data/lib/finch_api/models/hris/document_retreive_response.rb +1 -5
- data/lib/finch_api/models/hris/employment_data.rb +89 -100
- data/lib/finch_api/models/hris/employment_data_response.rb +2 -2
- data/lib/finch_api/models/hris/employment_retrieve_many_params.rb +4 -3
- data/lib/finch_api/models/hris/individual.rb +20 -26
- data/lib/finch_api/models/hris/individual_in_directory.rb +6 -6
- data/lib/finch_api/models/hris/individual_response.rb +2 -2
- data/lib/finch_api/models/hris/individual_retrieve_many_params.rb +4 -4
- data/lib/finch_api/models/hris/pay_statement.rb +184 -182
- data/lib/finch_api/models/hris/pay_statement_data_sync_in_progress.rb +76 -0
- data/lib/finch_api/models/hris/pay_statement_response.rb +50 -8
- data/lib/finch_api/models/hris/pay_statement_response_body.rb +27 -9
- data/lib/finch_api/models/hris/pay_statement_retrieve_many_params.rb +2 -2
- data/lib/finch_api/models/hris/payment.rb +37 -37
- data/lib/finch_api/models/hris/support_per_benefit_type.rb +4 -4
- data/lib/finch_api/models/hris/supported_benefit.rb +10 -9
- data/lib/finch_api/models/hris/w42005.rb +12 -12
- data/lib/finch_api/models/hris/w42020.rb +10 -10
- data/lib/finch_api/models/income.rb +8 -8
- data/lib/finch_api/models/individual_event.rb +4 -4
- data/lib/finch_api/models/introspection.rb +23 -23
- data/lib/finch_api/models/job_completion_event.rb +4 -4
- data/lib/finch_api/models/jobs/automated_async_job.rb +10 -10
- data/lib/finch_api/models/jobs/automated_create_params.rb +4 -4
- data/lib/finch_api/models/jobs/automated_list_response.rb +2 -2
- data/lib/finch_api/models/jobs/manual_async_job.rb +3 -3
- data/lib/finch_api/models/money.rb +4 -4
- data/lib/finch_api/models/operation_support_matrix.rb +9 -9
- data/lib/finch_api/models/pay_statement_event.rb +4 -4
- data/lib/finch_api/models/payment_event.rb +4 -4
- data/lib/finch_api/models/payroll/pay_group_list_response.rb +12 -12
- data/lib/finch_api/models/payroll/pay_group_retrieve_response.rb +5 -5
- data/lib/finch_api/models/provider.rb +104 -104
- data/lib/finch_api/models/sandbox/company_update_params.rb +21 -21
- data/lib/finch_api/models/sandbox/company_update_response.rb +2 -2
- data/lib/finch_api/models/sandbox/connection_create_params.rb +2 -2
- data/lib/finch_api/models/sandbox/connections/account_create_params.rb +2 -2
- data/lib/finch_api/models/sandbox/connections/account_update_params.rb +2 -2
- data/lib/finch_api/models/sandbox/directory_create_params.rb +49 -48
- data/lib/finch_api/models/sandbox/employment_update_params.rb +24 -23
- data/lib/finch_api/models/sandbox/employment_update_response.rb +6 -6
- data/lib/finch_api/models/sandbox/individual_update_params.rb +16 -16
- data/lib/finch_api/models/sandbox/individual_update_response.rb +2 -2
- data/lib/finch_api/models/sandbox/job_create_params.rb +2 -2
- data/lib/finch_api/models/sandbox/jobs/sandbox_job_configuration.rb +6 -6
- data/lib/finch_api/models/sandbox/payment_create_params.rb +160 -367
- data/lib/finch_api/models/webhook_event.rb +1 -16
- data/lib/finch_api/models.rb +30 -19
- data/lib/finch_api/resources/access_tokens.rb +1 -1
- data/lib/finch_api/resources/account.rb +2 -2
- data/lib/finch_api/resources/connect/sessions.rb +5 -5
- data/lib/finch_api/resources/hris/benefits/individuals.rb +4 -4
- data/lib/finch_api/resources/hris/benefits.rb +9 -9
- data/lib/finch_api/resources/hris/company/pay_statement_item/rules.rb +3 -3
- data/lib/finch_api/resources/hris/company/pay_statement_item.rb +1 -1
- data/lib/finch_api/resources/hris/company.rb +1 -1
- data/lib/finch_api/resources/hris/directory.rb +1 -1
- data/lib/finch_api/resources/hris/documents.rb +2 -2
- data/lib/finch_api/resources/hris/employments.rb +2 -2
- data/lib/finch_api/resources/hris/individuals.rb +3 -3
- data/lib/finch_api/resources/hris/pay_statements.rb +2 -2
- data/lib/finch_api/resources/hris/payments.rb +1 -1
- data/lib/finch_api/resources/jobs/automated.rb +3 -3
- data/lib/finch_api/resources/jobs/manual.rb +1 -1
- data/lib/finch_api/resources/providers.rb +1 -1
- data/lib/finch_api/resources/sandbox/company.rb +4 -4
- data/lib/finch_api/resources/sandbox/connections/accounts.rb +2 -2
- data/lib/finch_api/resources/sandbox/connections.rb +1 -1
- data/lib/finch_api/resources/sandbox/directory.rb +1 -1
- data/lib/finch_api/resources/sandbox/employment.rb +8 -8
- data/lib/finch_api/resources/sandbox/individual.rb +5 -5
- data/lib/finch_api/resources/sandbox/jobs/configuration.rb +4 -4
- data/lib/finch_api/resources/sandbox/jobs.rb +1 -1
- data/lib/finch_api/resources/sandbox/payment.rb +6 -3
- data/lib/finch_api/version.rb +1 -1
- data/lib/finch_api.rb +4 -2
- data/rbi/finch_api/errors.rbi +16 -0
- data/rbi/finch_api/internal/type/array_of.rbi +6 -0
- data/rbi/finch_api/internal/type/base_model.rbi +5 -0
- data/rbi/finch_api/internal/type/boolean.rbi +8 -0
- data/rbi/finch_api/internal/type/converter.rbi +15 -15
- data/rbi/finch_api/internal/type/enum.rbi +5 -0
- data/rbi/finch_api/internal/type/file_input.rbi +5 -0
- data/rbi/finch_api/internal/type/hash_of.rbi +6 -0
- data/rbi/finch_api/internal/type/union.rbi +10 -0
- data/rbi/finch_api/internal/type/unknown.rbi +8 -0
- data/rbi/finch_api/internal/util.rbi +36 -0
- data/rbi/finch_api/internal.rbi +3 -0
- data/rbi/finch_api/models/connect/session_new_params.rbi +4 -4
- data/rbi/finch_api/models/hris/benefit_features_and_operations.rbi +4 -296
- data/rbi/finch_api/models/hris/benefit_type.rbi +16 -16
- data/rbi/finch_api/models/hris/company/pay_statement_item_list_response.rbi +18 -33
- data/rbi/finch_api/models/hris/employment_data.rbi +123 -141
- data/rbi/finch_api/models/hris/employment_data_response.rbi +2 -13
- data/rbi/finch_api/models/hris/individual_response.rbi +2 -13
- data/rbi/finch_api/models/hris/pay_statement.rbi +275 -307
- data/rbi/finch_api/models/hris/pay_statement_data_sync_in_progress.rbi +188 -0
- data/rbi/finch_api/models/hris/pay_statement_response.rbi +84 -20
- data/rbi/finch_api/models/hris/pay_statement_response_body.rbi +45 -17
- data/rbi/finch_api/models/hris/payment.rbi +27 -30
- data/rbi/finch_api/models/hris/supported_benefit.rbi +12 -8
- data/rbi/finch_api/models/income.rbi +3 -3
- data/rbi/finch_api/models/money.rbi +4 -7
- data/rbi/finch_api/models/payroll/pay_group_list_response.rbi +25 -43
- data/rbi/finch_api/models/payroll/pay_group_retrieve_response.rbi +14 -14
- data/rbi/finch_api/models/sandbox/payment_create_params.rbi +463 -727
- data/rbi/finch_api/resources/connect/sessions.rbi +2 -2
- data/rbi/finch_api/resources/hris/benefits.rbi +1 -3
- data/rbi/finch_api/resources/hris/documents.rbi +1 -1
- data/rbi/finch_api/resources/sandbox/payment.rbi +3 -2
- data/sig/finch_api/errors.rbs +9 -0
- data/sig/finch_api/internal/type/array_of.rbs +3 -0
- data/sig/finch_api/internal/type/base_model.rbs +2 -0
- data/sig/finch_api/internal/type/boolean.rbs +3 -0
- data/sig/finch_api/internal/type/converter.rbs +7 -1
- data/sig/finch_api/internal/type/enum.rbs +2 -0
- data/sig/finch_api/internal/type/file_input.rbs +2 -0
- data/sig/finch_api/internal/type/hash_of.rbs +3 -0
- data/sig/finch_api/internal/type/union.rbs +2 -0
- data/sig/finch_api/internal/type/unknown.rbs +3 -0
- data/sig/finch_api/internal/util.rbs +12 -0
- data/sig/finch_api/internal.rbs +2 -0
- data/sig/finch_api/models/access_token_create_params.rbs +8 -0
- data/sig/finch_api/models/account_disconnect_params.rbs +2 -0
- data/sig/finch_api/models/account_introspect_params.rbs +2 -0
- data/sig/finch_api/models/account_update_event.rbs +230 -12
- data/sig/finch_api/models/base_webhook_event.rbs +6 -0
- data/sig/finch_api/models/company_event.rbs +11 -6
- data/sig/finch_api/models/connect/session_new_params.rbs +26 -8
- data/sig/finch_api/models/connect/session_new_response.rbs +2 -0
- data/sig/finch_api/models/connect/session_reauthenticate_params.rbs +12 -4
- data/sig/finch_api/models/connect/session_reauthenticate_response.rbs +2 -0
- data/sig/finch_api/models/create_access_token_response.rbs +21 -8
- data/sig/finch_api/models/directory_event.rbs +13 -6
- data/sig/finch_api/models/disconnect_response.rbs +2 -0
- data/sig/finch_api/models/employment_event.rbs +13 -6
- data/sig/finch_api/models/hris/benefit_contribution.rbs +12 -4
- data/sig/finch_api/models/hris/benefit_create_params.rbs +21 -6
- data/sig/finch_api/models/hris/benefit_features_and_operations.rbs +9 -78
- data/sig/finch_api/models/hris/benefit_list_params.rbs +2 -0
- data/sig/finch_api/models/hris/benefit_list_supported_benefits_params.rbs +2 -0
- data/sig/finch_api/models/hris/benefit_retrieve_params.rbs +2 -0
- data/sig/finch_api/models/hris/benefit_type.rbs +21 -21
- data/sig/finch_api/models/hris/benefit_update_params.rbs +5 -0
- data/sig/finch_api/models/hris/benefits/enrolled_individual_benefit_response.rbs +2 -0
- data/sig/finch_api/models/hris/benefits/individual_benefit.rbs +18 -4
- data/sig/finch_api/models/hris/benefits/individual_enroll_many_params.rbs +47 -18
- data/sig/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbs +2 -0
- data/sig/finch_api/models/hris/benefits/individual_enrolled_ids_response.rbs +5 -0
- data/sig/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbs +5 -0
- data/sig/finch_api/models/hris/benefits/individual_unenroll_many_params.rbs +5 -0
- data/sig/finch_api/models/hris/benefits/unenrolled_individual_benefit_response.rbs +2 -0
- data/sig/finch_api/models/hris/benefits_support.rbs +15 -0
- data/sig/finch_api/models/hris/company/pay_statement_item/rule_create_params.rbs +23 -6
- data/sig/finch_api/models/hris/company/pay_statement_item/rule_create_response.rbs +20 -0
- data/sig/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbs +2 -0
- data/sig/finch_api/models/hris/company/pay_statement_item/rule_delete_response.rbs +21 -0
- data/sig/finch_api/models/hris/company/pay_statement_item/rule_list_params.rbs +2 -0
- data/sig/finch_api/models/hris/company/pay_statement_item/rule_list_response.rbs +20 -0
- data/sig/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbs +5 -0
- data/sig/finch_api/models/hris/company/pay_statement_item/rule_update_response.rbs +20 -0
- data/sig/finch_api/models/hris/company/pay_statement_item_list_params.rbs +15 -6
- data/sig/finch_api/models/hris/company/pay_statement_item_list_response.rbs +23 -20
- data/sig/finch_api/models/hris/company.rbs +44 -12
- data/sig/finch_api/models/hris/company_benefit.rbs +21 -6
- data/sig/finch_api/models/hris/company_retrieve_params.rbs +2 -0
- data/sig/finch_api/models/hris/create_company_benefits_response.rbs +2 -0
- data/sig/finch_api/models/hris/directory_list_individuals_params.rbs +6 -0
- data/sig/finch_api/models/hris/directory_list_params.rbs +6 -0
- data/sig/finch_api/models/hris/document_list_params.rbs +14 -6
- data/sig/finch_api/models/hris/document_list_response.rbs +5 -0
- data/sig/finch_api/models/hris/document_response.rbs +14 -6
- data/sig/finch_api/models/hris/document_retreive_params.rbs +2 -0
- data/sig/finch_api/models/hris/employment_data.rbs +91 -47
- data/sig/finch_api/models/hris/employment_data_response.rbs +6 -0
- data/sig/finch_api/models/hris/employment_retrieve_many_params.rbs +7 -0
- data/sig/finch_api/models/hris/individual.rbs +49 -16
- data/sig/finch_api/models/hris/individual_in_directory.rbs +14 -0
- data/sig/finch_api/models/hris/individual_response.rbs +6 -0
- data/sig/finch_api/models/hris/individual_retrieve_many_params.rbs +10 -0
- data/sig/finch_api/models/hris/pay_statement.rbs +179 -133
- data/sig/finch_api/models/hris/pay_statement_data_sync_in_progress.rbs +78 -0
- data/sig/finch_api/models/hris/pay_statement_response.rbs +51 -13
- data/sig/finch_api/models/hris/pay_statement_response_body.rbs +24 -11
- data/sig/finch_api/models/hris/pay_statement_retrieve_many_params.rbs +11 -0
- data/sig/finch_api/models/hris/payment.rbs +44 -29
- data/sig/finch_api/models/hris/payment_list_params.rbs +6 -0
- data/sig/finch_api/models/hris/support_per_benefit_type.rbs +5 -0
- data/sig/finch_api/models/hris/supported_benefit.rbs +22 -12
- data/sig/finch_api/models/hris/update_company_benefit_response.rbs +2 -0
- data/sig/finch_api/models/hris/w42005.rbs +30 -16
- data/sig/finch_api/models/hris/w42020.rbs +27 -10
- data/sig/finch_api/models/income.rbs +14 -7
- data/sig/finch_api/models/individual_event.rbs +13 -6
- data/sig/finch_api/models/introspection.rbs +51 -14
- data/sig/finch_api/models/job_completion_event.rbs +13 -6
- data/sig/finch_api/models/jobs/automated_async_job.rbs +22 -8
- data/sig/finch_api/models/jobs/automated_create_params.rbs +8 -0
- data/sig/finch_api/models/jobs/automated_create_response.rbs +7 -0
- data/sig/finch_api/models/jobs/automated_list_params.rbs +6 -0
- data/sig/finch_api/models/jobs/automated_list_response.rbs +18 -0
- data/sig/finch_api/models/jobs/automated_retrieve_params.rbs +2 -0
- data/sig/finch_api/models/jobs/manual_async_job.rbs +10 -4
- data/sig/finch_api/models/jobs/manual_retrieve_params.rbs +2 -0
- data/sig/finch_api/models/location.rbs +11 -0
- data/sig/finch_api/models/money.rbs +3 -3
- data/sig/finch_api/models/operation_support_matrix.rbs +7 -0
- data/sig/finch_api/models/paging.rbs +2 -0
- data/sig/finch_api/models/pay_statement_event.rbs +13 -6
- data/sig/finch_api/models/payment_event.rbs +13 -6
- data/sig/finch_api/models/payroll/pay_group_list_params.rbs +6 -0
- data/sig/finch_api/models/payroll/pay_group_list_response.rbs +22 -24
- data/sig/finch_api/models/payroll/pay_group_retrieve_params.rbs +2 -0
- data/sig/finch_api/models/payroll/pay_group_retrieve_response.rbs +17 -10
- data/sig/finch_api/models/provider.rbs +227 -6
- data/sig/finch_api/models/provider_list_params.rbs +2 -0
- data/sig/finch_api/models/request_forwarding_forward_params.rbs +9 -0
- data/sig/finch_api/models/request_forwarding_forward_response.rbs +15 -0
- data/sig/finch_api/models/sandbox/company_update_params.rbs +44 -12
- data/sig/finch_api/models/sandbox/company_update_response.rbs +31 -0
- data/sig/finch_api/models/sandbox/connection_create_params.rbs +8 -0
- data/sig/finch_api/models/sandbox/connection_create_response.rbs +11 -0
- data/sig/finch_api/models/sandbox/connections/account_create_params.rbs +8 -0
- data/sig/finch_api/models/sandbox/connections/account_create_response.rbs +10 -0
- data/sig/finch_api/models/sandbox/connections/account_update_params.rbs +5 -0
- data/sig/finch_api/models/sandbox/connections/account_update_response.rbs +9 -0
- data/sig/finch_api/models/sandbox/directory_create_params.rbs +84 -28
- data/sig/finch_api/models/sandbox/employment_update_params.rbs +41 -8
- data/sig/finch_api/models/sandbox/employment_update_response.rbs +33 -0
- data/sig/finch_api/models/sandbox/individual_update_params.rbs +34 -8
- data/sig/finch_api/models/sandbox/individual_update_response.rbs +26 -0
- data/sig/finch_api/models/sandbox/job_create_params.rbs +5 -0
- data/sig/finch_api/models/sandbox/job_create_response.rbs +7 -0
- data/sig/finch_api/models/sandbox/jobs/configuration_retrieve_params.rbs +2 -0
- data/sig/finch_api/models/sandbox/jobs/configuration_update_params.rbs +2 -0
- data/sig/finch_api/models/sandbox/jobs/sandbox_job_configuration.rbs +13 -8
- data/sig/finch_api/models/sandbox/payment_create_params.rbs +287 -228
- data/sig/finch_api/models/sandbox/payment_create_response.rbs +2 -0
- data/sig/finch_api/resources/connect/sessions.rbs +2 -2
- data/sig/finch_api/resources/hris/benefits.rbs +1 -1
- data/sig/finch_api/resources/hris/company/pay_statement_item.rbs +1 -1
- data/sig/finch_api/resources/hris/documents.rbs +1 -1
- data/sig/finch_api/resources/sandbox/payment.rbs +2 -2
- metadata +5 -5
- data/lib/finch_api/models/hris/benefit_list_supported_benefits_response.rb +0 -110
- data/rbi/finch_api/models/hris/benefit_list_supported_benefits_response.rbi +0 -290
- data/sig/finch_api/models/hris/benefit_list_supported_benefits_response.rbs +0 -79
@@ -30,7 +30,7 @@ module FinchAPI
|
|
30
30
|
|
31
31
|
# @!method initialize(account_id:, company_id:, connection_id: nil)
|
32
32
|
# Some parameter documentations has been truncated, see
|
33
|
-
# {FinchAPI::BaseWebhookEvent} for more details.
|
33
|
+
# {FinchAPI::Models::BaseWebhookEvent} for more details.
|
34
34
|
#
|
35
35
|
# @param account_id [String] [DEPRECATED] Unique Finch ID of the employer account used to make this connectio
|
36
36
|
#
|
@@ -10,12 +10,12 @@ module FinchAPI
|
|
10
10
|
|
11
11
|
# @!attribute event_type
|
12
12
|
#
|
13
|
-
# @return [Symbol, FinchAPI::CompanyEvent::EventType, nil]
|
13
|
+
# @return [Symbol, FinchAPI::Models::CompanyEvent::EventType, nil]
|
14
14
|
optional :event_type, enum: -> { FinchAPI::CompanyEvent::EventType }
|
15
15
|
|
16
16
|
# @!method initialize(data: nil, event_type: nil)
|
17
17
|
# @param data [Hash{Symbol=>Object}, nil]
|
18
|
-
# @param event_type [Symbol, FinchAPI::CompanyEvent::EventType]
|
18
|
+
# @param event_type [Symbol, FinchAPI::Models::CompanyEvent::EventType]
|
19
19
|
|
20
20
|
module EventType
|
21
21
|
extend FinchAPI::Internal::Type::Enum
|
@@ -20,7 +20,7 @@ module FinchAPI
|
|
20
20
|
|
21
21
|
# @!attribute products
|
22
22
|
#
|
23
|
-
# @return [Array<Symbol, FinchAPI::Connect::SessionNewParams::Product>]
|
23
|
+
# @return [Array<Symbol, FinchAPI::Models::Connect::SessionNewParams::Product>]
|
24
24
|
required :products,
|
25
25
|
-> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Connect::SessionNewParams::Product] }
|
26
26
|
|
@@ -31,7 +31,7 @@ module FinchAPI
|
|
31
31
|
|
32
32
|
# @!attribute integration
|
33
33
|
#
|
34
|
-
# @return [FinchAPI::Connect::SessionNewParams::Integration, nil]
|
34
|
+
# @return [FinchAPI::Models::Connect::SessionNewParams::Integration, nil]
|
35
35
|
optional :integration, -> { FinchAPI::Connect::SessionNewParams::Integration }, nil?: true
|
36
36
|
|
37
37
|
# @!attribute manual
|
@@ -40,8 +40,8 @@ module FinchAPI
|
|
40
40
|
optional :manual, FinchAPI::Internal::Type::Boolean, nil?: true
|
41
41
|
|
42
42
|
# @!attribute minutes_to_expire
|
43
|
-
# The number of minutes until the session expires (defaults to
|
44
|
-
# days)
|
43
|
+
# The number of minutes until the session expires (defaults to 129,600, which is
|
44
|
+
# 90 days)
|
45
45
|
#
|
46
46
|
# @return [Float, nil]
|
47
47
|
optional :minutes_to_expire, Float, nil?: true
|
@@ -53,7 +53,7 @@ module FinchAPI
|
|
53
53
|
|
54
54
|
# @!attribute sandbox
|
55
55
|
#
|
56
|
-
# @return [Symbol, FinchAPI::Connect::SessionNewParams::Sandbox, nil]
|
56
|
+
# @return [Symbol, FinchAPI::Models::Connect::SessionNewParams::Sandbox, nil]
|
57
57
|
optional :sandbox, enum: -> { FinchAPI::Connect::SessionNewParams::Sandbox }, nil?: true
|
58
58
|
|
59
59
|
# @!method initialize(customer_id:, customer_name:, products:, customer_email: nil, integration: nil, manual: nil, minutes_to_expire: nil, redirect_uri: nil, sandbox: nil, request_options: {})
|
@@ -64,19 +64,19 @@ module FinchAPI
|
|
64
64
|
#
|
65
65
|
# @param customer_name [String]
|
66
66
|
#
|
67
|
-
# @param products [Array<Symbol, FinchAPI::Connect::SessionNewParams::Product>]
|
67
|
+
# @param products [Array<Symbol, FinchAPI::Models::Connect::SessionNewParams::Product>]
|
68
68
|
#
|
69
69
|
# @param customer_email [String, nil]
|
70
70
|
#
|
71
|
-
# @param integration [FinchAPI::Connect::SessionNewParams::Integration, nil]
|
71
|
+
# @param integration [FinchAPI::Models::Connect::SessionNewParams::Integration, nil]
|
72
72
|
#
|
73
73
|
# @param manual [Boolean, nil]
|
74
74
|
#
|
75
|
-
# @param minutes_to_expire [Float, nil] The number of minutes until the session expires (defaults to
|
75
|
+
# @param minutes_to_expire [Float, nil] The number of minutes until the session expires (defaults to 129,600, which is 9
|
76
76
|
#
|
77
77
|
# @param redirect_uri [String, nil]
|
78
78
|
#
|
79
|
-
# @param sandbox [Symbol, FinchAPI::Connect::SessionNewParams::Sandbox, nil]
|
79
|
+
# @param sandbox [Symbol, FinchAPI::Models::Connect::SessionNewParams::Sandbox, nil]
|
80
80
|
#
|
81
81
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
|
82
82
|
|
@@ -102,7 +102,7 @@ module FinchAPI
|
|
102
102
|
class Integration < FinchAPI::Internal::Type::BaseModel
|
103
103
|
# @!attribute auth_method
|
104
104
|
#
|
105
|
-
# @return [Symbol, FinchAPI::Connect::SessionNewParams::Integration::AuthMethod, nil]
|
105
|
+
# @return [Symbol, FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod, nil]
|
106
106
|
optional :auth_method,
|
107
107
|
enum: -> { FinchAPI::Connect::SessionNewParams::Integration::AuthMethod },
|
108
108
|
nil?: true
|
@@ -113,10 +113,10 @@ module FinchAPI
|
|
113
113
|
optional :provider, String, nil?: true
|
114
114
|
|
115
115
|
# @!method initialize(auth_method: nil, provider: nil)
|
116
|
-
# @param auth_method [Symbol, FinchAPI::Connect::SessionNewParams::Integration::AuthMethod, nil]
|
116
|
+
# @param auth_method [Symbol, FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod, nil]
|
117
117
|
# @param provider [String, nil]
|
118
118
|
|
119
|
-
# @see FinchAPI::Connect::SessionNewParams::Integration#auth_method
|
119
|
+
# @see FinchAPI::Models::Connect::SessionNewParams::Integration#auth_method
|
120
120
|
module AuthMethod
|
121
121
|
extend FinchAPI::Internal::Type::Enum
|
122
122
|
|
@@ -24,7 +24,7 @@ module FinchAPI
|
|
24
24
|
# @!attribute products
|
25
25
|
# The products to request access to (optional for reauthentication)
|
26
26
|
#
|
27
|
-
# @return [Array<Symbol, FinchAPI::Connect::SessionReauthenticateParams::Product>, nil]
|
27
|
+
# @return [Array<Symbol, FinchAPI::Models::Connect::SessionReauthenticateParams::Product>, nil]
|
28
28
|
optional :products,
|
29
29
|
-> {
|
30
30
|
FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Connect::SessionReauthenticateParams::Product]
|
@@ -45,7 +45,7 @@ module FinchAPI
|
|
45
45
|
#
|
46
46
|
# @param minutes_to_expire [Integer, nil] The number of minutes until the session expires (defaults to 43,200, which is 30
|
47
47
|
#
|
48
|
-
# @param products [Array<Symbol, FinchAPI::Connect::SessionReauthenticateParams::Product>, nil] The products to request access to (optional for reauthentication)
|
48
|
+
# @param products [Array<Symbol, FinchAPI::Models::Connect::SessionReauthenticateParams::Product>, nil] The products to request access to (optional for reauthentication)
|
49
49
|
#
|
50
50
|
# @param redirect_uri [String, nil] The URI to redirect to after the Connect flow is completed
|
51
51
|
#
|
@@ -22,7 +22,7 @@ module FinchAPI
|
|
22
22
|
# @!attribute client_type
|
23
23
|
# The type of application associated with a token.
|
24
24
|
#
|
25
|
-
# @return [Symbol, FinchAPI::CreateAccessTokenResponse::ClientType]
|
25
|
+
# @return [Symbol, FinchAPI::Models::CreateAccessTokenResponse::ClientType]
|
26
26
|
required :client_type, enum: -> { FinchAPI::CreateAccessTokenResponse::ClientType }
|
27
27
|
|
28
28
|
# @!attribute company_id
|
@@ -46,7 +46,7 @@ module FinchAPI
|
|
46
46
|
# - `provider` - connection to an external provider
|
47
47
|
# - `finch` - finch-generated data.
|
48
48
|
#
|
49
|
-
# @return [Symbol, FinchAPI::CreateAccessTokenResponse::ConnectionType]
|
49
|
+
# @return [Symbol, FinchAPI::Models::CreateAccessTokenResponse::ConnectionType]
|
50
50
|
required :connection_type, enum: -> { FinchAPI::CreateAccessTokenResponse::ConnectionType }
|
51
51
|
|
52
52
|
# @!attribute products
|
@@ -76,19 +76,19 @@ module FinchAPI
|
|
76
76
|
|
77
77
|
# @!method initialize(access_token:, account_id:, client_type:, company_id:, connection_id:, connection_type:, products:, provider_id:, customer_id: nil, token_type: nil)
|
78
78
|
# Some parameter documentations has been truncated, see
|
79
|
-
# {FinchAPI::CreateAccessTokenResponse} for more details.
|
79
|
+
# {FinchAPI::Models::CreateAccessTokenResponse} for more details.
|
80
80
|
#
|
81
81
|
# @param access_token [String] The access token for the connection.
|
82
82
|
#
|
83
83
|
# @param account_id [String] [DEPRECATED] Use `connection_id` to identify the connection instead of this acco
|
84
84
|
#
|
85
|
-
# @param client_type [Symbol, FinchAPI::CreateAccessTokenResponse::ClientType] The type of application associated with a token.
|
85
|
+
# @param client_type [Symbol, FinchAPI::Models::CreateAccessTokenResponse::ClientType] The type of application associated with a token.
|
86
86
|
#
|
87
87
|
# @param company_id [String] [DEPRECATED] Use `connection_id` to identify the connection instead of this comp
|
88
88
|
#
|
89
89
|
# @param connection_id [String] The Finch UUID of the connection associated with the `access_token`.
|
90
90
|
#
|
91
|
-
# @param connection_type [Symbol, FinchAPI::CreateAccessTokenResponse::ConnectionType] The type of the connection associated with the token.
|
91
|
+
# @param connection_type [Symbol, FinchAPI::Models::CreateAccessTokenResponse::ConnectionType] The type of the connection associated with the token.
|
92
92
|
#
|
93
93
|
# @param products [Array<String>] An array of the authorized products associated with the `access_token`.
|
94
94
|
#
|
@@ -100,7 +100,7 @@ module FinchAPI
|
|
100
100
|
|
101
101
|
# The type of application associated with a token.
|
102
102
|
#
|
103
|
-
# @see FinchAPI::CreateAccessTokenResponse#client_type
|
103
|
+
# @see FinchAPI::Models::CreateAccessTokenResponse#client_type
|
104
104
|
module ClientType
|
105
105
|
extend FinchAPI::Internal::Type::Enum
|
106
106
|
|
@@ -117,7 +117,7 @@ module FinchAPI
|
|
117
117
|
# - `provider` - connection to an external provider
|
118
118
|
# - `finch` - finch-generated data.
|
119
119
|
#
|
120
|
-
# @see FinchAPI::CreateAccessTokenResponse#connection_type
|
120
|
+
# @see FinchAPI::Models::CreateAccessTokenResponse#connection_type
|
121
121
|
module ConnectionType
|
122
122
|
extend FinchAPI::Internal::Type::Enum
|
123
123
|
|
@@ -5,17 +5,17 @@ module FinchAPI
|
|
5
5
|
class DirectoryEvent < FinchAPI::Models::BaseWebhookEvent
|
6
6
|
# @!attribute data
|
7
7
|
#
|
8
|
-
# @return [FinchAPI::DirectoryEvent::Data, nil]
|
8
|
+
# @return [FinchAPI::Models::DirectoryEvent::Data, nil]
|
9
9
|
optional :data, -> { FinchAPI::DirectoryEvent::Data }
|
10
10
|
|
11
11
|
# @!attribute event_type
|
12
12
|
#
|
13
|
-
# @return [Symbol, FinchAPI::DirectoryEvent::EventType, nil]
|
13
|
+
# @return [Symbol, FinchAPI::Models::DirectoryEvent::EventType, nil]
|
14
14
|
optional :event_type, enum: -> { FinchAPI::DirectoryEvent::EventType }
|
15
15
|
|
16
16
|
# @!method initialize(data: nil, event_type: nil)
|
17
|
-
# @param data [FinchAPI::DirectoryEvent::Data]
|
18
|
-
# @param event_type [Symbol, FinchAPI::DirectoryEvent::EventType]
|
17
|
+
# @param data [FinchAPI::Models::DirectoryEvent::Data]
|
18
|
+
# @param event_type [Symbol, FinchAPI::Models::DirectoryEvent::EventType]
|
19
19
|
|
20
20
|
class Data < FinchAPI::Internal::Type::BaseModel
|
21
21
|
# @!attribute individual_id
|
@@ -5,17 +5,17 @@ module FinchAPI
|
|
5
5
|
class EmploymentEvent < FinchAPI::Models::BaseWebhookEvent
|
6
6
|
# @!attribute data
|
7
7
|
#
|
8
|
-
# @return [FinchAPI::EmploymentEvent::Data, nil]
|
8
|
+
# @return [FinchAPI::Models::EmploymentEvent::Data, nil]
|
9
9
|
optional :data, -> { FinchAPI::EmploymentEvent::Data }
|
10
10
|
|
11
11
|
# @!attribute event_type
|
12
12
|
#
|
13
|
-
# @return [Symbol, FinchAPI::EmploymentEvent::EventType, nil]
|
13
|
+
# @return [Symbol, FinchAPI::Models::EmploymentEvent::EventType, nil]
|
14
14
|
optional :event_type, enum: -> { FinchAPI::EmploymentEvent::EventType }
|
15
15
|
|
16
16
|
# @!method initialize(data: nil, event_type: nil)
|
17
|
-
# @param data [FinchAPI::EmploymentEvent::Data]
|
18
|
-
# @param event_type [Symbol, FinchAPI::EmploymentEvent::EventType]
|
17
|
+
# @param data [FinchAPI::Models::EmploymentEvent::Data]
|
18
|
+
# @param event_type [Symbol, FinchAPI::Models::EmploymentEvent::EventType]
|
19
19
|
|
20
20
|
class Data < FinchAPI::Internal::Type::BaseModel
|
21
21
|
# @!attribute individual_id
|
@@ -13,17 +13,17 @@ module FinchAPI
|
|
13
13
|
# @!attribute type
|
14
14
|
# Contribution type.
|
15
15
|
#
|
16
|
-
# @return [Symbol, FinchAPI::HRIS::BenefitContribution::Type, nil]
|
16
|
+
# @return [Symbol, FinchAPI::Models::HRIS::BenefitContribution::Type, nil]
|
17
17
|
optional :type, enum: -> { FinchAPI::HRIS::BenefitContribution::Type }, nil?: true
|
18
18
|
|
19
19
|
# @!method initialize(amount: nil, type: nil)
|
20
20
|
# @param amount [Integer, nil] Contribution amount in cents (if `fixed`) or basis points (if `percent`).
|
21
21
|
#
|
22
|
-
# @param type [Symbol, FinchAPI::HRIS::BenefitContribution::Type, nil] Contribution type.
|
22
|
+
# @param type [Symbol, FinchAPI::Models::HRIS::BenefitContribution::Type, nil] Contribution type.
|
23
23
|
|
24
24
|
# Contribution type.
|
25
25
|
#
|
26
|
-
# @see FinchAPI::HRIS::BenefitContribution#type
|
26
|
+
# @see FinchAPI::Models::HRIS::BenefitContribution#type
|
27
27
|
module Type
|
28
28
|
extend FinchAPI::Internal::Type::Enum
|
29
29
|
|
@@ -11,7 +11,7 @@ module FinchAPI
|
|
11
11
|
# @!attribute company_contribution
|
12
12
|
# The company match for this benefit.
|
13
13
|
#
|
14
|
-
# @return [FinchAPI::HRIS::BenefitCreateParams::CompanyContribution, nil]
|
14
|
+
# @return [FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution, nil]
|
15
15
|
optional :company_contribution,
|
16
16
|
-> { FinchAPI::HRIS::BenefitCreateParams::CompanyContribution },
|
17
17
|
nil?: true
|
@@ -27,33 +27,33 @@ module FinchAPI
|
|
27
27
|
# @!attribute frequency
|
28
28
|
# The frequency of the benefit deduction/contribution.
|
29
29
|
#
|
30
|
-
# @return [Symbol, FinchAPI::HRIS::BenefitFrequency, nil]
|
30
|
+
# @return [Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil]
|
31
31
|
optional :frequency, enum: -> { FinchAPI::HRIS::BenefitFrequency }, nil?: true
|
32
32
|
|
33
33
|
# @!attribute type
|
34
34
|
# Type of benefit.
|
35
35
|
#
|
36
|
-
# @return [Symbol, FinchAPI::HRIS::BenefitType, nil]
|
36
|
+
# @return [Symbol, FinchAPI::Models::HRIS::BenefitType, nil]
|
37
37
|
optional :type, enum: -> { FinchAPI::HRIS::BenefitType }, nil?: true
|
38
38
|
|
39
39
|
# @!method initialize(company_contribution: nil, description: nil, frequency: nil, type: nil, request_options: {})
|
40
40
|
# Some parameter documentations has been truncated, see
|
41
41
|
# {FinchAPI::Models::HRIS::BenefitCreateParams} for more details.
|
42
42
|
#
|
43
|
-
# @param company_contribution [FinchAPI::HRIS::BenefitCreateParams::CompanyContribution, nil] The company match for this benefit.
|
43
|
+
# @param company_contribution [FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution, nil] The company match for this benefit.
|
44
44
|
#
|
45
45
|
# @param description [String] Name of the benefit as it appears in the provider and pay statements. Recommend
|
46
46
|
#
|
47
|
-
# @param frequency [Symbol, FinchAPI::HRIS::BenefitFrequency, nil] The frequency of the benefit deduction/contribution.
|
47
|
+
# @param frequency [Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil] The frequency of the benefit deduction/contribution.
|
48
48
|
#
|
49
|
-
# @param type [Symbol, FinchAPI::HRIS::BenefitType, nil] Type of benefit.
|
49
|
+
# @param type [Symbol, FinchAPI::Models::HRIS::BenefitType, nil] Type of benefit.
|
50
50
|
#
|
51
51
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
|
52
52
|
|
53
53
|
class CompanyContribution < FinchAPI::Internal::Type::BaseModel
|
54
54
|
# @!attribute tiers
|
55
55
|
#
|
56
|
-
# @return [Array<FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Tier>, nil]
|
56
|
+
# @return [Array<FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::Tier>, nil]
|
57
57
|
optional :tiers,
|
58
58
|
-> {
|
59
59
|
FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Tier]
|
@@ -61,14 +61,14 @@ module FinchAPI
|
|
61
61
|
|
62
62
|
# @!attribute type
|
63
63
|
#
|
64
|
-
# @return [Symbol, FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Type, nil]
|
64
|
+
# @return [Symbol, FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::Type, nil]
|
65
65
|
optional :type, enum: -> { FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Type }
|
66
66
|
|
67
67
|
# @!method initialize(tiers: nil, type: nil)
|
68
68
|
# The company match for this benefit.
|
69
69
|
#
|
70
|
-
# @param tiers [Array<FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Tier>]
|
71
|
-
# @param type [Symbol, FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Type]
|
70
|
+
# @param tiers [Array<FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::Tier>]
|
71
|
+
# @param type [Symbol, FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::Type]
|
72
72
|
|
73
73
|
class Tier < FinchAPI::Internal::Type::BaseModel
|
74
74
|
# @!attribute match
|
@@ -86,7 +86,7 @@ module FinchAPI
|
|
86
86
|
# @param threshold [Integer]
|
87
87
|
end
|
88
88
|
|
89
|
-
# @see FinchAPI::HRIS::BenefitCreateParams::CompanyContribution#type
|
89
|
+
# @see FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution#type
|
90
90
|
module Type
|
91
91
|
extend FinchAPI::Internal::Type::Enum
|
92
92
|
|
@@ -6,132 +6,17 @@ module FinchAPI
|
|
6
6
|
class BenefitFeaturesAndOperations < FinchAPI::Internal::Type::BaseModel
|
7
7
|
# @!attribute supported_features
|
8
8
|
#
|
9
|
-
# @return [FinchAPI::HRIS::
|
10
|
-
optional :supported_features, -> { FinchAPI::HRIS::
|
9
|
+
# @return [FinchAPI::Models::HRIS::SupportedBenefit, nil]
|
10
|
+
optional :supported_features, -> { FinchAPI::HRIS::SupportedBenefit }
|
11
11
|
|
12
12
|
# @!attribute supported_operations
|
13
13
|
#
|
14
|
-
# @return [FinchAPI::HRIS::SupportPerBenefitType, nil]
|
14
|
+
# @return [FinchAPI::Models::HRIS::SupportPerBenefitType, nil]
|
15
15
|
optional :supported_operations, -> { FinchAPI::HRIS::SupportPerBenefitType }
|
16
16
|
|
17
17
|
# @!method initialize(supported_features: nil, supported_operations: nil)
|
18
|
-
# @param supported_features [FinchAPI::HRIS::
|
19
|
-
# @param supported_operations [FinchAPI::HRIS::SupportPerBenefitType]
|
20
|
-
|
21
|
-
# @see FinchAPI::HRIS::BenefitFeaturesAndOperations#supported_features
|
22
|
-
class SupportedFeatures < FinchAPI::Internal::Type::BaseModel
|
23
|
-
# @!attribute annual_maximum
|
24
|
-
# Whether the provider supports an annual maximum for this benefit.
|
25
|
-
#
|
26
|
-
# @return [Boolean, nil]
|
27
|
-
optional :annual_maximum, FinchAPI::Internal::Type::Boolean, nil?: true
|
28
|
-
|
29
|
-
# @!attribute catch_up
|
30
|
-
# Whether the provider supports catch up for this benefit. This field will only be
|
31
|
-
# true for retirement benefits.
|
32
|
-
#
|
33
|
-
# @return [Boolean, nil]
|
34
|
-
optional :catch_up, FinchAPI::Internal::Type::Boolean, nil?: true
|
35
|
-
|
36
|
-
# @!attribute company_contribution
|
37
|
-
# Supported contribution types. An empty array indicates contributions are not
|
38
|
-
# supported.
|
39
|
-
#
|
40
|
-
# @return [Array<Symbol, FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution, nil>, nil]
|
41
|
-
optional :company_contribution,
|
42
|
-
-> {
|
43
|
-
FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution,
|
44
|
-
nil?: true]
|
45
|
-
},
|
46
|
-
nil?: true
|
47
|
-
|
48
|
-
# @!attribute description
|
49
|
-
#
|
50
|
-
# @return [String, nil]
|
51
|
-
optional :description, String, nil?: true
|
52
|
-
|
53
|
-
# @!attribute employee_deduction
|
54
|
-
# Supported deduction types. An empty array indicates deductions are not
|
55
|
-
# supported.
|
56
|
-
#
|
57
|
-
# @return [Array<Symbol, FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction, nil>, nil]
|
58
|
-
optional :employee_deduction,
|
59
|
-
-> {
|
60
|
-
FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction,
|
61
|
-
nil?: true]
|
62
|
-
},
|
63
|
-
nil?: true
|
64
|
-
|
65
|
-
# @!attribute frequencies
|
66
|
-
# The list of frequencies supported by the provider for this benefit
|
67
|
-
#
|
68
|
-
# @return [Array<Symbol, FinchAPI::HRIS::BenefitFrequency, nil>, nil]
|
69
|
-
optional :frequencies,
|
70
|
-
-> {
|
71
|
-
FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::BenefitFrequency, nil?: true]
|
72
|
-
}
|
73
|
-
|
74
|
-
# @!attribute hsa_contribution_limit
|
75
|
-
# Whether the provider supports HSA contribution limits. Empty if this feature is
|
76
|
-
# not supported for the benefit. This array only has values for HSA benefits.
|
77
|
-
#
|
78
|
-
# @return [Array<Symbol, FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit, nil>, nil]
|
79
|
-
optional :hsa_contribution_limit,
|
80
|
-
-> {
|
81
|
-
FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit,
|
82
|
-
nil?: true]
|
83
|
-
},
|
84
|
-
nil?: true
|
85
|
-
|
86
|
-
# @!method initialize(annual_maximum: nil, catch_up: nil, company_contribution: nil, description: nil, employee_deduction: nil, frequencies: nil, hsa_contribution_limit: nil)
|
87
|
-
# Some parameter documentations has been truncated, see
|
88
|
-
# {FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures} for more
|
89
|
-
# details.
|
90
|
-
#
|
91
|
-
# @param annual_maximum [Boolean, nil] Whether the provider supports an annual maximum for this benefit.
|
92
|
-
#
|
93
|
-
# @param catch_up [Boolean, nil] Whether the provider supports catch up for this benefit. This field will only be
|
94
|
-
#
|
95
|
-
# @param company_contribution [Array<Symbol, FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution, nil>, nil] Supported contribution types. An empty array indicates contributions are not sup
|
96
|
-
#
|
97
|
-
# @param description [String, nil]
|
98
|
-
#
|
99
|
-
# @param employee_deduction [Array<Symbol, FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction, nil>, nil] Supported deduction types. An empty array indicates deductions are not supported
|
100
|
-
#
|
101
|
-
# @param frequencies [Array<Symbol, FinchAPI::HRIS::BenefitFrequency, nil>] The list of frequencies supported by the provider for this benefit
|
102
|
-
#
|
103
|
-
# @param hsa_contribution_limit [Array<Symbol, FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit, nil>, nil] Whether the provider supports HSA contribution limits. Empty if this feature is
|
104
|
-
|
105
|
-
module CompanyContribution
|
106
|
-
extend FinchAPI::Internal::Type::Enum
|
107
|
-
|
108
|
-
FIXED = :fixed
|
109
|
-
PERCENT = :percent
|
110
|
-
|
111
|
-
# @!method self.values
|
112
|
-
# @return [Array<Symbol>]
|
113
|
-
end
|
114
|
-
|
115
|
-
module EmployeeDeduction
|
116
|
-
extend FinchAPI::Internal::Type::Enum
|
117
|
-
|
118
|
-
FIXED = :fixed
|
119
|
-
PERCENT = :percent
|
120
|
-
|
121
|
-
# @!method self.values
|
122
|
-
# @return [Array<Symbol>]
|
123
|
-
end
|
124
|
-
|
125
|
-
module HsaContributionLimit
|
126
|
-
extend FinchAPI::Internal::Type::Enum
|
127
|
-
|
128
|
-
INDIVIDUAL = :individual
|
129
|
-
FAMILY = :family
|
130
|
-
|
131
|
-
# @!method self.values
|
132
|
-
# @return [Array<Symbol>]
|
133
|
-
end
|
134
|
-
end
|
18
|
+
# @param supported_features [FinchAPI::Models::HRIS::SupportedBenefit]
|
19
|
+
# @param supported_operations [FinchAPI::Models::HRIS::SupportPerBenefitType]
|
135
20
|
end
|
136
21
|
end
|
137
22
|
end
|
@@ -7,25 +7,25 @@ module FinchAPI
|
|
7
7
|
module BenefitType
|
8
8
|
extend FinchAPI::Internal::Type::Enum
|
9
9
|
|
10
|
+
BENEFIT_TYPE_457 = :"457"
|
10
11
|
BENEFIT_TYPE_401K = :"401k"
|
11
12
|
BENEFIT_TYPE_401K_ROTH = :"401k_roth"
|
12
13
|
BENEFIT_TYPE_401K_LOAN = :"401k_loan"
|
13
14
|
BENEFIT_TYPE_403B = :"403b"
|
14
15
|
BENEFIT_TYPE_403B_ROTH = :"403b_roth"
|
15
|
-
BENEFIT_TYPE_457 = :"457"
|
16
16
|
BENEFIT_TYPE_457_ROTH = :"457_roth"
|
17
|
-
S125_MEDICAL = :s125_medical
|
18
|
-
S125_DENTAL = :s125_dental
|
19
|
-
S125_VISION = :s125_vision
|
20
|
-
HSA_PRE = :hsa_pre
|
21
|
-
HSA_POST = :hsa_post
|
22
|
-
FSA_MEDICAL = :fsa_medical
|
23
|
-
FSA_DEPENDENT_CARE = :fsa_dependent_care
|
24
|
-
SIMPLE_IRA = :simple_ira
|
25
|
-
SIMPLE = :simple
|
26
17
|
COMMUTER = :commuter
|
27
18
|
CUSTOM_POST_TAX = :custom_post_tax
|
28
19
|
CUSTOM_PRE_TAX = :custom_pre_tax
|
20
|
+
FSA_DEPENDENT_CARE = :fsa_dependent_care
|
21
|
+
FSA_MEDICAL = :fsa_medical
|
22
|
+
HSA_POST = :hsa_post
|
23
|
+
HSA_PRE = :hsa_pre
|
24
|
+
S125_DENTAL = :s125_dental
|
25
|
+
S125_MEDICAL = :s125_medical
|
26
|
+
S125_VISION = :s125_vision
|
27
|
+
SIMPLE = :simple
|
28
|
+
SIMPLE_IRA = :simple_ira
|
29
29
|
|
30
30
|
# @!method self.values
|
31
31
|
# @return [Array<Symbol>]
|
@@ -8,7 +8,7 @@ module FinchAPI
|
|
8
8
|
class IndividualBenefit < FinchAPI::Internal::Type::BaseModel
|
9
9
|
# @!attribute body
|
10
10
|
#
|
11
|
-
# @return [FinchAPI::HRIS::Benefits::IndividualBenefit::Body, nil]
|
11
|
+
# @return [FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body, nil]
|
12
12
|
optional :body, -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body }
|
13
13
|
|
14
14
|
# @!attribute code
|
@@ -22,11 +22,11 @@ module FinchAPI
|
|
22
22
|
optional :individual_id, String
|
23
23
|
|
24
24
|
# @!method initialize(body: nil, code: nil, individual_id: nil)
|
25
|
-
# @param body [FinchAPI::HRIS::Benefits::IndividualBenefit::Body]
|
25
|
+
# @param body [FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body]
|
26
26
|
# @param code [Integer]
|
27
27
|
# @param individual_id [String]
|
28
28
|
|
29
|
-
# @see FinchAPI::HRIS::Benefits::IndividualBenefit#body
|
29
|
+
# @see FinchAPI::Models::HRIS::Benefits::IndividualBenefit#body
|
30
30
|
class Body < FinchAPI::Internal::Type::BaseModel
|
31
31
|
# @!attribute annual_maximum
|
32
32
|
# If the benefit supports annual maximum, the amount in cents for this individual.
|
@@ -43,39 +43,39 @@ module FinchAPI
|
|
43
43
|
|
44
44
|
# @!attribute company_contribution
|
45
45
|
#
|
46
|
-
# @return [FinchAPI::HRIS::BenefitContribution, nil]
|
46
|
+
# @return [FinchAPI::Models::HRIS::BenefitContribution, nil]
|
47
47
|
optional :company_contribution, -> { FinchAPI::HRIS::BenefitContribution }, nil?: true
|
48
48
|
|
49
49
|
# @!attribute employee_deduction
|
50
50
|
#
|
51
|
-
# @return [FinchAPI::HRIS::BenefitContribution, nil]
|
51
|
+
# @return [FinchAPI::Models::HRIS::BenefitContribution, nil]
|
52
52
|
optional :employee_deduction, -> { FinchAPI::HRIS::BenefitContribution }, nil?: true
|
53
53
|
|
54
54
|
# @!attribute hsa_contribution_limit
|
55
55
|
# Type for HSA contribution limit if the benefit is a HSA.
|
56
56
|
#
|
57
|
-
# @return [Symbol, FinchAPI::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit, nil]
|
57
|
+
# @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit, nil]
|
58
58
|
optional :hsa_contribution_limit,
|
59
59
|
enum: -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit },
|
60
60
|
nil?: true
|
61
61
|
|
62
62
|
# @!method initialize(annual_maximum: nil, catch_up: nil, company_contribution: nil, employee_deduction: nil, hsa_contribution_limit: nil)
|
63
63
|
# Some parameter documentations has been truncated, see
|
64
|
-
# {FinchAPI::HRIS::Benefits::IndividualBenefit::Body} for more details.
|
64
|
+
# {FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body} for more details.
|
65
65
|
#
|
66
66
|
# @param annual_maximum [Integer, nil] If the benefit supports annual maximum, the amount in cents for this individual.
|
67
67
|
#
|
68
68
|
# @param catch_up [Boolean, nil] If the benefit supports catch up (401k, 403b, etc.), whether catch up is enabled
|
69
69
|
#
|
70
|
-
# @param company_contribution [FinchAPI::HRIS::BenefitContribution, nil]
|
70
|
+
# @param company_contribution [FinchAPI::Models::HRIS::BenefitContribution, nil]
|
71
71
|
#
|
72
|
-
# @param employee_deduction [FinchAPI::HRIS::BenefitContribution, nil]
|
72
|
+
# @param employee_deduction [FinchAPI::Models::HRIS::BenefitContribution, nil]
|
73
73
|
#
|
74
|
-
# @param hsa_contribution_limit [Symbol, FinchAPI::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit, nil] Type for HSA contribution limit if the benefit is a HSA.
|
74
|
+
# @param hsa_contribution_limit [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit, nil] Type for HSA contribution limit if the benefit is a HSA.
|
75
75
|
|
76
76
|
# Type for HSA contribution limit if the benefit is a HSA.
|
77
77
|
#
|
78
|
-
# @see FinchAPI::HRIS::Benefits::IndividualBenefit::Body#hsa_contribution_limit
|
78
|
+
# @see FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body#hsa_contribution_limit
|
79
79
|
module HsaContributionLimit
|
80
80
|
extend FinchAPI::Internal::Type::Enum
|
81
81
|
|