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
@@ -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::Sandbox::EmploymentUpdateParams::CustomField>, nil]
|
22
|
+
# @return [Array<FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField>, nil]
|
23
23
|
optional :custom_fields,
|
24
24
|
-> {
|
25
25
|
FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::EmploymentUpdateParams::CustomField]
|
26
|
-
}
|
26
|
+
},
|
27
|
+
nil?: true
|
27
28
|
|
28
29
|
# @!attribute department
|
29
30
|
# The department object.
|
30
31
|
#
|
31
|
-
# @return [FinchAPI::Sandbox::EmploymentUpdateParams::Department, nil]
|
32
|
+
# @return [FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department, nil]
|
32
33
|
optional :department, -> { FinchAPI::Sandbox::EmploymentUpdateParams::Department }, nil?: true
|
33
34
|
|
34
35
|
# @!attribute employment
|
35
36
|
# The employment object.
|
36
37
|
#
|
37
|
-
# @return [FinchAPI::Sandbox::EmploymentUpdateParams::Employment, nil]
|
38
|
+
# @return [FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment, nil]
|
38
39
|
optional :employment, -> { FinchAPI::Sandbox::EmploymentUpdateParams::Employment }, nil?: true
|
39
40
|
|
40
41
|
# @!attribute employment_status
|
41
|
-
# The detailed employment status of the individual.
|
42
|
+
# The detailed employment status of the individual. Available options: `active`,
|
43
|
+
# `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
|
42
44
|
#
|
43
|
-
# @return [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil]
|
45
|
+
# @return [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil]
|
44
46
|
optional :employment_status,
|
45
47
|
enum: -> { FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus },
|
46
48
|
nil?: true
|
@@ -61,13 +63,13 @@ module FinchAPI
|
|
61
63
|
# annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc,
|
62
64
|
# depending on what information the provider returns.
|
63
65
|
#
|
64
|
-
# @return [FinchAPI::Income, nil]
|
66
|
+
# @return [FinchAPI::Models::Income, nil]
|
65
67
|
optional :income, -> { FinchAPI::Income }, nil?: true
|
66
68
|
|
67
69
|
# @!attribute income_history
|
68
70
|
# The array of income history.
|
69
71
|
#
|
70
|
-
# @return [Array<FinchAPI::Income, nil>, nil]
|
72
|
+
# @return [Array<FinchAPI::Models::Income, nil>, nil]
|
71
73
|
optional :income_history,
|
72
74
|
-> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Income, nil?: true] },
|
73
75
|
nil?: true
|
@@ -91,13 +93,13 @@ module FinchAPI
|
|
91
93
|
|
92
94
|
# @!attribute location
|
93
95
|
#
|
94
|
-
# @return [FinchAPI::Location, nil]
|
96
|
+
# @return [FinchAPI::Models::Location, nil]
|
95
97
|
optional :location, -> { FinchAPI::Location }, nil?: true
|
96
98
|
|
97
99
|
# @!attribute manager
|
98
100
|
# The manager object representing the manager of the individual within the org.
|
99
101
|
#
|
100
|
-
# @return [FinchAPI::Sandbox::EmploymentUpdateParams::Manager, nil]
|
102
|
+
# @return [FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager, nil]
|
101
103
|
optional :manager, -> { FinchAPI::Sandbox::EmploymentUpdateParams::Manager }, nil?: true
|
102
104
|
|
103
105
|
# @!attribute middle_name
|
@@ -110,7 +112,7 @@ module FinchAPI
|
|
110
112
|
# The source system's unique employment identifier for this individual
|
111
113
|
#
|
112
114
|
# @return [String, nil]
|
113
|
-
optional :source_id, String
|
115
|
+
optional :source_id, String, nil?: true
|
114
116
|
|
115
117
|
# @!attribute start_date
|
116
118
|
#
|
@@ -129,21 +131,21 @@ module FinchAPI
|
|
129
131
|
#
|
130
132
|
# @param class_code [String, nil] Worker's compensation classification code for this employee
|
131
133
|
#
|
132
|
-
# @param custom_fields [Array<FinchAPI::Sandbox::EmploymentUpdateParams::CustomField
|
134
|
+
# @param custom_fields [Array<FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField>, nil] Custom fields for the individual. These are fields which are defined by the empl
|
133
135
|
#
|
134
|
-
# @param department [FinchAPI::Sandbox::EmploymentUpdateParams::Department, nil] The department object.
|
136
|
+
# @param department [FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department, nil] The department object.
|
135
137
|
#
|
136
|
-
# @param employment [FinchAPI::Sandbox::EmploymentUpdateParams::Employment, nil] The employment object.
|
138
|
+
# @param employment [FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment, nil] The employment object.
|
137
139
|
#
|
138
|
-
# @param employment_status [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil] The detailed employment status of the individual.
|
140
|
+
# @param employment_status [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil] The detailed employment status of the individual. Available options: `active`, `
|
139
141
|
#
|
140
142
|
# @param end_date [String, nil]
|
141
143
|
#
|
142
144
|
# @param first_name [String, nil] The legal first name of the individual.
|
143
145
|
#
|
144
|
-
# @param income [FinchAPI::Income, nil] The employee's income as reported by the provider. This may not always be annual
|
146
|
+
# @param income [FinchAPI::Models::Income, nil] The employee's income as reported by the provider. This may not always be annual
|
145
147
|
#
|
146
|
-
# @param income_history [Array<FinchAPI::Income, nil>, nil] The array of income history.
|
148
|
+
# @param income_history [Array<FinchAPI::Models::Income, nil>, nil] The array of income history.
|
147
149
|
#
|
148
150
|
# @param is_active [Boolean, nil] `true` if the individual an an active employee or contractor at the company.
|
149
151
|
#
|
@@ -151,13 +153,13 @@ module FinchAPI
|
|
151
153
|
#
|
152
154
|
# @param latest_rehire_date [String, nil]
|
153
155
|
#
|
154
|
-
# @param location [FinchAPI::Location, nil]
|
156
|
+
# @param location [FinchAPI::Models::Location, nil]
|
155
157
|
#
|
156
|
-
# @param manager [FinchAPI::Sandbox::EmploymentUpdateParams::Manager, nil] The manager object representing the manager of the individual within the org.
|
158
|
+
# @param manager [FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager, nil] The manager object representing the manager of the individual within the org.
|
157
159
|
#
|
158
160
|
# @param middle_name [String, nil] The legal middle name of the individual.
|
159
161
|
#
|
160
|
-
# @param source_id [String] The source system's unique employment identifier for this individual
|
162
|
+
# @param source_id [String, nil] The source system's unique employment identifier for this individual
|
161
163
|
#
|
162
164
|
# @param start_date [String, nil]
|
163
165
|
#
|
@@ -199,7 +201,7 @@ module FinchAPI
|
|
199
201
|
# The secondary employment type of the individual. Options: `full_time`,
|
200
202
|
# `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
|
201
203
|
#
|
202
|
-
# @return [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Subtype, nil]
|
204
|
+
# @return [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype, nil]
|
203
205
|
optional :subtype,
|
204
206
|
enum: -> {
|
205
207
|
FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Subtype
|
@@ -209,23 +211,24 @@ module FinchAPI
|
|
209
211
|
# @!attribute type
|
210
212
|
# The main employment type of the individual.
|
211
213
|
#
|
212
|
-
# @return [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Type, nil]
|
214
|
+
# @return [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type, nil]
|
213
215
|
optional :type, enum: -> { FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Type }, nil?: true
|
214
216
|
|
215
217
|
# @!method initialize(subtype: nil, type: nil)
|
216
218
|
# Some parameter documentations has been truncated, see
|
217
|
-
# {FinchAPI::Sandbox::EmploymentUpdateParams::Employment} for more
|
219
|
+
# {FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment} for more
|
220
|
+
# details.
|
218
221
|
#
|
219
222
|
# The employment object.
|
220
223
|
#
|
221
|
-
# @param subtype [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Subtype, nil] The secondary employment type of the individual. Options: `full_time`, `
|
224
|
+
# @param subtype [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype, nil] The secondary employment type of the individual. Options: `full_time`, `part_tim
|
222
225
|
#
|
223
|
-
# @param type [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Type, nil] The main employment type of the individual.
|
226
|
+
# @param type [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type, nil] The main employment type of the individual.
|
224
227
|
|
225
228
|
# The secondary employment type of the individual. Options: `full_time`,
|
226
229
|
# `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
|
227
230
|
#
|
228
|
-
# @see FinchAPI::Sandbox::EmploymentUpdateParams::Employment#subtype
|
231
|
+
# @see FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment#subtype
|
229
232
|
module Subtype
|
230
233
|
extend FinchAPI::Internal::Type::Enum
|
231
234
|
|
@@ -242,7 +245,7 @@ module FinchAPI
|
|
242
245
|
|
243
246
|
# The main employment type of the individual.
|
244
247
|
#
|
245
|
-
# @see FinchAPI::Sandbox::EmploymentUpdateParams::Employment#type
|
248
|
+
# @see FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment#type
|
246
249
|
module Type
|
247
250
|
extend FinchAPI::Internal::Type::Enum
|
248
251
|
|
@@ -254,7 +257,8 @@ module FinchAPI
|
|
254
257
|
end
|
255
258
|
end
|
256
259
|
|
257
|
-
# The detailed employment status of the individual.
|
260
|
+
# The detailed employment status of the individual. Available options: `active`,
|
261
|
+
# `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
|
258
262
|
module EmploymentStatus
|
259
263
|
extend FinchAPI::Internal::Type::Enum
|
260
264
|
|
@@ -24,7 +24,8 @@ module FinchAPI
|
|
24
24
|
#
|
25
25
|
# @return [Array<FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField>, nil]
|
26
26
|
optional :custom_fields,
|
27
|
-
-> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField] }
|
27
|
+
-> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField] },
|
28
|
+
nil?: true
|
28
29
|
|
29
30
|
# @!attribute department
|
30
31
|
# The department object.
|
@@ -39,7 +40,8 @@ module FinchAPI
|
|
39
40
|
optional :employment, -> { FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment }, nil?: true
|
40
41
|
|
41
42
|
# @!attribute employment_status
|
42
|
-
# The detailed employment status of the individual.
|
43
|
+
# The detailed employment status of the individual. Available options: `active`,
|
44
|
+
# `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
|
43
45
|
#
|
44
46
|
# @return [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus, nil]
|
45
47
|
optional :employment_status,
|
@@ -62,13 +64,13 @@ module FinchAPI
|
|
62
64
|
# annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc,
|
63
65
|
# depending on what information the provider returns.
|
64
66
|
#
|
65
|
-
# @return [FinchAPI::Income, nil]
|
67
|
+
# @return [FinchAPI::Models::Income, nil]
|
66
68
|
optional :income, -> { FinchAPI::Income }, nil?: true
|
67
69
|
|
68
70
|
# @!attribute income_history
|
69
71
|
# The array of income history.
|
70
72
|
#
|
71
|
-
# @return [Array<FinchAPI::Income, nil>, nil]
|
73
|
+
# @return [Array<FinchAPI::Models::Income, nil>, nil]
|
72
74
|
optional :income_history,
|
73
75
|
-> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Income, nil?: true] },
|
74
76
|
nil?: true
|
@@ -92,7 +94,7 @@ module FinchAPI
|
|
92
94
|
|
93
95
|
# @!attribute location
|
94
96
|
#
|
95
|
-
# @return [FinchAPI::Location, nil]
|
97
|
+
# @return [FinchAPI::Models::Location, nil]
|
96
98
|
optional :location, -> { FinchAPI::Location }, nil?: true
|
97
99
|
|
98
100
|
# @!attribute manager
|
@@ -111,7 +113,7 @@ module FinchAPI
|
|
111
113
|
# The source system's unique employment identifier for this individual
|
112
114
|
#
|
113
115
|
# @return [String, nil]
|
114
|
-
optional :source_id, String
|
116
|
+
optional :source_id, String, nil?: true
|
115
117
|
|
116
118
|
# @!attribute start_date
|
117
119
|
#
|
@@ -132,21 +134,21 @@ module FinchAPI
|
|
132
134
|
#
|
133
135
|
# @param class_code [String, nil] Worker's compensation classification code for this employee
|
134
136
|
#
|
135
|
-
# @param custom_fields [Array<FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField
|
137
|
+
# @param custom_fields [Array<FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField>, nil] Custom fields for the individual. These are fields which are defined by the empl
|
136
138
|
#
|
137
139
|
# @param department [FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department, nil] The department object.
|
138
140
|
#
|
139
141
|
# @param employment [FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment, nil] The employment object.
|
140
142
|
#
|
141
|
-
# @param employment_status [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus, nil] The detailed employment status of the individual.
|
143
|
+
# @param employment_status [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus, nil] The detailed employment status of the individual. Available options: `active`, `
|
142
144
|
#
|
143
145
|
# @param end_date [String, nil]
|
144
146
|
#
|
145
147
|
# @param first_name [String, nil] The legal first name of the individual.
|
146
148
|
#
|
147
|
-
# @param income [FinchAPI::Income, nil] The employee's income as reported by the provider. This may not always be annual
|
149
|
+
# @param income [FinchAPI::Models::Income, nil] The employee's income as reported by the provider. This may not always be annual
|
148
150
|
#
|
149
|
-
# @param income_history [Array<FinchAPI::Income, nil>, nil] The array of income history.
|
151
|
+
# @param income_history [Array<FinchAPI::Models::Income, nil>, nil] The array of income history.
|
150
152
|
#
|
151
153
|
# @param is_active [Boolean, nil] `true` if the individual an an active employee or contractor at the company.
|
152
154
|
#
|
@@ -154,13 +156,13 @@ module FinchAPI
|
|
154
156
|
#
|
155
157
|
# @param latest_rehire_date [String, nil]
|
156
158
|
#
|
157
|
-
# @param location [FinchAPI::Location, nil]
|
159
|
+
# @param location [FinchAPI::Models::Location, nil]
|
158
160
|
#
|
159
161
|
# @param manager [FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager, nil] The manager object representing the manager of the individual within the org.
|
160
162
|
#
|
161
163
|
# @param middle_name [String, nil] The legal middle name of the individual.
|
162
164
|
#
|
163
|
-
# @param source_id [String] The source system's unique employment identifier for this individual
|
165
|
+
# @param source_id [String, nil] The source system's unique employment identifier for this individual
|
164
166
|
#
|
165
167
|
# @param start_date [String, nil]
|
166
168
|
#
|
@@ -222,7 +224,7 @@ module FinchAPI
|
|
222
224
|
#
|
223
225
|
# The employment object.
|
224
226
|
#
|
225
|
-
# @param subtype [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype, nil] The secondary employment type of the individual. Options: `full_time`, `
|
227
|
+
# @param subtype [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype, nil] The secondary employment type of the individual. Options: `full_time`, `part_tim
|
226
228
|
#
|
227
229
|
# @param type [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Type, nil] The main employment type of the individual.
|
228
230
|
|
@@ -258,7 +260,8 @@ module FinchAPI
|
|
258
260
|
end
|
259
261
|
end
|
260
262
|
|
261
|
-
# The detailed employment status of the individual.
|
263
|
+
# The detailed employment status of the individual. Available options: `active`,
|
264
|
+
# `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
|
262
265
|
#
|
263
266
|
# @see FinchAPI::Models::Sandbox::EmploymentUpdateResponse#employment_status
|
264
267
|
module EmploymentStatus
|
@@ -15,7 +15,7 @@ module FinchAPI
|
|
15
15
|
|
16
16
|
# @!attribute emails
|
17
17
|
#
|
18
|
-
# @return [Array<FinchAPI::Sandbox::IndividualUpdateParams::Email>, nil]
|
18
|
+
# @return [Array<FinchAPI::Models::Sandbox::IndividualUpdateParams::Email>, nil]
|
19
19
|
optional :emails,
|
20
20
|
-> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::IndividualUpdateParams::Email] },
|
21
21
|
nil?: true
|
@@ -31,7 +31,7 @@ module FinchAPI
|
|
31
31
|
# @!attribute ethnicity
|
32
32
|
# The EEOC-defined ethnicity of the individual.
|
33
33
|
#
|
34
|
-
# @return [Symbol, FinchAPI::Sandbox::IndividualUpdateParams::Ethnicity, nil]
|
34
|
+
# @return [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity, nil]
|
35
35
|
optional :ethnicity, enum: -> { FinchAPI::Sandbox::IndividualUpdateParams::Ethnicity }, nil?: true
|
36
36
|
|
37
37
|
# @!attribute first_name
|
@@ -43,7 +43,7 @@ module FinchAPI
|
|
43
43
|
# @!attribute gender
|
44
44
|
# The gender of the individual.
|
45
45
|
#
|
46
|
-
# @return [Symbol, FinchAPI::Sandbox::IndividualUpdateParams::Gender, nil]
|
46
|
+
# @return [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender, nil]
|
47
47
|
optional :gender, enum: -> { FinchAPI::Sandbox::IndividualUpdateParams::Gender }, nil?: true
|
48
48
|
|
49
49
|
# @!attribute last_name
|
@@ -60,7 +60,7 @@ module FinchAPI
|
|
60
60
|
|
61
61
|
# @!attribute phone_numbers
|
62
62
|
#
|
63
|
-
# @return [Array<FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber, nil>, nil]
|
63
|
+
# @return [Array<FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber, nil>, nil]
|
64
64
|
optional :phone_numbers,
|
65
65
|
-> {
|
66
66
|
FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber,
|
@@ -76,7 +76,7 @@ module FinchAPI
|
|
76
76
|
|
77
77
|
# @!attribute residence
|
78
78
|
#
|
79
|
-
# @return [FinchAPI::Location, nil]
|
79
|
+
# @return [FinchAPI::Models::Location, nil]
|
80
80
|
optional :residence, -> { FinchAPI::Location }, nil?: true
|
81
81
|
|
82
82
|
# @!attribute ssn
|
@@ -94,25 +94,25 @@ module FinchAPI
|
|
94
94
|
#
|
95
95
|
# @param dob [String, nil]
|
96
96
|
#
|
97
|
-
# @param emails [Array<FinchAPI::Sandbox::IndividualUpdateParams::Email>, nil]
|
97
|
+
# @param emails [Array<FinchAPI::Models::Sandbox::IndividualUpdateParams::Email>, nil]
|
98
98
|
#
|
99
99
|
# @param encrypted_ssn [String, nil] Social Security Number of the individual in **encrypted** format. This field is
|
100
100
|
#
|
101
|
-
# @param ethnicity [Symbol, FinchAPI::Sandbox::IndividualUpdateParams::Ethnicity, nil] The EEOC-defined ethnicity of the individual.
|
101
|
+
# @param ethnicity [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity, nil] The EEOC-defined ethnicity of the individual.
|
102
102
|
#
|
103
103
|
# @param first_name [String, nil] The legal first name of the individual.
|
104
104
|
#
|
105
|
-
# @param gender [Symbol, FinchAPI::Sandbox::IndividualUpdateParams::Gender, nil] The gender of the individual.
|
105
|
+
# @param gender [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender, nil] The gender of the individual.
|
106
106
|
#
|
107
107
|
# @param last_name [String, nil] The legal last name of the individual.
|
108
108
|
#
|
109
109
|
# @param middle_name [String, nil] The legal middle name of the individual.
|
110
110
|
#
|
111
|
-
# @param phone_numbers [Array<FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber, nil>, nil]
|
111
|
+
# @param phone_numbers [Array<FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber, nil>, nil]
|
112
112
|
#
|
113
113
|
# @param preferred_name [String, nil] The preferred name of the individual.
|
114
114
|
#
|
115
|
-
# @param residence [FinchAPI::Location, nil]
|
115
|
+
# @param residence [FinchAPI::Models::Location, nil]
|
116
116
|
#
|
117
117
|
# @param ssn [String, nil] Social Security Number of the individual. This field is only available with the
|
118
118
|
#
|
@@ -126,14 +126,14 @@ module FinchAPI
|
|
126
126
|
|
127
127
|
# @!attribute type
|
128
128
|
#
|
129
|
-
# @return [Symbol, FinchAPI::Sandbox::IndividualUpdateParams::Email::Type, nil]
|
129
|
+
# @return [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::Type, nil]
|
130
130
|
optional :type, enum: -> { FinchAPI::Sandbox::IndividualUpdateParams::Email::Type }, nil?: true
|
131
131
|
|
132
132
|
# @!method initialize(data: nil, type: nil)
|
133
133
|
# @param data [String]
|
134
|
-
# @param type [Symbol, FinchAPI::Sandbox::IndividualUpdateParams::Email::Type, nil]
|
134
|
+
# @param type [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::Type, nil]
|
135
135
|
|
136
|
-
# @see FinchAPI::Sandbox::IndividualUpdateParams::Email#type
|
136
|
+
# @see FinchAPI::Models::Sandbox::IndividualUpdateParams::Email#type
|
137
137
|
module Type
|
138
138
|
extend FinchAPI::Internal::Type::Enum
|
139
139
|
|
@@ -183,7 +183,7 @@ module FinchAPI
|
|
183
183
|
|
184
184
|
# @!attribute type
|
185
185
|
#
|
186
|
-
# @return [Symbol, FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber::Type, nil]
|
186
|
+
# @return [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::Type, nil]
|
187
187
|
optional :type,
|
188
188
|
enum: -> {
|
189
189
|
FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber::Type
|
@@ -192,9 +192,9 @@ module FinchAPI
|
|
192
192
|
|
193
193
|
# @!method initialize(data: nil, type: nil)
|
194
194
|
# @param data [String, nil]
|
195
|
-
# @param type [Symbol, FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber::Type, nil]
|
195
|
+
# @param type [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::Type, nil]
|
196
196
|
|
197
|
-
# @see FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber#type
|
197
|
+
# @see FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber#type
|
198
198
|
module Type
|
199
199
|
extend FinchAPI::Internal::Type::Enum
|
200
200
|
|
@@ -78,7 +78,7 @@ module FinchAPI
|
|
78
78
|
|
79
79
|
# @!attribute residence
|
80
80
|
#
|
81
|
-
# @return [FinchAPI::Location, nil]
|
81
|
+
# @return [FinchAPI::Models::Location, nil]
|
82
82
|
optional :residence, -> { FinchAPI::Location }, nil?: true
|
83
83
|
|
84
84
|
# @!attribute ssn
|
@@ -116,7 +116,7 @@ module FinchAPI
|
|
116
116
|
#
|
117
117
|
# @param preferred_name [String, nil] The preferred name of the individual.
|
118
118
|
#
|
119
|
-
# @param residence [FinchAPI::Location, nil]
|
119
|
+
# @param residence [FinchAPI::Models::Location, nil]
|
120
120
|
#
|
121
121
|
# @param ssn [String, nil] Social Security Number of the individual. This field is only available with the
|
122
122
|
|
@@ -11,11 +11,11 @@ module FinchAPI
|
|
11
11
|
# @!attribute type
|
12
12
|
# The type of job to start. Currently the only supported type is `data_sync_all`
|
13
13
|
#
|
14
|
-
# @return [Symbol, FinchAPI::Sandbox::JobCreateParams::Type]
|
14
|
+
# @return [Symbol, FinchAPI::Models::Sandbox::JobCreateParams::Type]
|
15
15
|
required :type, enum: -> { FinchAPI::Sandbox::JobCreateParams::Type }
|
16
16
|
|
17
17
|
# @!method initialize(type:, request_options: {})
|
18
|
-
# @param type [Symbol, FinchAPI::Sandbox::JobCreateParams::Type] The type of job to start. Currently the only supported type is `data_sync_all`
|
18
|
+
# @param type [Symbol, FinchAPI::Models::Sandbox::JobCreateParams::Type] The type of job to start. Currently the only supported type is `data_sync_all`
|
19
19
|
#
|
20
20
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
|
21
21
|
|
@@ -8,20 +8,20 @@ module FinchAPI
|
|
8
8
|
class SandboxJobConfiguration < FinchAPI::Internal::Type::BaseModel
|
9
9
|
# @!attribute completion_status
|
10
10
|
#
|
11
|
-
# @return [Symbol, FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus]
|
11
|
+
# @return [Symbol, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus]
|
12
12
|
required :completion_status,
|
13
13
|
enum: -> { FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus }
|
14
14
|
|
15
15
|
# @!attribute type
|
16
16
|
#
|
17
|
-
# @return [Symbol, FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::Type]
|
17
|
+
# @return [Symbol, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type]
|
18
18
|
required :type, enum: -> { FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::Type }
|
19
19
|
|
20
20
|
# @!method initialize(completion_status:, type:)
|
21
|
-
# @param completion_status [Symbol, FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus]
|
22
|
-
# @param type [Symbol, FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::Type]
|
21
|
+
# @param completion_status [Symbol, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus]
|
22
|
+
# @param type [Symbol, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type]
|
23
23
|
|
24
|
-
# @see FinchAPI::Sandbox::Jobs::SandboxJobConfiguration#completion_status
|
24
|
+
# @see FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration#completion_status
|
25
25
|
module CompletionStatus
|
26
26
|
extend FinchAPI::Internal::Type::Enum
|
27
27
|
|
@@ -34,7 +34,7 @@ module FinchAPI
|
|
34
34
|
# @return [Array<Symbol>]
|
35
35
|
end
|
36
36
|
|
37
|
-
# @see FinchAPI::Sandbox::Jobs::SandboxJobConfiguration#type
|
37
|
+
# @see FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration#type
|
38
38
|
module Type
|
39
39
|
extend FinchAPI::Internal::Type::Enum
|
40
40
|
|