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
@@ -30,13 +30,11 @@ 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::
|
33
|
+
# {FinchAPI::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
|
-
# ...
|
37
36
|
#
|
38
37
|
# @param company_id [String] [DEPRECATED] Unique Finch ID of the company for which data has been updated. Use
|
39
|
-
# ...
|
40
38
|
#
|
41
39
|
# @param connection_id [String] Unique Finch ID of the connection associated with the webhook event.
|
42
40
|
end
|
@@ -10,12 +10,12 @@ module FinchAPI
|
|
10
10
|
|
11
11
|
# @!attribute event_type
|
12
12
|
#
|
13
|
-
# @return [Symbol, FinchAPI::
|
14
|
-
optional :event_type, enum: -> { FinchAPI::
|
13
|
+
# @return [Symbol, FinchAPI::CompanyEvent::EventType, nil]
|
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::
|
18
|
+
# @param event_type [Symbol, FinchAPI::CompanyEvent::EventType]
|
19
19
|
|
20
20
|
module EventType
|
21
21
|
extend FinchAPI::Internal::Type::Enum
|
@@ -20,9 +20,9 @@ module FinchAPI
|
|
20
20
|
|
21
21
|
# @!attribute products
|
22
22
|
#
|
23
|
-
# @return [Array<Symbol, FinchAPI::
|
23
|
+
# @return [Array<Symbol, FinchAPI::Connect::SessionNewParams::Product>]
|
24
24
|
required :products,
|
25
|
-
-> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::
|
25
|
+
-> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Connect::SessionNewParams::Product] }
|
26
26
|
|
27
27
|
# @!attribute customer_email
|
28
28
|
#
|
@@ -31,8 +31,8 @@ module FinchAPI
|
|
31
31
|
|
32
32
|
# @!attribute integration
|
33
33
|
#
|
34
|
-
# @return [FinchAPI::
|
35
|
-
optional :integration, -> { FinchAPI::
|
34
|
+
# @return [FinchAPI::Connect::SessionNewParams::Integration, nil]
|
35
|
+
optional :integration, -> { FinchAPI::Connect::SessionNewParams::Integration }, nil?: true
|
36
36
|
|
37
37
|
# @!attribute manual
|
38
38
|
#
|
@@ -53,8 +53,8 @@ module FinchAPI
|
|
53
53
|
|
54
54
|
# @!attribute sandbox
|
55
55
|
#
|
56
|
-
# @return [Symbol, FinchAPI::
|
57
|
-
optional :sandbox, enum: -> { FinchAPI::
|
56
|
+
# @return [Symbol, FinchAPI::Connect::SessionNewParams::Sandbox, nil]
|
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: {})
|
60
60
|
# Some parameter documentations has been truncated, see
|
@@ -64,20 +64,19 @@ module FinchAPI
|
|
64
64
|
#
|
65
65
|
# @param customer_name [String]
|
66
66
|
#
|
67
|
-
# @param products [Array<Symbol, FinchAPI::
|
67
|
+
# @param products [Array<Symbol, FinchAPI::Connect::SessionNewParams::Product>]
|
68
68
|
#
|
69
69
|
# @param customer_email [String, nil]
|
70
70
|
#
|
71
|
-
# @param integration [FinchAPI::
|
71
|
+
# @param integration [FinchAPI::Connect::SessionNewParams::Integration, nil]
|
72
72
|
#
|
73
73
|
# @param manual [Boolean, nil]
|
74
74
|
#
|
75
75
|
# @param minutes_to_expire [Float, nil] The number of minutes until the session expires (defaults to 43,200, which is 30
|
76
|
-
# ...
|
77
76
|
#
|
78
77
|
# @param redirect_uri [String, nil]
|
79
78
|
#
|
80
|
-
# @param sandbox [Symbol, FinchAPI::
|
79
|
+
# @param sandbox [Symbol, FinchAPI::Connect::SessionNewParams::Sandbox, nil]
|
81
80
|
#
|
82
81
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
|
83
82
|
|
@@ -103,9 +102,9 @@ module FinchAPI
|
|
103
102
|
class Integration < FinchAPI::Internal::Type::BaseModel
|
104
103
|
# @!attribute auth_method
|
105
104
|
#
|
106
|
-
# @return [Symbol, FinchAPI::
|
105
|
+
# @return [Symbol, FinchAPI::Connect::SessionNewParams::Integration::AuthMethod, nil]
|
107
106
|
optional :auth_method,
|
108
|
-
enum: -> { FinchAPI::
|
107
|
+
enum: -> { FinchAPI::Connect::SessionNewParams::Integration::AuthMethod },
|
109
108
|
nil?: true
|
110
109
|
|
111
110
|
# @!attribute provider
|
@@ -114,10 +113,10 @@ module FinchAPI
|
|
114
113
|
optional :provider, String, nil?: true
|
115
114
|
|
116
115
|
# @!method initialize(auth_method: nil, provider: nil)
|
117
|
-
# @param auth_method [Symbol, FinchAPI::
|
116
|
+
# @param auth_method [Symbol, FinchAPI::Connect::SessionNewParams::Integration::AuthMethod, nil]
|
118
117
|
# @param provider [String, nil]
|
119
118
|
|
120
|
-
# @see FinchAPI::
|
119
|
+
# @see FinchAPI::Connect::SessionNewParams::Integration#auth_method
|
121
120
|
module AuthMethod
|
122
121
|
extend FinchAPI::Internal::Type::Enum
|
123
122
|
|
@@ -24,9 +24,11 @@ module FinchAPI
|
|
24
24
|
# @!attribute products
|
25
25
|
# The products to request access to (optional for reauthentication)
|
26
26
|
#
|
27
|
-
# @return [Array<Symbol, FinchAPI::
|
27
|
+
# @return [Array<Symbol, FinchAPI::Connect::SessionReauthenticateParams::Product>, nil]
|
28
28
|
optional :products,
|
29
|
-
-> {
|
29
|
+
-> {
|
30
|
+
FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Connect::SessionReauthenticateParams::Product]
|
31
|
+
},
|
30
32
|
nil?: true
|
31
33
|
|
32
34
|
# @!attribute redirect_uri
|
@@ -42,9 +44,8 @@ module FinchAPI
|
|
42
44
|
# @param connection_id [String] The ID of the existing connection to reauthenticate
|
43
45
|
#
|
44
46
|
# @param minutes_to_expire [Integer, nil] The number of minutes until the session expires (defaults to 43,200, which is 30
|
45
|
-
# ...
|
46
47
|
#
|
47
|
-
# @param products [Array<Symbol, FinchAPI::
|
48
|
+
# @param products [Array<Symbol, FinchAPI::Connect::SessionReauthenticateParams::Product>, nil] The products to request access to (optional for reauthentication)
|
48
49
|
#
|
49
50
|
# @param redirect_uri [String, nil] The URI to redirect to after the Connect flow is completed
|
50
51
|
#
|
@@ -22,8 +22,8 @@ module FinchAPI
|
|
22
22
|
# @!attribute client_type
|
23
23
|
# The type of application associated with a token.
|
24
24
|
#
|
25
|
-
# @return [Symbol, FinchAPI::
|
26
|
-
required :client_type, enum: -> { FinchAPI::
|
25
|
+
# @return [Symbol, FinchAPI::CreateAccessTokenResponse::ClientType]
|
26
|
+
required :client_type, enum: -> { FinchAPI::CreateAccessTokenResponse::ClientType }
|
27
27
|
|
28
28
|
# @!attribute company_id
|
29
29
|
# @deprecated
|
@@ -46,8 +46,8 @@ module FinchAPI
|
|
46
46
|
# - `provider` - connection to an external provider
|
47
47
|
# - `finch` - finch-generated data.
|
48
48
|
#
|
49
|
-
# @return [Symbol, FinchAPI::
|
50
|
-
required :connection_type, enum: -> { FinchAPI::
|
49
|
+
# @return [Symbol, FinchAPI::CreateAccessTokenResponse::ConnectionType]
|
50
|
+
required :connection_type, enum: -> { FinchAPI::CreateAccessTokenResponse::ConnectionType }
|
51
51
|
|
52
52
|
# @!attribute products
|
53
53
|
# An array of the authorized products associated with the `access_token`.
|
@@ -76,34 +76,31 @@ 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::
|
79
|
+
# {FinchAPI::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
|
-
# ...
|
85
84
|
#
|
86
|
-
# @param client_type [Symbol, FinchAPI::
|
85
|
+
# @param client_type [Symbol, FinchAPI::CreateAccessTokenResponse::ClientType] The type of application associated with a token.
|
87
86
|
#
|
88
87
|
# @param company_id [String] [DEPRECATED] Use `connection_id` to identify the connection instead of this comp
|
89
|
-
# ...
|
90
88
|
#
|
91
89
|
# @param connection_id [String] The Finch UUID of the connection associated with the `access_token`.
|
92
90
|
#
|
93
|
-
# @param connection_type [Symbol, FinchAPI::
|
91
|
+
# @param connection_type [Symbol, FinchAPI::CreateAccessTokenResponse::ConnectionType] The type of the connection associated with the token.
|
94
92
|
#
|
95
93
|
# @param products [Array<String>] An array of the authorized products associated with the `access_token`.
|
96
94
|
#
|
97
95
|
# @param provider_id [String] The ID of the provider associated with the `access_token`.
|
98
96
|
#
|
99
97
|
# @param customer_id [String, nil] The ID of your customer you provided to Finch when a connect session was created
|
100
|
-
# ...
|
101
98
|
#
|
102
99
|
# @param token_type [String] The RFC 8693 token type (Finch uses `bearer` tokens)
|
103
100
|
|
104
101
|
# The type of application associated with a token.
|
105
102
|
#
|
106
|
-
# @see FinchAPI::
|
103
|
+
# @see FinchAPI::CreateAccessTokenResponse#client_type
|
107
104
|
module ClientType
|
108
105
|
extend FinchAPI::Internal::Type::Enum
|
109
106
|
|
@@ -120,7 +117,7 @@ module FinchAPI
|
|
120
117
|
# - `provider` - connection to an external provider
|
121
118
|
# - `finch` - finch-generated data.
|
122
119
|
#
|
123
|
-
# @see FinchAPI::
|
120
|
+
# @see FinchAPI::CreateAccessTokenResponse#connection_type
|
124
121
|
module ConnectionType
|
125
122
|
extend FinchAPI::Internal::Type::Enum
|
126
123
|
|
@@ -5,17 +5,17 @@ module FinchAPI
|
|
5
5
|
class DirectoryEvent < FinchAPI::Models::BaseWebhookEvent
|
6
6
|
# @!attribute data
|
7
7
|
#
|
8
|
-
# @return [FinchAPI::
|
9
|
-
optional :data, -> { FinchAPI::
|
8
|
+
# @return [FinchAPI::DirectoryEvent::Data, nil]
|
9
|
+
optional :data, -> { FinchAPI::DirectoryEvent::Data }
|
10
10
|
|
11
11
|
# @!attribute event_type
|
12
12
|
#
|
13
|
-
# @return [Symbol, FinchAPI::
|
14
|
-
optional :event_type, enum: -> { FinchAPI::
|
13
|
+
# @return [Symbol, FinchAPI::DirectoryEvent::EventType, nil]
|
14
|
+
optional :event_type, enum: -> { FinchAPI::DirectoryEvent::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::DirectoryEvent::Data]
|
18
|
+
# @param event_type [Symbol, FinchAPI::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::
|
9
|
-
optional :data, -> { FinchAPI::
|
8
|
+
# @return [FinchAPI::EmploymentEvent::Data, nil]
|
9
|
+
optional :data, -> { FinchAPI::EmploymentEvent::Data }
|
10
10
|
|
11
11
|
# @!attribute event_type
|
12
12
|
#
|
13
|
-
# @return [Symbol, FinchAPI::
|
14
|
-
optional :event_type, enum: -> { FinchAPI::
|
13
|
+
# @return [Symbol, FinchAPI::EmploymentEvent::EventType, nil]
|
14
|
+
optional :event_type, enum: -> { FinchAPI::EmploymentEvent::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::EmploymentEvent::Data]
|
18
|
+
# @param event_type [Symbol, FinchAPI::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::
|
17
|
-
optional :type, enum: -> { FinchAPI::
|
16
|
+
# @return [Symbol, FinchAPI::HRIS::BenefitContribution::Type, nil]
|
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::
|
22
|
+
# @param type [Symbol, FinchAPI::HRIS::BenefitContribution::Type, nil] Contribution type.
|
23
23
|
|
24
24
|
# Contribution type.
|
25
25
|
#
|
26
|
-
# @see FinchAPI::
|
26
|
+
# @see FinchAPI::HRIS::BenefitContribution#type
|
27
27
|
module Type
|
28
28
|
extend FinchAPI::Internal::Type::Enum
|
29
29
|
|
@@ -11,9 +11,9 @@ module FinchAPI
|
|
11
11
|
# @!attribute company_contribution
|
12
12
|
# The company match for this benefit.
|
13
13
|
#
|
14
|
-
# @return [FinchAPI::
|
14
|
+
# @return [FinchAPI::HRIS::BenefitCreateParams::CompanyContribution, nil]
|
15
15
|
optional :company_contribution,
|
16
|
-
-> { FinchAPI::
|
16
|
+
-> { FinchAPI::HRIS::BenefitCreateParams::CompanyContribution },
|
17
17
|
nil?: true
|
18
18
|
|
19
19
|
# @!attribute description
|
@@ -27,47 +27,48 @@ module FinchAPI
|
|
27
27
|
# @!attribute frequency
|
28
28
|
# The frequency of the benefit deduction/contribution.
|
29
29
|
#
|
30
|
-
# @return [Symbol, FinchAPI::
|
31
|
-
optional :frequency, enum: -> { FinchAPI::
|
30
|
+
# @return [Symbol, FinchAPI::HRIS::BenefitFrequency, nil]
|
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::
|
37
|
-
optional :type, enum: -> { FinchAPI::
|
36
|
+
# @return [Symbol, FinchAPI::HRIS::BenefitType, nil]
|
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::
|
43
|
+
# @param company_contribution [FinchAPI::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
|
-
# ...
|
47
46
|
#
|
48
|
-
# @param frequency [Symbol, FinchAPI::
|
47
|
+
# @param frequency [Symbol, FinchAPI::HRIS::BenefitFrequency, nil] The frequency of the benefit deduction/contribution.
|
49
48
|
#
|
50
|
-
# @param type [Symbol, FinchAPI::
|
49
|
+
# @param type [Symbol, FinchAPI::HRIS::BenefitType, nil] Type of benefit.
|
51
50
|
#
|
52
51
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
|
53
52
|
|
54
53
|
class CompanyContribution < FinchAPI::Internal::Type::BaseModel
|
55
54
|
# @!attribute tiers
|
56
55
|
#
|
57
|
-
# @return [Array<FinchAPI::
|
56
|
+
# @return [Array<FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Tier>, nil]
|
58
57
|
optional :tiers,
|
59
|
-
-> {
|
58
|
+
-> {
|
59
|
+
FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Tier]
|
60
|
+
}
|
60
61
|
|
61
62
|
# @!attribute type
|
62
63
|
#
|
63
|
-
# @return [Symbol, FinchAPI::
|
64
|
-
optional :type, enum: -> { FinchAPI::
|
64
|
+
# @return [Symbol, FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Type, nil]
|
65
|
+
optional :type, enum: -> { FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Type }
|
65
66
|
|
66
67
|
# @!method initialize(tiers: nil, type: nil)
|
67
68
|
# The company match for this benefit.
|
68
69
|
#
|
69
|
-
# @param tiers [Array<FinchAPI::
|
70
|
-
# @param type [Symbol, FinchAPI::
|
70
|
+
# @param tiers [Array<FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Tier>]
|
71
|
+
# @param type [Symbol, FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Type]
|
71
72
|
|
72
73
|
class Tier < FinchAPI::Internal::Type::BaseModel
|
73
74
|
# @!attribute match
|
@@ -85,7 +86,7 @@ module FinchAPI
|
|
85
86
|
# @param threshold [Integer]
|
86
87
|
end
|
87
88
|
|
88
|
-
# @see FinchAPI::
|
89
|
+
# @see FinchAPI::HRIS::BenefitCreateParams::CompanyContribution#type
|
89
90
|
module Type
|
90
91
|
extend FinchAPI::Internal::Type::Enum
|
91
92
|
|
@@ -6,20 +6,19 @@ module FinchAPI
|
|
6
6
|
class BenefitFeaturesAndOperations < FinchAPI::Internal::Type::BaseModel
|
7
7
|
# @!attribute supported_features
|
8
8
|
#
|
9
|
-
# @return [FinchAPI::
|
10
|
-
optional :supported_features,
|
11
|
-
-> { FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures }
|
9
|
+
# @return [FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures, nil]
|
10
|
+
optional :supported_features, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures }
|
12
11
|
|
13
12
|
# @!attribute supported_operations
|
14
13
|
#
|
15
|
-
# @return [FinchAPI::
|
16
|
-
optional :supported_operations, -> { FinchAPI::
|
14
|
+
# @return [FinchAPI::HRIS::SupportPerBenefitType, nil]
|
15
|
+
optional :supported_operations, -> { FinchAPI::HRIS::SupportPerBenefitType }
|
17
16
|
|
18
17
|
# @!method initialize(supported_features: nil, supported_operations: nil)
|
19
|
-
# @param supported_features [FinchAPI::
|
20
|
-
# @param supported_operations [FinchAPI::
|
18
|
+
# @param supported_features [FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures]
|
19
|
+
# @param supported_operations [FinchAPI::HRIS::SupportPerBenefitType]
|
21
20
|
|
22
|
-
# @see FinchAPI::
|
21
|
+
# @see FinchAPI::HRIS::BenefitFeaturesAndOperations#supported_features
|
23
22
|
class SupportedFeatures < FinchAPI::Internal::Type::BaseModel
|
24
23
|
# @!attribute annual_maximum
|
25
24
|
# Whether the provider supports an annual maximum for this benefit.
|
@@ -38,14 +37,12 @@ module FinchAPI
|
|
38
37
|
# Supported contribution types. An empty array indicates contributions are not
|
39
38
|
# supported.
|
40
39
|
#
|
41
|
-
# @return [Array<Symbol, FinchAPI::
|
40
|
+
# @return [Array<Symbol, FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution, nil>, nil]
|
42
41
|
optional :company_contribution,
|
43
|
-
->
|
44
|
-
FinchAPI::Internal::Type::ArrayOf[
|
45
|
-
|
46
|
-
|
47
|
-
]
|
48
|
-
end,
|
42
|
+
-> {
|
43
|
+
FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution,
|
44
|
+
nil?: true]
|
45
|
+
},
|
49
46
|
nil?: true
|
50
47
|
|
51
48
|
# @!attribute description
|
@@ -57,54 +54,53 @@ module FinchAPI
|
|
57
54
|
# Supported deduction types. An empty array indicates deductions are not
|
58
55
|
# supported.
|
59
56
|
#
|
60
|
-
# @return [Array<Symbol, FinchAPI::
|
57
|
+
# @return [Array<Symbol, FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction, nil>, nil]
|
61
58
|
optional :employee_deduction,
|
62
|
-
-> {
|
59
|
+
-> {
|
60
|
+
FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction,
|
61
|
+
nil?: true]
|
62
|
+
},
|
63
63
|
nil?: true
|
64
64
|
|
65
65
|
# @!attribute frequencies
|
66
66
|
# The list of frequencies supported by the provider for this benefit
|
67
67
|
#
|
68
|
-
# @return [Array<Symbol, FinchAPI::
|
68
|
+
# @return [Array<Symbol, FinchAPI::HRIS::BenefitFrequency, nil>, nil]
|
69
69
|
optional :frequencies,
|
70
|
-
-> {
|
70
|
+
-> {
|
71
|
+
FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::BenefitFrequency, nil?: true]
|
72
|
+
}
|
71
73
|
|
72
74
|
# @!attribute hsa_contribution_limit
|
73
75
|
# Whether the provider supports HSA contribution limits. Empty if this feature is
|
74
76
|
# not supported for the benefit. This array only has values for HSA benefits.
|
75
77
|
#
|
76
|
-
# @return [Array<Symbol, FinchAPI::
|
78
|
+
# @return [Array<Symbol, FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit, nil>, nil]
|
77
79
|
optional :hsa_contribution_limit,
|
78
|
-
->
|
79
|
-
FinchAPI::Internal::Type::ArrayOf[
|
80
|
-
|
81
|
-
|
82
|
-
]
|
83
|
-
end,
|
80
|
+
-> {
|
81
|
+
FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit,
|
82
|
+
nil?: true]
|
83
|
+
},
|
84
84
|
nil?: true
|
85
85
|
|
86
86
|
# @!method initialize(annual_maximum: nil, catch_up: nil, company_contribution: nil, description: nil, employee_deduction: nil, frequencies: nil, hsa_contribution_limit: nil)
|
87
87
|
# Some parameter documentations has been truncated, see
|
88
|
-
# {FinchAPI::
|
89
|
-
#
|
88
|
+
# {FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures} for more
|
89
|
+
# details.
|
90
90
|
#
|
91
91
|
# @param annual_maximum [Boolean, nil] Whether the provider supports an annual maximum for this benefit.
|
92
92
|
#
|
93
93
|
# @param catch_up [Boolean, nil] Whether the provider supports catch up for this benefit. This field will only be
|
94
|
-
# ...
|
95
94
|
#
|
96
|
-
# @param company_contribution [Array<Symbol, FinchAPI::
|
97
|
-
# ...
|
95
|
+
# @param company_contribution [Array<Symbol, FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution, nil>, nil] Supported contribution types. An empty array indicates contributions are not sup
|
98
96
|
#
|
99
97
|
# @param description [String, nil]
|
100
98
|
#
|
101
|
-
# @param employee_deduction [Array<Symbol, FinchAPI::
|
102
|
-
# ...
|
99
|
+
# @param employee_deduction [Array<Symbol, FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction, nil>, nil] Supported deduction types. An empty array indicates deductions are not supported
|
103
100
|
#
|
104
|
-
# @param frequencies [Array<Symbol, FinchAPI::
|
101
|
+
# @param frequencies [Array<Symbol, FinchAPI::HRIS::BenefitFrequency, nil>] The list of frequencies supported by the provider for this benefit
|
105
102
|
#
|
106
|
-
# @param hsa_contribution_limit [Array<Symbol, FinchAPI::
|
107
|
-
# ...
|
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
|
108
104
|
|
109
105
|
module CompanyContribution
|
110
106
|
extend FinchAPI::Internal::Type::Enum
|
@@ -44,9 +44,9 @@ module FinchAPI
|
|
44
44
|
# @!attribute frequencies
|
45
45
|
# The list of frequencies supported by the provider for this benefit
|
46
46
|
#
|
47
|
-
# @return [Array<Symbol, FinchAPI::
|
47
|
+
# @return [Array<Symbol, FinchAPI::HRIS::BenefitFrequency, nil>, nil]
|
48
48
|
optional :frequencies,
|
49
|
-
-> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::
|
49
|
+
-> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::BenefitFrequency, nil?: true] }
|
50
50
|
|
51
51
|
# @!attribute hsa_contribution_limit
|
52
52
|
# Whether the provider supports HSA contribution limits. Empty if this feature is
|
@@ -64,20 +64,16 @@ module FinchAPI
|
|
64
64
|
# @param annual_maximum [Boolean, nil] Whether the provider supports an annual maximum for this benefit.
|
65
65
|
#
|
66
66
|
# @param catch_up [Boolean, nil] Whether the provider supports catch up for this benefit. This field will only be
|
67
|
-
# ...
|
68
67
|
#
|
69
68
|
# @param company_contribution [Array<Symbol, FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::CompanyContribution, nil>, nil] Supported contribution types. An empty array indicates contributions are not sup
|
70
|
-
# ...
|
71
69
|
#
|
72
70
|
# @param description [String, nil]
|
73
71
|
#
|
74
72
|
# @param employee_deduction [Array<Symbol, FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::EmployeeDeduction, nil>, nil] Supported deduction types. An empty array indicates deductions are not supported
|
75
|
-
# ...
|
76
73
|
#
|
77
|
-
# @param frequencies [Array<Symbol, FinchAPI::
|
74
|
+
# @param frequencies [Array<Symbol, FinchAPI::HRIS::BenefitFrequency, nil>] The list of frequencies supported by the provider for this benefit
|
78
75
|
#
|
79
76
|
# @param hsa_contribution_limit [Array<Symbol, FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::HsaContributionLimit, nil>, nil] Whether the provider supports HSA contribution limits. Empty if this feature is
|
80
|
-
# ...
|
81
77
|
|
82
78
|
module CompanyContribution
|
83
79
|
extend FinchAPI::Internal::Type::Enum
|
@@ -8,8 +8,8 @@ module FinchAPI
|
|
8
8
|
class IndividualBenefit < FinchAPI::Internal::Type::BaseModel
|
9
9
|
# @!attribute body
|
10
10
|
#
|
11
|
-
# @return [FinchAPI::
|
12
|
-
optional :body, -> { FinchAPI::
|
11
|
+
# @return [FinchAPI::HRIS::Benefits::IndividualBenefit::Body, nil]
|
12
|
+
optional :body, -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body }
|
13
13
|
|
14
14
|
# @!attribute code
|
15
15
|
#
|
@@ -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::
|
25
|
+
# @param body [FinchAPI::HRIS::Benefits::IndividualBenefit::Body]
|
26
26
|
# @param code [Integer]
|
27
27
|
# @param individual_id [String]
|
28
28
|
|
29
|
-
# @see FinchAPI::
|
29
|
+
# @see FinchAPI::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,41 +43,39 @@ module FinchAPI
|
|
43
43
|
|
44
44
|
# @!attribute company_contribution
|
45
45
|
#
|
46
|
-
# @return [FinchAPI::
|
47
|
-
optional :company_contribution, -> { FinchAPI::
|
46
|
+
# @return [FinchAPI::HRIS::BenefitContribution, nil]
|
47
|
+
optional :company_contribution, -> { FinchAPI::HRIS::BenefitContribution }, nil?: true
|
48
48
|
|
49
49
|
# @!attribute employee_deduction
|
50
50
|
#
|
51
|
-
# @return [FinchAPI::
|
52
|
-
optional :employee_deduction, -> { FinchAPI::
|
51
|
+
# @return [FinchAPI::HRIS::BenefitContribution, nil]
|
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::
|
57
|
+
# @return [Symbol, FinchAPI::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit, nil]
|
58
58
|
optional :hsa_contribution_limit,
|
59
|
-
enum: -> { FinchAPI::
|
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::
|
64
|
+
# {FinchAPI::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
|
-
# ...
|
68
67
|
#
|
69
68
|
# @param catch_up [Boolean, nil] If the benefit supports catch up (401k, 403b, etc.), whether catch up is enabled
|
70
|
-
# ...
|
71
69
|
#
|
72
|
-
# @param company_contribution [FinchAPI::
|
70
|
+
# @param company_contribution [FinchAPI::HRIS::BenefitContribution, nil]
|
73
71
|
#
|
74
|
-
# @param employee_deduction [FinchAPI::
|
72
|
+
# @param employee_deduction [FinchAPI::HRIS::BenefitContribution, nil]
|
75
73
|
#
|
76
|
-
# @param hsa_contribution_limit [Symbol, FinchAPI::
|
74
|
+
# @param hsa_contribution_limit [Symbol, FinchAPI::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit, nil] Type for HSA contribution limit if the benefit is a HSA.
|
77
75
|
|
78
76
|
# Type for HSA contribution limit if the benefit is a HSA.
|
79
77
|
#
|
80
|
-
# @see FinchAPI::
|
78
|
+
# @see FinchAPI::HRIS::Benefits::IndividualBenefit::Body#hsa_contribution_limit
|
81
79
|
module HsaContributionLimit
|
82
80
|
extend FinchAPI::Internal::Type::Enum
|
83
81
|
|