finch-api 0.1.0.pre.alpha.13 → 0.1.0.pre.alpha.14
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 +38 -0
- data/README.md +6 -6
- data/lib/finch_api/file_part.rb +2 -2
- data/lib/finch_api/internal/individuals_page.rb +5 -5
- data/lib/finch_api/internal/page.rb +5 -5
- data/lib/finch_api/internal/responses_page.rb +2 -2
- data/lib/finch_api/internal/transport/base_client.rb +3 -3
- data/lib/finch_api/internal/type/base_model.rb +1 -9
- data/lib/finch_api/internal/type/enum.rb +4 -4
- data/lib/finch_api/internal/type/request_parameters.rb +6 -12
- data/lib/finch_api/internal/type/union.rb +2 -2
- data/lib/finch_api/internal/util.rb +21 -5
- data/lib/finch_api/models/account_update_event.rb +202 -148
- data/lib/finch_api/models/base_webhook_event.rb +1 -3
- data/lib/finch_api/models/company_event.rb +3 -3
- data/lib/finch_api/models/connect/session_new_params.rb +13 -14
- data/lib/finch_api/models/connect/session_reauthenticate_params.rb +5 -4
- data/lib/finch_api/models/create_access_token_response.rb +9 -12
- data/lib/finch_api/models/directory_event.rb +6 -6
- data/lib/finch_api/models/employment_event.rb +6 -6
- data/lib/finch_api/models/hris/benefit_contribution.rb +4 -4
- data/lib/finch_api/models/hris/benefit_create_params.rb +18 -17
- data/lib/finch_api/models/hris/benefit_features_and_operations.rb +32 -36
- data/lib/finch_api/models/hris/benefit_list_supported_benefits_response.rb +3 -7
- data/lib/finch_api/models/hris/benefits/individual_benefit.rb +15 -17
- data/lib/finch_api/models/hris/benefits/individual_enroll_many_params.rb +42 -33
- data/lib/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rb +0 -1
- data/lib/finch_api/models/hris/benefits_support.rb +36 -36
- data/lib/finch_api/models/hris/company/pay_statement_item/rule_create_params.rb +21 -16
- data/lib/finch_api/models/hris/company/pay_statement_item/rule_create_response.rb +0 -1
- data/lib/finch_api/models/hris/company/pay_statement_item/rule_delete_response.rb +0 -1
- data/lib/finch_api/models/hris/company/pay_statement_item/rule_list_response.rb +0 -1
- data/lib/finch_api/models/hris/company/pay_statement_item/rule_update_response.rb +0 -1
- data/lib/finch_api/models/hris/company/pay_statement_item_list_params.rb +5 -6
- data/lib/finch_api/models/hris/company/pay_statement_item_list_response.rb +0 -3
- data/lib/finch_api/models/hris/company.rb +35 -33
- data/lib/finch_api/models/hris/company_benefit.rb +19 -19
- data/lib/finch_api/models/hris/document_list_params.rb +5 -5
- data/lib/finch_api/models/hris/document_list_response.rb +6 -6
- data/lib/finch_api/models/hris/document_response.rb +5 -7
- data/lib/finch_api/models/hris/document_retreive_response.rb +3 -3
- data/lib/finch_api/models/hris/employment_data.rb +326 -258
- data/lib/finch_api/models/hris/employment_data_response.rb +8 -8
- data/lib/finch_api/models/hris/employment_retrieve_many_params.rb +6 -6
- data/lib/finch_api/models/hris/individual.rb +34 -31
- data/lib/finch_api/models/hris/individual_in_directory.rb +8 -8
- data/lib/finch_api/models/hris/individual_response.rb +3 -3
- data/lib/finch_api/models/hris/individual_retrieve_many_params.rb +8 -6
- data/lib/finch_api/models/hris/pay_statement.rb +105 -100
- data/lib/finch_api/models/hris/pay_statement_response.rb +3 -3
- data/lib/finch_api/models/hris/pay_statement_response_body.rb +6 -6
- data/lib/finch_api/models/hris/pay_statement_retrieve_many_params.rb +5 -3
- data/lib/finch_api/models/hris/payment.rb +22 -22
- data/lib/finch_api/models/hris/payment_list_params.rb +0 -2
- data/lib/finch_api/models/hris/support_per_benefit_type.rb +6 -6
- data/lib/finch_api/models/hris/supported_benefit.rb +22 -17
- data/lib/finch_api/models/hris/w42005.rb +16 -16
- data/lib/finch_api/models/hris/w42020.rb +13 -14
- data/lib/finch_api/models/income.rb +10 -11
- data/lib/finch_api/models/individual_event.rb +6 -6
- data/lib/finch_api/models/introspection.rb +31 -39
- data/lib/finch_api/models/job_completion_event.rb +6 -6
- data/lib/finch_api/models/jobs/automated_async_job.rb +13 -15
- data/lib/finch_api/models/jobs/automated_create_params.rb +6 -6
- data/lib/finch_api/models/jobs/automated_list_response.rb +3 -4
- data/lib/finch_api/models/jobs/manual_async_job.rb +4 -4
- data/lib/finch_api/models/operation_support_matrix.rb +13 -13
- data/lib/finch_api/models/pay_statement_event.rb +6 -6
- data/lib/finch_api/models/payment_event.rb +6 -6
- data/lib/finch_api/models/provider.rb +178 -140
- data/lib/finch_api/models/request_forwarding_forward_params.rb +0 -5
- data/lib/finch_api/models/request_forwarding_forward_response.rb +0 -8
- data/lib/finch_api/models/sandbox/company_update_params.rb +34 -33
- data/lib/finch_api/models/sandbox/company_update_response.rb +5 -5
- data/lib/finch_api/models/sandbox/connection_create_params.rb +5 -4
- data/lib/finch_api/models/sandbox/connections/account_create_params.rb +3 -4
- data/lib/finch_api/models/sandbox/connections/account_update_params.rb +3 -3
- data/lib/finch_api/models/sandbox/directory_create_params.rb +83 -77
- data/lib/finch_api/models/sandbox/employment_update_params.rb +37 -39
- data/lib/finch_api/models/sandbox/employment_update_response.rb +9 -12
- data/lib/finch_api/models/sandbox/individual_update_params.rb +28 -25
- data/lib/finch_api/models/sandbox/individual_update_response.rb +3 -5
- data/lib/finch_api/models/sandbox/job_create_params.rb +3 -3
- data/lib/finch_api/models/sandbox/jobs/configuration_retrieve_response.rb +1 -1
- data/lib/finch_api/models/sandbox/jobs/sandbox_job_configuration.rb +8 -8
- data/lib/finch_api/models/sandbox/payment_create_params.rb +124 -99
- data/lib/finch_api/models/webhook_event.rb +9 -9
- data/lib/finch_api/models.rb +65 -0
- data/lib/finch_api/resources/access_tokens.rb +3 -3
- data/lib/finch_api/resources/account.rb +4 -4
- data/lib/finch_api/resources/connect/sessions.rb +6 -8
- data/lib/finch_api/resources/hris/benefits/individuals.rb +10 -12
- data/lib/finch_api/resources/hris/benefits.rb +13 -14
- data/lib/finch_api/resources/hris/company/pay_statement_item/rules.rb +5 -7
- data/lib/finch_api/resources/hris/company/pay_statement_item.rb +2 -5
- data/lib/finch_api/resources/hris/company.rb +2 -2
- data/lib/finch_api/resources/hris/directory.rb +3 -3
- data/lib/finch_api/resources/hris/documents.rb +3 -5
- data/lib/finch_api/resources/hris/employments.rb +4 -4
- data/lib/finch_api/resources/hris/individuals.rb +5 -5
- data/lib/finch_api/resources/hris/pay_statements.rb +4 -4
- data/lib/finch_api/resources/hris/payments.rb +3 -5
- data/lib/finch_api/resources/jobs/automated.rb +6 -6
- data/lib/finch_api/resources/jobs/manual.rb +2 -2
- data/lib/finch_api/resources/payroll/pay_groups.rb +1 -1
- data/lib/finch_api/resources/providers.rb +2 -2
- data/lib/finch_api/resources/request_forwarding.rb +1 -6
- data/lib/finch_api/resources/sandbox/company.rb +5 -6
- data/lib/finch_api/resources/sandbox/connections/accounts.rb +4 -5
- data/lib/finch_api/resources/sandbox/connections.rb +2 -3
- data/lib/finch_api/resources/sandbox/directory.rb +2 -3
- data/lib/finch_api/resources/sandbox/employment.rb +9 -11
- data/lib/finch_api/resources/sandbox/individual.rb +6 -8
- data/lib/finch_api/resources/sandbox/jobs/configuration.rb +7 -7
- data/lib/finch_api/resources/sandbox/jobs.rb +2 -2
- data/lib/finch_api/resources/sandbox/payment.rb +2 -2
- data/lib/finch_api/version.rb +1 -1
- data/lib/finch_api.rb +1 -0
- data/rbi/finch_api/client.rbi +9 -6
- data/rbi/finch_api/errors.rbi +34 -15
- data/rbi/finch_api/file_part.rbi +9 -6
- data/rbi/finch_api/internal/individuals_page.rbi +3 -2
- data/rbi/finch_api/internal/page.rbi +3 -2
- data/rbi/finch_api/internal/responses_page.rbi +2 -1
- data/rbi/finch_api/internal/single_page.rbi +8 -4
- data/rbi/finch_api/internal/transport/base_client.rbi +140 -75
- data/rbi/finch_api/internal/transport/pooled_net_requester.rbi +26 -12
- data/rbi/finch_api/internal/type/array_of.rbi +34 -24
- data/rbi/finch_api/internal/type/base_model.rbi +129 -69
- data/rbi/finch_api/internal/type/base_page.rbi +13 -8
- data/rbi/finch_api/internal/type/boolean.rbi +16 -14
- data/rbi/finch_api/internal/type/converter.rbi +68 -28
- data/rbi/finch_api/internal/type/enum.rbi +27 -15
- data/rbi/finch_api/internal/type/file_input.rbi +8 -4
- data/rbi/finch_api/internal/type/hash_of.rbi +34 -24
- data/rbi/finch_api/internal/type/request_parameters.rbi +12 -4
- data/rbi/finch_api/internal/type/union.rbi +54 -19
- data/rbi/finch_api/internal/type/unknown.rbi +16 -6
- data/rbi/finch_api/internal/util.rbi +215 -86
- data/rbi/finch_api/models/access_token_create_params.rbi +23 -15
- data/rbi/finch_api/models/account_disconnect_params.rbi +10 -5
- data/rbi/finch_api/models/account_introspect_params.rbi +10 -5
- data/rbi/finch_api/models/account_update_event.rbi +968 -731
- data/rbi/finch_api/models/base_webhook_event.rbi +19 -4
- data/rbi/finch_api/models/company_event.rbi +34 -18
- data/rbi/finch_api/models/connect/session_new_params.rbi +202 -69
- data/rbi/finch_api/models/connect/session_new_response.rbi +14 -4
- data/rbi/finch_api/models/connect/session_reauthenticate_params.rbi +97 -30
- data/rbi/finch_api/models/connect/session_reauthenticate_response.rbi +14 -4
- data/rbi/finch_api/models/connection_status_type.rbi +19 -9
- data/rbi/finch_api/models/create_access_token_response.rbi +86 -34
- data/rbi/finch_api/models/directory_event.rbi +53 -26
- data/rbi/finch_api/models/disconnect_response.rbi +8 -3
- data/rbi/finch_api/models/employment_event.rbi +53 -26
- data/rbi/finch_api/models/hris/benefit_contribution.rbi +45 -15
- data/rbi/finch_api/models/hris/benefit_create_params.rbi +121 -56
- data/rbi/finch_api/models/hris/benefit_features_and_operations.rbi +145 -99
- data/rbi/finch_api/models/hris/benefit_frequency.rbi +15 -6
- data/rbi/finch_api/models/hris/benefit_list_params.rbi +11 -5
- data/rbi/finch_api/models/hris/benefit_list_supported_benefits_params.rbi +11 -5
- data/rbi/finch_api/models/hris/benefit_list_supported_benefits_response.rbi +126 -50
- data/rbi/finch_api/models/hris/benefit_retrieve_params.rbi +11 -5
- data/rbi/finch_api/models/hris/benefit_type.rbi +41 -22
- data/rbi/finch_api/models/hris/benefit_update_params.rbi +15 -9
- data/rbi/finch_api/models/hris/benefits/enrolled_individual_benefit_response.rbi +8 -3
- data/rbi/finch_api/models/hris/benefits/individual_benefit.rbi +82 -49
- data/rbi/finch_api/models/hris/benefits/individual_enroll_many_params.rbi +188 -153
- data/rbi/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbi +13 -5
- data/rbi/finch_api/models/hris/benefits/individual_enrolled_ids_response.rbi +19 -4
- data/rbi/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi +18 -6
- data/rbi/finch_api/models/hris/benefits/individual_unenroll_many_params.rbi +16 -6
- data/rbi/finch_api/models/hris/benefits/unenrolled_individual_benefit_response.rbi +8 -3
- data/rbi/finch_api/models/hris/benefits_support.rbi +106 -82
- data/rbi/finch_api/models/hris/company/pay_statement_item/rule_create_params.rbi +126 -82
- data/rbi/finch_api/models/hris/company/pay_statement_item/rule_create_response.rbi +125 -81
- data/rbi/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbi +13 -5
- data/rbi/finch_api/models/hris/company/pay_statement_item/rule_delete_response.rbi +126 -82
- data/rbi/finch_api/models/hris/company/pay_statement_item/rule_list_params.rbi +13 -5
- data/rbi/finch_api/models/hris/company/pay_statement_item/rule_list_response.rbi +125 -81
- data/rbi/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbi +15 -6
- data/rbi/finch_api/models/hris/company/pay_statement_item/rule_update_response.rbi +125 -81
- data/rbi/finch_api/models/hris/company/pay_statement_item_list_params.rbi +60 -29
- data/rbi/finch_api/models/hris/company/pay_statement_item_list_response.rbi +83 -45
- data/rbi/finch_api/models/hris/company.rbi +258 -98
- data/rbi/finch_api/models/hris/company_benefit.rbi +122 -50
- data/rbi/finch_api/models/hris/company_retrieve_params.rbi +11 -5
- data/rbi/finch_api/models/hris/create_company_benefits_response.rbi +12 -4
- data/rbi/finch_api/models/hris/directory_list_individuals_params.rbi +19 -6
- data/rbi/finch_api/models/hris/directory_list_params.rbi +19 -6
- data/rbi/finch_api/models/hris/document_list_params.rbi +54 -23
- data/rbi/finch_api/models/hris/document_list_response.rbi +19 -11
- data/rbi/finch_api/models/hris/document_response.rbi +48 -22
- data/rbi/finch_api/models/hris/document_retreive_params.rbi +11 -5
- data/rbi/finch_api/models/hris/document_retreive_response.rbi +10 -2
- data/rbi/finch_api/models/hris/employment_data.rbi +616 -278
- data/rbi/finch_api/models/hris/employment_data_response.rbi +42 -23
- data/rbi/finch_api/models/hris/employment_retrieve_many_params.rbi +35 -17
- data/rbi/finch_api/models/hris/individual.rbi +302 -103
- data/rbi/finch_api/models/hris/individual_in_directory.rbi +60 -32
- data/rbi/finch_api/models/hris/individual_response.rbi +28 -18
- data/rbi/finch_api/models/hris/individual_retrieve_many_params.rbi +66 -33
- data/rbi/finch_api/models/hris/pay_statement.rbi +632 -252
- data/rbi/finch_api/models/hris/pay_statement_response.rbi +20 -9
- data/rbi/finch_api/models/hris/pay_statement_response_body.rbi +23 -15
- data/rbi/finch_api/models/hris/pay_statement_retrieve_many_params.rbi +46 -18
- data/rbi/finch_api/models/hris/payment.rbi +122 -61
- data/rbi/finch_api/models/hris/payment_list_params.rbi +17 -6
- data/rbi/finch_api/models/hris/support_per_benefit_type.rbi +24 -18
- data/rbi/finch_api/models/hris/supported_benefit.rbi +173 -40
- data/rbi/finch_api/models/hris/update_company_benefit_response.rbi +12 -4
- data/rbi/finch_api/models/hris/w42005.rbi +119 -52
- data/rbi/finch_api/models/hris/w42020.rbi +84 -47
- data/rbi/finch_api/models/income.rbi +36 -31
- data/rbi/finch_api/models/individual_event.rbi +53 -26
- data/rbi/finch_api/models/introspection.rbi +195 -99
- data/rbi/finch_api/models/job_completion_event.rbi +74 -30
- data/rbi/finch_api/models/jobs/automated_async_job.rbi +100 -44
- data/rbi/finch_api/models/jobs/automated_create_params.rbi +50 -26
- data/rbi/finch_api/models/jobs/automated_create_response.rbi +22 -11
- data/rbi/finch_api/models/jobs/automated_list_params.rbi +19 -6
- data/rbi/finch_api/models/jobs/automated_list_response.rbi +93 -45
- data/rbi/finch_api/models/jobs/automated_retrieve_params.rbi +11 -5
- data/rbi/finch_api/models/jobs/manual_async_job.rbi +46 -21
- data/rbi/finch_api/models/jobs/manual_retrieve_params.rbi +11 -5
- data/rbi/finch_api/models/location.rbi +20 -17
- data/rbi/finch_api/models/money.rbi +13 -4
- data/rbi/finch_api/models/operation_support.rbi +15 -7
- data/rbi/finch_api/models/operation_support_matrix.rbi +28 -25
- data/rbi/finch_api/models/paging.rbi +8 -3
- data/rbi/finch_api/models/pay_statement_event.rbi +60 -27
- data/rbi/finch_api/models/payment_event.rbi +59 -27
- data/rbi/finch_api/models/payroll/pay_group_list_params.rbi +20 -13
- data/rbi/finch_api/models/payroll/pay_group_list_response.rbi +94 -28
- data/rbi/finch_api/models/payroll/pay_group_retrieve_params.rbi +11 -5
- data/rbi/finch_api/models/payroll/pay_group_retrieve_response.rbi +83 -27
- data/rbi/finch_api/models/provider.rbi +1000 -711
- data/rbi/finch_api/models/provider_list_params.rbi +10 -5
- data/rbi/finch_api/models/request_forwarding_forward_params.rbi +19 -16
- data/rbi/finch_api/models/request_forwarding_forward_response.rbi +43 -32
- data/rbi/finch_api/models/sandbox/company_update_params.rbi +283 -110
- data/rbi/finch_api/models/sandbox/company_update_response.rbi +296 -112
- data/rbi/finch_api/models/sandbox/connection_create_params.rbi +61 -28
- data/rbi/finch_api/models/sandbox/connection_create_response.rbi +58 -27
- data/rbi/finch_api/models/sandbox/connections/account_create_params.rbi +45 -30
- data/rbi/finch_api/models/sandbox/connections/account_create_response.rbi +41 -24
- data/rbi/finch_api/models/sandbox/connections/account_update_params.rbi +22 -15
- data/rbi/finch_api/models/sandbox/connections/account_update_response.rbi +40 -23
- data/rbi/finch_api/models/sandbox/directory_create_params.rbi +565 -221
- data/rbi/finch_api/models/sandbox/employment_update_params.rbi +296 -119
- data/rbi/finch_api/models/sandbox/employment_update_response.rbi +304 -121
- data/rbi/finch_api/models/sandbox/individual_update_params.rbi +275 -94
- data/rbi/finch_api/models/sandbox/individual_update_response.rbi +276 -93
- data/rbi/finch_api/models/sandbox/job_create_params.rbi +34 -15
- data/rbi/finch_api/models/sandbox/job_create_response.rbi +22 -11
- data/rbi/finch_api/models/sandbox/jobs/configuration_retrieve_params.rbi +13 -5
- data/rbi/finch_api/models/sandbox/jobs/configuration_retrieve_response.rbi +3 -1
- data/rbi/finch_api/models/sandbox/jobs/configuration_update_params.rbi +13 -5
- data/rbi/finch_api/models/sandbox/jobs/sandbox_job_configuration.rbi +72 -29
- data/rbi/finch_api/models/sandbox/payment_create_params.rbi +658 -355
- data/rbi/finch_api/models/sandbox/payment_create_response.rbi +12 -4
- data/rbi/finch_api/models/webhook_event.rbi +15 -5
- data/rbi/finch_api/models.rbi +66 -0
- data/rbi/finch_api/request_options.rbi +15 -7
- data/rbi/finch_api/resources/access_tokens.rbi +12 -5
- data/rbi/finch_api/resources/account.rbi +16 -5
- data/rbi/finch_api/resources/connect/sessions.rbi +26 -13
- data/rbi/finch_api/resources/connect.rbi +2 -1
- data/rbi/finch_api/resources/hris/benefits/individuals.rbi +38 -19
- data/rbi/finch_api/resources/hris/benefits.rbi +39 -22
- data/rbi/finch_api/resources/hris/company/pay_statement_item/rules.rbi +40 -26
- data/rbi/finch_api/resources/hris/company/pay_statement_item.rbi +17 -6
- data/rbi/finch_api/resources/hris/company.rbi +9 -3
- data/rbi/finch_api/resources/hris/directory.rbi +14 -4
- data/rbi/finch_api/resources/hris/documents.rbi +15 -9
- data/rbi/finch_api/resources/hris/employments.rbi +14 -5
- data/rbi/finch_api/resources/hris/individuals.rbi +17 -8
- data/rbi/finch_api/resources/hris/pay_statements.rbi +14 -5
- data/rbi/finch_api/resources/hris/payments.rbi +10 -4
- data/rbi/finch_api/resources/hris.rbi +2 -1
- data/rbi/finch_api/resources/jobs/automated.rbi +23 -13
- data/rbi/finch_api/resources/jobs/manual.rbi +8 -4
- data/rbi/finch_api/resources/jobs.rbi +2 -1
- data/rbi/finch_api/resources/payroll/pay_groups.rbi +15 -7
- data/rbi/finch_api/resources/payroll.rbi +2 -1
- data/rbi/finch_api/resources/providers.rbi +7 -4
- data/rbi/finch_api/resources/request_forwarding.rbi +7 -5
- data/rbi/finch_api/resources/sandbox/company.rbi +25 -13
- data/rbi/finch_api/resources/sandbox/connections/accounts.rbi +16 -9
- data/rbi/finch_api/resources/sandbox/connections.rbi +9 -6
- data/rbi/finch_api/resources/sandbox/directory.rbi +9 -6
- data/rbi/finch_api/resources/sandbox/employment.rbi +31 -17
- data/rbi/finch_api/resources/sandbox/individual.rbi +30 -18
- data/rbi/finch_api/resources/sandbox/jobs/configuration.rbi +15 -10
- data/rbi/finch_api/resources/sandbox/jobs.rbi +8 -6
- data/rbi/finch_api/resources/sandbox/payment.rbi +15 -6
- data/rbi/finch_api/resources/sandbox.rbi +2 -1
- data/rbi/finch_api/resources/webhooks.rbi +2 -1
- data/sig/finch_api/internal/individuals_page.rbs +1 -1
- data/sig/finch_api/internal/page.rbs +1 -1
- data/sig/finch_api/internal/type/request_parameters.rbs +3 -1
- data/sig/finch_api/internal/util.rbs +2 -0
- data/sig/finch_api/models/access_token_create_params.rbs +0 -2
- data/sig/finch_api/models/account_disconnect_params.rbs +0 -2
- data/sig/finch_api/models/account_introspect_params.rbs +0 -2
- data/sig/finch_api/models/account_update_event.rbs +176 -244
- data/sig/finch_api/models/base_webhook_event.rbs +0 -2
- data/sig/finch_api/models/company_event.rbs +6 -8
- data/sig/finch_api/models/connect/session_new_params.rbs +11 -15
- data/sig/finch_api/models/connect/session_new_response.rbs +0 -2
- data/sig/finch_api/models/connect/session_reauthenticate_params.rbs +4 -6
- data/sig/finch_api/models/connect/session_reauthenticate_response.rbs +0 -2
- data/sig/finch_api/models/create_access_token_response.rbs +8 -10
- data/sig/finch_api/models/directory_event.rbs +11 -15
- data/sig/finch_api/models/disconnect_response.rbs +0 -2
- data/sig/finch_api/models/employment_event.rbs +11 -15
- data/sig/finch_api/models/hris/benefit_contribution.rbs +4 -9
- data/sig/finch_api/models/hris/benefit_create_params.rbs +14 -20
- data/sig/finch_api/models/hris/benefit_features_and_operations.rbs +22 -26
- data/sig/finch_api/models/hris/benefit_list_params.rbs +0 -2
- data/sig/finch_api/models/hris/benefit_list_supported_benefits_params.rbs +0 -2
- data/sig/finch_api/models/hris/benefit_list_supported_benefits_response.rbs +0 -2
- data/sig/finch_api/models/hris/benefit_retrieve_params.rbs +0 -2
- data/sig/finch_api/models/hris/benefit_update_params.rbs +0 -2
- data/sig/finch_api/models/hris/benefits/enrolled_individual_benefit_response.rbs +0 -2
- data/sig/finch_api/models/hris/benefits/individual_benefit.rbs +15 -19
- data/sig/finch_api/models/hris/benefits/individual_enroll_many_params.rbs +38 -48
- data/sig/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbs +0 -2
- data/sig/finch_api/models/hris/benefits/individual_enrolled_ids_response.rbs +0 -2
- data/sig/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbs +0 -2
- data/sig/finch_api/models/hris/benefits/individual_unenroll_many_params.rbs +0 -2
- data/sig/finch_api/models/hris/benefits/unenrolled_individual_benefit_response.rbs +0 -2
- data/sig/finch_api/models/hris/benefits_support.rbs +36 -38
- data/sig/finch_api/models/hris/company/pay_statement_item/rule_create_params.rbs +16 -22
- data/sig/finch_api/models/hris/company/pay_statement_item/rule_create_response.rbs +0 -6
- data/sig/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbs +0 -2
- data/sig/finch_api/models/hris/company/pay_statement_item/rule_delete_response.rbs +0 -6
- data/sig/finch_api/models/hris/company/pay_statement_item/rule_list_params.rbs +0 -2
- data/sig/finch_api/models/hris/company/pay_statement_item/rule_list_response.rbs +0 -6
- data/sig/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbs +0 -2
- data/sig/finch_api/models/hris/company/pay_statement_item/rule_update_response.rbs +0 -6
- data/sig/finch_api/models/hris/company/pay_statement_item_list_params.rbs +6 -8
- data/sig/finch_api/models/hris/company/pay_statement_item_list_response.rbs +0 -4
- data/sig/finch_api/models/hris/company.rbs +27 -37
- data/sig/finch_api/models/hris/company_benefit.rbs +14 -20
- data/sig/finch_api/models/hris/company_retrieve_params.rbs +0 -2
- data/sig/finch_api/models/hris/create_company_benefits_response.rbs +0 -2
- data/sig/finch_api/models/hris/directory_list_individuals_params.rbs +0 -2
- data/sig/finch_api/models/hris/directory_list_params.rbs +0 -2
- data/sig/finch_api/models/hris/document_list_params.rbs +6 -8
- data/sig/finch_api/models/hris/document_list_response.rbs +6 -8
- data/sig/finch_api/models/hris/document_response.rbs +6 -8
- data/sig/finch_api/models/hris/document_retreive_params.rbs +0 -2
- data/sig/finch_api/models/hris/document_retreive_response.rbs +2 -2
- data/sig/finch_api/models/hris/employment_data.rbs +177 -144
- data/sig/finch_api/models/hris/employment_data_response.rbs +7 -17
- data/sig/finch_api/models/hris/employment_retrieve_many_params.rbs +3 -7
- data/sig/finch_api/models/hris/individual.rbs +28 -36
- data/sig/finch_api/models/hris/individual_in_directory.rbs +6 -12
- data/sig/finch_api/models/hris/individual_response.rbs +0 -2
- data/sig/finch_api/models/hris/individual_retrieve_many_params.rbs +8 -14
- data/sig/finch_api/models/hris/pay_statement.rbs +82 -108
- data/sig/finch_api/models/hris/pay_statement_response.rbs +5 -7
- data/sig/finch_api/models/hris/pay_statement_response_body.rbs +9 -11
- data/sig/finch_api/models/hris/pay_statement_retrieve_many_params.rbs +3 -7
- data/sig/finch_api/models/hris/payment.rbs +22 -26
- data/sig/finch_api/models/hris/payment_list_params.rbs +0 -2
- data/sig/finch_api/models/hris/support_per_benefit_type.rbs +10 -12
- data/sig/finch_api/models/hris/supported_benefit.rbs +12 -14
- data/sig/finch_api/models/hris/update_company_benefit_response.rbs +0 -2
- data/sig/finch_api/models/hris/w42005.rbs +21 -25
- data/sig/finch_api/models/hris/w42020.rbs +15 -19
- data/sig/finch_api/models/income.rbs +7 -9
- data/sig/finch_api/models/individual_event.rbs +11 -15
- data/sig/finch_api/models/introspection.rbs +25 -33
- data/sig/finch_api/models/job_completion_event.rbs +11 -15
- data/sig/finch_api/models/jobs/automated_async_job.rbs +11 -15
- data/sig/finch_api/models/jobs/automated_create_params.rbs +3 -7
- data/sig/finch_api/models/jobs/automated_create_response.rbs +0 -2
- data/sig/finch_api/models/jobs/automated_list_params.rbs +0 -2
- data/sig/finch_api/models/jobs/automated_list_response.rbs +3 -11
- data/sig/finch_api/models/jobs/automated_retrieve_params.rbs +0 -2
- data/sig/finch_api/models/jobs/manual_async_job.rbs +4 -6
- data/sig/finch_api/models/jobs/manual_retrieve_params.rbs +0 -2
- data/sig/finch_api/models/location.rbs +0 -2
- data/sig/finch_api/models/money.rbs +0 -2
- data/sig/finch_api/models/operation_support_matrix.rbs +0 -2
- data/sig/finch_api/models/paging.rbs +0 -2
- data/sig/finch_api/models/pay_statement_event.rbs +11 -15
- data/sig/finch_api/models/payment_event.rbs +11 -15
- data/sig/finch_api/models/payroll/pay_group_list_params.rbs +0 -2
- data/sig/finch_api/models/payroll/pay_group_list_response.rbs +0 -2
- data/sig/finch_api/models/payroll/pay_group_retrieve_params.rbs +0 -2
- data/sig/finch_api/models/payroll/pay_group_retrieve_response.rbs +0 -2
- data/sig/finch_api/models/provider.rbs +167 -233
- data/sig/finch_api/models/provider_list_params.rbs +0 -2
- data/sig/finch_api/models/request_forwarding_forward_params.rbs +0 -2
- data/sig/finch_api/models/request_forwarding_forward_response.rbs +0 -4
- data/sig/finch_api/models/sandbox/company_update_params.rbs +27 -37
- data/sig/finch_api/models/sandbox/company_update_response.rbs +3 -13
- data/sig/finch_api/models/sandbox/connection_create_params.rbs +0 -2
- data/sig/finch_api/models/sandbox/connection_create_response.rbs +0 -2
- data/sig/finch_api/models/sandbox/connections/account_create_params.rbs +0 -2
- data/sig/finch_api/models/sandbox/connections/account_create_response.rbs +0 -2
- data/sig/finch_api/models/sandbox/connections/account_update_params.rbs +0 -2
- data/sig/finch_api/models/sandbox/connections/account_update_response.rbs +0 -2
- data/sig/finch_api/models/sandbox/directory_create_params.rbs +65 -83
- data/sig/finch_api/models/sandbox/employment_update_params.rbs +31 -41
- data/sig/finch_api/models/sandbox/employment_update_response.rbs +9 -19
- data/sig/finch_api/models/sandbox/individual_update_params.rbs +17 -23
- data/sig/finch_api/models/sandbox/individual_update_response.rbs +3 -9
- data/sig/finch_api/models/sandbox/job_create_params.rbs +0 -2
- data/sig/finch_api/models/sandbox/job_create_response.rbs +0 -2
- data/sig/finch_api/models/sandbox/jobs/configuration_retrieve_params.rbs +0 -2
- data/sig/finch_api/models/sandbox/jobs/configuration_retrieve_response.rbs +1 -1
- data/sig/finch_api/models/sandbox/jobs/configuration_update_params.rbs +0 -2
- data/sig/finch_api/models/sandbox/jobs/sandbox_job_configuration.rbs +8 -10
- data/sig/finch_api/models/sandbox/payment_create_params.rbs +87 -115
- data/sig/finch_api/models/sandbox/payment_create_response.rbs +0 -2
- data/sig/finch_api/models/webhook_event.rbs +9 -9
- data/sig/finch_api/models.rbs +63 -0
- data/sig/finch_api/request_options.rbs +1 -1
- data/sig/finch_api/resources/access_tokens.rbs +1 -1
- data/sig/finch_api/resources/account.rbs +2 -2
- data/sig/finch_api/resources/connect/sessions.rbs +3 -3
- data/sig/finch_api/resources/hris/benefits/individuals.rbs +4 -4
- data/sig/finch_api/resources/hris/benefits.rbs +5 -5
- data/sig/finch_api/resources/hris/company/pay_statement_item/rules.rbs +2 -2
- data/sig/finch_api/resources/hris/company/pay_statement_item.rbs +1 -1
- data/sig/finch_api/resources/hris/company.rbs +1 -1
- data/sig/finch_api/resources/hris/directory.rbs +1 -1
- data/sig/finch_api/resources/hris/documents.rbs +1 -1
- data/sig/finch_api/resources/hris/employments.rbs +2 -2
- data/sig/finch_api/resources/hris/individuals.rbs +3 -3
- data/sig/finch_api/resources/hris/pay_statements.rbs +2 -2
- data/sig/finch_api/resources/hris/payments.rbs +1 -1
- data/sig/finch_api/resources/jobs/automated.rbs +2 -2
- data/sig/finch_api/resources/jobs/manual.rbs +1 -1
- data/sig/finch_api/resources/providers.rbs +1 -1
- data/sig/finch_api/resources/sandbox/company.rbs +4 -4
- data/sig/finch_api/resources/sandbox/directory.rbs +1 -1
- data/sig/finch_api/resources/sandbox/employment.rbs +7 -7
- data/sig/finch_api/resources/sandbox/individual.rbs +3 -3
- data/sig/finch_api/resources/sandbox/jobs/configuration.rbs +1 -1
- data/sig/finch_api/resources/sandbox/payment.rbs +1 -1
- metadata +7 -4
@@ -6,17 +6,17 @@ module FinchAPI
|
|
6
6
|
class SupportPerBenefitType < FinchAPI::Internal::Type::BaseModel
|
7
7
|
# @!attribute company_benefits
|
8
8
|
#
|
9
|
-
# @return [FinchAPI::
|
10
|
-
optional :company_benefits, -> { FinchAPI::
|
9
|
+
# @return [FinchAPI::OperationSupportMatrix, nil]
|
10
|
+
optional :company_benefits, -> { FinchAPI::OperationSupportMatrix }
|
11
11
|
|
12
12
|
# @!attribute individual_benefits
|
13
13
|
#
|
14
|
-
# @return [FinchAPI::
|
15
|
-
optional :individual_benefits, -> { FinchAPI::
|
14
|
+
# @return [FinchAPI::OperationSupportMatrix, nil]
|
15
|
+
optional :individual_benefits, -> { FinchAPI::OperationSupportMatrix }
|
16
16
|
|
17
17
|
# @!method initialize(company_benefits: nil, individual_benefits: nil)
|
18
|
-
# @param company_benefits [FinchAPI::
|
19
|
-
# @param individual_benefits [FinchAPI::
|
18
|
+
# @param company_benefits [FinchAPI::OperationSupportMatrix]
|
19
|
+
# @param individual_benefits [FinchAPI::OperationSupportMatrix]
|
20
20
|
end
|
21
21
|
end
|
22
22
|
end
|
@@ -21,9 +21,12 @@ module FinchAPI
|
|
21
21
|
# Supported contribution types. An empty array indicates contributions are not
|
22
22
|
# supported.
|
23
23
|
#
|
24
|
-
# @return [Array<Symbol, FinchAPI::
|
24
|
+
# @return [Array<Symbol, FinchAPI::HRIS::SupportedBenefit::CompanyContribution, nil>, nil]
|
25
25
|
optional :company_contribution,
|
26
|
-
-> {
|
26
|
+
-> {
|
27
|
+
FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::SupportedBenefit::CompanyContribution,
|
28
|
+
nil?: true]
|
29
|
+
},
|
27
30
|
nil?: true
|
28
31
|
|
29
32
|
# @!attribute description
|
@@ -35,48 +38,50 @@ module FinchAPI
|
|
35
38
|
# Supported deduction types. An empty array indicates deductions are not
|
36
39
|
# supported.
|
37
40
|
#
|
38
|
-
# @return [Array<Symbol, FinchAPI::
|
41
|
+
# @return [Array<Symbol, FinchAPI::HRIS::SupportedBenefit::EmployeeDeduction, nil>, nil]
|
39
42
|
optional :employee_deduction,
|
40
|
-
-> {
|
43
|
+
-> {
|
44
|
+
FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::SupportedBenefit::EmployeeDeduction,
|
45
|
+
nil?: true]
|
46
|
+
},
|
41
47
|
nil?: true
|
42
48
|
|
43
49
|
# @!attribute frequencies
|
44
50
|
# The list of frequencies supported by the provider for this benefit
|
45
51
|
#
|
46
|
-
# @return [Array<Symbol, FinchAPI::
|
52
|
+
# @return [Array<Symbol, FinchAPI::HRIS::BenefitFrequency, nil>, nil]
|
47
53
|
optional :frequencies,
|
48
|
-
-> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::
|
54
|
+
-> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::BenefitFrequency, nil?: true] }
|
49
55
|
|
50
56
|
# @!attribute hsa_contribution_limit
|
51
57
|
# Whether the provider supports HSA contribution limits. Empty if this feature is
|
52
58
|
# not supported for the benefit. This array only has values for HSA benefits.
|
53
59
|
#
|
54
|
-
# @return [Array<Symbol, FinchAPI::
|
60
|
+
# @return [Array<Symbol, FinchAPI::HRIS::SupportedBenefit::HsaContributionLimit, nil>, nil]
|
55
61
|
optional :hsa_contribution_limit,
|
56
|
-
-> {
|
62
|
+
-> {
|
63
|
+
FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::SupportedBenefit::HsaContributionLimit,
|
64
|
+
nil?: true]
|
65
|
+
},
|
57
66
|
nil?: true
|
58
67
|
|
59
68
|
# @!method initialize(annual_maximum: nil, catch_up: nil, company_contribution: nil, description: nil, employee_deduction: nil, frequencies: nil, hsa_contribution_limit: nil)
|
60
69
|
# Some parameter documentations has been truncated, see
|
61
|
-
# {FinchAPI::
|
70
|
+
# {FinchAPI::HRIS::SupportedBenefit} for more details.
|
62
71
|
#
|
63
72
|
# @param annual_maximum [Boolean, nil] Whether the provider supports an annual maximum for this benefit.
|
64
73
|
#
|
65
74
|
# @param catch_up [Boolean, nil] Whether the provider supports catch up for this benefit. This field will only be
|
66
|
-
# ...
|
67
75
|
#
|
68
|
-
# @param company_contribution [Array<Symbol, FinchAPI::
|
69
|
-
# ...
|
76
|
+
# @param company_contribution [Array<Symbol, FinchAPI::HRIS::SupportedBenefit::CompanyContribution, nil>, nil] Supported contribution types. An empty array indicates contributions are not sup
|
70
77
|
#
|
71
78
|
# @param description [String, nil]
|
72
79
|
#
|
73
|
-
# @param employee_deduction [Array<Symbol, FinchAPI::
|
74
|
-
# ...
|
80
|
+
# @param employee_deduction [Array<Symbol, FinchAPI::HRIS::SupportedBenefit::EmployeeDeduction, nil>, nil] Supported deduction types. An empty array indicates deductions are not supported
|
75
81
|
#
|
76
|
-
# @param frequencies [Array<Symbol, FinchAPI::
|
82
|
+
# @param frequencies [Array<Symbol, FinchAPI::HRIS::BenefitFrequency, nil>] The list of frequencies supported by the provider for this benefit
|
77
83
|
#
|
78
|
-
# @param hsa_contribution_limit [Array<Symbol, FinchAPI::
|
79
|
-
# ...
|
84
|
+
# @param hsa_contribution_limit [Array<Symbol, FinchAPI::HRIS::SupportedBenefit::HsaContributionLimit, nil>, nil] Whether the provider supports HSA contribution limits. Empty if this feature is
|
80
85
|
|
81
86
|
module CompanyContribution
|
82
87
|
extend FinchAPI::Internal::Type::Enum
|
@@ -7,14 +7,14 @@ module FinchAPI
|
|
7
7
|
# @!attribute data
|
8
8
|
# Detailed information specific to the 2005 W4 form.
|
9
9
|
#
|
10
|
-
# @return [FinchAPI::
|
11
|
-
optional :data, -> { FinchAPI::
|
10
|
+
# @return [FinchAPI::HRIS::W42005::Data, nil]
|
11
|
+
optional :data, -> { FinchAPI::HRIS::W42005::Data }
|
12
12
|
|
13
13
|
# @!attribute type
|
14
14
|
# Specifies the form type, indicating that this document is a 2005 W4 form.
|
15
15
|
#
|
16
|
-
# @return [Symbol, FinchAPI::
|
17
|
-
optional :type, enum: -> { FinchAPI::
|
16
|
+
# @return [Symbol, FinchAPI::HRIS::W42005::Type, nil]
|
17
|
+
optional :type, enum: -> { FinchAPI::HRIS::W42005::Type }
|
18
18
|
|
19
19
|
# @!attribute year
|
20
20
|
# The tax year this W4 document applies to.
|
@@ -26,13 +26,13 @@ module FinchAPI
|
|
26
26
|
# A 2005 version of the W-4 tax form containing information on an individual's
|
27
27
|
# filing status, dependents, and withholding details.
|
28
28
|
#
|
29
|
-
# @param data [FinchAPI::
|
29
|
+
# @param data [FinchAPI::HRIS::W42005::Data] Detailed information specific to the 2005 W4 form.
|
30
30
|
#
|
31
|
-
# @param type [Symbol, FinchAPI::
|
31
|
+
# @param type [Symbol, FinchAPI::HRIS::W42005::Type] Specifies the form type, indicating that this document is a 2005 W4 form.
|
32
32
|
#
|
33
33
|
# @param year [Float, nil] The tax year this W4 document applies to.
|
34
34
|
|
35
|
-
# @see FinchAPI::
|
35
|
+
# @see FinchAPI::HRIS::W42005#data
|
36
36
|
class Data < FinchAPI::Internal::Type::BaseModel
|
37
37
|
# @!attribute additional_withholding
|
38
38
|
# Additional withholding amount (in cents).
|
@@ -43,14 +43,14 @@ module FinchAPI
|
|
43
43
|
# @!attribute exemption
|
44
44
|
# Indicates exemption status from federal tax withholding.
|
45
45
|
#
|
46
|
-
# @return [Symbol, FinchAPI::
|
47
|
-
optional :exemption, enum: -> { FinchAPI::
|
46
|
+
# @return [Symbol, FinchAPI::HRIS::W42005::Data::Exemption, nil]
|
47
|
+
optional :exemption, enum: -> { FinchAPI::HRIS::W42005::Data::Exemption }
|
48
48
|
|
49
49
|
# @!attribute filing_status
|
50
50
|
# The individual's filing status for tax purposes.
|
51
51
|
#
|
52
|
-
# @return [Symbol, FinchAPI::
|
53
|
-
optional :filing_status, enum: -> { FinchAPI::
|
52
|
+
# @return [Symbol, FinchAPI::HRIS::W42005::Data::FilingStatus, nil]
|
53
|
+
optional :filing_status, enum: -> { FinchAPI::HRIS::W42005::Data::FilingStatus }, nil?: true
|
54
54
|
|
55
55
|
# @!attribute individual_id
|
56
56
|
# The unique identifier for the individual associated with this 2005 W4 form.
|
@@ -69,9 +69,9 @@ module FinchAPI
|
|
69
69
|
#
|
70
70
|
# @param additional_withholding [Integer, nil] Additional withholding amount (in cents).
|
71
71
|
#
|
72
|
-
# @param exemption [Symbol, FinchAPI::
|
72
|
+
# @param exemption [Symbol, FinchAPI::HRIS::W42005::Data::Exemption] Indicates exemption status from federal tax withholding.
|
73
73
|
#
|
74
|
-
# @param filing_status [Symbol, FinchAPI::
|
74
|
+
# @param filing_status [Symbol, FinchAPI::HRIS::W42005::Data::FilingStatus, nil] The individual's filing status for tax purposes.
|
75
75
|
#
|
76
76
|
# @param individual_id [String] The unique identifier for the individual associated with this 2005 W4 form.
|
77
77
|
#
|
@@ -79,7 +79,7 @@ module FinchAPI
|
|
79
79
|
|
80
80
|
# Indicates exemption status from federal tax withholding.
|
81
81
|
#
|
82
|
-
# @see FinchAPI::
|
82
|
+
# @see FinchAPI::HRIS::W42005::Data#exemption
|
83
83
|
module Exemption
|
84
84
|
extend FinchAPI::Internal::Type::Enum
|
85
85
|
|
@@ -92,7 +92,7 @@ module FinchAPI
|
|
92
92
|
|
93
93
|
# The individual's filing status for tax purposes.
|
94
94
|
#
|
95
|
-
# @see FinchAPI::
|
95
|
+
# @see FinchAPI::HRIS::W42005::Data#filing_status
|
96
96
|
module FilingStatus
|
97
97
|
extend FinchAPI::Internal::Type::Enum
|
98
98
|
|
@@ -107,7 +107,7 @@ module FinchAPI
|
|
107
107
|
|
108
108
|
# Specifies the form type, indicating that this document is a 2005 W4 form.
|
109
109
|
#
|
110
|
-
# @see FinchAPI::
|
110
|
+
# @see FinchAPI::HRIS::W42005#type
|
111
111
|
module Type
|
112
112
|
extend FinchAPI::Internal::Type::Enum
|
113
113
|
|
@@ -7,14 +7,14 @@ module FinchAPI
|
|
7
7
|
# @!attribute data
|
8
8
|
# Detailed information specific to the 2020 W4 form.
|
9
9
|
#
|
10
|
-
# @return [FinchAPI::
|
11
|
-
optional :data, -> { FinchAPI::
|
10
|
+
# @return [FinchAPI::HRIS::W42020::Data, nil]
|
11
|
+
optional :data, -> { FinchAPI::HRIS::W42020::Data }
|
12
12
|
|
13
13
|
# @!attribute type
|
14
14
|
# Specifies the form type, indicating that this document is a 2020 W4 form.
|
15
15
|
#
|
16
|
-
# @return [Symbol, FinchAPI::
|
17
|
-
optional :type, enum: -> { FinchAPI::
|
16
|
+
# @return [Symbol, FinchAPI::HRIS::W42020::Type, nil]
|
17
|
+
optional :type, enum: -> { FinchAPI::HRIS::W42020::Type }
|
18
18
|
|
19
19
|
# @!attribute year
|
20
20
|
# The tax year this W4 document applies to.
|
@@ -26,13 +26,13 @@ module FinchAPI
|
|
26
26
|
# A 2020 version of the W-4 tax form containing information on an individual's
|
27
27
|
# filing status, dependents, and withholding details.
|
28
28
|
#
|
29
|
-
# @param data [FinchAPI::
|
29
|
+
# @param data [FinchAPI::HRIS::W42020::Data] Detailed information specific to the 2020 W4 form.
|
30
30
|
#
|
31
|
-
# @param type [Symbol, FinchAPI::
|
31
|
+
# @param type [Symbol, FinchAPI::HRIS::W42020::Type] Specifies the form type, indicating that this document is a 2020 W4 form.
|
32
32
|
#
|
33
33
|
# @param year [Float, nil] The tax year this W4 document applies to.
|
34
34
|
|
35
|
-
# @see FinchAPI::
|
35
|
+
# @see FinchAPI::HRIS::W42020#data
|
36
36
|
class Data < FinchAPI::Internal::Type::BaseModel
|
37
37
|
# @!attribute amount_for_other_dependents
|
38
38
|
# Amount claimed for dependents other than qualifying children under 17 (in
|
@@ -62,8 +62,8 @@ module FinchAPI
|
|
62
62
|
# @!attribute filing_status
|
63
63
|
# The individual's filing status for tax purposes.
|
64
64
|
#
|
65
|
-
# @return [Symbol, FinchAPI::
|
66
|
-
optional :filing_status, enum: -> { FinchAPI::
|
65
|
+
# @return [Symbol, FinchAPI::HRIS::W42020::Data::FilingStatus, nil]
|
66
|
+
optional :filing_status, enum: -> { FinchAPI::HRIS::W42020::Data::FilingStatus }, nil?: true
|
67
67
|
|
68
68
|
# @!attribute individual_id
|
69
69
|
# The unique identifier for the individual associated with this document.
|
@@ -85,12 +85,11 @@ module FinchAPI
|
|
85
85
|
|
86
86
|
# @!method initialize(amount_for_other_dependents: nil, amount_for_qualifying_children_under_17: nil, deductions: nil, extra_withholding: nil, filing_status: nil, individual_id: nil, other_income: nil, total_claim_dependent_and_other_credits: nil)
|
87
87
|
# Some parameter documentations has been truncated, see
|
88
|
-
# {FinchAPI::
|
88
|
+
# {FinchAPI::HRIS::W42020::Data} for more details.
|
89
89
|
#
|
90
90
|
# Detailed information specific to the 2020 W4 form.
|
91
91
|
#
|
92
92
|
# @param amount_for_other_dependents [Integer, nil] Amount claimed for dependents other than qualifying children under 17 (in cents)
|
93
|
-
# ...
|
94
93
|
#
|
95
94
|
# @param amount_for_qualifying_children_under_17 [Integer, nil] Amount claimed for dependents under 17 years old (in cents).
|
96
95
|
#
|
@@ -98,7 +97,7 @@ module FinchAPI
|
|
98
97
|
#
|
99
98
|
# @param extra_withholding [Integer, nil] Additional withholding amount (in cents).
|
100
99
|
#
|
101
|
-
# @param filing_status [Symbol, FinchAPI::
|
100
|
+
# @param filing_status [Symbol, FinchAPI::HRIS::W42020::Data::FilingStatus, nil] The individual's filing status for tax purposes.
|
102
101
|
#
|
103
102
|
# @param individual_id [String] The unique identifier for the individual associated with this document.
|
104
103
|
#
|
@@ -108,7 +107,7 @@ module FinchAPI
|
|
108
107
|
|
109
108
|
# The individual's filing status for tax purposes.
|
110
109
|
#
|
111
|
-
# @see FinchAPI::
|
110
|
+
# @see FinchAPI::HRIS::W42020::Data#filing_status
|
112
111
|
module FilingStatus
|
113
112
|
extend FinchAPI::Internal::Type::Enum
|
114
113
|
|
@@ -124,7 +123,7 @@ module FinchAPI
|
|
124
123
|
|
125
124
|
# Specifies the form type, indicating that this document is a 2020 W4 form.
|
126
125
|
#
|
127
|
-
# @see FinchAPI::
|
126
|
+
# @see FinchAPI::HRIS::W42020#type
|
128
127
|
module Type
|
129
128
|
extend FinchAPI::Internal::Type::Enum
|
130
129
|
|
@@ -7,30 +7,30 @@ module FinchAPI
|
|
7
7
|
# The income amount in cents.
|
8
8
|
#
|
9
9
|
# @return [Integer, nil]
|
10
|
-
|
10
|
+
required :amount, Integer, nil?: true
|
11
11
|
|
12
12
|
# @!attribute currency
|
13
13
|
# The currency code.
|
14
14
|
#
|
15
15
|
# @return [String, nil]
|
16
|
-
|
16
|
+
required :currency, String, nil?: true
|
17
17
|
|
18
18
|
# @!attribute effective_date
|
19
19
|
# The date the income amount went into effect.
|
20
20
|
#
|
21
21
|
# @return [String, nil]
|
22
|
-
|
22
|
+
required :effective_date, String, nil?: true
|
23
23
|
|
24
24
|
# @!attribute unit
|
25
25
|
# The income unit of payment. Options: `yearly`, `quarterly`, `monthly`,
|
26
26
|
# `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`.
|
27
27
|
#
|
28
|
-
# @return [Symbol, FinchAPI::
|
29
|
-
|
28
|
+
# @return [Symbol, FinchAPI::Income::Unit, nil]
|
29
|
+
required :unit, enum: -> { FinchAPI::Income::Unit }, nil?: true
|
30
30
|
|
31
|
-
# @!method initialize(amount
|
32
|
-
# Some parameter documentations has been truncated, see {FinchAPI::
|
33
|
-
#
|
31
|
+
# @!method initialize(amount:, currency:, effective_date:, unit:)
|
32
|
+
# Some parameter documentations has been truncated, see {FinchAPI::Income} for
|
33
|
+
# more details.
|
34
34
|
#
|
35
35
|
# The employee's income as reported by the provider. This may not always be
|
36
36
|
# annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc,
|
@@ -42,13 +42,12 @@ module FinchAPI
|
|
42
42
|
#
|
43
43
|
# @param effective_date [String, nil] The date the income amount went into effect.
|
44
44
|
#
|
45
|
-
# @param unit [Symbol, FinchAPI::
|
46
|
-
# ...
|
45
|
+
# @param unit [Symbol, FinchAPI::Income::Unit, nil] The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, `semi_mon
|
47
46
|
|
48
47
|
# The income unit of payment. Options: `yearly`, `quarterly`, `monthly`,
|
49
48
|
# `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`.
|
50
49
|
#
|
51
|
-
# @see FinchAPI::
|
50
|
+
# @see FinchAPI::Income#unit
|
52
51
|
module Unit
|
53
52
|
extend FinchAPI::Internal::Type::Enum
|
54
53
|
|
@@ -5,17 +5,17 @@ module FinchAPI
|
|
5
5
|
class IndividualEvent < FinchAPI::Models::BaseWebhookEvent
|
6
6
|
# @!attribute data
|
7
7
|
#
|
8
|
-
# @return [FinchAPI::
|
9
|
-
optional :data, -> { FinchAPI::
|
8
|
+
# @return [FinchAPI::IndividualEvent::Data, nil]
|
9
|
+
optional :data, -> { FinchAPI::IndividualEvent::Data }
|
10
10
|
|
11
11
|
# @!attribute event_type
|
12
12
|
#
|
13
|
-
# @return [Symbol, FinchAPI::
|
14
|
-
optional :event_type, enum: -> { FinchAPI::
|
13
|
+
# @return [Symbol, FinchAPI::IndividualEvent::EventType, nil]
|
14
|
+
optional :event_type, enum: -> { FinchAPI::IndividualEvent::EventType }
|
15
15
|
|
16
16
|
# @!method initialize(data: nil, event_type: nil)
|
17
|
-
# @param data [FinchAPI::
|
18
|
-
# @param event_type [Symbol, FinchAPI::
|
17
|
+
# @param data [FinchAPI::IndividualEvent::Data]
|
18
|
+
# @param event_type [Symbol, FinchAPI::IndividualEvent::EventType]
|
19
19
|
|
20
20
|
class Data < FinchAPI::Internal::Type::BaseModel
|
21
21
|
# @!attribute individual_id
|
@@ -21,9 +21,9 @@ module FinchAPI
|
|
21
21
|
|
22
22
|
# @!attribute authentication_methods
|
23
23
|
#
|
24
|
-
# @return [Array<FinchAPI::
|
24
|
+
# @return [Array<FinchAPI::Introspection::AuthenticationMethod>]
|
25
25
|
required :authentication_methods,
|
26
|
-
-> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::
|
26
|
+
-> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Introspection::AuthenticationMethod] }
|
27
27
|
|
28
28
|
# @!attribute client_id
|
29
29
|
# The client ID of the application associated with the `access_token`.
|
@@ -34,8 +34,8 @@ module FinchAPI
|
|
34
34
|
# @!attribute client_type
|
35
35
|
# The type of application associated with a token.
|
36
36
|
#
|
37
|
-
# @return [Symbol, FinchAPI::
|
38
|
-
required :client_type, enum: -> { FinchAPI::
|
37
|
+
# @return [Symbol, FinchAPI::Introspection::ClientType]
|
38
|
+
required :client_type, enum: -> { FinchAPI::Introspection::ClientType }
|
39
39
|
|
40
40
|
# @!attribute company_id
|
41
41
|
# @deprecated
|
@@ -54,8 +54,8 @@ module FinchAPI
|
|
54
54
|
|
55
55
|
# @!attribute connection_status
|
56
56
|
#
|
57
|
-
# @return [FinchAPI::
|
58
|
-
required :connection_status, -> { FinchAPI::
|
57
|
+
# @return [FinchAPI::Introspection::ConnectionStatus]
|
58
|
+
required :connection_status, -> { FinchAPI::Introspection::ConnectionStatus }
|
59
59
|
|
60
60
|
# @!attribute connection_type
|
61
61
|
# The type of the connection associated with the token.
|
@@ -63,8 +63,8 @@ module FinchAPI
|
|
63
63
|
# - `provider` - connection to an external provider
|
64
64
|
# - `finch` - finch-generated data.
|
65
65
|
#
|
66
|
-
# @return [Symbol, FinchAPI::
|
67
|
-
required :connection_type, enum: -> { FinchAPI::
|
66
|
+
# @return [Symbol, FinchAPI::Introspection::ConnectionType]
|
67
|
+
required :connection_type, enum: -> { FinchAPI::Introspection::ConnectionType }
|
68
68
|
|
69
69
|
# @!attribute customer_email
|
70
70
|
# The email of your customer you provided to Finch when a connect session was
|
@@ -123,43 +123,36 @@ module FinchAPI
|
|
123
123
|
required :username, String
|
124
124
|
|
125
125
|
# @!method initialize(id:, account_id:, authentication_methods:, client_id:, client_type:, company_id:, connection_id:, connection_status:, connection_type:, customer_email:, customer_id:, customer_name:, manual:, payroll_provider_id:, products:, provider_id:, username:)
|
126
|
-
# Some parameter documentations has been truncated, see
|
127
|
-
#
|
126
|
+
# Some parameter documentations has been truncated, see {FinchAPI::Introspection}
|
127
|
+
# for more details.
|
128
128
|
#
|
129
129
|
# @param id [String] The Finch UUID of the token being introspected.
|
130
130
|
#
|
131
131
|
# @param account_id [String] [DEPRECATED] Use `connection_id` to associate tokens with a Finch connection ins
|
132
|
-
# ...
|
133
132
|
#
|
134
|
-
# @param authentication_methods [Array<FinchAPI::
|
133
|
+
# @param authentication_methods [Array<FinchAPI::Introspection::AuthenticationMethod>]
|
135
134
|
#
|
136
135
|
# @param client_id [String] The client ID of the application associated with the `access_token`.
|
137
136
|
#
|
138
|
-
# @param client_type [Symbol, FinchAPI::
|
137
|
+
# @param client_type [Symbol, FinchAPI::Introspection::ClientType] The type of application associated with a token.
|
139
138
|
#
|
140
139
|
# @param company_id [String] [DEPRECATED] Use `connection_id` to associate tokens with a Finch connection ins
|
141
|
-
# ...
|
142
140
|
#
|
143
141
|
# @param connection_id [String] The Finch UUID of the connection associated with the `access_token`.
|
144
142
|
#
|
145
|
-
# @param connection_status [FinchAPI::
|
143
|
+
# @param connection_status [FinchAPI::Introspection::ConnectionStatus]
|
146
144
|
#
|
147
|
-
# @param connection_type [Symbol, FinchAPI::
|
145
|
+
# @param connection_type [Symbol, FinchAPI::Introspection::ConnectionType] The type of the connection associated with the token.
|
148
146
|
#
|
149
147
|
# @param customer_email [String, nil] The email of your customer you provided to Finch when a connect session was crea
|
150
|
-
# ...
|
151
148
|
#
|
152
149
|
# @param customer_id [String, nil] The ID of your customer you provided to Finch when a connect session was created
|
153
|
-
# ...
|
154
150
|
#
|
155
151
|
# @param customer_name [String, nil] The name of your customer you provided to Finch when a connect session was creat
|
156
|
-
# ...
|
157
152
|
#
|
158
153
|
# @param manual [Boolean] Whether the connection associated with the `access_token` uses the Assisted Conn
|
159
|
-
# ...
|
160
154
|
#
|
161
155
|
# @param payroll_provider_id [String] [DEPRECATED] Use `provider_id` to identify the provider instead of this payroll
|
162
|
-
# ...
|
163
156
|
#
|
164
157
|
# @param products [Array<String>] An array of the authorized products associated with the `access_token`.
|
165
158
|
#
|
@@ -170,9 +163,8 @@ module FinchAPI
|
|
170
163
|
class AuthenticationMethod < FinchAPI::Internal::Type::BaseModel
|
171
164
|
# @!attribute connection_status
|
172
165
|
#
|
173
|
-
# @return [FinchAPI::
|
174
|
-
optional :connection_status,
|
175
|
-
-> { FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus }
|
166
|
+
# @return [FinchAPI::Introspection::AuthenticationMethod::ConnectionStatus, nil]
|
167
|
+
optional :connection_status, -> { FinchAPI::Introspection::AuthenticationMethod::ConnectionStatus }
|
176
168
|
|
177
169
|
# @!attribute products
|
178
170
|
# An array of the authorized products associated with the `access_token`.
|
@@ -183,17 +175,17 @@ module FinchAPI
|
|
183
175
|
# @!attribute type
|
184
176
|
# The type of authentication method.
|
185
177
|
#
|
186
|
-
# @return [Symbol, FinchAPI::
|
187
|
-
optional :type, enum: -> { FinchAPI::
|
178
|
+
# @return [Symbol, FinchAPI::Introspection::AuthenticationMethod::Type, nil]
|
179
|
+
optional :type, enum: -> { FinchAPI::Introspection::AuthenticationMethod::Type }
|
188
180
|
|
189
181
|
# @!method initialize(connection_status: nil, products: nil, type: nil)
|
190
|
-
# @param connection_status [FinchAPI::
|
182
|
+
# @param connection_status [FinchAPI::Introspection::AuthenticationMethod::ConnectionStatus]
|
191
183
|
#
|
192
184
|
# @param products [Array<String>] An array of the authorized products associated with the `access_token`.
|
193
185
|
#
|
194
|
-
# @param type [Symbol, FinchAPI::
|
186
|
+
# @param type [Symbol, FinchAPI::Introspection::AuthenticationMethod::Type] The type of authentication method.
|
195
187
|
|
196
|
-
# @see FinchAPI::
|
188
|
+
# @see FinchAPI::Introspection::AuthenticationMethod#connection_status
|
197
189
|
class ConnectionStatus < FinchAPI::Internal::Type::BaseModel
|
198
190
|
# @!attribute message
|
199
191
|
#
|
@@ -202,17 +194,17 @@ module FinchAPI
|
|
202
194
|
|
203
195
|
# @!attribute status
|
204
196
|
#
|
205
|
-
# @return [Symbol, FinchAPI::
|
206
|
-
optional :status, enum: -> { FinchAPI::
|
197
|
+
# @return [Symbol, FinchAPI::ConnectionStatusType, nil]
|
198
|
+
optional :status, enum: -> { FinchAPI::ConnectionStatusType }
|
207
199
|
|
208
200
|
# @!method initialize(message: nil, status: nil)
|
209
201
|
# @param message [String]
|
210
|
-
# @param status [Symbol, FinchAPI::
|
202
|
+
# @param status [Symbol, FinchAPI::ConnectionStatusType]
|
211
203
|
end
|
212
204
|
|
213
205
|
# The type of authentication method.
|
214
206
|
#
|
215
|
-
# @see FinchAPI::
|
207
|
+
# @see FinchAPI::Introspection::AuthenticationMethod#type
|
216
208
|
module Type
|
217
209
|
extend FinchAPI::Internal::Type::Enum
|
218
210
|
|
@@ -229,7 +221,7 @@ module FinchAPI
|
|
229
221
|
|
230
222
|
# The type of application associated with a token.
|
231
223
|
#
|
232
|
-
# @see FinchAPI::
|
224
|
+
# @see FinchAPI::Introspection#client_type
|
233
225
|
module ClientType
|
234
226
|
extend FinchAPI::Internal::Type::Enum
|
235
227
|
|
@@ -241,7 +233,7 @@ module FinchAPI
|
|
241
233
|
# @return [Array<Symbol>]
|
242
234
|
end
|
243
235
|
|
244
|
-
# @see FinchAPI::
|
236
|
+
# @see FinchAPI::Introspection#connection_status
|
245
237
|
class ConnectionStatus < FinchAPI::Internal::Type::BaseModel
|
246
238
|
# @!attribute last_successful_sync
|
247
239
|
# The datetime when the connection was last successfully synced.
|
@@ -256,15 +248,15 @@ module FinchAPI
|
|
256
248
|
|
257
249
|
# @!attribute status
|
258
250
|
#
|
259
|
-
# @return [Symbol, FinchAPI::
|
260
|
-
optional :status, enum: -> { FinchAPI::
|
251
|
+
# @return [Symbol, FinchAPI::ConnectionStatusType, nil]
|
252
|
+
optional :status, enum: -> { FinchAPI::ConnectionStatusType }
|
261
253
|
|
262
254
|
# @!method initialize(last_successful_sync: nil, message: nil, status: nil)
|
263
255
|
# @param last_successful_sync [Time] The datetime when the connection was last successfully synced.
|
264
256
|
#
|
265
257
|
# @param message [String]
|
266
258
|
#
|
267
|
-
# @param status [Symbol, FinchAPI::
|
259
|
+
# @param status [Symbol, FinchAPI::ConnectionStatusType]
|
268
260
|
end
|
269
261
|
|
270
262
|
# The type of the connection associated with the token.
|
@@ -272,7 +264,7 @@ module FinchAPI
|
|
272
264
|
# - `provider` - connection to an external provider
|
273
265
|
# - `finch` - finch-generated data.
|
274
266
|
#
|
275
|
-
# @see FinchAPI::
|
267
|
+
# @see FinchAPI::Introspection#connection_type
|
276
268
|
module ConnectionType
|
277
269
|
extend FinchAPI::Internal::Type::Enum
|
278
270
|
|
@@ -5,17 +5,17 @@ module FinchAPI
|
|
5
5
|
class JobCompletionEvent < FinchAPI::Models::BaseWebhookEvent
|
6
6
|
# @!attribute data
|
7
7
|
#
|
8
|
-
# @return [FinchAPI::
|
9
|
-
optional :data, -> { FinchAPI::
|
8
|
+
# @return [FinchAPI::JobCompletionEvent::Data, nil]
|
9
|
+
optional :data, -> { FinchAPI::JobCompletionEvent::Data }
|
10
10
|
|
11
11
|
# @!attribute event_type
|
12
12
|
#
|
13
|
-
# @return [Symbol, FinchAPI::
|
14
|
-
optional :event_type, enum: -> { FinchAPI::
|
13
|
+
# @return [Symbol, FinchAPI::JobCompletionEvent::EventType, nil]
|
14
|
+
optional :event_type, enum: -> { FinchAPI::JobCompletionEvent::EventType }
|
15
15
|
|
16
16
|
# @!method initialize(data: nil, event_type: nil)
|
17
|
-
# @param data [FinchAPI::
|
18
|
-
# @param event_type [Symbol, FinchAPI::
|
17
|
+
# @param data [FinchAPI::JobCompletionEvent::Data]
|
18
|
+
# @param event_type [Symbol, FinchAPI::JobCompletionEvent::EventType]
|
19
19
|
|
20
20
|
class Data < FinchAPI::Internal::Type::BaseModel
|
21
21
|
# @!attribute job_id
|