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
@@ -12,21 +12,23 @@ module FinchAPI
|
|
12
12
|
# @!attribute individuals
|
13
13
|
# Array of the individual_id to enroll and a configuration object.
|
14
14
|
#
|
15
|
-
# @return [Array<FinchAPI::
|
15
|
+
# @return [Array<FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual>, nil]
|
16
16
|
optional :individuals,
|
17
|
-
-> {
|
17
|
+
-> {
|
18
|
+
FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual]
|
19
|
+
}
|
18
20
|
|
19
21
|
# @!method initialize(individuals: nil, request_options: {})
|
20
|
-
# @param individuals [Array<FinchAPI::
|
22
|
+
# @param individuals [Array<FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual>] Array of the individual_id to enroll and a configuration object.
|
21
23
|
#
|
22
24
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
|
23
25
|
|
24
26
|
class Individual < FinchAPI::Internal::Type::BaseModel
|
25
27
|
# @!attribute configuration
|
26
28
|
#
|
27
|
-
# @return [FinchAPI::
|
29
|
+
# @return [FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration, nil]
|
28
30
|
optional :configuration,
|
29
|
-
-> { FinchAPI::
|
31
|
+
-> { FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration }
|
30
32
|
|
31
33
|
# @!attribute individual_id
|
32
34
|
# Finch id (uuidv4) for the individual to enroll
|
@@ -35,19 +37,21 @@ module FinchAPI
|
|
35
37
|
optional :individual_id, String
|
36
38
|
|
37
39
|
# @!method initialize(configuration: nil, individual_id: nil)
|
38
|
-
# @param configuration [FinchAPI::
|
40
|
+
# @param configuration [FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration]
|
39
41
|
#
|
40
42
|
# @param individual_id [String] Finch id (uuidv4) for the individual to enroll
|
41
43
|
|
42
|
-
# @see FinchAPI::
|
44
|
+
# @see FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual#configuration
|
43
45
|
class Configuration < FinchAPI::Internal::Type::BaseModel
|
44
46
|
# @!attribute annual_contribution_limit
|
45
47
|
# For HSA benefits only - whether the contribution limit is for an individual or
|
46
48
|
# family
|
47
49
|
#
|
48
|
-
# @return [Symbol, FinchAPI::
|
50
|
+
# @return [Symbol, FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit, nil]
|
49
51
|
optional :annual_contribution_limit,
|
50
|
-
enum: -> {
|
52
|
+
enum: -> {
|
53
|
+
FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit
|
54
|
+
}
|
51
55
|
|
52
56
|
# @!attribute annual_maximum
|
53
57
|
# Maximum annual amount in cents
|
@@ -63,9 +67,11 @@ module FinchAPI
|
|
63
67
|
|
64
68
|
# @!attribute company_contribution
|
65
69
|
#
|
66
|
-
# @return [FinchAPI::
|
70
|
+
# @return [FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution, nil]
|
67
71
|
optional :company_contribution,
|
68
|
-
-> {
|
72
|
+
-> {
|
73
|
+
FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution
|
74
|
+
}
|
69
75
|
|
70
76
|
# @!attribute effective_date
|
71
77
|
# The date the enrollment will take effect
|
@@ -75,32 +81,33 @@ module FinchAPI
|
|
75
81
|
|
76
82
|
# @!attribute employee_deduction
|
77
83
|
#
|
78
|
-
# @return [FinchAPI::
|
84
|
+
# @return [FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction, nil]
|
79
85
|
optional :employee_deduction,
|
80
|
-
-> {
|
86
|
+
-> {
|
87
|
+
FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction
|
88
|
+
}
|
81
89
|
|
82
90
|
# @!method initialize(annual_contribution_limit: nil, annual_maximum: nil, catch_up: nil, company_contribution: nil, effective_date: nil, employee_deduction: nil)
|
83
91
|
# Some parameter documentations has been truncated, see
|
84
|
-
# {FinchAPI::
|
92
|
+
# {FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration}
|
85
93
|
# for more details.
|
86
94
|
#
|
87
|
-
# @param annual_contribution_limit [Symbol, FinchAPI::
|
88
|
-
# ...
|
95
|
+
# @param annual_contribution_limit [Symbol, FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit] For HSA benefits only - whether the contribution limit is for an individual or f
|
89
96
|
#
|
90
97
|
# @param annual_maximum [Integer, nil] Maximum annual amount in cents
|
91
98
|
#
|
92
99
|
# @param catch_up [Boolean] For retirement benefits only - whether catch up contributions are enabled
|
93
100
|
#
|
94
|
-
# @param company_contribution [FinchAPI::
|
101
|
+
# @param company_contribution [FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution]
|
95
102
|
#
|
96
103
|
# @param effective_date [Date] The date the enrollment will take effect
|
97
104
|
#
|
98
|
-
# @param employee_deduction [FinchAPI::
|
105
|
+
# @param employee_deduction [FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction]
|
99
106
|
|
100
107
|
# For HSA benefits only - whether the contribution limit is for an individual or
|
101
108
|
# family
|
102
109
|
#
|
103
|
-
# @see FinchAPI::
|
110
|
+
# @see FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration#annual_contribution_limit
|
104
111
|
module AnnualContributionLimit
|
105
112
|
extend FinchAPI::Internal::Type::Enum
|
106
113
|
|
@@ -111,7 +118,7 @@ module FinchAPI
|
|
111
118
|
# @return [Array<Symbol>]
|
112
119
|
end
|
113
120
|
|
114
|
-
# @see FinchAPI::
|
121
|
+
# @see FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration#company_contribution
|
115
122
|
class CompanyContribution < FinchAPI::Internal::Type::BaseModel
|
116
123
|
# @!attribute amount
|
117
124
|
# Amount in cents for fixed type or basis points (1/100th of a percent) for
|
@@ -122,21 +129,22 @@ module FinchAPI
|
|
122
129
|
|
123
130
|
# @!attribute type
|
124
131
|
#
|
125
|
-
# @return [Symbol, FinchAPI::
|
132
|
+
# @return [Symbol, FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type, nil]
|
126
133
|
optional :type,
|
127
|
-
enum: -> {
|
134
|
+
enum: -> {
|
135
|
+
FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type
|
136
|
+
}
|
128
137
|
|
129
138
|
# @!method initialize(amount: nil, type: nil)
|
130
139
|
# Some parameter documentations has been truncated, see
|
131
|
-
# {FinchAPI::
|
140
|
+
# {FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution}
|
132
141
|
# for more details.
|
133
142
|
#
|
134
143
|
# @param amount [Integer] Amount in cents for fixed type or basis points (1/100th of a percent) for percen
|
135
|
-
# ...
|
136
144
|
#
|
137
|
-
# @param type [Symbol, FinchAPI::
|
145
|
+
# @param type [Symbol, FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type]
|
138
146
|
|
139
|
-
# @see FinchAPI::
|
147
|
+
# @see FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution#type
|
140
148
|
module Type
|
141
149
|
extend FinchAPI::Internal::Type::Enum
|
142
150
|
|
@@ -148,7 +156,7 @@ module FinchAPI
|
|
148
156
|
end
|
149
157
|
end
|
150
158
|
|
151
|
-
# @see FinchAPI::
|
159
|
+
# @see FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration#employee_deduction
|
152
160
|
class EmployeeDeduction < FinchAPI::Internal::Type::BaseModel
|
153
161
|
# @!attribute amount
|
154
162
|
# Amount in cents for fixed type or basis points (1/100th of a percent) for
|
@@ -159,21 +167,22 @@ module FinchAPI
|
|
159
167
|
|
160
168
|
# @!attribute type
|
161
169
|
#
|
162
|
-
# @return [Symbol, FinchAPI::
|
170
|
+
# @return [Symbol, FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type, nil]
|
163
171
|
optional :type,
|
164
|
-
enum: -> {
|
172
|
+
enum: -> {
|
173
|
+
FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type
|
174
|
+
}
|
165
175
|
|
166
176
|
# @!method initialize(amount: nil, type: nil)
|
167
177
|
# Some parameter documentations has been truncated, see
|
168
|
-
# {FinchAPI::
|
178
|
+
# {FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction}
|
169
179
|
# for more details.
|
170
180
|
#
|
171
181
|
# @param amount [Integer] Amount in cents for fixed type or basis points (1/100th of a percent) for percen
|
172
|
-
# ...
|
173
182
|
#
|
174
|
-
# @param type [Symbol, FinchAPI::
|
183
|
+
# @param type [Symbol, FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type]
|
175
184
|
|
176
|
-
# @see FinchAPI::
|
185
|
+
# @see FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction#type
|
177
186
|
module Type
|
178
187
|
extend FinchAPI::Internal::Type::Enum
|
179
188
|
|
@@ -6,80 +6,80 @@ module FinchAPI
|
|
6
6
|
class BenefitsSupport < FinchAPI::Internal::Type::BaseModel
|
7
7
|
# @!attribute commuter
|
8
8
|
#
|
9
|
-
# @return [FinchAPI::
|
10
|
-
optional :commuter, -> { FinchAPI::
|
9
|
+
# @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
|
10
|
+
optional :commuter, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true
|
11
11
|
|
12
12
|
# @!attribute custom_post_tax
|
13
13
|
#
|
14
|
-
# @return [FinchAPI::
|
15
|
-
optional :custom_post_tax, -> { FinchAPI::
|
14
|
+
# @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
|
15
|
+
optional :custom_post_tax, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true
|
16
16
|
|
17
17
|
# @!attribute custom_pre_tax
|
18
18
|
#
|
19
|
-
# @return [FinchAPI::
|
20
|
-
optional :custom_pre_tax, -> { FinchAPI::
|
19
|
+
# @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
|
20
|
+
optional :custom_pre_tax, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true
|
21
21
|
|
22
22
|
# @!attribute fsa_dependent_care
|
23
23
|
#
|
24
|
-
# @return [FinchAPI::
|
25
|
-
optional :fsa_dependent_care, -> { FinchAPI::
|
24
|
+
# @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
|
25
|
+
optional :fsa_dependent_care, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true
|
26
26
|
|
27
27
|
# @!attribute fsa_medical
|
28
28
|
#
|
29
|
-
# @return [FinchAPI::
|
30
|
-
optional :fsa_medical, -> { FinchAPI::
|
29
|
+
# @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
|
30
|
+
optional :fsa_medical, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true
|
31
31
|
|
32
32
|
# @!attribute hsa_post
|
33
33
|
#
|
34
|
-
# @return [FinchAPI::
|
35
|
-
optional :hsa_post, -> { FinchAPI::
|
34
|
+
# @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
|
35
|
+
optional :hsa_post, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true
|
36
36
|
|
37
37
|
# @!attribute hsa_pre
|
38
38
|
#
|
39
|
-
# @return [FinchAPI::
|
40
|
-
optional :hsa_pre, -> { FinchAPI::
|
39
|
+
# @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
|
40
|
+
optional :hsa_pre, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true
|
41
41
|
|
42
42
|
# @!attribute s125_dental
|
43
43
|
#
|
44
|
-
# @return [FinchAPI::
|
45
|
-
optional :s125_dental, -> { FinchAPI::
|
44
|
+
# @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
|
45
|
+
optional :s125_dental, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true
|
46
46
|
|
47
47
|
# @!attribute s125_medical
|
48
48
|
#
|
49
|
-
# @return [FinchAPI::
|
50
|
-
optional :s125_medical, -> { FinchAPI::
|
49
|
+
# @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
|
50
|
+
optional :s125_medical, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true
|
51
51
|
|
52
52
|
# @!attribute s125_vision
|
53
53
|
#
|
54
|
-
# @return [FinchAPI::
|
55
|
-
optional :s125_vision, -> { FinchAPI::
|
54
|
+
# @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
|
55
|
+
optional :s125_vision, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true
|
56
56
|
|
57
57
|
# @!attribute simple
|
58
58
|
#
|
59
|
-
# @return [FinchAPI::
|
60
|
-
optional :simple, -> { FinchAPI::
|
59
|
+
# @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
|
60
|
+
optional :simple, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true
|
61
61
|
|
62
62
|
# @!attribute simple_ira
|
63
63
|
#
|
64
|
-
# @return [FinchAPI::
|
65
|
-
optional :simple_ira, -> { FinchAPI::
|
64
|
+
# @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
|
65
|
+
optional :simple_ira, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true
|
66
66
|
|
67
67
|
# @!method initialize(commuter: nil, custom_post_tax: nil, custom_pre_tax: nil, fsa_dependent_care: nil, fsa_medical: nil, hsa_post: nil, hsa_pre: nil, s125_dental: nil, s125_medical: nil, s125_vision: nil, simple: nil, simple_ira: nil)
|
68
68
|
# Each benefit type and their supported features. If the benefit type is not
|
69
69
|
# supported, the property will be null
|
70
70
|
#
|
71
|
-
# @param commuter [FinchAPI::
|
72
|
-
# @param custom_post_tax [FinchAPI::
|
73
|
-
# @param custom_pre_tax [FinchAPI::
|
74
|
-
# @param fsa_dependent_care [FinchAPI::
|
75
|
-
# @param fsa_medical [FinchAPI::
|
76
|
-
# @param hsa_post [FinchAPI::
|
77
|
-
# @param hsa_pre [FinchAPI::
|
78
|
-
# @param s125_dental [FinchAPI::
|
79
|
-
# @param s125_medical [FinchAPI::
|
80
|
-
# @param s125_vision [FinchAPI::
|
81
|
-
# @param simple [FinchAPI::
|
82
|
-
# @param simple_ira [FinchAPI::
|
71
|
+
# @param commuter [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
|
72
|
+
# @param custom_post_tax [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
|
73
|
+
# @param custom_pre_tax [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
|
74
|
+
# @param fsa_dependent_care [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
|
75
|
+
# @param fsa_medical [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
|
76
|
+
# @param hsa_post [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
|
77
|
+
# @param hsa_pre [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
|
78
|
+
# @param s125_dental [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
|
79
|
+
# @param s125_medical [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
|
80
|
+
# @param s125_vision [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
|
81
|
+
# @param simple [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
|
82
|
+
# @param simple_ira [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
|
83
83
|
end
|
84
84
|
end
|
85
85
|
end
|
@@ -13,15 +13,19 @@ module FinchAPI
|
|
13
13
|
# @!attribute attributes
|
14
14
|
# Specifies the fields to be applied when the condition is met.
|
15
15
|
#
|
16
|
-
# @return [FinchAPI::
|
16
|
+
# @return [FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes, nil]
|
17
17
|
optional :attributes,
|
18
|
-
-> {
|
18
|
+
-> {
|
19
|
+
FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes
|
20
|
+
}
|
19
21
|
|
20
22
|
# @!attribute conditions
|
21
23
|
#
|
22
|
-
# @return [Array<FinchAPI::
|
24
|
+
# @return [Array<FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition>, nil]
|
23
25
|
optional :conditions,
|
24
|
-
-> {
|
26
|
+
-> {
|
27
|
+
FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition]
|
28
|
+
}
|
25
29
|
|
26
30
|
# @!attribute effective_end_date
|
27
31
|
# Specifies when the rules should stop applying rules based on the date.
|
@@ -38,20 +42,20 @@ module FinchAPI
|
|
38
42
|
# @!attribute entity_type
|
39
43
|
# The entity type to which the rule is applied.
|
40
44
|
#
|
41
|
-
# @return [Symbol, FinchAPI::
|
45
|
+
# @return [Symbol, FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType, nil]
|
42
46
|
optional :entity_type,
|
43
|
-
enum: -> { FinchAPI::
|
47
|
+
enum: -> { FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType }
|
44
48
|
|
45
49
|
# @!method initialize(attributes: nil, conditions: nil, effective_end_date: nil, effective_start_date: nil, entity_type: nil, request_options: {})
|
46
|
-
# @param attributes [FinchAPI::
|
50
|
+
# @param attributes [FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes] Specifies the fields to be applied when the condition is met.
|
47
51
|
#
|
48
|
-
# @param conditions [Array<FinchAPI::
|
52
|
+
# @param conditions [Array<FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition>]
|
49
53
|
#
|
50
54
|
# @param effective_end_date [String, nil] Specifies when the rules should stop applying rules based on the date.
|
51
55
|
#
|
52
56
|
# @param effective_start_date [String, nil] Specifies when the rule should begin applying based on the date.
|
53
57
|
#
|
54
|
-
# @param entity_type [Symbol, FinchAPI::
|
58
|
+
# @param entity_type [Symbol, FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType] The entity type to which the rule is applied.
|
55
59
|
#
|
56
60
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
|
57
61
|
|
@@ -65,13 +69,12 @@ module FinchAPI
|
|
65
69
|
|
66
70
|
# @!method initialize(metadata: nil)
|
67
71
|
# Some parameter documentations has been truncated, see
|
68
|
-
# {FinchAPI::
|
69
|
-
#
|
72
|
+
# {FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes} for
|
73
|
+
# more details.
|
70
74
|
#
|
71
75
|
# Specifies the fields to be applied when the condition is met.
|
72
76
|
#
|
73
77
|
# @param metadata [Hash{Symbol=>Object}] The metadata to be attached in the entity. It is a key-value pairs where the val
|
74
|
-
# ...
|
75
78
|
end
|
76
79
|
|
77
80
|
class Condition < FinchAPI::Internal::Type::BaseModel
|
@@ -84,9 +87,11 @@ module FinchAPI
|
|
84
87
|
# @!attribute operator
|
85
88
|
# The operator to be used in the rule.
|
86
89
|
#
|
87
|
-
# @return [Symbol, FinchAPI::
|
90
|
+
# @return [Symbol, FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::Operator, nil]
|
88
91
|
optional :operator,
|
89
|
-
enum: -> {
|
92
|
+
enum: -> {
|
93
|
+
FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::Operator
|
94
|
+
}
|
90
95
|
|
91
96
|
# @!attribute value
|
92
97
|
# The value of the field to be checked in the rule.
|
@@ -97,13 +102,13 @@ module FinchAPI
|
|
97
102
|
# @!method initialize(field: nil, operator: nil, value: nil)
|
98
103
|
# @param field [String] The field to be checked in the rule.
|
99
104
|
#
|
100
|
-
# @param operator [Symbol, FinchAPI::
|
105
|
+
# @param operator [Symbol, FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::Operator] The operator to be used in the rule.
|
101
106
|
#
|
102
107
|
# @param value [String] The value of the field to be checked in the rule.
|
103
108
|
|
104
109
|
# The operator to be used in the rule.
|
105
110
|
#
|
106
|
-
# @see FinchAPI::
|
111
|
+
# @see FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition#operator
|
107
112
|
module Operator
|
108
113
|
extend FinchAPI::Internal::Type::Enum
|
109
114
|
|
@@ -99,7 +99,6 @@ module FinchAPI
|
|
99
99
|
# Specifies the fields to be applied when the condition is met.
|
100
100
|
#
|
101
101
|
# @param metadata [Hash{Symbol=>Object}] The metadata to be attached in the entity. It is a key-value pairs where the val
|
102
|
-
# ...
|
103
102
|
end
|
104
103
|
|
105
104
|
class Condition < FinchAPI::Internal::Type::BaseModel
|
@@ -107,7 +107,6 @@ module FinchAPI
|
|
107
107
|
# Specifies the fields to be applied when the condition is met.
|
108
108
|
#
|
109
109
|
# @param metadata [Hash{Symbol=>Object}] The metadata to be attached in the entity. It is a key-value pairs where the val
|
110
|
-
# ...
|
111
110
|
end
|
112
111
|
|
113
112
|
class Condition < FinchAPI::Internal::Type::BaseModel
|
@@ -99,7 +99,6 @@ module FinchAPI
|
|
99
99
|
# Specifies the fields to be applied when the condition is met.
|
100
100
|
#
|
101
101
|
# @param metadata [Hash{Symbol=>Object}] The metadata to be attached in the entity. It is a key-value pairs where the val
|
102
|
-
# ...
|
103
102
|
end
|
104
103
|
|
105
104
|
class Condition < FinchAPI::Internal::Type::BaseModel
|
@@ -99,7 +99,6 @@ module FinchAPI
|
|
99
99
|
# Specifies the fields to be applied when the condition is met.
|
100
100
|
#
|
101
101
|
# @param metadata [Hash{Symbol=>Object}] The metadata to be attached in the entity. It is a key-value pairs where the val
|
102
|
-
# ...
|
103
102
|
end
|
104
103
|
|
105
104
|
class Condition < FinchAPI::Internal::Type::BaseModel
|
@@ -13,9 +13,11 @@ module FinchAPI
|
|
13
13
|
# Comma-delimited list of pay statement item categories to filter on. If empty,
|
14
14
|
# defaults to all categories.
|
15
15
|
#
|
16
|
-
# @return [Array<Symbol, FinchAPI::
|
16
|
+
# @return [Array<Symbol, FinchAPI::HRIS::Company::PayStatementItemListParams::Category>, nil]
|
17
17
|
optional :categories,
|
18
|
-
-> {
|
18
|
+
-> {
|
19
|
+
FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::Company::PayStatementItemListParams::Category]
|
20
|
+
}
|
19
21
|
|
20
22
|
# @!attribute end_date
|
21
23
|
# The end date to retrieve pay statement items by via their last seen pay date in
|
@@ -47,16 +49,13 @@ module FinchAPI
|
|
47
49
|
# Some parameter documentations has been truncated, see
|
48
50
|
# {FinchAPI::Models::HRIS::Company::PayStatementItemListParams} for more details.
|
49
51
|
#
|
50
|
-
# @param categories [Array<Symbol, FinchAPI::
|
51
|
-
# ...
|
52
|
+
# @param categories [Array<Symbol, FinchAPI::HRIS::Company::PayStatementItemListParams::Category>] Comma-delimited list of pay statement item categories to filter on. If empty, de
|
52
53
|
#
|
53
54
|
# @param end_date [Date] The end date to retrieve pay statement items by via their last seen pay date in
|
54
|
-
# ...
|
55
55
|
#
|
56
56
|
# @param name [String] Case-insensitive partial match search by pay statement item name.
|
57
57
|
#
|
58
58
|
# @param start_date [Date] The start date to retrieve pay statement items by via their last seen pay date (
|
59
|
-
# ...
|
60
59
|
#
|
61
60
|
# @param type [String] String search by pay statement item type.
|
62
61
|
#
|
@@ -70,13 +70,10 @@ module FinchAPI
|
|
70
70
|
# The attributes of the pay statement item.
|
71
71
|
#
|
72
72
|
# @param employer [Boolean, nil] `true` if the amount is paid by the employers. This field is only available for
|
73
|
-
# ...
|
74
73
|
#
|
75
74
|
# @param metadata [Hash{Symbol=>Object, nil}, nil] The metadata of the pay statement item derived by the rules engine if available.
|
76
|
-
# ...
|
77
75
|
#
|
78
76
|
# @param pre_tax [Boolean, nil] `true` if the pay statement item is pre-tax. This field is only available for em
|
79
|
-
# ...
|
80
77
|
#
|
81
78
|
# @param type [String, nil] The type of the pay statement item.
|
82
79
|
end
|