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
@@ -13,9 +13,9 @@ module FinchAPI
|
|
13
13
|
# @!attribute authentication_methods
|
14
14
|
# The list of authentication methods supported by the provider.
|
15
15
|
#
|
16
|
-
# @return [Array<FinchAPI::
|
16
|
+
# @return [Array<FinchAPI::Provider::AuthenticationMethod>, nil]
|
17
17
|
optional :authentication_methods,
|
18
|
-
-> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::
|
18
|
+
-> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Provider::AuthenticationMethod] }
|
19
19
|
|
20
20
|
# @!attribute beta
|
21
21
|
# `true` if the integration is in a beta state, `false` otherwise
|
@@ -68,12 +68,12 @@ module FinchAPI
|
|
68
68
|
optional :products, FinchAPI::Internal::Type::ArrayOf[String]
|
69
69
|
|
70
70
|
# @!method initialize(id: nil, authentication_methods: nil, beta: nil, display_name: nil, icon: nil, logo: nil, manual: nil, mfa_required: nil, primary_color: nil, products: nil)
|
71
|
-
# Some parameter documentations has been truncated, see
|
72
|
-
#
|
71
|
+
# Some parameter documentations has been truncated, see {FinchAPI::Provider} for
|
72
|
+
# more details.
|
73
73
|
#
|
74
74
|
# @param id [String] The id of the payroll provider used in Connect.
|
75
75
|
#
|
76
|
-
# @param authentication_methods [Array<FinchAPI::
|
76
|
+
# @param authentication_methods [Array<FinchAPI::Provider::AuthenticationMethod>] The list of authentication methods supported by the provider.
|
77
77
|
#
|
78
78
|
# @param beta [Boolean] `true` if the integration is in a beta state, `false` otherwise
|
79
79
|
#
|
@@ -84,7 +84,6 @@ module FinchAPI
|
|
84
84
|
# @param logo [String] The url to the official logo of the payroll provider.
|
85
85
|
#
|
86
86
|
# @param manual [Boolean] [DEPRECATED] Whether the Finch integration with this provider uses the Assisted
|
87
|
-
# ...
|
88
87
|
#
|
89
88
|
# @param mfa_required [Boolean] whether MFA is required for the provider.
|
90
89
|
#
|
@@ -97,84 +96,87 @@ module FinchAPI
|
|
97
96
|
# Each benefit type and their supported features. If the benefit type is not
|
98
97
|
# supported, the property will be null
|
99
98
|
#
|
100
|
-
# @return [FinchAPI::
|
101
|
-
optional :benefits_support, -> { FinchAPI::
|
99
|
+
# @return [FinchAPI::HRIS::BenefitsSupport, nil]
|
100
|
+
optional :benefits_support, -> { FinchAPI::HRIS::BenefitsSupport }, nil?: true
|
102
101
|
|
103
102
|
# @!attribute supported_fields
|
104
103
|
# The supported data fields returned by our HR and payroll endpoints
|
105
104
|
#
|
106
|
-
# @return [FinchAPI::
|
105
|
+
# @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields, nil]
|
107
106
|
optional :supported_fields,
|
108
|
-
-> {
|
107
|
+
-> {
|
108
|
+
FinchAPI::Provider::AuthenticationMethod::SupportedFields
|
109
|
+
},
|
109
110
|
nil?: true
|
110
111
|
|
111
112
|
# @!attribute type
|
112
113
|
# The type of authentication method.
|
113
114
|
#
|
114
|
-
# @return [Symbol, FinchAPI::
|
115
|
-
optional :type, enum: -> { FinchAPI::
|
115
|
+
# @return [Symbol, FinchAPI::Provider::AuthenticationMethod::Type, nil]
|
116
|
+
optional :type, enum: -> { FinchAPI::Provider::AuthenticationMethod::Type }
|
116
117
|
|
117
118
|
# @!method initialize(benefits_support: nil, supported_fields: nil, type: nil)
|
118
119
|
# Some parameter documentations has been truncated, see
|
119
|
-
# {FinchAPI::
|
120
|
+
# {FinchAPI::Provider::AuthenticationMethod} for more details.
|
120
121
|
#
|
121
|
-
# @param benefits_support [FinchAPI::
|
122
|
-
# ...
|
122
|
+
# @param benefits_support [FinchAPI::HRIS::BenefitsSupport, nil] Each benefit type and their supported features. If the benefit type is not suppo
|
123
123
|
#
|
124
|
-
# @param supported_fields [FinchAPI::
|
124
|
+
# @param supported_fields [FinchAPI::Provider::AuthenticationMethod::SupportedFields, nil] The supported data fields returned by our HR and payroll endpoints
|
125
125
|
#
|
126
|
-
# @param type [Symbol, FinchAPI::
|
126
|
+
# @param type [Symbol, FinchAPI::Provider::AuthenticationMethod::Type] The type of authentication method.
|
127
127
|
|
128
|
-
# @see FinchAPI::
|
128
|
+
# @see FinchAPI::Provider::AuthenticationMethod#supported_fields
|
129
129
|
class SupportedFields < FinchAPI::Internal::Type::BaseModel
|
130
130
|
# @!attribute company
|
131
131
|
#
|
132
|
-
# @return [FinchAPI::
|
133
|
-
optional :company, -> { FinchAPI::
|
132
|
+
# @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company, nil]
|
133
|
+
optional :company, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company }
|
134
134
|
|
135
135
|
# @!attribute directory
|
136
136
|
#
|
137
|
-
# @return [FinchAPI::
|
138
|
-
optional :directory, -> { FinchAPI::
|
137
|
+
# @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory, nil]
|
138
|
+
optional :directory, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory }
|
139
139
|
|
140
140
|
# @!attribute employment
|
141
141
|
#
|
142
|
-
# @return [FinchAPI::
|
143
|
-
optional :employment, -> { FinchAPI::
|
142
|
+
# @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment, nil]
|
143
|
+
optional :employment, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment }
|
144
144
|
|
145
145
|
# @!attribute individual
|
146
146
|
#
|
147
|
-
# @return [FinchAPI::
|
148
|
-
optional :individual, -> { FinchAPI::
|
147
|
+
# @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual, nil]
|
148
|
+
optional :individual, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual }
|
149
149
|
|
150
150
|
# @!attribute pay_group
|
151
151
|
#
|
152
|
-
# @return [FinchAPI::
|
153
|
-
optional :pay_group, -> { FinchAPI::
|
152
|
+
# @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayGroup, nil]
|
153
|
+
optional :pay_group, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayGroup }
|
154
154
|
|
155
155
|
# @!attribute pay_statement
|
156
156
|
#
|
157
|
-
# @return [FinchAPI::
|
157
|
+
# @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement, nil]
|
158
158
|
optional :pay_statement,
|
159
|
-
-> {
|
159
|
+
-> {
|
160
|
+
FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement
|
161
|
+
}
|
160
162
|
|
161
163
|
# @!attribute payment
|
162
164
|
#
|
163
|
-
# @return [FinchAPI::
|
164
|
-
optional :payment, -> { FinchAPI::
|
165
|
+
# @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment, nil]
|
166
|
+
optional :payment, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment }
|
165
167
|
|
166
168
|
# @!method initialize(company: nil, directory: nil, employment: nil, individual: nil, pay_group: nil, pay_statement: nil, payment: nil)
|
167
169
|
# The supported data fields returned by our HR and payroll endpoints
|
168
170
|
#
|
169
|
-
# @param company [FinchAPI::
|
170
|
-
# @param directory [FinchAPI::
|
171
|
-
# @param employment [FinchAPI::
|
172
|
-
# @param individual [FinchAPI::
|
173
|
-
# @param pay_group [FinchAPI::
|
174
|
-
# @param pay_statement [FinchAPI::
|
175
|
-
# @param payment [FinchAPI::
|
176
|
-
|
177
|
-
# @see FinchAPI::
|
171
|
+
# @param company [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company]
|
172
|
+
# @param directory [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory]
|
173
|
+
# @param employment [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment]
|
174
|
+
# @param individual [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual]
|
175
|
+
# @param pay_group [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayGroup]
|
176
|
+
# @param pay_statement [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement]
|
177
|
+
# @param payment [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment]
|
178
|
+
|
179
|
+
# @see FinchAPI::Provider::AuthenticationMethod::SupportedFields#company
|
178
180
|
class Company < FinchAPI::Internal::Type::BaseModel
|
179
181
|
# @!attribute id
|
180
182
|
#
|
@@ -183,15 +185,17 @@ module FinchAPI
|
|
183
185
|
|
184
186
|
# @!attribute accounts
|
185
187
|
#
|
186
|
-
# @return [FinchAPI::
|
188
|
+
# @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Accounts, nil]
|
187
189
|
optional :accounts,
|
188
|
-
-> {
|
190
|
+
-> {
|
191
|
+
FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Accounts
|
192
|
+
}
|
189
193
|
|
190
194
|
# @!attribute departments
|
191
195
|
#
|
192
|
-
# @return [FinchAPI::
|
196
|
+
# @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments, nil]
|
193
197
|
optional :departments,
|
194
|
-
-> { FinchAPI::
|
198
|
+
-> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments }
|
195
199
|
|
196
200
|
# @!attribute ein
|
197
201
|
#
|
@@ -200,9 +204,11 @@ module FinchAPI
|
|
200
204
|
|
201
205
|
# @!attribute entity
|
202
206
|
#
|
203
|
-
# @return [FinchAPI::
|
207
|
+
# @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Entity, nil]
|
204
208
|
optional :entity,
|
205
|
-
-> {
|
209
|
+
-> {
|
210
|
+
FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Entity
|
211
|
+
}
|
206
212
|
|
207
213
|
# @!attribute legal_name
|
208
214
|
#
|
@@ -211,9 +217,11 @@ module FinchAPI
|
|
211
217
|
|
212
218
|
# @!attribute locations
|
213
219
|
#
|
214
|
-
# @return [FinchAPI::
|
220
|
+
# @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Locations, nil]
|
215
221
|
optional :locations,
|
216
|
-
-> {
|
222
|
+
-> {
|
223
|
+
FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Locations
|
224
|
+
}
|
217
225
|
|
218
226
|
# @!attribute primary_email
|
219
227
|
#
|
@@ -227,16 +235,16 @@ module FinchAPI
|
|
227
235
|
|
228
236
|
# @!method initialize(id: nil, accounts: nil, departments: nil, ein: nil, entity: nil, legal_name: nil, locations: nil, primary_email: nil, primary_phone_number: nil)
|
229
237
|
# @param id [Boolean]
|
230
|
-
# @param accounts [FinchAPI::
|
231
|
-
# @param departments [FinchAPI::
|
238
|
+
# @param accounts [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Accounts]
|
239
|
+
# @param departments [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments]
|
232
240
|
# @param ein [Boolean]
|
233
|
-
# @param entity [FinchAPI::
|
241
|
+
# @param entity [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Entity]
|
234
242
|
# @param legal_name [Boolean]
|
235
|
-
# @param locations [FinchAPI::
|
243
|
+
# @param locations [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Locations]
|
236
244
|
# @param primary_email [Boolean]
|
237
245
|
# @param primary_phone_number [Boolean]
|
238
246
|
|
239
|
-
# @see FinchAPI::
|
247
|
+
# @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company#accounts
|
240
248
|
class Accounts < FinchAPI::Internal::Type::BaseModel
|
241
249
|
# @!attribute account_name
|
242
250
|
#
|
@@ -271,7 +279,7 @@ module FinchAPI
|
|
271
279
|
# @param routing_number [Boolean]
|
272
280
|
end
|
273
281
|
|
274
|
-
# @see FinchAPI::
|
282
|
+
# @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company#departments
|
275
283
|
class Departments < FinchAPI::Internal::Type::BaseModel
|
276
284
|
# @!attribute name
|
277
285
|
#
|
@@ -280,15 +288,17 @@ module FinchAPI
|
|
280
288
|
|
281
289
|
# @!attribute parent
|
282
290
|
#
|
283
|
-
# @return [FinchAPI::
|
291
|
+
# @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent, nil]
|
284
292
|
optional :parent,
|
285
|
-
-> {
|
293
|
+
-> {
|
294
|
+
FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent
|
295
|
+
}
|
286
296
|
|
287
297
|
# @!method initialize(name: nil, parent: nil)
|
288
298
|
# @param name [Boolean]
|
289
|
-
# @param parent [FinchAPI::
|
299
|
+
# @param parent [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent]
|
290
300
|
|
291
|
-
# @see FinchAPI::
|
301
|
+
# @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments#parent
|
292
302
|
class Parent < FinchAPI::Internal::Type::BaseModel
|
293
303
|
# @!attribute name
|
294
304
|
#
|
@@ -300,7 +310,7 @@ module FinchAPI
|
|
300
310
|
end
|
301
311
|
end
|
302
312
|
|
303
|
-
# @see FinchAPI::
|
313
|
+
# @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company#entity
|
304
314
|
class Entity < FinchAPI::Internal::Type::BaseModel
|
305
315
|
# @!attribute subtype
|
306
316
|
#
|
@@ -317,7 +327,7 @@ module FinchAPI
|
|
317
327
|
# @param type [Boolean]
|
318
328
|
end
|
319
329
|
|
320
|
-
# @see FinchAPI::
|
330
|
+
# @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company#locations
|
321
331
|
class Locations < FinchAPI::Internal::Type::BaseModel
|
322
332
|
# @!attribute city
|
323
333
|
#
|
@@ -359,25 +369,27 @@ module FinchAPI
|
|
359
369
|
end
|
360
370
|
end
|
361
371
|
|
362
|
-
# @see FinchAPI::
|
372
|
+
# @see FinchAPI::Provider::AuthenticationMethod::SupportedFields#directory
|
363
373
|
class Directory < FinchAPI::Internal::Type::BaseModel
|
364
374
|
# @!attribute individuals
|
365
375
|
#
|
366
|
-
# @return [FinchAPI::
|
376
|
+
# @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals, nil]
|
367
377
|
optional :individuals,
|
368
|
-
-> { FinchAPI::
|
378
|
+
-> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals }
|
369
379
|
|
370
380
|
# @!attribute paging
|
371
381
|
#
|
372
|
-
# @return [FinchAPI::
|
382
|
+
# @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Paging, nil]
|
373
383
|
optional :paging,
|
374
|
-
-> {
|
384
|
+
-> {
|
385
|
+
FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Paging
|
386
|
+
}
|
375
387
|
|
376
388
|
# @!method initialize(individuals: nil, paging: nil)
|
377
|
-
# @param individuals [FinchAPI::
|
378
|
-
# @param paging [FinchAPI::
|
389
|
+
# @param individuals [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals]
|
390
|
+
# @param paging [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Paging]
|
379
391
|
|
380
|
-
# @see FinchAPI::
|
392
|
+
# @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory#individuals
|
381
393
|
class Individuals < FinchAPI::Internal::Type::BaseModel
|
382
394
|
# @!attribute id
|
383
395
|
#
|
@@ -406,9 +418,11 @@ module FinchAPI
|
|
406
418
|
|
407
419
|
# @!attribute manager
|
408
420
|
#
|
409
|
-
# @return [FinchAPI::
|
421
|
+
# @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, nil]
|
410
422
|
optional :manager,
|
411
|
-
-> {
|
423
|
+
-> {
|
424
|
+
FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager
|
425
|
+
}
|
412
426
|
|
413
427
|
# @!attribute middle_name
|
414
428
|
#
|
@@ -421,10 +435,10 @@ module FinchAPI
|
|
421
435
|
# @param first_name [Boolean]
|
422
436
|
# @param is_active [Boolean]
|
423
437
|
# @param last_name [Boolean]
|
424
|
-
# @param manager [FinchAPI::
|
438
|
+
# @param manager [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager]
|
425
439
|
# @param middle_name [Boolean]
|
426
440
|
|
427
|
-
# @see FinchAPI::
|
441
|
+
# @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals#manager
|
428
442
|
class Manager < FinchAPI::Internal::Type::BaseModel
|
429
443
|
# @!attribute id
|
430
444
|
#
|
@@ -436,7 +450,7 @@ module FinchAPI
|
|
436
450
|
end
|
437
451
|
end
|
438
452
|
|
439
|
-
# @see FinchAPI::
|
453
|
+
# @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory#paging
|
440
454
|
class Paging < FinchAPI::Internal::Type::BaseModel
|
441
455
|
# @!attribute count
|
442
456
|
#
|
@@ -454,7 +468,7 @@ module FinchAPI
|
|
454
468
|
end
|
455
469
|
end
|
456
470
|
|
457
|
-
# @see FinchAPI::
|
471
|
+
# @see FinchAPI::Provider::AuthenticationMethod::SupportedFields#employment
|
458
472
|
class Employment < FinchAPI::Internal::Type::BaseModel
|
459
473
|
# @!attribute id
|
460
474
|
#
|
@@ -473,15 +487,15 @@ module FinchAPI
|
|
473
487
|
|
474
488
|
# @!attribute department
|
475
489
|
#
|
476
|
-
# @return [FinchAPI::
|
490
|
+
# @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Department, nil]
|
477
491
|
optional :department,
|
478
|
-
-> { FinchAPI::
|
492
|
+
-> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Department }
|
479
493
|
|
480
494
|
# @!attribute employment
|
481
495
|
#
|
482
|
-
# @return [FinchAPI::
|
496
|
+
# @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Employment, nil]
|
483
497
|
optional :employment,
|
484
|
-
-> { FinchAPI::
|
498
|
+
-> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Employment }
|
485
499
|
|
486
500
|
# @!attribute employment_status
|
487
501
|
#
|
@@ -500,9 +514,11 @@ module FinchAPI
|
|
500
514
|
|
501
515
|
# @!attribute income
|
502
516
|
#
|
503
|
-
# @return [FinchAPI::
|
517
|
+
# @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Income, nil]
|
504
518
|
optional :income,
|
505
|
-
-> {
|
519
|
+
-> {
|
520
|
+
FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Income
|
521
|
+
}
|
506
522
|
|
507
523
|
# @!attribute income_history
|
508
524
|
#
|
@@ -521,15 +537,19 @@ module FinchAPI
|
|
521
537
|
|
522
538
|
# @!attribute location
|
523
539
|
#
|
524
|
-
# @return [FinchAPI::
|
540
|
+
# @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Location, nil]
|
525
541
|
optional :location,
|
526
|
-
-> {
|
542
|
+
-> {
|
543
|
+
FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Location
|
544
|
+
}
|
527
545
|
|
528
546
|
# @!attribute manager
|
529
547
|
#
|
530
|
-
# @return [FinchAPI::
|
548
|
+
# @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Manager, nil]
|
531
549
|
optional :manager,
|
532
|
-
-> {
|
550
|
+
-> {
|
551
|
+
FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Manager
|
552
|
+
}
|
533
553
|
|
534
554
|
# @!attribute middle_name
|
535
555
|
#
|
@@ -550,22 +570,22 @@ module FinchAPI
|
|
550
570
|
# @param id [Boolean]
|
551
571
|
# @param class_code [Boolean]
|
552
572
|
# @param custom_fields [Boolean]
|
553
|
-
# @param department [FinchAPI::
|
554
|
-
# @param employment [FinchAPI::
|
573
|
+
# @param department [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Department]
|
574
|
+
# @param employment [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Employment]
|
555
575
|
# @param employment_status [Boolean]
|
556
576
|
# @param end_date [Boolean]
|
557
577
|
# @param first_name [Boolean]
|
558
|
-
# @param income [FinchAPI::
|
578
|
+
# @param income [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Income]
|
559
579
|
# @param income_history [Boolean]
|
560
580
|
# @param is_active [Boolean]
|
561
581
|
# @param last_name [Boolean]
|
562
|
-
# @param location [FinchAPI::
|
563
|
-
# @param manager [FinchAPI::
|
582
|
+
# @param location [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Location]
|
583
|
+
# @param manager [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Manager]
|
564
584
|
# @param middle_name [Boolean]
|
565
585
|
# @param start_date [Boolean]
|
566
586
|
# @param title [Boolean]
|
567
587
|
|
568
|
-
# @see FinchAPI::
|
588
|
+
# @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment#department
|
569
589
|
class Department < FinchAPI::Internal::Type::BaseModel
|
570
590
|
# @!attribute name
|
571
591
|
#
|
@@ -576,7 +596,7 @@ module FinchAPI
|
|
576
596
|
# @param name [Boolean]
|
577
597
|
end
|
578
598
|
|
579
|
-
# @see FinchAPI::
|
599
|
+
# @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment#employment
|
580
600
|
class Employment < FinchAPI::Internal::Type::BaseModel
|
581
601
|
# @!attribute subtype
|
582
602
|
#
|
@@ -593,7 +613,7 @@ module FinchAPI
|
|
593
613
|
# @param type [Boolean]
|
594
614
|
end
|
595
615
|
|
596
|
-
# @see FinchAPI::
|
616
|
+
# @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment#income
|
597
617
|
class Income < FinchAPI::Internal::Type::BaseModel
|
598
618
|
# @!attribute amount
|
599
619
|
#
|
@@ -616,7 +636,7 @@ module FinchAPI
|
|
616
636
|
# @param unit [Boolean]
|
617
637
|
end
|
618
638
|
|
619
|
-
# @see FinchAPI::
|
639
|
+
# @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment#location
|
620
640
|
class Location < FinchAPI::Internal::Type::BaseModel
|
621
641
|
# @!attribute city
|
622
642
|
#
|
@@ -657,7 +677,7 @@ module FinchAPI
|
|
657
677
|
# @param state [Boolean]
|
658
678
|
end
|
659
679
|
|
660
|
-
# @see FinchAPI::
|
680
|
+
# @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment#manager
|
661
681
|
class Manager < FinchAPI::Internal::Type::BaseModel
|
662
682
|
# @!attribute id
|
663
683
|
#
|
@@ -669,7 +689,7 @@ module FinchAPI
|
|
669
689
|
end
|
670
690
|
end
|
671
691
|
|
672
|
-
# @see FinchAPI::
|
692
|
+
# @see FinchAPI::Provider::AuthenticationMethod::SupportedFields#individual
|
673
693
|
class Individual < FinchAPI::Internal::Type::BaseModel
|
674
694
|
# @!attribute id
|
675
695
|
#
|
@@ -683,9 +703,11 @@ module FinchAPI
|
|
683
703
|
|
684
704
|
# @!attribute emails
|
685
705
|
#
|
686
|
-
# @return [FinchAPI::
|
706
|
+
# @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Emails, nil]
|
687
707
|
optional :emails,
|
688
|
-
-> {
|
708
|
+
-> {
|
709
|
+
FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Emails
|
710
|
+
}
|
689
711
|
|
690
712
|
# @!attribute encrypted_ssn
|
691
713
|
#
|
@@ -719,9 +741,11 @@ module FinchAPI
|
|
719
741
|
|
720
742
|
# @!attribute phone_numbers
|
721
743
|
#
|
722
|
-
# @return [FinchAPI::
|
744
|
+
# @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, nil]
|
723
745
|
optional :phone_numbers,
|
724
|
-
-> {
|
746
|
+
-> {
|
747
|
+
FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers
|
748
|
+
}
|
725
749
|
|
726
750
|
# @!attribute preferred_name
|
727
751
|
#
|
@@ -730,9 +754,9 @@ module FinchAPI
|
|
730
754
|
|
731
755
|
# @!attribute residence
|
732
756
|
#
|
733
|
-
# @return [FinchAPI::
|
757
|
+
# @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Residence, nil]
|
734
758
|
optional :residence,
|
735
|
-
-> { FinchAPI::
|
759
|
+
-> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Residence }
|
736
760
|
|
737
761
|
# @!attribute ssn
|
738
762
|
#
|
@@ -742,19 +766,19 @@ module FinchAPI
|
|
742
766
|
# @!method initialize(id: nil, dob: nil, emails: nil, encrypted_ssn: nil, ethnicity: nil, first_name: nil, gender: nil, last_name: nil, middle_name: nil, phone_numbers: nil, preferred_name: nil, residence: nil, ssn: nil)
|
743
767
|
# @param id [Boolean]
|
744
768
|
# @param dob [Boolean]
|
745
|
-
# @param emails [FinchAPI::
|
769
|
+
# @param emails [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Emails]
|
746
770
|
# @param encrypted_ssn [Boolean]
|
747
771
|
# @param ethnicity [Boolean]
|
748
772
|
# @param first_name [Boolean]
|
749
773
|
# @param gender [Boolean]
|
750
774
|
# @param last_name [Boolean]
|
751
775
|
# @param middle_name [Boolean]
|
752
|
-
# @param phone_numbers [FinchAPI::
|
776
|
+
# @param phone_numbers [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers]
|
753
777
|
# @param preferred_name [Boolean]
|
754
|
-
# @param residence [FinchAPI::
|
778
|
+
# @param residence [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Residence]
|
755
779
|
# @param ssn [Boolean]
|
756
780
|
|
757
|
-
# @see FinchAPI::
|
781
|
+
# @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual#emails
|
758
782
|
class Emails < FinchAPI::Internal::Type::BaseModel
|
759
783
|
# @!attribute data
|
760
784
|
#
|
@@ -771,7 +795,7 @@ module FinchAPI
|
|
771
795
|
# @param type [Boolean]
|
772
796
|
end
|
773
797
|
|
774
|
-
# @see FinchAPI::
|
798
|
+
# @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual#phone_numbers
|
775
799
|
class PhoneNumbers < FinchAPI::Internal::Type::BaseModel
|
776
800
|
# @!attribute data
|
777
801
|
#
|
@@ -788,7 +812,7 @@ module FinchAPI
|
|
788
812
|
# @param type [Boolean]
|
789
813
|
end
|
790
814
|
|
791
|
-
# @see FinchAPI::
|
815
|
+
# @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual#residence
|
792
816
|
class Residence < FinchAPI::Internal::Type::BaseModel
|
793
817
|
# @!attribute city
|
794
818
|
#
|
@@ -830,7 +854,7 @@ module FinchAPI
|
|
830
854
|
end
|
831
855
|
end
|
832
856
|
|
833
|
-
# @see FinchAPI::
|
857
|
+
# @see FinchAPI::Provider::AuthenticationMethod::SupportedFields#pay_group
|
834
858
|
class PayGroup < FinchAPI::Internal::Type::BaseModel
|
835
859
|
# @!attribute id
|
836
860
|
#
|
@@ -859,25 +883,29 @@ module FinchAPI
|
|
859
883
|
# @param pay_frequencies [Boolean]
|
860
884
|
end
|
861
885
|
|
862
|
-
# @see FinchAPI::
|
886
|
+
# @see FinchAPI::Provider::AuthenticationMethod::SupportedFields#pay_statement
|
863
887
|
class PayStatement < FinchAPI::Internal::Type::BaseModel
|
864
888
|
# @!attribute paging
|
865
889
|
#
|
866
|
-
# @return [FinchAPI::
|
890
|
+
# @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging, nil]
|
867
891
|
optional :paging,
|
868
|
-
-> {
|
892
|
+
-> {
|
893
|
+
FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging
|
894
|
+
}
|
869
895
|
|
870
896
|
# @!attribute pay_statements
|
871
897
|
#
|
872
|
-
# @return [FinchAPI::
|
898
|
+
# @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements, nil]
|
873
899
|
optional :pay_statements,
|
874
|
-
-> {
|
900
|
+
-> {
|
901
|
+
FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements
|
902
|
+
}
|
875
903
|
|
876
904
|
# @!method initialize(paging: nil, pay_statements: nil)
|
877
|
-
# @param paging [FinchAPI::
|
878
|
-
# @param pay_statements [FinchAPI::
|
905
|
+
# @param paging [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging]
|
906
|
+
# @param pay_statements [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements]
|
879
907
|
|
880
|
-
# @see FinchAPI::
|
908
|
+
# @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement#paging
|
881
909
|
class Paging < FinchAPI::Internal::Type::BaseModel
|
882
910
|
# @!attribute count
|
883
911
|
#
|
@@ -894,25 +922,31 @@ module FinchAPI
|
|
894
922
|
# @param offset [Boolean]
|
895
923
|
end
|
896
924
|
|
897
|
-
# @see FinchAPI::
|
925
|
+
# @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement#pay_statements
|
898
926
|
class PayStatements < FinchAPI::Internal::Type::BaseModel
|
899
927
|
# @!attribute earnings
|
900
928
|
#
|
901
|
-
# @return [FinchAPI::
|
929
|
+
# @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, nil]
|
902
930
|
optional :earnings,
|
903
|
-
-> {
|
931
|
+
-> {
|
932
|
+
FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings
|
933
|
+
}
|
904
934
|
|
905
935
|
# @!attribute employee_deductions
|
906
936
|
#
|
907
|
-
# @return [FinchAPI::
|
937
|
+
# @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, nil]
|
908
938
|
optional :employee_deductions,
|
909
|
-
-> {
|
939
|
+
-> {
|
940
|
+
FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions
|
941
|
+
}
|
910
942
|
|
911
943
|
# @!attribute employer_contributions
|
912
944
|
#
|
913
|
-
# @return [FinchAPI::
|
945
|
+
# @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions, nil]
|
914
946
|
optional :employer_contributions,
|
915
|
-
-> {
|
947
|
+
-> {
|
948
|
+
FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions
|
949
|
+
}
|
916
950
|
|
917
951
|
# @!attribute gross_pay
|
918
952
|
#
|
@@ -936,9 +970,11 @@ module FinchAPI
|
|
936
970
|
|
937
971
|
# @!attribute taxes
|
938
972
|
#
|
939
|
-
# @return [FinchAPI::
|
973
|
+
# @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, nil]
|
940
974
|
optional :taxes,
|
941
|
-
-> {
|
975
|
+
-> {
|
976
|
+
FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes
|
977
|
+
}
|
942
978
|
|
943
979
|
# @!attribute total_hours
|
944
980
|
#
|
@@ -951,18 +987,18 @@ module FinchAPI
|
|
951
987
|
optional :type, FinchAPI::Internal::Type::Boolean
|
952
988
|
|
953
989
|
# @!method initialize(earnings: nil, employee_deductions: nil, employer_contributions: nil, gross_pay: nil, individual_id: nil, net_pay: nil, payment_method: nil, taxes: nil, total_hours: nil, type: nil)
|
954
|
-
# @param earnings [FinchAPI::
|
955
|
-
# @param employee_deductions [FinchAPI::
|
956
|
-
# @param employer_contributions [FinchAPI::
|
990
|
+
# @param earnings [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings]
|
991
|
+
# @param employee_deductions [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions]
|
992
|
+
# @param employer_contributions [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions]
|
957
993
|
# @param gross_pay [Boolean]
|
958
994
|
# @param individual_id [Boolean]
|
959
995
|
# @param net_pay [Boolean]
|
960
996
|
# @param payment_method [Boolean]
|
961
|
-
# @param taxes [FinchAPI::
|
997
|
+
# @param taxes [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes]
|
962
998
|
# @param total_hours [Boolean]
|
963
999
|
# @param type [Boolean]
|
964
1000
|
|
965
|
-
# @see FinchAPI::
|
1001
|
+
# @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements#earnings
|
966
1002
|
class Earnings < FinchAPI::Internal::Type::BaseModel
|
967
1003
|
# @!attribute amount
|
968
1004
|
#
|
@@ -991,7 +1027,7 @@ module FinchAPI
|
|
991
1027
|
# @param type [Boolean]
|
992
1028
|
end
|
993
1029
|
|
994
|
-
# @see FinchAPI::
|
1030
|
+
# @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements#employee_deductions
|
995
1031
|
class EmployeeDeductions < FinchAPI::Internal::Type::BaseModel
|
996
1032
|
# @!attribute amount
|
997
1033
|
#
|
@@ -1026,7 +1062,7 @@ module FinchAPI
|
|
1026
1062
|
# @param type [Boolean]
|
1027
1063
|
end
|
1028
1064
|
|
1029
|
-
# @see FinchAPI::
|
1065
|
+
# @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements#employer_contributions
|
1030
1066
|
class EmployerContributions < FinchAPI::Internal::Type::BaseModel
|
1031
1067
|
# @!attribute amount
|
1032
1068
|
#
|
@@ -1049,7 +1085,7 @@ module FinchAPI
|
|
1049
1085
|
# @param name [Boolean]
|
1050
1086
|
end
|
1051
1087
|
|
1052
|
-
# @see FinchAPI::
|
1088
|
+
# @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements#taxes
|
1053
1089
|
class Taxes < FinchAPI::Internal::Type::BaseModel
|
1054
1090
|
# @!attribute amount
|
1055
1091
|
#
|
@@ -1086,7 +1122,7 @@ module FinchAPI
|
|
1086
1122
|
end
|
1087
1123
|
end
|
1088
1124
|
|
1089
|
-
# @see FinchAPI::
|
1125
|
+
# @see FinchAPI::Provider::AuthenticationMethod::SupportedFields#payment
|
1090
1126
|
class Payment < FinchAPI::Internal::Type::BaseModel
|
1091
1127
|
# @!attribute id
|
1092
1128
|
#
|
@@ -1145,9 +1181,11 @@ module FinchAPI
|
|
1145
1181
|
|
1146
1182
|
# @!attribute pay_period
|
1147
1183
|
#
|
1148
|
-
# @return [FinchAPI::
|
1184
|
+
# @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod, nil]
|
1149
1185
|
optional :pay_period,
|
1150
|
-
-> {
|
1186
|
+
-> {
|
1187
|
+
FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod
|
1188
|
+
}
|
1151
1189
|
|
1152
1190
|
# @!method initialize(id: nil, company_debit: nil, debit_date: nil, employee_taxes: nil, employer_taxes: nil, gross_pay: nil, individual_ids: nil, net_pay: nil, pay_date: nil, pay_frequencies: nil, pay_group_ids: nil, pay_period: nil)
|
1153
1191
|
# @param id [Boolean]
|
@@ -1161,9 +1199,9 @@ module FinchAPI
|
|
1161
1199
|
# @param pay_date [Boolean]
|
1162
1200
|
# @param pay_frequencies [Boolean]
|
1163
1201
|
# @param pay_group_ids [Boolean]
|
1164
|
-
# @param pay_period [FinchAPI::
|
1202
|
+
# @param pay_period [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod]
|
1165
1203
|
|
1166
|
-
# @see FinchAPI::
|
1204
|
+
# @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment#pay_period
|
1167
1205
|
class PayPeriod < FinchAPI::Internal::Type::BaseModel
|
1168
1206
|
# @!attribute end_date
|
1169
1207
|
#
|
@@ -1184,7 +1222,7 @@ module FinchAPI
|
|
1184
1222
|
|
1185
1223
|
# The type of authentication method.
|
1186
1224
|
#
|
1187
|
-
# @see FinchAPI::
|
1225
|
+
# @see FinchAPI::Provider::AuthenticationMethod#type
|
1188
1226
|
module Type
|
1189
1227
|
extend FinchAPI::Internal::Type::Enum
|
1190
1228
|
|