finch-api 0.1.0.pre.alpha.18 → 0.1.0.pre.alpha.20
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 +50 -0
- data/README.md +4 -4
- data/SECURITY.md +2 -2
- data/lib/finch_api/errors.rb +22 -0
- data/lib/finch_api/internal/individuals_page.rb +1 -1
- data/lib/finch_api/internal/page.rb +1 -1
- data/lib/finch_api/internal/type/array_of.rb +14 -1
- data/lib/finch_api/internal/type/base_model.rb +84 -25
- data/lib/finch_api/internal/type/boolean.rb +15 -1
- data/lib/finch_api/internal/type/converter.rb +42 -34
- data/lib/finch_api/internal/type/enum.rb +25 -2
- data/lib/finch_api/internal/type/file_input.rb +13 -1
- data/lib/finch_api/internal/type/hash_of.rb +14 -1
- data/lib/finch_api/internal/type/union.rb +27 -7
- data/lib/finch_api/internal/type/unknown.rb +15 -1
- data/lib/finch_api/internal/util.rb +62 -10
- data/lib/finch_api/internal.rb +3 -0
- data/lib/finch_api/models/account_update_event.rb +110 -109
- data/lib/finch_api/models/base_webhook_event.rb +1 -1
- data/lib/finch_api/models/company_event.rb +2 -2
- data/lib/finch_api/models/connect/session_new_params.rb +12 -12
- data/lib/finch_api/models/connect/session_reauthenticate_params.rb +2 -2
- data/lib/finch_api/models/create_access_token_response.rb +7 -7
- data/lib/finch_api/models/directory_event.rb +4 -4
- data/lib/finch_api/models/employment_event.rb +4 -4
- data/lib/finch_api/models/hris/benefit_contribution.rb +3 -3
- data/lib/finch_api/models/hris/benefit_create_params.rb +11 -11
- data/lib/finch_api/models/hris/benefit_features_and_operations.rb +5 -120
- data/lib/finch_api/models/hris/benefit_type.rb +10 -10
- data/lib/finch_api/models/hris/benefits/individual_benefit.rb +11 -11
- data/lib/finch_api/models/hris/benefits/individual_enroll_many_params.rb +23 -23
- data/lib/finch_api/models/hris/benefits_support.rb +24 -24
- data/lib/finch_api/models/hris/company/pay_statement_item/rule_create_params.rb +11 -11
- data/lib/finch_api/models/hris/company/pay_statement_item_list_params.rb +2 -2
- data/lib/finch_api/models/hris/company/pay_statement_item_list_response.rb +18 -18
- data/lib/finch_api/models/hris/company.rb +23 -23
- data/lib/finch_api/models/hris/company_benefit.rb +12 -12
- data/lib/finch_api/models/hris/document_list_params.rb +2 -2
- data/lib/finch_api/models/hris/document_list_response.rb +4 -4
- data/lib/finch_api/models/hris/document_response.rb +4 -4
- data/lib/finch_api/models/hris/document_retreive_response.rb +1 -5
- data/lib/finch_api/models/hris/employment_data.rb +89 -99
- data/lib/finch_api/models/hris/employment_data_response.rb +2 -2
- data/lib/finch_api/models/hris/employment_retrieve_many_params.rb +4 -3
- data/lib/finch_api/models/hris/individual.rb +20 -26
- data/lib/finch_api/models/hris/individual_in_directory.rb +6 -6
- data/lib/finch_api/models/hris/individual_response.rb +2 -2
- data/lib/finch_api/models/hris/individual_retrieve_many_params.rb +4 -4
- data/lib/finch_api/models/hris/pay_statement.rb +184 -182
- data/lib/finch_api/models/hris/pay_statement_data_sync_in_progress.rb +76 -0
- data/lib/finch_api/models/hris/pay_statement_response.rb +50 -8
- data/lib/finch_api/models/hris/pay_statement_response_body.rb +27 -9
- data/lib/finch_api/models/hris/pay_statement_retrieve_many_params.rb +2 -2
- data/lib/finch_api/models/hris/payment.rb +37 -37
- data/lib/finch_api/models/hris/support_per_benefit_type.rb +4 -4
- data/lib/finch_api/models/hris/supported_benefit.rb +10 -9
- data/lib/finch_api/models/hris/w42005.rb +12 -12
- data/lib/finch_api/models/hris/w42020.rb +10 -10
- data/lib/finch_api/models/income.rb +8 -8
- data/lib/finch_api/models/individual_event.rb +4 -4
- data/lib/finch_api/models/introspection.rb +23 -23
- data/lib/finch_api/models/job_completion_event.rb +4 -4
- data/lib/finch_api/models/jobs/automated_async_job.rb +10 -10
- data/lib/finch_api/models/jobs/automated_create_params.rb +4 -4
- data/lib/finch_api/models/jobs/automated_list_response.rb +2 -2
- data/lib/finch_api/models/jobs/manual_async_job.rb +3 -3
- data/lib/finch_api/models/money.rb +4 -4
- data/lib/finch_api/models/operation_support_matrix.rb +9 -9
- data/lib/finch_api/models/pay_statement_event.rb +4 -4
- data/lib/finch_api/models/payment_event.rb +4 -4
- data/lib/finch_api/models/payroll/pay_group_list_response.rb +12 -12
- data/lib/finch_api/models/payroll/pay_group_retrieve_response.rb +5 -5
- data/lib/finch_api/models/provider.rb +104 -104
- data/lib/finch_api/models/sandbox/company_update_params.rb +21 -21
- data/lib/finch_api/models/sandbox/company_update_response.rb +2 -2
- data/lib/finch_api/models/sandbox/connection_create_params.rb +2 -2
- data/lib/finch_api/models/sandbox/connections/account_create_params.rb +2 -2
- data/lib/finch_api/models/sandbox/connections/account_update_params.rb +2 -2
- data/lib/finch_api/models/sandbox/directory_create_params.rb +57 -53
- data/lib/finch_api/models/sandbox/employment_update_params.rb +32 -28
- data/lib/finch_api/models/sandbox/employment_update_response.rb +17 -14
- data/lib/finch_api/models/sandbox/individual_update_params.rb +16 -16
- data/lib/finch_api/models/sandbox/individual_update_response.rb +2 -2
- data/lib/finch_api/models/sandbox/job_create_params.rb +2 -2
- data/lib/finch_api/models/sandbox/jobs/sandbox_job_configuration.rb +6 -6
- data/lib/finch_api/models/sandbox/payment_create_params.rb +160 -367
- data/lib/finch_api/models/webhook_event.rb +1 -16
- data/lib/finch_api/models.rb +30 -19
- data/lib/finch_api/resources/access_tokens.rb +1 -1
- data/lib/finch_api/resources/account.rb +2 -2
- data/lib/finch_api/resources/connect/sessions.rb +5 -5
- data/lib/finch_api/resources/hris/benefits/individuals.rb +4 -4
- data/lib/finch_api/resources/hris/benefits.rb +9 -9
- data/lib/finch_api/resources/hris/company/pay_statement_item/rules.rb +3 -3
- data/lib/finch_api/resources/hris/company/pay_statement_item.rb +1 -1
- data/lib/finch_api/resources/hris/company.rb +1 -1
- data/lib/finch_api/resources/hris/directory.rb +1 -1
- data/lib/finch_api/resources/hris/documents.rb +2 -2
- data/lib/finch_api/resources/hris/employments.rb +2 -2
- data/lib/finch_api/resources/hris/individuals.rb +3 -3
- data/lib/finch_api/resources/hris/pay_statements.rb +2 -2
- data/lib/finch_api/resources/hris/payments.rb +1 -1
- data/lib/finch_api/resources/jobs/automated.rb +3 -3
- data/lib/finch_api/resources/jobs/manual.rb +1 -1
- data/lib/finch_api/resources/providers.rb +1 -1
- data/lib/finch_api/resources/sandbox/company.rb +4 -4
- data/lib/finch_api/resources/sandbox/connections/accounts.rb +2 -2
- data/lib/finch_api/resources/sandbox/connections.rb +1 -1
- data/lib/finch_api/resources/sandbox/directory.rb +1 -1
- data/lib/finch_api/resources/sandbox/employment.rb +9 -9
- data/lib/finch_api/resources/sandbox/individual.rb +5 -5
- data/lib/finch_api/resources/sandbox/jobs/configuration.rb +4 -4
- data/lib/finch_api/resources/sandbox/jobs.rb +1 -1
- data/lib/finch_api/resources/sandbox/payment.rb +6 -3
- data/lib/finch_api/version.rb +1 -1
- data/lib/finch_api.rb +4 -2
- data/rbi/finch_api/errors.rbi +16 -0
- data/rbi/finch_api/internal/type/array_of.rbi +6 -0
- data/rbi/finch_api/internal/type/base_model.rbi +5 -0
- data/rbi/finch_api/internal/type/boolean.rbi +8 -0
- data/rbi/finch_api/internal/type/converter.rbi +15 -15
- data/rbi/finch_api/internal/type/enum.rbi +5 -0
- data/rbi/finch_api/internal/type/file_input.rbi +5 -0
- data/rbi/finch_api/internal/type/hash_of.rbi +6 -0
- data/rbi/finch_api/internal/type/union.rbi +10 -0
- data/rbi/finch_api/internal/type/unknown.rbi +8 -0
- data/rbi/finch_api/internal/util.rbi +36 -0
- data/rbi/finch_api/internal.rbi +3 -0
- data/rbi/finch_api/models/connect/session_new_params.rbi +4 -4
- data/rbi/finch_api/models/hris/benefit_features_and_operations.rbi +4 -296
- data/rbi/finch_api/models/hris/benefit_type.rbi +16 -16
- data/rbi/finch_api/models/hris/company/pay_statement_item_list_response.rbi +18 -33
- data/rbi/finch_api/models/hris/employment_data.rbi +123 -140
- data/rbi/finch_api/models/hris/employment_data_response.rbi +2 -13
- data/rbi/finch_api/models/hris/individual_response.rbi +2 -13
- data/rbi/finch_api/models/hris/pay_statement.rbi +275 -307
- data/rbi/finch_api/models/hris/pay_statement_data_sync_in_progress.rbi +188 -0
- data/rbi/finch_api/models/hris/pay_statement_response.rbi +84 -20
- data/rbi/finch_api/models/hris/pay_statement_response_body.rbi +45 -17
- data/rbi/finch_api/models/hris/payment.rbi +27 -30
- data/rbi/finch_api/models/hris/supported_benefit.rbi +12 -8
- data/rbi/finch_api/models/income.rbi +3 -3
- data/rbi/finch_api/models/money.rbi +4 -7
- data/rbi/finch_api/models/payroll/pay_group_list_response.rbi +25 -43
- data/rbi/finch_api/models/payroll/pay_group_retrieve_response.rbi +14 -14
- data/rbi/finch_api/models/sandbox/directory_create_params.rbi +20 -26
- data/rbi/finch_api/models/sandbox/employment_update_params.rbi +20 -26
- data/rbi/finch_api/models/sandbox/employment_update_response.rbi +20 -26
- data/rbi/finch_api/models/sandbox/payment_create_params.rbi +463 -727
- data/rbi/finch_api/resources/connect/sessions.rbi +2 -2
- data/rbi/finch_api/resources/hris/benefits.rbi +1 -3
- data/rbi/finch_api/resources/hris/documents.rbi +1 -1
- data/rbi/finch_api/resources/sandbox/employment.rbi +8 -5
- data/rbi/finch_api/resources/sandbox/payment.rbi +3 -2
- data/sig/finch_api/errors.rbs +9 -0
- data/sig/finch_api/internal/type/array_of.rbs +3 -0
- data/sig/finch_api/internal/type/base_model.rbs +2 -0
- data/sig/finch_api/internal/type/boolean.rbs +3 -0
- data/sig/finch_api/internal/type/converter.rbs +7 -1
- data/sig/finch_api/internal/type/enum.rbs +2 -0
- data/sig/finch_api/internal/type/file_input.rbs +2 -0
- data/sig/finch_api/internal/type/hash_of.rbs +3 -0
- data/sig/finch_api/internal/type/union.rbs +2 -0
- data/sig/finch_api/internal/type/unknown.rbs +3 -0
- data/sig/finch_api/internal/util.rbs +12 -0
- data/sig/finch_api/internal.rbs +2 -0
- data/sig/finch_api/models/access_token_create_params.rbs +8 -0
- data/sig/finch_api/models/account_disconnect_params.rbs +2 -0
- data/sig/finch_api/models/account_introspect_params.rbs +2 -0
- data/sig/finch_api/models/account_update_event.rbs +230 -12
- data/sig/finch_api/models/base_webhook_event.rbs +6 -0
- data/sig/finch_api/models/company_event.rbs +11 -6
- data/sig/finch_api/models/connect/session_new_params.rbs +26 -8
- data/sig/finch_api/models/connect/session_new_response.rbs +2 -0
- data/sig/finch_api/models/connect/session_reauthenticate_params.rbs +12 -4
- data/sig/finch_api/models/connect/session_reauthenticate_response.rbs +2 -0
- data/sig/finch_api/models/create_access_token_response.rbs +21 -8
- data/sig/finch_api/models/directory_event.rbs +13 -6
- data/sig/finch_api/models/disconnect_response.rbs +2 -0
- data/sig/finch_api/models/employment_event.rbs +13 -6
- data/sig/finch_api/models/hris/benefit_contribution.rbs +12 -4
- data/sig/finch_api/models/hris/benefit_create_params.rbs +21 -6
- data/sig/finch_api/models/hris/benefit_features_and_operations.rbs +9 -78
- data/sig/finch_api/models/hris/benefit_list_params.rbs +2 -0
- data/sig/finch_api/models/hris/benefit_list_supported_benefits_params.rbs +2 -0
- data/sig/finch_api/models/hris/benefit_retrieve_params.rbs +2 -0
- data/sig/finch_api/models/hris/benefit_type.rbs +21 -21
- data/sig/finch_api/models/hris/benefit_update_params.rbs +5 -0
- data/sig/finch_api/models/hris/benefits/enrolled_individual_benefit_response.rbs +2 -0
- data/sig/finch_api/models/hris/benefits/individual_benefit.rbs +18 -4
- data/sig/finch_api/models/hris/benefits/individual_enroll_many_params.rbs +47 -18
- data/sig/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbs +2 -0
- data/sig/finch_api/models/hris/benefits/individual_enrolled_ids_response.rbs +5 -0
- data/sig/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbs +5 -0
- data/sig/finch_api/models/hris/benefits/individual_unenroll_many_params.rbs +5 -0
- data/sig/finch_api/models/hris/benefits/unenrolled_individual_benefit_response.rbs +2 -0
- data/sig/finch_api/models/hris/benefits_support.rbs +15 -0
- data/sig/finch_api/models/hris/company/pay_statement_item/rule_create_params.rbs +23 -6
- data/sig/finch_api/models/hris/company/pay_statement_item/rule_create_response.rbs +20 -0
- data/sig/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbs +2 -0
- data/sig/finch_api/models/hris/company/pay_statement_item/rule_delete_response.rbs +21 -0
- data/sig/finch_api/models/hris/company/pay_statement_item/rule_list_params.rbs +2 -0
- data/sig/finch_api/models/hris/company/pay_statement_item/rule_list_response.rbs +20 -0
- data/sig/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbs +5 -0
- data/sig/finch_api/models/hris/company/pay_statement_item/rule_update_response.rbs +20 -0
- data/sig/finch_api/models/hris/company/pay_statement_item_list_params.rbs +15 -6
- data/sig/finch_api/models/hris/company/pay_statement_item_list_response.rbs +23 -20
- data/sig/finch_api/models/hris/company.rbs +44 -12
- data/sig/finch_api/models/hris/company_benefit.rbs +21 -6
- data/sig/finch_api/models/hris/company_retrieve_params.rbs +2 -0
- data/sig/finch_api/models/hris/create_company_benefits_response.rbs +2 -0
- data/sig/finch_api/models/hris/directory_list_individuals_params.rbs +6 -0
- data/sig/finch_api/models/hris/directory_list_params.rbs +6 -0
- data/sig/finch_api/models/hris/document_list_params.rbs +14 -6
- data/sig/finch_api/models/hris/document_list_response.rbs +5 -0
- data/sig/finch_api/models/hris/document_response.rbs +14 -6
- data/sig/finch_api/models/hris/document_retreive_params.rbs +2 -0
- data/sig/finch_api/models/hris/employment_data.rbs +91 -49
- data/sig/finch_api/models/hris/employment_data_response.rbs +6 -0
- data/sig/finch_api/models/hris/employment_retrieve_many_params.rbs +7 -0
- data/sig/finch_api/models/hris/individual.rbs +49 -16
- data/sig/finch_api/models/hris/individual_in_directory.rbs +14 -0
- data/sig/finch_api/models/hris/individual_response.rbs +6 -0
- data/sig/finch_api/models/hris/individual_retrieve_many_params.rbs +10 -0
- data/sig/finch_api/models/hris/pay_statement.rbs +179 -133
- data/sig/finch_api/models/hris/pay_statement_data_sync_in_progress.rbs +78 -0
- data/sig/finch_api/models/hris/pay_statement_response.rbs +51 -13
- data/sig/finch_api/models/hris/pay_statement_response_body.rbs +24 -11
- data/sig/finch_api/models/hris/pay_statement_retrieve_many_params.rbs +11 -0
- data/sig/finch_api/models/hris/payment.rbs +44 -29
- data/sig/finch_api/models/hris/payment_list_params.rbs +6 -0
- data/sig/finch_api/models/hris/support_per_benefit_type.rbs +5 -0
- data/sig/finch_api/models/hris/supported_benefit.rbs +22 -12
- data/sig/finch_api/models/hris/update_company_benefit_response.rbs +2 -0
- data/sig/finch_api/models/hris/w42005.rbs +30 -16
- data/sig/finch_api/models/hris/w42020.rbs +27 -10
- data/sig/finch_api/models/income.rbs +14 -7
- data/sig/finch_api/models/individual_event.rbs +13 -6
- data/sig/finch_api/models/introspection.rbs +51 -14
- data/sig/finch_api/models/job_completion_event.rbs +13 -6
- data/sig/finch_api/models/jobs/automated_async_job.rbs +22 -8
- data/sig/finch_api/models/jobs/automated_create_params.rbs +8 -0
- data/sig/finch_api/models/jobs/automated_create_response.rbs +7 -0
- data/sig/finch_api/models/jobs/automated_list_params.rbs +6 -0
- data/sig/finch_api/models/jobs/automated_list_response.rbs +18 -0
- data/sig/finch_api/models/jobs/automated_retrieve_params.rbs +2 -0
- data/sig/finch_api/models/jobs/manual_async_job.rbs +10 -4
- data/sig/finch_api/models/jobs/manual_retrieve_params.rbs +2 -0
- data/sig/finch_api/models/location.rbs +11 -0
- data/sig/finch_api/models/money.rbs +3 -3
- data/sig/finch_api/models/operation_support_matrix.rbs +7 -0
- data/sig/finch_api/models/paging.rbs +2 -0
- data/sig/finch_api/models/pay_statement_event.rbs +13 -6
- data/sig/finch_api/models/payment_event.rbs +13 -6
- data/sig/finch_api/models/payroll/pay_group_list_params.rbs +6 -0
- data/sig/finch_api/models/payroll/pay_group_list_response.rbs +22 -24
- data/sig/finch_api/models/payroll/pay_group_retrieve_params.rbs +2 -0
- data/sig/finch_api/models/payroll/pay_group_retrieve_response.rbs +17 -10
- data/sig/finch_api/models/provider.rbs +227 -6
- data/sig/finch_api/models/provider_list_params.rbs +2 -0
- data/sig/finch_api/models/request_forwarding_forward_params.rbs +9 -0
- data/sig/finch_api/models/request_forwarding_forward_response.rbs +15 -0
- data/sig/finch_api/models/sandbox/company_update_params.rbs +44 -12
- data/sig/finch_api/models/sandbox/company_update_response.rbs +31 -0
- data/sig/finch_api/models/sandbox/connection_create_params.rbs +8 -0
- data/sig/finch_api/models/sandbox/connection_create_response.rbs +11 -0
- data/sig/finch_api/models/sandbox/connections/account_create_params.rbs +8 -0
- data/sig/finch_api/models/sandbox/connections/account_create_response.rbs +10 -0
- data/sig/finch_api/models/sandbox/connections/account_update_params.rbs +5 -0
- data/sig/finch_api/models/sandbox/connections/account_update_response.rbs +9 -0
- data/sig/finch_api/models/sandbox/directory_create_params.rbs +90 -40
- data/sig/finch_api/models/sandbox/employment_update_params.rbs +47 -20
- data/sig/finch_api/models/sandbox/employment_update_response.rbs +39 -12
- data/sig/finch_api/models/sandbox/individual_update_params.rbs +34 -8
- data/sig/finch_api/models/sandbox/individual_update_response.rbs +26 -0
- data/sig/finch_api/models/sandbox/job_create_params.rbs +5 -0
- data/sig/finch_api/models/sandbox/job_create_response.rbs +7 -0
- data/sig/finch_api/models/sandbox/jobs/configuration_retrieve_params.rbs +2 -0
- data/sig/finch_api/models/sandbox/jobs/configuration_update_params.rbs +2 -0
- data/sig/finch_api/models/sandbox/jobs/sandbox_job_configuration.rbs +13 -8
- data/sig/finch_api/models/sandbox/payment_create_params.rbs +287 -228
- data/sig/finch_api/models/sandbox/payment_create_response.rbs +2 -0
- data/sig/finch_api/resources/connect/sessions.rbs +2 -2
- data/sig/finch_api/resources/hris/benefits.rbs +1 -1
- data/sig/finch_api/resources/hris/company/pay_statement_item.rbs +1 -1
- data/sig/finch_api/resources/hris/documents.rbs +1 -1
- data/sig/finch_api/resources/sandbox/employment.rbs +2 -2
- data/sig/finch_api/resources/sandbox/payment.rbs +2 -2
- metadata +5 -5
- data/lib/finch_api/models/hris/benefit_list_supported_benefits_response.rb +0 -110
- data/rbi/finch_api/models/hris/benefit_list_supported_benefits_response.rbi +0 -290
- data/sig/finch_api/models/hris/benefit_list_supported_benefits_response.rbs +0 -79
@@ -31,19 +31,6 @@ module FinchAPI
|
|
31
31
|
sig { returns(T.nilable(String)) }
|
32
32
|
attr_accessor :class_code
|
33
33
|
|
34
|
-
# Custom fields for the individual. These are fields which are defined by the
|
35
|
-
# employer in the system.
|
36
|
-
sig do
|
37
|
-
returns(
|
38
|
-
T.nilable(
|
39
|
-
T::Array[
|
40
|
-
FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField
|
41
|
-
]
|
42
|
-
)
|
43
|
-
)
|
44
|
-
end
|
45
|
-
attr_accessor :custom_fields
|
46
|
-
|
47
34
|
# The department object.
|
48
35
|
sig do
|
49
36
|
returns(
|
@@ -148,9 +135,19 @@ module FinchAPI
|
|
148
135
|
sig { returns(T.nilable(String)) }
|
149
136
|
attr_accessor :title
|
150
137
|
|
151
|
-
#
|
152
|
-
|
153
|
-
|
138
|
+
# Custom fields for the individual. These are fields which are defined by the
|
139
|
+
# employer in the system. Custom fields are not currently supported for assisted
|
140
|
+
# connections.
|
141
|
+
sig do
|
142
|
+
returns(
|
143
|
+
T.nilable(
|
144
|
+
T::Array[
|
145
|
+
FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField
|
146
|
+
]
|
147
|
+
)
|
148
|
+
)
|
149
|
+
end
|
150
|
+
attr_accessor :custom_fields
|
154
151
|
|
155
152
|
# The employee's income as reported by the provider. This may not always be
|
156
153
|
# annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc,
|
@@ -169,16 +166,14 @@ module FinchAPI
|
|
169
166
|
sig { returns(T.nilable(String)) }
|
170
167
|
attr_accessor :source_id
|
171
168
|
|
169
|
+
# This field is deprecated in favour of `source_id`
|
170
|
+
sig { returns(T.nilable(String)) }
|
171
|
+
attr_accessor :work_id
|
172
|
+
|
172
173
|
sig do
|
173
174
|
params(
|
174
175
|
id: String,
|
175
176
|
class_code: T.nilable(String),
|
176
|
-
custom_fields:
|
177
|
-
T.nilable(
|
178
|
-
T::Array[
|
179
|
-
FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField::OrHash
|
180
|
-
]
|
181
|
-
),
|
182
177
|
department:
|
183
178
|
T.nilable(
|
184
179
|
FinchAPI::HRIS::EmploymentData::UnionMember0::Department::OrHash
|
@@ -204,11 +199,17 @@ module FinchAPI
|
|
204
199
|
middle_name: T.nilable(String),
|
205
200
|
start_date: T.nilable(String),
|
206
201
|
title: T.nilable(String),
|
207
|
-
|
202
|
+
custom_fields:
|
203
|
+
T.nilable(
|
204
|
+
T::Array[
|
205
|
+
FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField::OrHash
|
206
|
+
]
|
207
|
+
),
|
208
208
|
income: T.nilable(FinchAPI::Income::OrHash),
|
209
209
|
income_history:
|
210
210
|
T.nilable(T::Array[T.nilable(FinchAPI::Income::OrHash)]),
|
211
|
-
source_id: T.nilable(String)
|
211
|
+
source_id: T.nilable(String),
|
212
|
+
work_id: T.nilable(String)
|
212
213
|
).returns(T.attached_class)
|
213
214
|
end
|
214
215
|
def self.new(
|
@@ -216,9 +217,6 @@ module FinchAPI
|
|
216
217
|
id:,
|
217
218
|
# Worker's compensation classification code for this employee
|
218
219
|
class_code:,
|
219
|
-
# Custom fields for the individual. These are fields which are defined by the
|
220
|
-
# employer in the system.
|
221
|
-
custom_fields:,
|
222
220
|
# The department object.
|
223
221
|
department:,
|
224
222
|
# The employment object.
|
@@ -242,8 +240,10 @@ module FinchAPI
|
|
242
240
|
start_date:,
|
243
241
|
# The current title of the individual.
|
244
242
|
title:,
|
245
|
-
#
|
246
|
-
|
243
|
+
# Custom fields for the individual. These are fields which are defined by the
|
244
|
+
# employer in the system. Custom fields are not currently supported for assisted
|
245
|
+
# connections.
|
246
|
+
custom_fields: nil,
|
247
247
|
# The employee's income as reported by the provider. This may not always be
|
248
248
|
# annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc,
|
249
249
|
# depending on what information the provider returns.
|
@@ -251,7 +251,9 @@ module FinchAPI
|
|
251
251
|
# The array of income history.
|
252
252
|
income_history: nil,
|
253
253
|
# The source system's unique employment identifier for this individual
|
254
|
-
source_id: nil
|
254
|
+
source_id: nil,
|
255
|
+
# This field is deprecated in favour of `source_id`
|
256
|
+
work_id: nil
|
255
257
|
)
|
256
258
|
end
|
257
259
|
|
@@ -260,12 +262,6 @@ module FinchAPI
|
|
260
262
|
{
|
261
263
|
id: String,
|
262
264
|
class_code: T.nilable(String),
|
263
|
-
custom_fields:
|
264
|
-
T.nilable(
|
265
|
-
T::Array[
|
266
|
-
FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField
|
267
|
-
]
|
268
|
-
),
|
269
265
|
department:
|
270
266
|
T.nilable(
|
271
267
|
FinchAPI::HRIS::EmploymentData::UnionMember0::Department
|
@@ -291,119 +287,23 @@ module FinchAPI
|
|
291
287
|
middle_name: T.nilable(String),
|
292
288
|
start_date: T.nilable(String),
|
293
289
|
title: T.nilable(String),
|
294
|
-
|
290
|
+
custom_fields:
|
291
|
+
T.nilable(
|
292
|
+
T::Array[
|
293
|
+
FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField
|
294
|
+
]
|
295
|
+
),
|
295
296
|
income: T.nilable(FinchAPI::Income),
|
296
297
|
income_history:
|
297
298
|
T.nilable(T::Array[T.nilable(FinchAPI::Income)]),
|
298
|
-
source_id: T.nilable(String)
|
299
|
+
source_id: T.nilable(String),
|
300
|
+
work_id: T.nilable(String)
|
299
301
|
}
|
300
302
|
)
|
301
303
|
end
|
302
304
|
def to_hash
|
303
305
|
end
|
304
306
|
|
305
|
-
class CustomField < FinchAPI::Internal::Type::BaseModel
|
306
|
-
OrHash =
|
307
|
-
T.type_alias do
|
308
|
-
T.any(
|
309
|
-
FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField,
|
310
|
-
FinchAPI::Internal::AnyHash
|
311
|
-
)
|
312
|
-
end
|
313
|
-
|
314
|
-
sig { returns(T.nilable(String)) }
|
315
|
-
attr_reader :name
|
316
|
-
|
317
|
-
sig { params(name: String).void }
|
318
|
-
attr_writer :name
|
319
|
-
|
320
|
-
sig do
|
321
|
-
returns(
|
322
|
-
T.nilable(
|
323
|
-
T.any(
|
324
|
-
String,
|
325
|
-
T::Array[T.anything],
|
326
|
-
T.anything,
|
327
|
-
Float,
|
328
|
-
T::Boolean
|
329
|
-
)
|
330
|
-
)
|
331
|
-
)
|
332
|
-
end
|
333
|
-
attr_accessor :value
|
334
|
-
|
335
|
-
sig do
|
336
|
-
params(
|
337
|
-
name: String,
|
338
|
-
value:
|
339
|
-
T.nilable(
|
340
|
-
T.any(
|
341
|
-
String,
|
342
|
-
T::Array[T.anything],
|
343
|
-
T.anything,
|
344
|
-
Float,
|
345
|
-
T::Boolean
|
346
|
-
)
|
347
|
-
)
|
348
|
-
).returns(T.attached_class)
|
349
|
-
end
|
350
|
-
def self.new(name: nil, value: nil)
|
351
|
-
end
|
352
|
-
|
353
|
-
sig do
|
354
|
-
override.returns(
|
355
|
-
{
|
356
|
-
name: String,
|
357
|
-
value:
|
358
|
-
T.nilable(
|
359
|
-
T.any(
|
360
|
-
String,
|
361
|
-
T::Array[T.anything],
|
362
|
-
T.anything,
|
363
|
-
Float,
|
364
|
-
T::Boolean
|
365
|
-
)
|
366
|
-
)
|
367
|
-
}
|
368
|
-
)
|
369
|
-
end
|
370
|
-
def to_hash
|
371
|
-
end
|
372
|
-
|
373
|
-
module Value
|
374
|
-
extend FinchAPI::Internal::Type::Union
|
375
|
-
|
376
|
-
Variants =
|
377
|
-
T.type_alias do
|
378
|
-
T.any(
|
379
|
-
String,
|
380
|
-
T::Array[T.anything],
|
381
|
-
T.anything,
|
382
|
-
Float,
|
383
|
-
T::Boolean
|
384
|
-
)
|
385
|
-
end
|
386
|
-
|
387
|
-
sig do
|
388
|
-
override.returns(
|
389
|
-
T::Array[
|
390
|
-
FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField::Value::Variants
|
391
|
-
]
|
392
|
-
)
|
393
|
-
end
|
394
|
-
def self.variants
|
395
|
-
end
|
396
|
-
|
397
|
-
UnionMember1Array =
|
398
|
-
T.let(
|
399
|
-
FinchAPI::Internal::Type::ArrayOf[
|
400
|
-
FinchAPI::Internal::Type::Unknown
|
401
|
-
],
|
402
|
-
FinchAPI::Internal::Type::Converter
|
403
|
-
)
|
404
|
-
end
|
405
|
-
end
|
406
|
-
|
407
307
|
class Department < FinchAPI::Internal::Type::BaseModel
|
408
308
|
OrHash =
|
409
309
|
T.type_alias do
|
@@ -677,6 +577,89 @@ module FinchAPI
|
|
677
577
|
def to_hash
|
678
578
|
end
|
679
579
|
end
|
580
|
+
|
581
|
+
class CustomField < FinchAPI::Internal::Type::BaseModel
|
582
|
+
OrHash =
|
583
|
+
T.type_alias do
|
584
|
+
T.any(
|
585
|
+
FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField,
|
586
|
+
FinchAPI::Internal::AnyHash
|
587
|
+
)
|
588
|
+
end
|
589
|
+
|
590
|
+
sig { returns(T.nilable(String)) }
|
591
|
+
attr_accessor :name
|
592
|
+
|
593
|
+
sig do
|
594
|
+
returns(
|
595
|
+
T.nilable(
|
596
|
+
FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField::Value::Variants
|
597
|
+
)
|
598
|
+
)
|
599
|
+
end
|
600
|
+
attr_accessor :value
|
601
|
+
|
602
|
+
sig do
|
603
|
+
params(
|
604
|
+
name: T.nilable(String),
|
605
|
+
value:
|
606
|
+
T.nilable(
|
607
|
+
FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField::Value::Variants
|
608
|
+
)
|
609
|
+
).returns(T.attached_class)
|
610
|
+
end
|
611
|
+
def self.new(name: nil, value: nil)
|
612
|
+
end
|
613
|
+
|
614
|
+
sig do
|
615
|
+
override.returns(
|
616
|
+
{
|
617
|
+
name: T.nilable(String),
|
618
|
+
value:
|
619
|
+
T.nilable(
|
620
|
+
FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField::Value::Variants
|
621
|
+
)
|
622
|
+
}
|
623
|
+
)
|
624
|
+
end
|
625
|
+
def to_hash
|
626
|
+
end
|
627
|
+
|
628
|
+
module Value
|
629
|
+
extend FinchAPI::Internal::Type::Union
|
630
|
+
|
631
|
+
Variants =
|
632
|
+
T.type_alias do
|
633
|
+
T.nilable(
|
634
|
+
T.any(
|
635
|
+
String,
|
636
|
+
T::Array[T.anything],
|
637
|
+
T.anything,
|
638
|
+
Float,
|
639
|
+
T::Boolean
|
640
|
+
)
|
641
|
+
)
|
642
|
+
end
|
643
|
+
|
644
|
+
sig do
|
645
|
+
override.returns(
|
646
|
+
T::Array[
|
647
|
+
FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField::Value::Variants
|
648
|
+
]
|
649
|
+
)
|
650
|
+
end
|
651
|
+
def self.variants
|
652
|
+
end
|
653
|
+
|
654
|
+
UnionMember1Array =
|
655
|
+
T.let(
|
656
|
+
FinchAPI::Internal::Type::ArrayOf[
|
657
|
+
FinchAPI::Internal::Type::Unknown
|
658
|
+
],
|
659
|
+
FinchAPI::Internal::Type::Converter
|
660
|
+
)
|
661
|
+
end
|
662
|
+
end
|
680
663
|
end
|
681
664
|
|
682
665
|
class BatchError < FinchAPI::Internal::Type::BaseModel
|
@@ -12,14 +12,7 @@ module FinchAPI
|
|
12
12
|
)
|
13
13
|
end
|
14
14
|
|
15
|
-
sig
|
16
|
-
returns(
|
17
|
-
T.any(
|
18
|
-
FinchAPI::HRIS::EmploymentData::UnionMember0,
|
19
|
-
FinchAPI::HRIS::EmploymentData::BatchError
|
20
|
-
)
|
21
|
-
)
|
22
|
-
end
|
15
|
+
sig { returns(FinchAPI::HRIS::EmploymentData::Variants) }
|
23
16
|
attr_accessor :body
|
24
17
|
|
25
18
|
sig { returns(Integer) }
|
@@ -51,11 +44,7 @@ module FinchAPI
|
|
51
44
|
sig do
|
52
45
|
override.returns(
|
53
46
|
{
|
54
|
-
body:
|
55
|
-
T.any(
|
56
|
-
FinchAPI::HRIS::EmploymentData::UnionMember0,
|
57
|
-
FinchAPI::HRIS::EmploymentData::BatchError
|
58
|
-
),
|
47
|
+
body: FinchAPI::HRIS::EmploymentData::Variants,
|
59
48
|
code: Integer,
|
60
49
|
individual_id: String
|
61
50
|
}
|
@@ -12,14 +12,7 @@ module FinchAPI
|
|
12
12
|
)
|
13
13
|
end
|
14
14
|
|
15
|
-
sig
|
16
|
-
returns(
|
17
|
-
T.any(
|
18
|
-
FinchAPI::HRIS::Individual::UnionMember0,
|
19
|
-
FinchAPI::HRIS::Individual::BatchError
|
20
|
-
)
|
21
|
-
)
|
22
|
-
end
|
15
|
+
sig { returns(FinchAPI::HRIS::Individual::Variants) }
|
23
16
|
attr_accessor :body
|
24
17
|
|
25
18
|
sig { returns(Integer) }
|
@@ -45,11 +38,7 @@ module FinchAPI
|
|
45
38
|
sig do
|
46
39
|
override.returns(
|
47
40
|
{
|
48
|
-
body:
|
49
|
-
T.any(
|
50
|
-
FinchAPI::HRIS::Individual::UnionMember0,
|
51
|
-
FinchAPI::HRIS::Individual::BatchError
|
52
|
-
),
|
41
|
+
body: FinchAPI::HRIS::Individual::Variants,
|
53
42
|
code: Integer,
|
54
43
|
individual_id: String
|
55
44
|
}
|