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,16 +12,17 @@ module FinchAPI
|
|
12
12
|
# Array of individuals to create. Takes all combined fields from `/individual` and
|
13
13
|
# `/employment` endpoints. All fields are optional.
|
14
14
|
#
|
15
|
-
# @return [Array<FinchAPI::
|
15
|
+
# @return [Array<FinchAPI::Sandbox::DirectoryCreateParams::Body>, nil]
|
16
16
|
optional :body,
|
17
|
-
-> {
|
17
|
+
-> {
|
18
|
+
FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::DirectoryCreateParams::Body]
|
19
|
+
}
|
18
20
|
|
19
21
|
# @!method initialize(body: nil, request_options: {})
|
20
22
|
# Some parameter documentations has been truncated, see
|
21
23
|
# {FinchAPI::Models::Sandbox::DirectoryCreateParams} for more details.
|
22
24
|
#
|
23
|
-
# @param body [Array<FinchAPI::
|
24
|
-
# ...
|
25
|
+
# @param body [Array<FinchAPI::Sandbox::DirectoryCreateParams::Body>] Array of individuals to create. Takes all combined fields from `/individual` and
|
25
26
|
#
|
26
27
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
|
27
28
|
|
@@ -37,17 +38,17 @@ module FinchAPI
|
|
37
38
|
# employer in the system. Custom fields are not currently supported for assisted
|
38
39
|
# connections.
|
39
40
|
#
|
40
|
-
# @return [Array<FinchAPI::
|
41
|
+
# @return [Array<FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField>, nil]
|
41
42
|
optional :custom_fields,
|
42
|
-
-> {
|
43
|
+
-> {
|
44
|
+
FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField]
|
45
|
+
}
|
43
46
|
|
44
47
|
# @!attribute department
|
45
48
|
# The department object.
|
46
49
|
#
|
47
|
-
# @return [FinchAPI::
|
48
|
-
optional :department,
|
49
|
-
-> { FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Department },
|
50
|
-
nil?: true
|
50
|
+
# @return [FinchAPI::Sandbox::DirectoryCreateParams::Body::Department, nil]
|
51
|
+
optional :department, -> { FinchAPI::Sandbox::DirectoryCreateParams::Body::Department }, nil?: true
|
51
52
|
|
52
53
|
# @!attribute dob
|
53
54
|
#
|
@@ -56,25 +57,25 @@ module FinchAPI
|
|
56
57
|
|
57
58
|
# @!attribute emails
|
58
59
|
#
|
59
|
-
# @return [Array<FinchAPI::
|
60
|
+
# @return [Array<FinchAPI::Sandbox::DirectoryCreateParams::Body::Email>, nil]
|
60
61
|
optional :emails,
|
61
|
-
-> {
|
62
|
+
-> {
|
63
|
+
FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::DirectoryCreateParams::Body::Email]
|
64
|
+
},
|
62
65
|
nil?: true
|
63
66
|
|
64
67
|
# @!attribute employment
|
65
68
|
# The employment object.
|
66
69
|
#
|
67
|
-
# @return [FinchAPI::
|
68
|
-
optional :employment,
|
69
|
-
-> { FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment },
|
70
|
-
nil?: true
|
70
|
+
# @return [FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment, nil]
|
71
|
+
optional :employment, -> { FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment }, nil?: true
|
71
72
|
|
72
73
|
# @!attribute employment_status
|
73
74
|
# The detailed employment status of the individual.
|
74
75
|
#
|
75
|
-
# @return [Symbol, FinchAPI::
|
76
|
+
# @return [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::EmploymentStatus, nil]
|
76
77
|
optional :employment_status,
|
77
|
-
enum: -> { FinchAPI::
|
78
|
+
enum: -> { FinchAPI::Sandbox::DirectoryCreateParams::Body::EmploymentStatus },
|
78
79
|
nil?: true
|
79
80
|
|
80
81
|
# @!attribute encrypted_ssn
|
@@ -93,9 +94,11 @@ module FinchAPI
|
|
93
94
|
# @!attribute ethnicity
|
94
95
|
# The EEOC-defined ethnicity of the individual.
|
95
96
|
#
|
96
|
-
# @return [Symbol, FinchAPI::
|
97
|
+
# @return [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Ethnicity, nil]
|
97
98
|
optional :ethnicity,
|
98
|
-
enum: -> {
|
99
|
+
enum: -> {
|
100
|
+
FinchAPI::Sandbox::DirectoryCreateParams::Body::Ethnicity
|
101
|
+
},
|
99
102
|
nil?: true
|
100
103
|
|
101
104
|
# @!attribute first_name
|
@@ -107,23 +110,23 @@ module FinchAPI
|
|
107
110
|
# @!attribute gender
|
108
111
|
# The gender of the individual.
|
109
112
|
#
|
110
|
-
# @return [Symbol, FinchAPI::
|
111
|
-
optional :gender, enum: -> { FinchAPI::
|
113
|
+
# @return [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Gender, nil]
|
114
|
+
optional :gender, enum: -> { FinchAPI::Sandbox::DirectoryCreateParams::Body::Gender }, nil?: true
|
112
115
|
|
113
116
|
# @!attribute income
|
114
117
|
# The employee's income as reported by the provider. This may not always be
|
115
118
|
# annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc,
|
116
119
|
# depending on what information the provider returns.
|
117
120
|
#
|
118
|
-
# @return [FinchAPI::
|
119
|
-
optional :income, -> { FinchAPI::
|
121
|
+
# @return [FinchAPI::Income, nil]
|
122
|
+
optional :income, -> { FinchAPI::Income }, nil?: true
|
120
123
|
|
121
124
|
# @!attribute income_history
|
122
125
|
# The array of income history.
|
123
126
|
#
|
124
|
-
# @return [Array<FinchAPI::
|
127
|
+
# @return [Array<FinchAPI::Income, nil>, nil]
|
125
128
|
optional :income_history,
|
126
|
-
-> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::
|
129
|
+
-> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Income, nil?: true] },
|
127
130
|
nil?: true
|
128
131
|
|
129
132
|
# @!attribute is_active
|
@@ -145,14 +148,14 @@ module FinchAPI
|
|
145
148
|
|
146
149
|
# @!attribute location
|
147
150
|
#
|
148
|
-
# @return [FinchAPI::
|
149
|
-
optional :location, -> { FinchAPI::
|
151
|
+
# @return [FinchAPI::Location, nil]
|
152
|
+
optional :location, -> { FinchAPI::Location }, nil?: true
|
150
153
|
|
151
154
|
# @!attribute manager
|
152
155
|
# The manager object representing the manager of the individual within the org.
|
153
156
|
#
|
154
|
-
# @return [FinchAPI::
|
155
|
-
optional :manager, -> { FinchAPI::
|
157
|
+
# @return [FinchAPI::Sandbox::DirectoryCreateParams::Body::Manager, nil]
|
158
|
+
optional :manager, -> { FinchAPI::Sandbox::DirectoryCreateParams::Body::Manager }, nil?: true
|
156
159
|
|
157
160
|
# @!attribute middle_name
|
158
161
|
# The legal middle name of the individual.
|
@@ -162,9 +165,12 @@ module FinchAPI
|
|
162
165
|
|
163
166
|
# @!attribute phone_numbers
|
164
167
|
#
|
165
|
-
# @return [Array<FinchAPI::
|
168
|
+
# @return [Array<FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber, nil>, nil]
|
166
169
|
optional :phone_numbers,
|
167
|
-
-> {
|
170
|
+
-> {
|
171
|
+
FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber,
|
172
|
+
nil?: true]
|
173
|
+
},
|
168
174
|
nil?: true
|
169
175
|
|
170
176
|
# @!attribute preferred_name
|
@@ -175,8 +181,8 @@ module FinchAPI
|
|
175
181
|
|
176
182
|
# @!attribute residence
|
177
183
|
#
|
178
|
-
# @return [FinchAPI::
|
179
|
-
optional :residence, -> { FinchAPI::
|
184
|
+
# @return [FinchAPI::Location, nil]
|
185
|
+
optional :residence, -> { FinchAPI::Location }, nil?: true
|
180
186
|
|
181
187
|
# @!attribute source_id
|
182
188
|
# The source system's unique employment identifier for this individual
|
@@ -206,38 +212,35 @@ module FinchAPI
|
|
206
212
|
|
207
213
|
# @!method initialize(class_code: nil, custom_fields: nil, department: nil, dob: nil, emails: nil, employment: nil, employment_status: nil, encrypted_ssn: nil, end_date: nil, ethnicity: nil, first_name: nil, gender: nil, income: nil, income_history: nil, is_active: nil, last_name: nil, latest_rehire_date: nil, location: nil, manager: nil, middle_name: nil, phone_numbers: nil, preferred_name: nil, residence: nil, source_id: nil, ssn: nil, start_date: nil, title: nil)
|
208
214
|
# Some parameter documentations has been truncated, see
|
209
|
-
# {FinchAPI::
|
215
|
+
# {FinchAPI::Sandbox::DirectoryCreateParams::Body} for more details.
|
210
216
|
#
|
211
217
|
# @param class_code [String, nil] Worker's compensation classification code for this employee
|
212
218
|
#
|
213
|
-
# @param custom_fields [Array<FinchAPI::
|
214
|
-
# ...
|
219
|
+
# @param custom_fields [Array<FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField>] Custom fields for the individual. These are fields which are defined by the empl
|
215
220
|
#
|
216
|
-
# @param department [FinchAPI::
|
221
|
+
# @param department [FinchAPI::Sandbox::DirectoryCreateParams::Body::Department, nil] The department object.
|
217
222
|
#
|
218
223
|
# @param dob [String, nil]
|
219
224
|
#
|
220
|
-
# @param emails [Array<FinchAPI::
|
225
|
+
# @param emails [Array<FinchAPI::Sandbox::DirectoryCreateParams::Body::Email>, nil]
|
221
226
|
#
|
222
|
-
# @param employment [FinchAPI::
|
227
|
+
# @param employment [FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment, nil] The employment object.
|
223
228
|
#
|
224
|
-
# @param employment_status [Symbol, FinchAPI::
|
229
|
+
# @param employment_status [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::EmploymentStatus, nil] The detailed employment status of the individual.
|
225
230
|
#
|
226
231
|
# @param encrypted_ssn [String, nil] Social Security Number of the individual in **encrypted** format. This field is
|
227
|
-
# ...
|
228
232
|
#
|
229
233
|
# @param end_date [String, nil]
|
230
234
|
#
|
231
|
-
# @param ethnicity [Symbol, FinchAPI::
|
235
|
+
# @param ethnicity [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Ethnicity, nil] The EEOC-defined ethnicity of the individual.
|
232
236
|
#
|
233
237
|
# @param first_name [String, nil] The legal first name of the individual.
|
234
238
|
#
|
235
|
-
# @param gender [Symbol, FinchAPI::
|
239
|
+
# @param gender [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Gender, nil] The gender of the individual.
|
236
240
|
#
|
237
|
-
# @param income [FinchAPI::
|
238
|
-
# ...
|
241
|
+
# @param income [FinchAPI::Income, nil] The employee's income as reported by the provider. This may not always be annual
|
239
242
|
#
|
240
|
-
# @param income_history [Array<FinchAPI::
|
243
|
+
# @param income_history [Array<FinchAPI::Income, nil>, nil] The array of income history.
|
241
244
|
#
|
242
245
|
# @param is_active [Boolean, nil] `true` if the individual an an active employee or contractor at the company.
|
243
246
|
#
|
@@ -245,22 +248,21 @@ module FinchAPI
|
|
245
248
|
#
|
246
249
|
# @param latest_rehire_date [String, nil]
|
247
250
|
#
|
248
|
-
# @param location [FinchAPI::
|
251
|
+
# @param location [FinchAPI::Location, nil]
|
249
252
|
#
|
250
|
-
# @param manager [FinchAPI::
|
253
|
+
# @param manager [FinchAPI::Sandbox::DirectoryCreateParams::Body::Manager, nil] The manager object representing the manager of the individual within the org.
|
251
254
|
#
|
252
255
|
# @param middle_name [String, nil] The legal middle name of the individual.
|
253
256
|
#
|
254
|
-
# @param phone_numbers [Array<FinchAPI::
|
257
|
+
# @param phone_numbers [Array<FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber, nil>, nil]
|
255
258
|
#
|
256
259
|
# @param preferred_name [String, nil] The preferred name of the individual.
|
257
260
|
#
|
258
|
-
# @param residence [FinchAPI::
|
261
|
+
# @param residence [FinchAPI::Location, nil]
|
259
262
|
#
|
260
263
|
# @param source_id [String] The source system's unique employment identifier for this individual
|
261
264
|
#
|
262
265
|
# @param ssn [String, nil] Social Security Number of the individual. This field is only available with the
|
263
|
-
# ...
|
264
266
|
#
|
265
267
|
# @param start_date [String, nil]
|
266
268
|
#
|
@@ -282,7 +284,7 @@ module FinchAPI
|
|
282
284
|
# @param value [Object]
|
283
285
|
end
|
284
286
|
|
285
|
-
# @see FinchAPI::
|
287
|
+
# @see FinchAPI::Sandbox::DirectoryCreateParams::Body#department
|
286
288
|
class Department < FinchAPI::Internal::Type::BaseModel
|
287
289
|
# @!attribute name
|
288
290
|
# The name of the department associated with the individual.
|
@@ -304,16 +306,18 @@ module FinchAPI
|
|
304
306
|
|
305
307
|
# @!attribute type
|
306
308
|
#
|
307
|
-
# @return [Symbol, FinchAPI::
|
309
|
+
# @return [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Email::Type, nil]
|
308
310
|
optional :type,
|
309
|
-
enum: -> {
|
311
|
+
enum: -> {
|
312
|
+
FinchAPI::Sandbox::DirectoryCreateParams::Body::Email::Type
|
313
|
+
},
|
310
314
|
nil?: true
|
311
315
|
|
312
316
|
# @!method initialize(data: nil, type: nil)
|
313
317
|
# @param data [String]
|
314
|
-
# @param type [Symbol, FinchAPI::
|
318
|
+
# @param type [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Email::Type, nil]
|
315
319
|
|
316
|
-
# @see FinchAPI::
|
320
|
+
# @see FinchAPI::Sandbox::DirectoryCreateParams::Body::Email#type
|
317
321
|
module Type
|
318
322
|
extend FinchAPI::Internal::Type::Enum
|
319
323
|
|
@@ -325,41 +329,41 @@ module FinchAPI
|
|
325
329
|
end
|
326
330
|
end
|
327
331
|
|
328
|
-
# @see FinchAPI::
|
332
|
+
# @see FinchAPI::Sandbox::DirectoryCreateParams::Body#employment
|
329
333
|
class Employment < FinchAPI::Internal::Type::BaseModel
|
330
334
|
# @!attribute subtype
|
331
335
|
# The secondary employment type of the individual. Options: `full_time`,
|
332
336
|
# `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
|
333
337
|
#
|
334
|
-
# @return [Symbol, FinchAPI::
|
338
|
+
# @return [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Subtype, nil]
|
335
339
|
optional :subtype,
|
336
|
-
enum: -> { FinchAPI::
|
340
|
+
enum: -> { FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Subtype },
|
337
341
|
nil?: true
|
338
342
|
|
339
343
|
# @!attribute type
|
340
344
|
# The main employment type of the individual.
|
341
345
|
#
|
342
|
-
# @return [Symbol, FinchAPI::
|
346
|
+
# @return [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Type, nil]
|
343
347
|
optional :type,
|
344
|
-
enum: -> {
|
348
|
+
enum: -> {
|
349
|
+
FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Type
|
350
|
+
},
|
345
351
|
nil?: true
|
346
352
|
|
347
353
|
# @!method initialize(subtype: nil, type: nil)
|
348
354
|
# Some parameter documentations has been truncated, see
|
349
|
-
# {FinchAPI::
|
350
|
-
# details.
|
355
|
+
# {FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment} for more details.
|
351
356
|
#
|
352
357
|
# The employment object.
|
353
358
|
#
|
354
|
-
# @param subtype [Symbol, FinchAPI::
|
355
|
-
# ...
|
359
|
+
# @param subtype [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Subtype, nil] The secondary employment type of the individual. Options: `full_time`, `part_ti
|
356
360
|
#
|
357
|
-
# @param type [Symbol, FinchAPI::
|
361
|
+
# @param type [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Type, nil] The main employment type of the individual.
|
358
362
|
|
359
363
|
# The secondary employment type of the individual. Options: `full_time`,
|
360
364
|
# `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
|
361
365
|
#
|
362
|
-
# @see FinchAPI::
|
366
|
+
# @see FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment#subtype
|
363
367
|
module Subtype
|
364
368
|
extend FinchAPI::Internal::Type::Enum
|
365
369
|
|
@@ -376,7 +380,7 @@ module FinchAPI
|
|
376
380
|
|
377
381
|
# The main employment type of the individual.
|
378
382
|
#
|
379
|
-
# @see FinchAPI::
|
383
|
+
# @see FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment#type
|
380
384
|
module Type
|
381
385
|
extend FinchAPI::Internal::Type::Enum
|
382
386
|
|
@@ -390,7 +394,7 @@ module FinchAPI
|
|
390
394
|
|
391
395
|
# The detailed employment status of the individual.
|
392
396
|
#
|
393
|
-
# @see FinchAPI::
|
397
|
+
# @see FinchAPI::Sandbox::DirectoryCreateParams::Body#employment_status
|
394
398
|
module EmploymentStatus
|
395
399
|
extend FinchAPI::Internal::Type::Enum
|
396
400
|
|
@@ -408,7 +412,7 @@ module FinchAPI
|
|
408
412
|
|
409
413
|
# The EEOC-defined ethnicity of the individual.
|
410
414
|
#
|
411
|
-
# @see FinchAPI::
|
415
|
+
# @see FinchAPI::Sandbox::DirectoryCreateParams::Body#ethnicity
|
412
416
|
module Ethnicity
|
413
417
|
extend FinchAPI::Internal::Type::Enum
|
414
418
|
|
@@ -427,7 +431,7 @@ module FinchAPI
|
|
427
431
|
|
428
432
|
# The gender of the individual.
|
429
433
|
#
|
430
|
-
# @see FinchAPI::
|
434
|
+
# @see FinchAPI::Sandbox::DirectoryCreateParams::Body#gender
|
431
435
|
module Gender
|
432
436
|
extend FinchAPI::Internal::Type::Enum
|
433
437
|
|
@@ -440,7 +444,7 @@ module FinchAPI
|
|
440
444
|
# @return [Array<Symbol>]
|
441
445
|
end
|
442
446
|
|
443
|
-
# @see FinchAPI::
|
447
|
+
# @see FinchAPI::Sandbox::DirectoryCreateParams::Body#manager
|
444
448
|
class Manager < FinchAPI::Internal::Type::BaseModel
|
445
449
|
# @!attribute id
|
446
450
|
# A stable Finch `id` (UUID v4) for an individual in the company.
|
@@ -462,16 +466,18 @@ module FinchAPI
|
|
462
466
|
|
463
467
|
# @!attribute type
|
464
468
|
#
|
465
|
-
# @return [Symbol, FinchAPI::
|
469
|
+
# @return [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type, nil]
|
466
470
|
optional :type,
|
467
|
-
enum: -> {
|
471
|
+
enum: -> {
|
472
|
+
FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type
|
473
|
+
},
|
468
474
|
nil?: true
|
469
475
|
|
470
476
|
# @!method initialize(data: nil, type: nil)
|
471
477
|
# @param data [String, nil]
|
472
|
-
# @param type [Symbol, FinchAPI::
|
478
|
+
# @param type [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type, nil]
|
473
479
|
|
474
|
-
# @see FinchAPI::
|
480
|
+
# @see FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber#type
|
475
481
|
module Type
|
476
482
|
extend FinchAPI::Internal::Type::Enum
|
477
483
|
|
@@ -19,28 +19,30 @@ module FinchAPI
|
|
19
19
|
# employer in the system. Custom fields are not currently supported for assisted
|
20
20
|
# connections.
|
21
21
|
#
|
22
|
-
# @return [Array<FinchAPI::
|
22
|
+
# @return [Array<FinchAPI::Sandbox::EmploymentUpdateParams::CustomField>, nil]
|
23
23
|
optional :custom_fields,
|
24
|
-
-> {
|
24
|
+
-> {
|
25
|
+
FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::EmploymentUpdateParams::CustomField]
|
26
|
+
}
|
25
27
|
|
26
28
|
# @!attribute department
|
27
29
|
# The department object.
|
28
30
|
#
|
29
|
-
# @return [FinchAPI::
|
30
|
-
optional :department, -> { FinchAPI::
|
31
|
+
# @return [FinchAPI::Sandbox::EmploymentUpdateParams::Department, nil]
|
32
|
+
optional :department, -> { FinchAPI::Sandbox::EmploymentUpdateParams::Department }, nil?: true
|
31
33
|
|
32
34
|
# @!attribute employment
|
33
35
|
# The employment object.
|
34
36
|
#
|
35
|
-
# @return [FinchAPI::
|
36
|
-
optional :employment, -> { FinchAPI::
|
37
|
+
# @return [FinchAPI::Sandbox::EmploymentUpdateParams::Employment, nil]
|
38
|
+
optional :employment, -> { FinchAPI::Sandbox::EmploymentUpdateParams::Employment }, nil?: true
|
37
39
|
|
38
40
|
# @!attribute employment_status
|
39
41
|
# The detailed employment status of the individual.
|
40
42
|
#
|
41
|
-
# @return [Symbol, FinchAPI::
|
43
|
+
# @return [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil]
|
42
44
|
optional :employment_status,
|
43
|
-
enum: -> { FinchAPI::
|
45
|
+
enum: -> { FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus },
|
44
46
|
nil?: true
|
45
47
|
|
46
48
|
# @!attribute end_date
|
@@ -59,15 +61,15 @@ module FinchAPI
|
|
59
61
|
# annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc,
|
60
62
|
# depending on what information the provider returns.
|
61
63
|
#
|
62
|
-
# @return [FinchAPI::
|
63
|
-
optional :income, -> { FinchAPI::
|
64
|
+
# @return [FinchAPI::Income, nil]
|
65
|
+
optional :income, -> { FinchAPI::Income }, nil?: true
|
64
66
|
|
65
67
|
# @!attribute income_history
|
66
68
|
# The array of income history.
|
67
69
|
#
|
68
|
-
# @return [Array<FinchAPI::
|
70
|
+
# @return [Array<FinchAPI::Income, nil>, nil]
|
69
71
|
optional :income_history,
|
70
|
-
-> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::
|
72
|
+
-> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Income, nil?: true] },
|
71
73
|
nil?: true
|
72
74
|
|
73
75
|
# @!attribute is_active
|
@@ -89,14 +91,14 @@ module FinchAPI
|
|
89
91
|
|
90
92
|
# @!attribute location
|
91
93
|
#
|
92
|
-
# @return [FinchAPI::
|
93
|
-
optional :location, -> { FinchAPI::
|
94
|
+
# @return [FinchAPI::Location, nil]
|
95
|
+
optional :location, -> { FinchAPI::Location }, nil?: true
|
94
96
|
|
95
97
|
# @!attribute manager
|
96
98
|
# The manager object representing the manager of the individual within the org.
|
97
99
|
#
|
98
|
-
# @return [FinchAPI::
|
99
|
-
optional :manager, -> { FinchAPI::
|
100
|
+
# @return [FinchAPI::Sandbox::EmploymentUpdateParams::Manager, nil]
|
101
|
+
optional :manager, -> { FinchAPI::Sandbox::EmploymentUpdateParams::Manager }, nil?: true
|
100
102
|
|
101
103
|
# @!attribute middle_name
|
102
104
|
# The legal middle name of the individual.
|
@@ -127,23 +129,21 @@ module FinchAPI
|
|
127
129
|
#
|
128
130
|
# @param class_code [String, nil] Worker's compensation classification code for this employee
|
129
131
|
#
|
130
|
-
# @param custom_fields [Array<FinchAPI::
|
131
|
-
# ...
|
132
|
+
# @param custom_fields [Array<FinchAPI::Sandbox::EmploymentUpdateParams::CustomField>] Custom fields for the individual. These are fields which are defined by the empl
|
132
133
|
#
|
133
|
-
# @param department [FinchAPI::
|
134
|
+
# @param department [FinchAPI::Sandbox::EmploymentUpdateParams::Department, nil] The department object.
|
134
135
|
#
|
135
|
-
# @param employment [FinchAPI::
|
136
|
+
# @param employment [FinchAPI::Sandbox::EmploymentUpdateParams::Employment, nil] The employment object.
|
136
137
|
#
|
137
|
-
# @param employment_status [Symbol, FinchAPI::
|
138
|
+
# @param employment_status [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil] The detailed employment status of the individual.
|
138
139
|
#
|
139
140
|
# @param end_date [String, nil]
|
140
141
|
#
|
141
142
|
# @param first_name [String, nil] The legal first name of the individual.
|
142
143
|
#
|
143
|
-
# @param income [FinchAPI::
|
144
|
-
# ...
|
144
|
+
# @param income [FinchAPI::Income, nil] The employee's income as reported by the provider. This may not always be annual
|
145
145
|
#
|
146
|
-
# @param income_history [Array<FinchAPI::
|
146
|
+
# @param income_history [Array<FinchAPI::Income, nil>, nil] The array of income history.
|
147
147
|
#
|
148
148
|
# @param is_active [Boolean, nil] `true` if the individual an an active employee or contractor at the company.
|
149
149
|
#
|
@@ -151,9 +151,9 @@ module FinchAPI
|
|
151
151
|
#
|
152
152
|
# @param latest_rehire_date [String, nil]
|
153
153
|
#
|
154
|
-
# @param location [FinchAPI::
|
154
|
+
# @param location [FinchAPI::Location, nil]
|
155
155
|
#
|
156
|
-
# @param manager [FinchAPI::
|
156
|
+
# @param manager [FinchAPI::Sandbox::EmploymentUpdateParams::Manager, nil] The manager object representing the manager of the individual within the org.
|
157
157
|
#
|
158
158
|
# @param middle_name [String, nil] The legal middle name of the individual.
|
159
159
|
#
|
@@ -199,35 +199,33 @@ module FinchAPI
|
|
199
199
|
# The secondary employment type of the individual. Options: `full_time`,
|
200
200
|
# `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
|
201
201
|
#
|
202
|
-
# @return [Symbol, FinchAPI::
|
202
|
+
# @return [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Subtype, nil]
|
203
203
|
optional :subtype,
|
204
|
-
enum: -> {
|
204
|
+
enum: -> {
|
205
|
+
FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Subtype
|
206
|
+
},
|
205
207
|
nil?: true
|
206
208
|
|
207
209
|
# @!attribute type
|
208
210
|
# The main employment type of the individual.
|
209
211
|
#
|
210
|
-
# @return [Symbol, FinchAPI::
|
211
|
-
optional :type,
|
212
|
-
enum: -> { FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type },
|
213
|
-
nil?: true
|
212
|
+
# @return [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Type, nil]
|
213
|
+
optional :type, enum: -> { FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Type }, nil?: true
|
214
214
|
|
215
215
|
# @!method initialize(subtype: nil, type: nil)
|
216
216
|
# Some parameter documentations has been truncated, see
|
217
|
-
# {FinchAPI::
|
218
|
-
# details.
|
217
|
+
# {FinchAPI::Sandbox::EmploymentUpdateParams::Employment} for more details.
|
219
218
|
#
|
220
219
|
# The employment object.
|
221
220
|
#
|
222
|
-
# @param subtype [Symbol, FinchAPI::
|
223
|
-
# ...
|
221
|
+
# @param subtype [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Subtype, nil] The secondary employment type of the individual. Options: `full_time`, `part_ti
|
224
222
|
#
|
225
|
-
# @param type [Symbol, FinchAPI::
|
223
|
+
# @param type [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Type, nil] The main employment type of the individual.
|
226
224
|
|
227
225
|
# The secondary employment type of the individual. Options: `full_time`,
|
228
226
|
# `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
|
229
227
|
#
|
230
|
-
# @see FinchAPI::
|
228
|
+
# @see FinchAPI::Sandbox::EmploymentUpdateParams::Employment#subtype
|
231
229
|
module Subtype
|
232
230
|
extend FinchAPI::Internal::Type::Enum
|
233
231
|
|
@@ -244,7 +242,7 @@ module FinchAPI
|
|
244
242
|
|
245
243
|
# The main employment type of the individual.
|
246
244
|
#
|
247
|
-
# @see FinchAPI::
|
245
|
+
# @see FinchAPI::Sandbox::EmploymentUpdateParams::Employment#type
|
248
246
|
module Type
|
249
247
|
extend FinchAPI::Internal::Type::Enum
|
250
248
|
|
@@ -62,15 +62,15 @@ module FinchAPI
|
|
62
62
|
# annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc,
|
63
63
|
# depending on what information the provider returns.
|
64
64
|
#
|
65
|
-
# @return [FinchAPI::
|
66
|
-
optional :income, -> { FinchAPI::
|
65
|
+
# @return [FinchAPI::Income, nil]
|
66
|
+
optional :income, -> { FinchAPI::Income }, nil?: true
|
67
67
|
|
68
68
|
# @!attribute income_history
|
69
69
|
# The array of income history.
|
70
70
|
#
|
71
|
-
# @return [Array<FinchAPI::
|
71
|
+
# @return [Array<FinchAPI::Income, nil>, nil]
|
72
72
|
optional :income_history,
|
73
|
-
-> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::
|
73
|
+
-> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Income, nil?: true] },
|
74
74
|
nil?: true
|
75
75
|
|
76
76
|
# @!attribute is_active
|
@@ -92,8 +92,8 @@ module FinchAPI
|
|
92
92
|
|
93
93
|
# @!attribute location
|
94
94
|
#
|
95
|
-
# @return [FinchAPI::
|
96
|
-
optional :location, -> { FinchAPI::
|
95
|
+
# @return [FinchAPI::Location, nil]
|
96
|
+
optional :location, -> { FinchAPI::Location }, nil?: true
|
97
97
|
|
98
98
|
# @!attribute manager
|
99
99
|
# The manager object representing the manager of the individual within the org.
|
@@ -133,7 +133,6 @@ module FinchAPI
|
|
133
133
|
# @param class_code [String, nil] Worker's compensation classification code for this employee
|
134
134
|
#
|
135
135
|
# @param custom_fields [Array<FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField>] Custom fields for the individual. These are fields which are defined by the empl
|
136
|
-
# ...
|
137
136
|
#
|
138
137
|
# @param department [FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department, nil] The department object.
|
139
138
|
#
|
@@ -145,10 +144,9 @@ module FinchAPI
|
|
145
144
|
#
|
146
145
|
# @param first_name [String, nil] The legal first name of the individual.
|
147
146
|
#
|
148
|
-
# @param income [FinchAPI::
|
149
|
-
# ...
|
147
|
+
# @param income [FinchAPI::Income, nil] The employee's income as reported by the provider. This may not always be annual
|
150
148
|
#
|
151
|
-
# @param income_history [Array<FinchAPI::
|
149
|
+
# @param income_history [Array<FinchAPI::Income, nil>, nil] The array of income history.
|
152
150
|
#
|
153
151
|
# @param is_active [Boolean, nil] `true` if the individual an an active employee or contractor at the company.
|
154
152
|
#
|
@@ -156,7 +154,7 @@ module FinchAPI
|
|
156
154
|
#
|
157
155
|
# @param latest_rehire_date [String, nil]
|
158
156
|
#
|
159
|
-
# @param location [FinchAPI::
|
157
|
+
# @param location [FinchAPI::Location, nil]
|
160
158
|
#
|
161
159
|
# @param manager [FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager, nil] The manager object representing the manager of the individual within the org.
|
162
160
|
#
|
@@ -225,7 +223,6 @@ module FinchAPI
|
|
225
223
|
# The employment object.
|
226
224
|
#
|
227
225
|
# @param subtype [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype, nil] The secondary employment type of the individual. Options: `full_time`, `part_ti
|
228
|
-
# ...
|
229
226
|
#
|
230
227
|
# @param type [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Type, nil] The main employment type of the individual.
|
231
228
|
|