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
@@ -9,14 +9,14 @@ module FinchAPI
|
|
9
9
|
#
|
10
10
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
|
11
11
|
#
|
12
|
-
# @return [FinchAPI::
|
12
|
+
# @return [FinchAPI::DisconnectResponse]
|
13
13
|
#
|
14
14
|
# @see FinchAPI::Models::AccountDisconnectParams
|
15
15
|
def disconnect(params = {})
|
16
16
|
@client.request(
|
17
17
|
method: :post,
|
18
18
|
path: "disconnect",
|
19
|
-
model: FinchAPI::
|
19
|
+
model: FinchAPI::DisconnectResponse,
|
20
20
|
options: params[:request_options]
|
21
21
|
)
|
22
22
|
end
|
@@ -27,14 +27,14 @@ module FinchAPI
|
|
27
27
|
#
|
28
28
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
|
29
29
|
#
|
30
|
-
# @return [FinchAPI::
|
30
|
+
# @return [FinchAPI::Introspection]
|
31
31
|
#
|
32
32
|
# @see FinchAPI::Models::AccountIntrospectParams
|
33
33
|
def introspect(params = {})
|
34
34
|
@client.request(
|
35
35
|
method: :get,
|
36
36
|
path: "introspect",
|
37
|
-
model: FinchAPI::
|
37
|
+
model: FinchAPI::Introspection,
|
38
38
|
options: params[:request_options]
|
39
39
|
)
|
40
40
|
end
|
@@ -15,20 +15,19 @@ module FinchAPI
|
|
15
15
|
#
|
16
16
|
# @param customer_name [String]
|
17
17
|
#
|
18
|
-
# @param products [Array<Symbol, FinchAPI::
|
18
|
+
# @param products [Array<Symbol, FinchAPI::Connect::SessionNewParams::Product>]
|
19
19
|
#
|
20
20
|
# @param customer_email [String, nil]
|
21
21
|
#
|
22
|
-
# @param integration [FinchAPI::
|
22
|
+
# @param integration [FinchAPI::Connect::SessionNewParams::Integration, nil]
|
23
23
|
#
|
24
24
|
# @param manual [Boolean, nil]
|
25
25
|
#
|
26
26
|
# @param minutes_to_expire [Float, nil] The number of minutes until the session expires (defaults to 43,200, which is 30
|
27
|
-
# ...
|
28
27
|
#
|
29
28
|
# @param redirect_uri [String, nil]
|
30
29
|
#
|
31
|
-
# @param sandbox [Symbol, FinchAPI::
|
30
|
+
# @param sandbox [Symbol, FinchAPI::Connect::SessionNewParams::Sandbox, nil]
|
32
31
|
#
|
33
32
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
|
34
33
|
#
|
@@ -36,7 +35,7 @@ module FinchAPI
|
|
36
35
|
#
|
37
36
|
# @see FinchAPI::Models::Connect::SessionNewParams
|
38
37
|
def new(params)
|
39
|
-
parsed, options = FinchAPI::
|
38
|
+
parsed, options = FinchAPI::Connect::SessionNewParams.dump_request(params)
|
40
39
|
@client.request(
|
41
40
|
method: :post,
|
42
41
|
path: "connect/sessions",
|
@@ -56,9 +55,8 @@ module FinchAPI
|
|
56
55
|
# @param connection_id [String] The ID of the existing connection to reauthenticate
|
57
56
|
#
|
58
57
|
# @param minutes_to_expire [Integer, nil] The number of minutes until the session expires (defaults to 43,200, which is 30
|
59
|
-
# ...
|
60
58
|
#
|
61
|
-
# @param products [Array<Symbol, FinchAPI::
|
59
|
+
# @param products [Array<Symbol, FinchAPI::Connect::SessionReauthenticateParams::Product>, nil] The products to request access to (optional for reauthentication)
|
62
60
|
#
|
63
61
|
# @param redirect_uri [String, nil] The URI to redirect to after the Connect flow is completed
|
64
62
|
#
|
@@ -68,7 +66,7 @@ module FinchAPI
|
|
68
66
|
#
|
69
67
|
# @see FinchAPI::Models::Connect::SessionReauthenticateParams
|
70
68
|
def reauthenticate(params)
|
71
|
-
parsed, options = FinchAPI::
|
69
|
+
parsed, options = FinchAPI::Connect::SessionReauthenticateParams.dump_request(params)
|
72
70
|
@client.request(
|
73
71
|
method: :post,
|
74
72
|
path: "connect/sessions/reauthenticate",
|
@@ -14,20 +14,20 @@ module FinchAPI
|
|
14
14
|
#
|
15
15
|
# @param benefit_id [String]
|
16
16
|
#
|
17
|
-
# @param individuals [Array<FinchAPI::
|
17
|
+
# @param individuals [Array<FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual>] Array of the individual_id to enroll and a configuration object.
|
18
18
|
#
|
19
19
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
|
20
20
|
#
|
21
|
-
# @return [FinchAPI::
|
21
|
+
# @return [FinchAPI::HRIS::Benefits::EnrolledIndividualBenefitResponse]
|
22
22
|
#
|
23
23
|
# @see FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams
|
24
24
|
def enroll_many(benefit_id, params = {})
|
25
|
-
parsed, options = FinchAPI::
|
25
|
+
parsed, options = FinchAPI::HRIS::Benefits::IndividualEnrollManyParams.dump_request(params)
|
26
26
|
@client.request(
|
27
27
|
method: :post,
|
28
28
|
path: ["employer/benefits/%1$s/individuals", benefit_id],
|
29
29
|
body: parsed[:individuals],
|
30
|
-
model: FinchAPI::
|
30
|
+
model: FinchAPI::HRIS::Benefits::EnrolledIndividualBenefitResponse,
|
31
31
|
options: options
|
32
32
|
)
|
33
33
|
end
|
@@ -62,22 +62,20 @@ module FinchAPI
|
|
62
62
|
# @param benefit_id [String]
|
63
63
|
#
|
64
64
|
# @param individual_ids [String] comma-delimited list of stable Finch uuids for each individual. If empty, defaul
|
65
|
-
# ...
|
66
65
|
#
|
67
66
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
|
68
67
|
#
|
69
|
-
# @return [FinchAPI::Internal::SinglePage<FinchAPI::
|
68
|
+
# @return [FinchAPI::Internal::SinglePage<FinchAPI::HRIS::Benefits::IndividualBenefit>]
|
70
69
|
#
|
71
70
|
# @see FinchAPI::Models::HRIS::Benefits::IndividualRetrieveManyBenefitsParams
|
72
71
|
def retrieve_many_benefits(benefit_id, params = {})
|
73
|
-
parsed, options =
|
74
|
-
FinchAPI::Models::HRIS::Benefits::IndividualRetrieveManyBenefitsParams.dump_request(params)
|
72
|
+
parsed, options = FinchAPI::HRIS::Benefits::IndividualRetrieveManyBenefitsParams.dump_request(params)
|
75
73
|
@client.request(
|
76
74
|
method: :get,
|
77
75
|
path: ["employer/benefits/%1$s/individuals", benefit_id],
|
78
76
|
query: parsed,
|
79
77
|
page: FinchAPI::Internal::SinglePage,
|
80
|
-
model: FinchAPI::
|
78
|
+
model: FinchAPI::HRIS::Benefits::IndividualBenefit,
|
81
79
|
options: options
|
82
80
|
)
|
83
81
|
end
|
@@ -92,16 +90,16 @@ module FinchAPI
|
|
92
90
|
#
|
93
91
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
|
94
92
|
#
|
95
|
-
# @return [FinchAPI::
|
93
|
+
# @return [FinchAPI::HRIS::Benefits::UnenrolledIndividualBenefitResponse]
|
96
94
|
#
|
97
95
|
# @see FinchAPI::Models::HRIS::Benefits::IndividualUnenrollManyParams
|
98
96
|
def unenroll_many(benefit_id, params = {})
|
99
|
-
parsed, options = FinchAPI::
|
97
|
+
parsed, options = FinchAPI::HRIS::Benefits::IndividualUnenrollManyParams.dump_request(params)
|
100
98
|
@client.request(
|
101
99
|
method: :delete,
|
102
100
|
path: ["employer/benefits/%1$s/individuals", benefit_id],
|
103
101
|
body: parsed,
|
104
|
-
model: FinchAPI::
|
102
|
+
model: FinchAPI::HRIS::Benefits::UnenrolledIndividualBenefitResponse,
|
105
103
|
options: options
|
106
104
|
)
|
107
105
|
end
|
@@ -15,27 +15,26 @@ module FinchAPI
|
|
15
15
|
#
|
16
16
|
# @overload create(company_contribution: nil, description: nil, frequency: nil, type: nil, request_options: {})
|
17
17
|
#
|
18
|
-
# @param company_contribution [FinchAPI::
|
18
|
+
# @param company_contribution [FinchAPI::HRIS::BenefitCreateParams::CompanyContribution, nil] The company match for this benefit.
|
19
19
|
#
|
20
20
|
# @param description [String] Name of the benefit as it appears in the provider and pay statements. Recommend
|
21
|
-
# ...
|
22
21
|
#
|
23
|
-
# @param frequency [Symbol, FinchAPI::
|
22
|
+
# @param frequency [Symbol, FinchAPI::HRIS::BenefitFrequency, nil] The frequency of the benefit deduction/contribution.
|
24
23
|
#
|
25
|
-
# @param type [Symbol, FinchAPI::
|
24
|
+
# @param type [Symbol, FinchAPI::HRIS::BenefitType, nil] Type of benefit.
|
26
25
|
#
|
27
26
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
|
28
27
|
#
|
29
|
-
# @return [FinchAPI::
|
28
|
+
# @return [FinchAPI::HRIS::CreateCompanyBenefitsResponse]
|
30
29
|
#
|
31
30
|
# @see FinchAPI::Models::HRIS::BenefitCreateParams
|
32
31
|
def create(params = {})
|
33
|
-
parsed, options = FinchAPI::
|
32
|
+
parsed, options = FinchAPI::HRIS::BenefitCreateParams.dump_request(params)
|
34
33
|
@client.request(
|
35
34
|
method: :post,
|
36
35
|
path: "employer/benefits",
|
37
36
|
body: parsed,
|
38
|
-
model: FinchAPI::
|
37
|
+
model: FinchAPI::HRIS::CreateCompanyBenefitsResponse,
|
39
38
|
options: options
|
40
39
|
)
|
41
40
|
end
|
@@ -47,14 +46,14 @@ module FinchAPI
|
|
47
46
|
# @param benefit_id [String]
|
48
47
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
|
49
48
|
#
|
50
|
-
# @return [FinchAPI::
|
49
|
+
# @return [FinchAPI::HRIS::CompanyBenefit]
|
51
50
|
#
|
52
51
|
# @see FinchAPI::Models::HRIS::BenefitRetrieveParams
|
53
52
|
def retrieve(benefit_id, params = {})
|
54
53
|
@client.request(
|
55
54
|
method: :get,
|
56
55
|
path: ["employer/benefits/%1$s", benefit_id],
|
57
|
-
model: FinchAPI::
|
56
|
+
model: FinchAPI::HRIS::CompanyBenefit,
|
58
57
|
options: params[:request_options]
|
59
58
|
)
|
60
59
|
end
|
@@ -69,16 +68,16 @@ module FinchAPI
|
|
69
68
|
#
|
70
69
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
|
71
70
|
#
|
72
|
-
# @return [FinchAPI::
|
71
|
+
# @return [FinchAPI::HRIS::UpdateCompanyBenefitResponse]
|
73
72
|
#
|
74
73
|
# @see FinchAPI::Models::HRIS::BenefitUpdateParams
|
75
74
|
def update(benefit_id, params = {})
|
76
|
-
parsed, options = FinchAPI::
|
75
|
+
parsed, options = FinchAPI::HRIS::BenefitUpdateParams.dump_request(params)
|
77
76
|
@client.request(
|
78
77
|
method: :post,
|
79
78
|
path: ["employer/benefits/%1$s", benefit_id],
|
80
79
|
body: parsed,
|
81
|
-
model: FinchAPI::
|
80
|
+
model: FinchAPI::HRIS::UpdateCompanyBenefitResponse,
|
82
81
|
options: options
|
83
82
|
)
|
84
83
|
end
|
@@ -89,7 +88,7 @@ module FinchAPI
|
|
89
88
|
#
|
90
89
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
|
91
90
|
#
|
92
|
-
# @return [FinchAPI::Internal::SinglePage<FinchAPI::
|
91
|
+
# @return [FinchAPI::Internal::SinglePage<FinchAPI::HRIS::CompanyBenefit>]
|
93
92
|
#
|
94
93
|
# @see FinchAPI::Models::HRIS::BenefitListParams
|
95
94
|
def list(params = {})
|
@@ -97,7 +96,7 @@ module FinchAPI
|
|
97
96
|
method: :get,
|
98
97
|
path: "employer/benefits",
|
99
98
|
page: FinchAPI::Internal::SinglePage,
|
100
|
-
model: FinchAPI::
|
99
|
+
model: FinchAPI::HRIS::CompanyBenefit,
|
101
100
|
options: params[:request_options]
|
102
101
|
)
|
103
102
|
end
|
@@ -15,15 +15,15 @@ module FinchAPI
|
|
15
15
|
#
|
16
16
|
# @overload create(attributes: nil, conditions: nil, effective_end_date: nil, effective_start_date: nil, entity_type: nil, request_options: {})
|
17
17
|
#
|
18
|
-
# @param attributes [FinchAPI::
|
18
|
+
# @param attributes [FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes] Specifies the fields to be applied when the condition is met.
|
19
19
|
#
|
20
|
-
# @param conditions [Array<FinchAPI::
|
20
|
+
# @param conditions [Array<FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition>]
|
21
21
|
#
|
22
22
|
# @param effective_end_date [String, nil] Specifies when the rules should stop applying rules based on the date.
|
23
23
|
#
|
24
24
|
# @param effective_start_date [String, nil] Specifies when the rule should begin applying based on the date.
|
25
25
|
#
|
26
|
-
# @param entity_type [Symbol, FinchAPI::
|
26
|
+
# @param entity_type [Symbol, FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType] The entity type to which the rule is applied.
|
27
27
|
#
|
28
28
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
|
29
29
|
#
|
@@ -31,8 +31,7 @@ module FinchAPI
|
|
31
31
|
#
|
32
32
|
# @see FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams
|
33
33
|
def create(params = {})
|
34
|
-
parsed, options =
|
35
|
-
FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams.dump_request(params)
|
34
|
+
parsed, options = FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams.dump_request(params)
|
36
35
|
@client.request(
|
37
36
|
method: :post,
|
38
37
|
path: "employer/pay-statement-item/rule",
|
@@ -55,8 +54,7 @@ module FinchAPI
|
|
55
54
|
#
|
56
55
|
# @see FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateParams
|
57
56
|
def update(rule_id, params = {})
|
58
|
-
parsed, options =
|
59
|
-
FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateParams.dump_request(params)
|
57
|
+
parsed, options = FinchAPI::HRIS::Company::PayStatementItem::RuleUpdateParams.dump_request(params)
|
60
58
|
@client.request(
|
61
59
|
method: :put,
|
62
60
|
path: ["employer/pay-statement-item/rule/%1$s", rule_id],
|
@@ -17,16 +17,13 @@ module FinchAPI
|
|
17
17
|
#
|
18
18
|
# @overload list(categories: nil, end_date: nil, name: nil, start_date: nil, type: nil, request_options: {})
|
19
19
|
#
|
20
|
-
# @param categories [Array<Symbol, FinchAPI::
|
21
|
-
# ...
|
20
|
+
# @param categories [Array<Symbol, FinchAPI::HRIS::Company::PayStatementItemListParams::Category>] Comma-delimited list of pay statement item categories to filter on. If empty, de
|
22
21
|
#
|
23
22
|
# @param end_date [Date] The end date to retrieve pay statement items by via their last seen pay date in
|
24
|
-
# ...
|
25
23
|
#
|
26
24
|
# @param name [String] Case-insensitive partial match search by pay statement item name.
|
27
25
|
#
|
28
26
|
# @param start_date [Date] The start date to retrieve pay statement items by via their last seen pay date (
|
29
|
-
# ...
|
30
27
|
#
|
31
28
|
# @param type [String] String search by pay statement item type.
|
32
29
|
#
|
@@ -36,7 +33,7 @@ module FinchAPI
|
|
36
33
|
#
|
37
34
|
# @see FinchAPI::Models::HRIS::Company::PayStatementItemListParams
|
38
35
|
def list(params = {})
|
39
|
-
parsed, options = FinchAPI::
|
36
|
+
parsed, options = FinchAPI::HRIS::Company::PayStatementItemListParams.dump_request(params)
|
40
37
|
@client.request(
|
41
38
|
method: :get,
|
42
39
|
path: "employer/pay-statement-item",
|
@@ -13,14 +13,14 @@ module FinchAPI
|
|
13
13
|
#
|
14
14
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
|
15
15
|
#
|
16
|
-
# @return [FinchAPI::
|
16
|
+
# @return [FinchAPI::HRIS::HRISCompany]
|
17
17
|
#
|
18
18
|
# @see FinchAPI::Models::HRIS::CompanyRetrieveParams
|
19
19
|
def retrieve(params = {})
|
20
20
|
@client.request(
|
21
21
|
method: :get,
|
22
22
|
path: "employer/company",
|
23
|
-
model: FinchAPI::
|
23
|
+
model: FinchAPI::HRIS::HRISCompany,
|
24
24
|
options: params[:request_options]
|
25
25
|
)
|
26
26
|
end
|
@@ -14,17 +14,17 @@ module FinchAPI
|
|
14
14
|
#
|
15
15
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
|
16
16
|
#
|
17
|
-
# @return [FinchAPI::Internal::IndividualsPage<FinchAPI::
|
17
|
+
# @return [FinchAPI::Internal::IndividualsPage<FinchAPI::HRIS::IndividualInDirectory>]
|
18
18
|
#
|
19
19
|
# @see FinchAPI::Models::HRIS::DirectoryListParams
|
20
20
|
def list(params = {})
|
21
|
-
parsed, options = FinchAPI::
|
21
|
+
parsed, options = FinchAPI::HRIS::DirectoryListParams.dump_request(params)
|
22
22
|
@client.request(
|
23
23
|
method: :get,
|
24
24
|
path: "employer/directory",
|
25
25
|
query: parsed,
|
26
26
|
page: FinchAPI::Internal::IndividualsPage,
|
27
|
-
model: FinchAPI::
|
27
|
+
model: FinchAPI::HRIS::IndividualInDirectory,
|
28
28
|
options: options
|
29
29
|
)
|
30
30
|
end
|
@@ -13,14 +13,12 @@ module FinchAPI
|
|
13
13
|
# @overload list(individual_ids: nil, limit: nil, offset: nil, types: nil, request_options: {})
|
14
14
|
#
|
15
15
|
# @param individual_ids [Array<String>] Comma-delimited list of stable Finch uuids for each individual. If empty, defaul
|
16
|
-
# ...
|
17
16
|
#
|
18
17
|
# @param limit [Integer] Number of documents to return (defaults to all)
|
19
18
|
#
|
20
19
|
# @param offset [Integer] Index to start from (defaults to 0)
|
21
20
|
#
|
22
|
-
# @param types [Array<Symbol, FinchAPI::
|
23
|
-
# ...
|
21
|
+
# @param types [Array<Symbol, FinchAPI::HRIS::DocumentListParams::Type>] Comma-delimited list of document types to filter on. If empty, defaults to all t
|
24
22
|
#
|
25
23
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
|
26
24
|
#
|
@@ -28,7 +26,7 @@ module FinchAPI
|
|
28
26
|
#
|
29
27
|
# @see FinchAPI::Models::HRIS::DocumentListParams
|
30
28
|
def list(params = {})
|
31
|
-
parsed, options = FinchAPI::
|
29
|
+
parsed, options = FinchAPI::HRIS::DocumentListParams.dump_request(params)
|
32
30
|
@client.request(
|
33
31
|
method: :get,
|
34
32
|
path: "employer/documents",
|
@@ -47,7 +45,7 @@ module FinchAPI
|
|
47
45
|
#
|
48
46
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
|
49
47
|
#
|
50
|
-
# @return [FinchAPI::
|
48
|
+
# @return [FinchAPI::HRIS::W42020, FinchAPI::HRIS::W42005]
|
51
49
|
#
|
52
50
|
# @see FinchAPI::Models::HRIS::DocumentRetreiveParams
|
53
51
|
def retreive(document_id, params = {})
|
@@ -8,21 +8,21 @@ module FinchAPI
|
|
8
8
|
#
|
9
9
|
# @overload retrieve_many(requests:, request_options: {})
|
10
10
|
#
|
11
|
-
# @param requests [Array<FinchAPI::
|
11
|
+
# @param requests [Array<FinchAPI::HRIS::EmploymentRetrieveManyParams::Request>] The array of batch requests.
|
12
12
|
#
|
13
13
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
|
14
14
|
#
|
15
|
-
# @return [FinchAPI::Internal::ResponsesPage<FinchAPI::
|
15
|
+
# @return [FinchAPI::Internal::ResponsesPage<FinchAPI::HRIS::EmploymentDataResponse>]
|
16
16
|
#
|
17
17
|
# @see FinchAPI::Models::HRIS::EmploymentRetrieveManyParams
|
18
18
|
def retrieve_many(params)
|
19
|
-
parsed, options = FinchAPI::
|
19
|
+
parsed, options = FinchAPI::HRIS::EmploymentRetrieveManyParams.dump_request(params)
|
20
20
|
@client.request(
|
21
21
|
method: :post,
|
22
22
|
path: "employer/employment",
|
23
23
|
body: parsed,
|
24
24
|
page: FinchAPI::Internal::ResponsesPage,
|
25
|
-
model: FinchAPI::
|
25
|
+
model: FinchAPI::HRIS::EmploymentDataResponse,
|
26
26
|
options: options
|
27
27
|
)
|
28
28
|
end
|
@@ -8,21 +8,21 @@ module FinchAPI
|
|
8
8
|
#
|
9
9
|
# @overload retrieve_many(options: nil, requests: nil, request_options: {})
|
10
10
|
#
|
11
|
-
# @param options [FinchAPI::
|
12
|
-
# @param requests [Array<FinchAPI::
|
11
|
+
# @param options [FinchAPI::HRIS::IndividualRetrieveManyParams::Options, nil]
|
12
|
+
# @param requests [Array<FinchAPI::HRIS::IndividualRetrieveManyParams::Request>]
|
13
13
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
|
14
14
|
#
|
15
|
-
# @return [FinchAPI::Internal::ResponsesPage<FinchAPI::
|
15
|
+
# @return [FinchAPI::Internal::ResponsesPage<FinchAPI::HRIS::IndividualResponse>]
|
16
16
|
#
|
17
17
|
# @see FinchAPI::Models::HRIS::IndividualRetrieveManyParams
|
18
18
|
def retrieve_many(params = {})
|
19
|
-
parsed, options = FinchAPI::
|
19
|
+
parsed, options = FinchAPI::HRIS::IndividualRetrieveManyParams.dump_request(params)
|
20
20
|
@client.request(
|
21
21
|
method: :post,
|
22
22
|
path: "employer/individual",
|
23
23
|
body: parsed,
|
24
24
|
page: FinchAPI::Internal::ResponsesPage,
|
25
|
-
model: FinchAPI::
|
25
|
+
model: FinchAPI::HRIS::IndividualResponse,
|
26
26
|
options: options
|
27
27
|
)
|
28
28
|
end
|
@@ -11,21 +11,21 @@ module FinchAPI
|
|
11
11
|
#
|
12
12
|
# @overload retrieve_many(requests:, request_options: {})
|
13
13
|
#
|
14
|
-
# @param requests [Array<FinchAPI::
|
14
|
+
# @param requests [Array<FinchAPI::HRIS::PayStatementRetrieveManyParams::Request>] The array of batch requests.
|
15
15
|
#
|
16
16
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
|
17
17
|
#
|
18
|
-
# @return [FinchAPI::Internal::ResponsesPage<FinchAPI::
|
18
|
+
# @return [FinchAPI::Internal::ResponsesPage<FinchAPI::HRIS::PayStatementResponse>]
|
19
19
|
#
|
20
20
|
# @see FinchAPI::Models::HRIS::PayStatementRetrieveManyParams
|
21
21
|
def retrieve_many(params)
|
22
|
-
parsed, options = FinchAPI::
|
22
|
+
parsed, options = FinchAPI::HRIS::PayStatementRetrieveManyParams.dump_request(params)
|
23
23
|
@client.request(
|
24
24
|
method: :post,
|
25
25
|
path: "employer/pay-statement",
|
26
26
|
body: parsed,
|
27
27
|
page: FinchAPI::Internal::ResponsesPage,
|
28
|
-
model: FinchAPI::
|
28
|
+
model: FinchAPI::HRIS::PayStatementResponse,
|
29
29
|
options: options
|
30
30
|
)
|
31
31
|
end
|
@@ -12,24 +12,22 @@ module FinchAPI
|
|
12
12
|
# @overload list(end_date:, start_date:, request_options: {})
|
13
13
|
#
|
14
14
|
# @param end_date [Date] The end date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` forma
|
15
|
-
# ...
|
16
15
|
#
|
17
16
|
# @param start_date [Date] The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` for
|
18
|
-
# ...
|
19
17
|
#
|
20
18
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
|
21
19
|
#
|
22
|
-
# @return [FinchAPI::Internal::SinglePage<FinchAPI::
|
20
|
+
# @return [FinchAPI::Internal::SinglePage<FinchAPI::HRIS::Payment>]
|
23
21
|
#
|
24
22
|
# @see FinchAPI::Models::HRIS::PaymentListParams
|
25
23
|
def list(params)
|
26
|
-
parsed, options = FinchAPI::
|
24
|
+
parsed, options = FinchAPI::HRIS::PaymentListParams.dump_request(params)
|
27
25
|
@client.request(
|
28
26
|
method: :get,
|
29
27
|
path: "employer/payment",
|
30
28
|
query: parsed,
|
31
29
|
page: FinchAPI::Internal::SinglePage,
|
32
|
-
model: FinchAPI::
|
30
|
+
model: FinchAPI::HRIS::Payment,
|
33
31
|
options: options
|
34
32
|
)
|
35
33
|
end
|
@@ -21,9 +21,9 @@ module FinchAPI
|
|
21
21
|
#
|
22
22
|
# @overload create(type:, params:, request_options: {})
|
23
23
|
#
|
24
|
-
# @param type [Symbol, FinchAPI::
|
24
|
+
# @param type [Symbol, FinchAPI::Jobs::AutomatedCreateParams::Type] The type of job to start.
|
25
25
|
#
|
26
|
-
# @param params [FinchAPI::
|
26
|
+
# @param params [FinchAPI::Jobs::AutomatedCreateParams::Params]
|
27
27
|
#
|
28
28
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
|
29
29
|
#
|
@@ -31,7 +31,7 @@ module FinchAPI
|
|
31
31
|
#
|
32
32
|
# @see FinchAPI::Models::Jobs::AutomatedCreateParams
|
33
33
|
def create(params)
|
34
|
-
parsed, options = FinchAPI::
|
34
|
+
parsed, options = FinchAPI::Jobs::AutomatedCreateParams.dump_request(params)
|
35
35
|
@client.request(
|
36
36
|
method: :post,
|
37
37
|
path: "jobs/automated",
|
@@ -48,14 +48,14 @@ module FinchAPI
|
|
48
48
|
# @param job_id [String]
|
49
49
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
|
50
50
|
#
|
51
|
-
# @return [FinchAPI::
|
51
|
+
# @return [FinchAPI::Jobs::AutomatedAsyncJob]
|
52
52
|
#
|
53
53
|
# @see FinchAPI::Models::Jobs::AutomatedRetrieveParams
|
54
54
|
def retrieve(job_id, params = {})
|
55
55
|
@client.request(
|
56
56
|
method: :get,
|
57
57
|
path: ["jobs/automated/%1$s", job_id],
|
58
|
-
model: FinchAPI::
|
58
|
+
model: FinchAPI::Jobs::AutomatedAsyncJob,
|
59
59
|
options: params[:request_options]
|
60
60
|
)
|
61
61
|
end
|
@@ -76,7 +76,7 @@ module FinchAPI
|
|
76
76
|
#
|
77
77
|
# @see FinchAPI::Models::Jobs::AutomatedListParams
|
78
78
|
def list(params = {})
|
79
|
-
parsed, options = FinchAPI::
|
79
|
+
parsed, options = FinchAPI::Jobs::AutomatedListParams.dump_request(params)
|
80
80
|
@client.request(
|
81
81
|
method: :get,
|
82
82
|
path: "jobs/automated",
|
@@ -12,14 +12,14 @@ module FinchAPI
|
|
12
12
|
# @param job_id [String]
|
13
13
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
|
14
14
|
#
|
15
|
-
# @return [FinchAPI::
|
15
|
+
# @return [FinchAPI::Jobs::ManualAsyncJob]
|
16
16
|
#
|
17
17
|
# @see FinchAPI::Models::Jobs::ManualRetrieveParams
|
18
18
|
def retrieve(job_id, params = {})
|
19
19
|
@client.request(
|
20
20
|
method: :get,
|
21
21
|
path: ["jobs/manual/%1$s", job_id],
|
22
|
-
model: FinchAPI::
|
22
|
+
model: FinchAPI::Jobs::ManualAsyncJob,
|
23
23
|
options: params[:request_options]
|
24
24
|
)
|
25
25
|
end
|
@@ -35,7 +35,7 @@ module FinchAPI
|
|
35
35
|
#
|
36
36
|
# @see FinchAPI::Models::Payroll::PayGroupListParams
|
37
37
|
def list(params = {})
|
38
|
-
parsed, options = FinchAPI::
|
38
|
+
parsed, options = FinchAPI::Payroll::PayGroupListParams.dump_request(params)
|
39
39
|
@client.request(
|
40
40
|
method: :get,
|
41
41
|
path: "employer/pay-groups",
|
@@ -9,7 +9,7 @@ module FinchAPI
|
|
9
9
|
#
|
10
10
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
|
11
11
|
#
|
12
|
-
# @return [FinchAPI::Internal::SinglePage<FinchAPI::
|
12
|
+
# @return [FinchAPI::Internal::SinglePage<FinchAPI::Provider>]
|
13
13
|
#
|
14
14
|
# @see FinchAPI::Models::ProviderListParams
|
15
15
|
def list(params = {})
|
@@ -17,7 +17,7 @@ module FinchAPI
|
|
17
17
|
method: :get,
|
18
18
|
path: "providers",
|
19
19
|
page: FinchAPI::Internal::SinglePage,
|
20
|
-
model: FinchAPI::
|
20
|
+
model: FinchAPI::Provider,
|
21
21
|
options: params[:request_options]
|
22
22
|
)
|
23
23
|
end
|
@@ -14,19 +14,14 @@ module FinchAPI
|
|
14
14
|
# @overload forward(method_:, route:, data: nil, headers: nil, params: nil, request_options: {})
|
15
15
|
#
|
16
16
|
# @param method_ [String] The HTTP method for the forwarded request. Valid values include: `GET` , `POST`
|
17
|
-
# ...
|
18
17
|
#
|
19
18
|
# @param route [String] The URL route path for the forwarded request. This value must begin with a forwa
|
20
|
-
# ...
|
21
19
|
#
|
22
20
|
# @param data [String, nil] The body for the forwarded request. This value must be specified as either a str
|
23
|
-
# ...
|
24
21
|
#
|
25
22
|
# @param headers [Object, nil] The HTTP headers to include on the forwarded request. This value must be specifi
|
26
|
-
# ...
|
27
23
|
#
|
28
24
|
# @param params [Object, nil] The query parameters for the forwarded request. This value must be specified as
|
29
|
-
# ...
|
30
25
|
#
|
31
26
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
|
32
27
|
#
|
@@ -34,7 +29,7 @@ module FinchAPI
|
|
34
29
|
#
|
35
30
|
# @see FinchAPI::Models::RequestForwardingForwardParams
|
36
31
|
def forward(params)
|
37
|
-
parsed, options = FinchAPI::
|
32
|
+
parsed, options = FinchAPI::RequestForwardingForwardParams.dump_request(params)
|
38
33
|
@client.request(
|
39
34
|
method: :post,
|
40
35
|
path: "forward",
|