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
@@ -3,302 +3,370 @@
|
|
3
3
|
module FinchAPI
|
4
4
|
module Models
|
5
5
|
module HRIS
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
#
|
23
|
-
# @return [Array<FinchAPI::Models::HRIS::EmploymentData::CustomField>, nil]
|
24
|
-
optional :custom_fields,
|
25
|
-
-> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::EmploymentData::CustomField] },
|
26
|
-
nil?: true
|
27
|
-
|
28
|
-
# @!attribute department
|
29
|
-
# The department object.
|
30
|
-
#
|
31
|
-
# @return [FinchAPI::Models::HRIS::EmploymentData::Department, nil]
|
32
|
-
optional :department, -> { FinchAPI::Models::HRIS::EmploymentData::Department }, nil?: true
|
33
|
-
|
34
|
-
# @!attribute employment
|
35
|
-
# The employment object.
|
36
|
-
#
|
37
|
-
# @return [FinchAPI::Models::HRIS::EmploymentData::Employment, nil]
|
38
|
-
optional :employment, -> { FinchAPI::Models::HRIS::EmploymentData::Employment }, nil?: true
|
39
|
-
|
40
|
-
# @!attribute employment_status
|
41
|
-
# The detailed employment status of the individual. Available options: `active`,
|
42
|
-
# `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
|
43
|
-
#
|
44
|
-
# @return [Symbol, FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus, nil]
|
45
|
-
optional :employment_status,
|
46
|
-
enum: -> { FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus },
|
47
|
-
nil?: true
|
48
|
-
|
49
|
-
# @!attribute end_date
|
50
|
-
#
|
51
|
-
# @return [String, nil]
|
52
|
-
optional :end_date, String, nil?: true
|
53
|
-
|
54
|
-
# @!attribute first_name
|
55
|
-
# The legal first name of the individual.
|
56
|
-
#
|
57
|
-
# @return [String, nil]
|
58
|
-
optional :first_name, String, nil?: true
|
59
|
-
|
60
|
-
# @!attribute income
|
61
|
-
# The employee's income as reported by the provider. This may not always be
|
62
|
-
# annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc,
|
63
|
-
# depending on what information the provider returns.
|
64
|
-
#
|
65
|
-
# @return [FinchAPI::Models::Income, nil]
|
66
|
-
optional :income, -> { FinchAPI::Models::Income }, nil?: true
|
67
|
-
|
68
|
-
# @!attribute income_history
|
69
|
-
# The array of income history.
|
70
|
-
#
|
71
|
-
# @return [Array<FinchAPI::Models::Income, nil>, nil]
|
72
|
-
optional :income_history,
|
73
|
-
-> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Income, nil?: true] },
|
74
|
-
nil?: true
|
75
|
-
|
76
|
-
# @!attribute is_active
|
77
|
-
# `true` if the individual an an active employee or contractor at the company.
|
78
|
-
#
|
79
|
-
# @return [Boolean, nil]
|
80
|
-
optional :is_active, FinchAPI::Internal::Type::Boolean, nil?: true
|
81
|
-
|
82
|
-
# @!attribute last_name
|
83
|
-
# The legal last name of the individual.
|
84
|
-
#
|
85
|
-
# @return [String, nil]
|
86
|
-
optional :last_name, String, nil?: true
|
87
|
-
|
88
|
-
# @!attribute latest_rehire_date
|
89
|
-
#
|
90
|
-
# @return [String, nil]
|
91
|
-
optional :latest_rehire_date, String, nil?: true
|
92
|
-
|
93
|
-
# @!attribute location
|
94
|
-
#
|
95
|
-
# @return [FinchAPI::Models::Location, nil]
|
96
|
-
optional :location, -> { FinchAPI::Models::Location }, nil?: true
|
97
|
-
|
98
|
-
# @!attribute manager
|
99
|
-
# The manager object representing the manager of the individual within the org.
|
100
|
-
#
|
101
|
-
# @return [FinchAPI::Models::HRIS::EmploymentData::Manager, nil]
|
102
|
-
optional :manager, -> { FinchAPI::Models::HRIS::EmploymentData::Manager }, nil?: true
|
103
|
-
|
104
|
-
# @!attribute middle_name
|
105
|
-
# The legal middle name of the individual.
|
106
|
-
#
|
107
|
-
# @return [String, nil]
|
108
|
-
optional :middle_name, String, nil?: true
|
109
|
-
|
110
|
-
# @!attribute source_id
|
111
|
-
# The source system's unique employment identifier for this individual
|
112
|
-
#
|
113
|
-
# @return [String, nil]
|
114
|
-
optional :source_id, String, nil?: true
|
115
|
-
|
116
|
-
# @!attribute start_date
|
117
|
-
#
|
118
|
-
# @return [String, nil]
|
119
|
-
optional :start_date, String, nil?: true
|
120
|
-
|
121
|
-
# @!attribute title
|
122
|
-
# The current title of the individual.
|
123
|
-
#
|
124
|
-
# @return [String, nil]
|
125
|
-
optional :title, String, nil?: true
|
126
|
-
|
127
|
-
# @!attribute work_id
|
128
|
-
# @deprecated
|
129
|
-
#
|
130
|
-
# This field is deprecated in favour of `source_id`
|
131
|
-
#
|
132
|
-
# @return [String, nil]
|
133
|
-
optional :work_id, String, nil?: true
|
134
|
-
|
135
|
-
# @!method initialize(id: nil, class_code: nil, custom_fields: nil, department: nil, employment: nil, employment_status: nil, end_date: nil, first_name: nil, income: nil, income_history: nil, is_active: nil, last_name: nil, latest_rehire_date: nil, location: nil, manager: nil, middle_name: nil, source_id: nil, start_date: nil, title: nil, work_id: nil)
|
136
|
-
# Some parameter documentations has been truncated, see
|
137
|
-
# {FinchAPI::Models::HRIS::EmploymentData} for more details.
|
138
|
-
#
|
139
|
-
# @param id [String] A stable Finch `id` (UUID v4) for an individual in the company.
|
140
|
-
#
|
141
|
-
# @param class_code [String, nil] Worker's compensation classification code for this employee
|
142
|
-
#
|
143
|
-
# @param custom_fields [Array<FinchAPI::Models::HRIS::EmploymentData::CustomField>, nil] Custom fields for the individual. These are fields which are defined by the empl
|
144
|
-
# ...
|
145
|
-
#
|
146
|
-
# @param department [FinchAPI::Models::HRIS::EmploymentData::Department, nil] The department object.
|
147
|
-
#
|
148
|
-
# @param employment [FinchAPI::Models::HRIS::EmploymentData::Employment, nil] The employment object.
|
149
|
-
#
|
150
|
-
# @param employment_status [Symbol, FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus, nil] The detailed employment status of the individual. Available options: `active`, `
|
151
|
-
# ...
|
152
|
-
#
|
153
|
-
# @param end_date [String, nil]
|
154
|
-
#
|
155
|
-
# @param first_name [String, nil] The legal first name of the individual.
|
156
|
-
#
|
157
|
-
# @param income [FinchAPI::Models::Income, nil] The employee's income as reported by the provider. This may not always be annual
|
158
|
-
# ...
|
159
|
-
#
|
160
|
-
# @param income_history [Array<FinchAPI::Models::Income, nil>, nil] The array of income history.
|
161
|
-
#
|
162
|
-
# @param is_active [Boolean, nil] `true` if the individual an an active employee or contractor at the company.
|
163
|
-
#
|
164
|
-
# @param last_name [String, nil] The legal last name of the individual.
|
165
|
-
#
|
166
|
-
# @param latest_rehire_date [String, nil]
|
167
|
-
#
|
168
|
-
# @param location [FinchAPI::Models::Location, nil]
|
169
|
-
#
|
170
|
-
# @param manager [FinchAPI::Models::HRIS::EmploymentData::Manager, nil] The manager object representing the manager of the individual within the org.
|
171
|
-
#
|
172
|
-
# @param middle_name [String, nil] The legal middle name of the individual.
|
173
|
-
#
|
174
|
-
# @param source_id [String, nil] The source system's unique employment identifier for this individual
|
175
|
-
#
|
176
|
-
# @param start_date [String, nil]
|
177
|
-
#
|
178
|
-
# @param title [String, nil] The current title of the individual.
|
179
|
-
#
|
180
|
-
# @param work_id [String, nil] This field is deprecated in favour of `source_id`
|
181
|
-
|
182
|
-
class CustomField < FinchAPI::Internal::Type::BaseModel
|
183
|
-
# @!attribute name
|
6
|
+
module EmploymentData
|
7
|
+
extend FinchAPI::Internal::Type::Union
|
8
|
+
|
9
|
+
variant -> { FinchAPI::HRIS::EmploymentData::UnionMember0 }
|
10
|
+
|
11
|
+
variant -> { FinchAPI::HRIS::EmploymentData::BatchError }
|
12
|
+
|
13
|
+
class UnionMember0 < FinchAPI::Internal::Type::BaseModel
|
14
|
+
# @!attribute id
|
15
|
+
# A stable Finch `id` (UUID v4) for an individual in the company.
|
16
|
+
#
|
17
|
+
# @return [String]
|
18
|
+
required :id, String
|
19
|
+
|
20
|
+
# @!attribute class_code
|
21
|
+
# Worker's compensation classification code for this employee
|
184
22
|
#
|
185
23
|
# @return [String, nil]
|
186
|
-
|
24
|
+
required :class_code, String, nil?: true
|
187
25
|
|
188
|
-
# @!attribute
|
26
|
+
# @!attribute custom_fields
|
27
|
+
# Custom fields for the individual. These are fields which are defined by the
|
28
|
+
# employer in the system.
|
29
|
+
#
|
30
|
+
# @return [Array<FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField>, nil]
|
31
|
+
required :custom_fields,
|
32
|
+
-> {
|
33
|
+
FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField]
|
34
|
+
},
|
35
|
+
nil?: true
|
36
|
+
|
37
|
+
# @!attribute department
|
38
|
+
# The department object.
|
189
39
|
#
|
190
|
-
# @return [
|
191
|
-
|
40
|
+
# @return [FinchAPI::HRIS::EmploymentData::UnionMember0::Department, nil]
|
41
|
+
required :department, -> { FinchAPI::HRIS::EmploymentData::UnionMember0::Department }, nil?: true
|
192
42
|
|
193
|
-
# @!
|
194
|
-
#
|
195
|
-
#
|
196
|
-
|
43
|
+
# @!attribute employment
|
44
|
+
# The employment object.
|
45
|
+
#
|
46
|
+
# @return [FinchAPI::HRIS::EmploymentData::UnionMember0::Employment, nil]
|
47
|
+
required :employment, -> { FinchAPI::HRIS::EmploymentData::UnionMember0::Employment }, nil?: true
|
197
48
|
|
198
|
-
|
199
|
-
|
200
|
-
#
|
201
|
-
#
|
49
|
+
# @!attribute employment_status
|
50
|
+
# The detailed employment status of the individual. Available options: `active`,
|
51
|
+
# `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
|
52
|
+
#
|
53
|
+
# @return [Symbol, FinchAPI::HRIS::EmploymentData::UnionMember0::EmploymentStatus, nil]
|
54
|
+
required :employment_status,
|
55
|
+
enum: -> { FinchAPI::HRIS::EmploymentData::UnionMember0::EmploymentStatus },
|
56
|
+
nil?: true
|
57
|
+
|
58
|
+
# @!attribute end_date
|
202
59
|
#
|
203
60
|
# @return [String, nil]
|
204
|
-
|
61
|
+
required :end_date, String, nil?: true
|
205
62
|
|
206
|
-
# @!
|
207
|
-
# The
|
63
|
+
# @!attribute first_name
|
64
|
+
# The legal first name of the individual.
|
208
65
|
#
|
209
|
-
# @
|
210
|
-
|
66
|
+
# @return [String, nil]
|
67
|
+
required :first_name, String, nil?: true
|
211
68
|
|
212
|
-
|
213
|
-
|
214
|
-
# @!attribute subtype
|
215
|
-
# The secondary employment type of the individual. Options: `full_time`,
|
216
|
-
# `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
|
69
|
+
# @!attribute is_active
|
70
|
+
# `true` if the individual an an active employee or contractor at the company.
|
217
71
|
#
|
218
|
-
# @return [
|
219
|
-
|
72
|
+
# @return [Boolean, nil]
|
73
|
+
required :is_active, FinchAPI::Internal::Type::Boolean, nil?: true
|
220
74
|
|
221
|
-
# @!attribute
|
222
|
-
# The
|
75
|
+
# @!attribute last_name
|
76
|
+
# The legal last name of the individual.
|
223
77
|
#
|
224
|
-
# @return [
|
225
|
-
|
78
|
+
# @return [String, nil]
|
79
|
+
required :last_name, String, nil?: true
|
226
80
|
|
227
|
-
# @!
|
228
|
-
# Some parameter documentations has been truncated, see
|
229
|
-
# {FinchAPI::Models::HRIS::EmploymentData::Employment} for more details.
|
81
|
+
# @!attribute latest_rehire_date
|
230
82
|
#
|
231
|
-
#
|
83
|
+
# @return [String, nil]
|
84
|
+
required :latest_rehire_date, String, nil?: true
|
85
|
+
|
86
|
+
# @!attribute location
|
232
87
|
#
|
233
|
-
# @
|
234
|
-
|
88
|
+
# @return [FinchAPI::Location, nil]
|
89
|
+
required :location, -> { FinchAPI::Location }, nil?: true
|
90
|
+
|
91
|
+
# @!attribute manager
|
92
|
+
# The manager object representing the manager of the individual within the org.
|
235
93
|
#
|
236
|
-
# @
|
94
|
+
# @return [FinchAPI::HRIS::EmploymentData::UnionMember0::Manager, nil]
|
95
|
+
required :manager, -> { FinchAPI::HRIS::EmploymentData::UnionMember0::Manager }, nil?: true
|
237
96
|
|
238
|
-
#
|
239
|
-
#
|
97
|
+
# @!attribute middle_name
|
98
|
+
# The legal middle name of the individual.
|
240
99
|
#
|
241
|
-
#
|
242
|
-
|
243
|
-
extend FinchAPI::Internal::Type::Enum
|
100
|
+
# @return [String, nil]
|
101
|
+
required :middle_name, String, nil?: true
|
244
102
|
|
245
|
-
|
246
|
-
|
247
|
-
|
248
|
-
|
249
|
-
|
250
|
-
INDIVIDUAL_CONTRACTOR = :individual_contractor
|
103
|
+
# @!attribute source_id
|
104
|
+
# The source system's unique employment identifier for this individual
|
105
|
+
#
|
106
|
+
# @return [String, nil]
|
107
|
+
required :source_id, String, nil?: true
|
251
108
|
|
252
|
-
|
253
|
-
|
109
|
+
# @!attribute start_date
|
110
|
+
#
|
111
|
+
# @return [String, nil]
|
112
|
+
required :start_date, String, nil?: true
|
113
|
+
|
114
|
+
# @!attribute title
|
115
|
+
# The current title of the individual.
|
116
|
+
#
|
117
|
+
# @return [String, nil]
|
118
|
+
required :title, String, nil?: true
|
119
|
+
|
120
|
+
# @!attribute work_id
|
121
|
+
# @deprecated
|
122
|
+
#
|
123
|
+
# This field is deprecated in favour of `source_id`
|
124
|
+
#
|
125
|
+
# @return [String, nil]
|
126
|
+
required :work_id, String, nil?: true
|
127
|
+
|
128
|
+
# @!attribute income
|
129
|
+
# The employee's income as reported by the provider. This may not always be
|
130
|
+
# annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc,
|
131
|
+
# depending on what information the provider returns.
|
132
|
+
#
|
133
|
+
# @return [FinchAPI::Income, nil]
|
134
|
+
optional :income, -> { FinchAPI::Income }, nil?: true
|
135
|
+
|
136
|
+
# @!attribute income_history
|
137
|
+
# The array of income history.
|
138
|
+
#
|
139
|
+
# @return [Array<FinchAPI::Income, nil>, nil]
|
140
|
+
optional :income_history,
|
141
|
+
-> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Income, nil?: true] },
|
142
|
+
nil?: true
|
143
|
+
|
144
|
+
# @!method initialize(id:, class_code:, custom_fields:, department:, employment:, employment_status:, end_date:, first_name:, is_active:, last_name:, latest_rehire_date:, location:, manager:, middle_name:, source_id:, start_date:, title:, work_id:, income: nil, income_history: nil)
|
145
|
+
# Some parameter documentations has been truncated, see
|
146
|
+
# {FinchAPI::HRIS::EmploymentData::UnionMember0} for more details.
|
147
|
+
#
|
148
|
+
# @param id [String] A stable Finch `id` (UUID v4) for an individual in the company.
|
149
|
+
#
|
150
|
+
# @param class_code [String, nil] Worker's compensation classification code for this employee
|
151
|
+
#
|
152
|
+
# @param custom_fields [Array<FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField>, nil] Custom fields for the individual. These are fields which are defined by the empl
|
153
|
+
#
|
154
|
+
# @param department [FinchAPI::HRIS::EmploymentData::UnionMember0::Department, nil] The department object.
|
155
|
+
#
|
156
|
+
# @param employment [FinchAPI::HRIS::EmploymentData::UnionMember0::Employment, nil] The employment object.
|
157
|
+
#
|
158
|
+
# @param employment_status [Symbol, FinchAPI::HRIS::EmploymentData::UnionMember0::EmploymentStatus, nil] The detailed employment status of the individual. Available options: `active`, `
|
159
|
+
#
|
160
|
+
# @param end_date [String, nil]
|
161
|
+
#
|
162
|
+
# @param first_name [String, nil] The legal first name of the individual.
|
163
|
+
#
|
164
|
+
# @param is_active [Boolean, nil] `true` if the individual an an active employee or contractor at the company.
|
165
|
+
#
|
166
|
+
# @param last_name [String, nil] The legal last name of the individual.
|
167
|
+
#
|
168
|
+
# @param latest_rehire_date [String, nil]
|
169
|
+
#
|
170
|
+
# @param location [FinchAPI::Location, nil]
|
171
|
+
#
|
172
|
+
# @param manager [FinchAPI::HRIS::EmploymentData::UnionMember0::Manager, nil] The manager object representing the manager of the individual within the org.
|
173
|
+
#
|
174
|
+
# @param middle_name [String, nil] The legal middle name of the individual.
|
175
|
+
#
|
176
|
+
# @param source_id [String, nil] The source system's unique employment identifier for this individual
|
177
|
+
#
|
178
|
+
# @param start_date [String, nil]
|
179
|
+
#
|
180
|
+
# @param title [String, nil] The current title of the individual.
|
181
|
+
#
|
182
|
+
# @param work_id [String, nil] This field is deprecated in favour of `source_id`
|
183
|
+
#
|
184
|
+
# @param income [FinchAPI::Income, nil] The employee's income as reported by the provider. This may not always be annual
|
185
|
+
#
|
186
|
+
# @param income_history [Array<FinchAPI::Income, nil>, nil] The array of income history.
|
187
|
+
|
188
|
+
class CustomField < FinchAPI::Internal::Type::BaseModel
|
189
|
+
# @!attribute name
|
190
|
+
#
|
191
|
+
# @return [String, nil]
|
192
|
+
optional :name, String
|
193
|
+
|
194
|
+
# @!attribute value
|
195
|
+
#
|
196
|
+
# @return [String, Array<Object>, Object, Float, Boolean, nil]
|
197
|
+
optional :value,
|
198
|
+
union: -> { FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField::Value },
|
199
|
+
nil?: true
|
200
|
+
|
201
|
+
# @!method initialize(name: nil, value: nil)
|
202
|
+
# @param name [String]
|
203
|
+
# @param value [String, Array<Object>, Object, Float, Boolean, nil]
|
204
|
+
|
205
|
+
# @see FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField#value
|
206
|
+
module Value
|
207
|
+
extend FinchAPI::Internal::Type::Union
|
208
|
+
|
209
|
+
variant String
|
210
|
+
|
211
|
+
variant -> {
|
212
|
+
FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField::Value::UnionMember1Array
|
213
|
+
}
|
214
|
+
|
215
|
+
variant FinchAPI::Internal::Type::Unknown
|
216
|
+
|
217
|
+
variant Float
|
218
|
+
|
219
|
+
variant FinchAPI::Internal::Type::Boolean
|
220
|
+
|
221
|
+
# @!method self.variants
|
222
|
+
# @return [Array(String, Array<Object>, Object, Float, Boolean)]
|
223
|
+
|
224
|
+
# @type [FinchAPI::Internal::Type::Converter]
|
225
|
+
UnionMember1Array = FinchAPI::Internal::Type::ArrayOf[FinchAPI::Internal::Type::Unknown]
|
226
|
+
end
|
227
|
+
end
|
228
|
+
|
229
|
+
# @see FinchAPI::HRIS::EmploymentData::UnionMember0#department
|
230
|
+
class Department < FinchAPI::Internal::Type::BaseModel
|
231
|
+
# @!attribute name
|
232
|
+
# The name of the department associated with the individual.
|
233
|
+
#
|
234
|
+
# @return [String, nil]
|
235
|
+
required :name, String, nil?: true
|
236
|
+
|
237
|
+
# @!method initialize(name:)
|
238
|
+
# The department object.
|
239
|
+
#
|
240
|
+
# @param name [String, nil] The name of the department associated with the individual.
|
254
241
|
end
|
255
242
|
|
256
|
-
#
|
243
|
+
# @see FinchAPI::HRIS::EmploymentData::UnionMember0#employment
|
244
|
+
class Employment < FinchAPI::Internal::Type::BaseModel
|
245
|
+
# @!attribute subtype
|
246
|
+
# The secondary employment type of the individual. Options: `full_time`,
|
247
|
+
# `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
|
248
|
+
#
|
249
|
+
# @return [Symbol, FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::Subtype, nil]
|
250
|
+
required :subtype,
|
251
|
+
enum: -> { FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::Subtype },
|
252
|
+
nil?: true
|
253
|
+
|
254
|
+
# @!attribute type
|
255
|
+
# The main employment type of the individual.
|
256
|
+
#
|
257
|
+
# @return [Symbol, FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::Type, nil]
|
258
|
+
required :type,
|
259
|
+
enum: -> {
|
260
|
+
FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::Type
|
261
|
+
},
|
262
|
+
nil?: true
|
263
|
+
|
264
|
+
# @!method initialize(subtype:, type:)
|
265
|
+
# Some parameter documentations has been truncated, see
|
266
|
+
# {FinchAPI::HRIS::EmploymentData::UnionMember0::Employment} for more details.
|
267
|
+
#
|
268
|
+
# The employment object.
|
269
|
+
#
|
270
|
+
# @param subtype [Symbol, FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::Subtype, nil] The secondary employment type of the individual. Options: `full_time`, `part_tim
|
271
|
+
#
|
272
|
+
# @param type [Symbol, FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::Type, nil] The main employment type of the individual.
|
273
|
+
|
274
|
+
# The secondary employment type of the individual. Options: `full_time`,
|
275
|
+
# `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
|
276
|
+
#
|
277
|
+
# @see FinchAPI::HRIS::EmploymentData::UnionMember0::Employment#subtype
|
278
|
+
module Subtype
|
279
|
+
extend FinchAPI::Internal::Type::Enum
|
280
|
+
|
281
|
+
FULL_TIME = :full_time
|
282
|
+
INTERN = :intern
|
283
|
+
PART_TIME = :part_time
|
284
|
+
TEMP = :temp
|
285
|
+
SEASONAL = :seasonal
|
286
|
+
INDIVIDUAL_CONTRACTOR = :individual_contractor
|
287
|
+
|
288
|
+
# @!method self.values
|
289
|
+
# @return [Array<Symbol>]
|
290
|
+
end
|
291
|
+
|
292
|
+
# The main employment type of the individual.
|
293
|
+
#
|
294
|
+
# @see FinchAPI::HRIS::EmploymentData::UnionMember0::Employment#type
|
295
|
+
module Type
|
296
|
+
extend FinchAPI::Internal::Type::Enum
|
297
|
+
|
298
|
+
EMPLOYEE = :employee
|
299
|
+
CONTRACTOR = :contractor
|
300
|
+
|
301
|
+
# @!method self.values
|
302
|
+
# @return [Array<Symbol>]
|
303
|
+
end
|
304
|
+
end
|
305
|
+
|
306
|
+
# The detailed employment status of the individual. Available options: `active`,
|
307
|
+
# `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
|
257
308
|
#
|
258
|
-
# @see FinchAPI::
|
259
|
-
module
|
309
|
+
# @see FinchAPI::HRIS::EmploymentData::UnionMember0#employment_status
|
310
|
+
module EmploymentStatus
|
260
311
|
extend FinchAPI::Internal::Type::Enum
|
261
312
|
|
262
|
-
|
263
|
-
|
313
|
+
ACTIVE = :active
|
314
|
+
DECEASED = :deceased
|
315
|
+
LEAVE = :leave
|
316
|
+
ONBOARDING = :onboarding
|
317
|
+
PREHIRE = :prehire
|
318
|
+
RETIRED = :retired
|
319
|
+
TERMINATED = :terminated
|
264
320
|
|
265
321
|
# @!method self.values
|
266
322
|
# @return [Array<Symbol>]
|
267
323
|
end
|
268
|
-
end
|
269
324
|
|
270
|
-
|
271
|
-
|
272
|
-
|
273
|
-
|
274
|
-
|
275
|
-
|
276
|
-
|
277
|
-
|
278
|
-
|
279
|
-
|
280
|
-
|
281
|
-
|
282
|
-
|
283
|
-
TERMINATED = :terminated
|
284
|
-
|
285
|
-
# @!method self.values
|
286
|
-
# @return [Array<Symbol>]
|
325
|
+
# @see FinchAPI::HRIS::EmploymentData::UnionMember0#manager
|
326
|
+
class Manager < FinchAPI::Internal::Type::BaseModel
|
327
|
+
# @!attribute id
|
328
|
+
# A stable Finch `id` (UUID v4) for an individual in the company.
|
329
|
+
#
|
330
|
+
# @return [String]
|
331
|
+
required :id, String
|
332
|
+
|
333
|
+
# @!method initialize(id:)
|
334
|
+
# The manager object representing the manager of the individual within the org.
|
335
|
+
#
|
336
|
+
# @param id [String] A stable Finch `id` (UUID v4) for an individual in the company.
|
337
|
+
end
|
287
338
|
end
|
288
339
|
|
289
|
-
|
290
|
-
|
291
|
-
# @!attribute id
|
292
|
-
# A stable Finch `id` (UUID v4) for an individual in the company.
|
340
|
+
class BatchError < FinchAPI::Internal::Type::BaseModel
|
341
|
+
# @!attribute code
|
293
342
|
#
|
294
|
-
# @return [
|
295
|
-
|
343
|
+
# @return [Float]
|
344
|
+
required :code, Float
|
296
345
|
|
297
|
-
# @!
|
298
|
-
# The manager object representing the manager of the individual within the org.
|
346
|
+
# @!attribute message
|
299
347
|
#
|
300
|
-
# @
|
348
|
+
# @return [String]
|
349
|
+
required :message, String
|
350
|
+
|
351
|
+
# @!attribute name
|
352
|
+
#
|
353
|
+
# @return [String]
|
354
|
+
required :name, String
|
355
|
+
|
356
|
+
# @!attribute finch_code
|
357
|
+
#
|
358
|
+
# @return [String, nil]
|
359
|
+
optional :finch_code, String
|
360
|
+
|
361
|
+
# @!method initialize(code:, message:, name:, finch_code: nil)
|
362
|
+
# @param code [Float]
|
363
|
+
# @param message [String]
|
364
|
+
# @param name [String]
|
365
|
+
# @param finch_code [String]
|
301
366
|
end
|
367
|
+
|
368
|
+
# @!method self.variants
|
369
|
+
# @return [Array(FinchAPI::HRIS::EmploymentData::UnionMember0, FinchAPI::HRIS::EmploymentData::BatchError)]
|
302
370
|
end
|
303
371
|
end
|
304
372
|
end
|
@@ -7,22 +7,22 @@ module FinchAPI
|
|
7
7
|
class EmploymentDataResponse < FinchAPI::Internal::Type::BaseModel
|
8
8
|
# @!attribute body
|
9
9
|
#
|
10
|
-
# @return [FinchAPI::
|
11
|
-
|
10
|
+
# @return [FinchAPI::HRIS::EmploymentData::UnionMember0, FinchAPI::HRIS::EmploymentData::BatchError]
|
11
|
+
required :body, union: -> { FinchAPI::HRIS::EmploymentData }
|
12
12
|
|
13
13
|
# @!attribute code
|
14
14
|
#
|
15
|
-
# @return [Integer
|
16
|
-
|
15
|
+
# @return [Integer]
|
16
|
+
required :code, Integer
|
17
17
|
|
18
18
|
# @!attribute individual_id
|
19
19
|
# A stable Finch `id` (UUID v4) for an individual in the company.
|
20
20
|
#
|
21
|
-
# @return [String
|
22
|
-
|
21
|
+
# @return [String]
|
22
|
+
required :individual_id, String
|
23
23
|
|
24
|
-
# @!method initialize(body
|
25
|
-
# @param body [FinchAPI::
|
24
|
+
# @!method initialize(body:, code:, individual_id:)
|
25
|
+
# @param body [FinchAPI::HRIS::EmploymentData::UnionMember0, FinchAPI::HRIS::EmploymentData::BatchError]
|
26
26
|
#
|
27
27
|
# @param code [Integer]
|
28
28
|
#
|