finch-api 0.1.0.pre.alpha.19 → 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 +37 -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 -100
- 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 +49 -48
- data/lib/finch_api/models/sandbox/employment_update_params.rb +24 -23
- data/lib/finch_api/models/sandbox/employment_update_response.rb +6 -6
- 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 +8 -8
- 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 -141
- 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/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/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 -47
- 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 +84 -28
- data/sig/finch_api/models/sandbox/employment_update_params.rbs +41 -8
- data/sig/finch_api/models/sandbox/employment_update_response.rbs +33 -0
- 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/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
@@ -11,7 +11,7 @@ module FinchAPI
|
|
11
11
|
# @!attribute accounts
|
12
12
|
# An array of bank account objects associated with the payroll/HRIS system.
|
13
13
|
#
|
14
|
-
# @return [Array<FinchAPI::Sandbox::CompanyUpdateParams::Account>, nil]
|
14
|
+
# @return [Array<FinchAPI::Models::Sandbox::CompanyUpdateParams::Account>, nil]
|
15
15
|
required :accounts,
|
16
16
|
-> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::CompanyUpdateParams::Account] },
|
17
17
|
nil?: true
|
@@ -19,7 +19,7 @@ module FinchAPI
|
|
19
19
|
# @!attribute departments
|
20
20
|
# The array of company departments.
|
21
21
|
#
|
22
|
-
# @return [Array<FinchAPI::Sandbox::CompanyUpdateParams::Department, nil>, nil]
|
22
|
+
# @return [Array<FinchAPI::Models::Sandbox::CompanyUpdateParams::Department, nil>, nil]
|
23
23
|
required :departments,
|
24
24
|
-> {
|
25
25
|
FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::CompanyUpdateParams::Department,
|
@@ -36,7 +36,7 @@ module FinchAPI
|
|
36
36
|
# @!attribute entity
|
37
37
|
# The entity type object.
|
38
38
|
#
|
39
|
-
# @return [FinchAPI::Sandbox::CompanyUpdateParams::Entity, nil]
|
39
|
+
# @return [FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity, nil]
|
40
40
|
required :entity, -> { FinchAPI::Sandbox::CompanyUpdateParams::Entity }, nil?: true
|
41
41
|
|
42
42
|
# @!attribute legal_name
|
@@ -47,7 +47,7 @@ module FinchAPI
|
|
47
47
|
|
48
48
|
# @!attribute locations
|
49
49
|
#
|
50
|
-
# @return [Array<FinchAPI::Location, nil>, nil]
|
50
|
+
# @return [Array<FinchAPI::Models::Location, nil>, nil]
|
51
51
|
required :locations,
|
52
52
|
-> {
|
53
53
|
FinchAPI::Internal::Type::ArrayOf[FinchAPI::Location, nil?: true]
|
@@ -71,17 +71,17 @@ module FinchAPI
|
|
71
71
|
# Some parameter documentations has been truncated, see
|
72
72
|
# {FinchAPI::Models::Sandbox::CompanyUpdateParams} for more details.
|
73
73
|
#
|
74
|
-
# @param accounts [Array<FinchAPI::Sandbox::CompanyUpdateParams::Account>, nil] An array of bank account objects associated with the payroll/HRIS system.
|
74
|
+
# @param accounts [Array<FinchAPI::Models::Sandbox::CompanyUpdateParams::Account>, nil] An array of bank account objects associated with the payroll/HRIS system.
|
75
75
|
#
|
76
|
-
# @param departments [Array<FinchAPI::Sandbox::CompanyUpdateParams::Department, nil>, nil] The array of company departments.
|
76
|
+
# @param departments [Array<FinchAPI::Models::Sandbox::CompanyUpdateParams::Department, nil>, nil] The array of company departments.
|
77
77
|
#
|
78
78
|
# @param ein [String, nil] The employer identification number.
|
79
79
|
#
|
80
|
-
# @param entity [FinchAPI::Sandbox::CompanyUpdateParams::Entity, nil] The entity type object.
|
80
|
+
# @param entity [FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity, nil] The entity type object.
|
81
81
|
#
|
82
82
|
# @param legal_name [String, nil] The legal name of the company.
|
83
83
|
#
|
84
|
-
# @param locations [Array<FinchAPI::Location, nil>, nil]
|
84
|
+
# @param locations [Array<FinchAPI::Models::Location, nil>, nil]
|
85
85
|
#
|
86
86
|
# @param primary_email [String, nil] The email of the main administrator on the account.
|
87
87
|
#
|
@@ -105,7 +105,7 @@ module FinchAPI
|
|
105
105
|
# @!attribute account_type
|
106
106
|
# The type of bank account.
|
107
107
|
#
|
108
|
-
# @return [Symbol, FinchAPI::Sandbox::CompanyUpdateParams::Account::AccountType, nil]
|
108
|
+
# @return [Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType, nil]
|
109
109
|
optional :account_type,
|
110
110
|
enum: -> { FinchAPI::Sandbox::CompanyUpdateParams::Account::AccountType },
|
111
111
|
nil?: true
|
@@ -125,13 +125,13 @@ module FinchAPI
|
|
125
125
|
|
126
126
|
# @!method initialize(account_name: nil, account_number: nil, account_type: nil, institution_name: nil, routing_number: nil)
|
127
127
|
# Some parameter documentations has been truncated, see
|
128
|
-
# {FinchAPI::Sandbox::CompanyUpdateParams::Account} for more details.
|
128
|
+
# {FinchAPI::Models::Sandbox::CompanyUpdateParams::Account} for more details.
|
129
129
|
#
|
130
130
|
# @param account_name [String, nil] The name of the bank associated in the payroll/HRIS system.
|
131
131
|
#
|
132
132
|
# @param account_number [String, nil] 10-12 digit number to specify the bank account
|
133
133
|
#
|
134
|
-
# @param account_type [Symbol, FinchAPI::Sandbox::CompanyUpdateParams::Account::AccountType, nil] The type of bank account.
|
134
|
+
# @param account_type [Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType, nil] The type of bank account.
|
135
135
|
#
|
136
136
|
# @param institution_name [String, nil] Name of the banking institution.
|
137
137
|
#
|
@@ -139,7 +139,7 @@ module FinchAPI
|
|
139
139
|
|
140
140
|
# The type of bank account.
|
141
141
|
#
|
142
|
-
# @see FinchAPI::Sandbox::CompanyUpdateParams::Account#account_type
|
142
|
+
# @see FinchAPI::Models::Sandbox::CompanyUpdateParams::Account#account_type
|
143
143
|
module AccountType
|
144
144
|
extend FinchAPI::Internal::Type::Enum
|
145
145
|
|
@@ -161,15 +161,15 @@ module FinchAPI
|
|
161
161
|
# @!attribute parent
|
162
162
|
# The parent department, if present.
|
163
163
|
#
|
164
|
-
# @return [FinchAPI::Sandbox::CompanyUpdateParams::Department::Parent, nil]
|
164
|
+
# @return [FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::Parent, nil]
|
165
165
|
optional :parent, -> { FinchAPI::Sandbox::CompanyUpdateParams::Department::Parent }, nil?: true
|
166
166
|
|
167
167
|
# @!method initialize(name: nil, parent: nil)
|
168
168
|
# @param name [String, nil] The department name.
|
169
169
|
#
|
170
|
-
# @param parent [FinchAPI::Sandbox::CompanyUpdateParams::Department::Parent, nil] The parent department, if present.
|
170
|
+
# @param parent [FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::Parent, nil] The parent department, if present.
|
171
171
|
|
172
|
-
# @see FinchAPI::Sandbox::CompanyUpdateParams::Department#parent
|
172
|
+
# @see FinchAPI::Models::Sandbox::CompanyUpdateParams::Department#parent
|
173
173
|
class Parent < FinchAPI::Internal::Type::BaseModel
|
174
174
|
# @!attribute name
|
175
175
|
# The parent department's name.
|
@@ -188,25 +188,25 @@ module FinchAPI
|
|
188
188
|
# @!attribute subtype
|
189
189
|
# The tax payer subtype of the company.
|
190
190
|
#
|
191
|
-
# @return [Symbol, FinchAPI::Sandbox::CompanyUpdateParams::Entity::Subtype, nil]
|
191
|
+
# @return [Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype, nil]
|
192
192
|
optional :subtype, enum: -> { FinchAPI::Sandbox::CompanyUpdateParams::Entity::Subtype }, nil?: true
|
193
193
|
|
194
194
|
# @!attribute type
|
195
195
|
# The tax payer type of the company.
|
196
196
|
#
|
197
|
-
# @return [Symbol, FinchAPI::Sandbox::CompanyUpdateParams::Entity::Type, nil]
|
197
|
+
# @return [Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type, nil]
|
198
198
|
optional :type, enum: -> { FinchAPI::Sandbox::CompanyUpdateParams::Entity::Type }, nil?: true
|
199
199
|
|
200
200
|
# @!method initialize(subtype: nil, type: nil)
|
201
201
|
# The entity type object.
|
202
202
|
#
|
203
|
-
# @param subtype [Symbol, FinchAPI::Sandbox::CompanyUpdateParams::Entity::Subtype, nil] The tax payer subtype of the company.
|
203
|
+
# @param subtype [Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype, nil] The tax payer subtype of the company.
|
204
204
|
#
|
205
|
-
# @param type [Symbol, FinchAPI::Sandbox::CompanyUpdateParams::Entity::Type, nil] The tax payer type of the company.
|
205
|
+
# @param type [Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type, nil] The tax payer type of the company.
|
206
206
|
|
207
207
|
# The tax payer subtype of the company.
|
208
208
|
#
|
209
|
-
# @see FinchAPI::Sandbox::CompanyUpdateParams::Entity#subtype
|
209
|
+
# @see FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity#subtype
|
210
210
|
module Subtype
|
211
211
|
extend FinchAPI::Internal::Type::Enum
|
212
212
|
|
@@ -220,7 +220,7 @@ module FinchAPI
|
|
220
220
|
|
221
221
|
# The tax payer type of the company.
|
222
222
|
#
|
223
|
-
# @see FinchAPI::Sandbox::CompanyUpdateParams::Entity#type
|
223
|
+
# @see FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity#type
|
224
224
|
module Type
|
225
225
|
extend FinchAPI::Internal::Type::Enum
|
226
226
|
|
@@ -41,7 +41,7 @@ module FinchAPI
|
|
41
41
|
|
42
42
|
# @!attribute locations
|
43
43
|
#
|
44
|
-
# @return [Array<FinchAPI::Location, nil>, nil]
|
44
|
+
# @return [Array<FinchAPI::Models::Location, nil>, nil]
|
45
45
|
required :locations,
|
46
46
|
-> {
|
47
47
|
FinchAPI::Internal::Type::ArrayOf[FinchAPI::Location, nil?: true]
|
@@ -75,7 +75,7 @@ module FinchAPI
|
|
75
75
|
#
|
76
76
|
# @param legal_name [String, nil] The legal name of the company.
|
77
77
|
#
|
78
|
-
# @param locations [Array<FinchAPI::Location, nil>, nil]
|
78
|
+
# @param locations [Array<FinchAPI::Models::Location, nil>, nil]
|
79
79
|
#
|
80
80
|
# @param primary_email [String, nil] The email of the main administrator on the account.
|
81
81
|
#
|
@@ -16,7 +16,7 @@ module FinchAPI
|
|
16
16
|
|
17
17
|
# @!attribute authentication_type
|
18
18
|
#
|
19
|
-
# @return [Symbol, FinchAPI::Sandbox::ConnectionCreateParams::AuthenticationType, nil]
|
19
|
+
# @return [Symbol, FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType, nil]
|
20
20
|
optional :authentication_type,
|
21
21
|
enum: -> {
|
22
22
|
FinchAPI::Sandbox::ConnectionCreateParams::AuthenticationType
|
@@ -41,7 +41,7 @@ module FinchAPI
|
|
41
41
|
#
|
42
42
|
# @param provider_id [String] The provider associated with the connection
|
43
43
|
#
|
44
|
-
# @param authentication_type [Symbol, FinchAPI::Sandbox::ConnectionCreateParams::AuthenticationType]
|
44
|
+
# @param authentication_type [Symbol, FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType]
|
45
45
|
#
|
46
46
|
# @param employee_size [Integer] Optional: the size of the employer to be created with this connection. Defaults
|
47
47
|
#
|
@@ -22,7 +22,7 @@ module FinchAPI
|
|
22
22
|
|
23
23
|
# @!attribute authentication_type
|
24
24
|
#
|
25
|
-
# @return [Symbol, FinchAPI::Sandbox::Connections::AccountCreateParams::AuthenticationType, nil]
|
25
|
+
# @return [Symbol, FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType, nil]
|
26
26
|
optional :authentication_type,
|
27
27
|
enum: -> { FinchAPI::Sandbox::Connections::AccountCreateParams::AuthenticationType }
|
28
28
|
|
@@ -41,7 +41,7 @@ module FinchAPI
|
|
41
41
|
#
|
42
42
|
# @param provider_id [String] The provider associated with the `access_token`
|
43
43
|
#
|
44
|
-
# @param authentication_type [Symbol, FinchAPI::Sandbox::Connections::AccountCreateParams::AuthenticationType]
|
44
|
+
# @param authentication_type [Symbol, FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType]
|
45
45
|
#
|
46
46
|
# @param products [Array<String>] Optional, defaults to Organization products (`company`, `directory`, `employment
|
47
47
|
#
|
@@ -11,11 +11,11 @@ module FinchAPI
|
|
11
11
|
|
12
12
|
# @!attribute connection_status
|
13
13
|
#
|
14
|
-
# @return [Symbol, FinchAPI::ConnectionStatusType, nil]
|
14
|
+
# @return [Symbol, FinchAPI::Models::ConnectionStatusType, nil]
|
15
15
|
optional :connection_status, enum: -> { FinchAPI::ConnectionStatusType }
|
16
16
|
|
17
17
|
# @!method initialize(connection_status: nil, request_options: {})
|
18
|
-
# @param connection_status [Symbol, FinchAPI::ConnectionStatusType]
|
18
|
+
# @param connection_status [Symbol, FinchAPI::Models::ConnectionStatusType]
|
19
19
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
|
20
20
|
end
|
21
21
|
end
|
@@ -12,7 +12,7 @@ module FinchAPI
|
|
12
12
|
# Array of individuals to create. Takes all combined fields from `/individual` and
|
13
13
|
# `/employment` endpoints. All fields are optional.
|
14
14
|
#
|
15
|
-
# @return [Array<FinchAPI::Sandbox::DirectoryCreateParams::Body>, nil]
|
15
|
+
# @return [Array<FinchAPI::Models::Sandbox::DirectoryCreateParams::Body>, nil]
|
16
16
|
optional :body,
|
17
17
|
-> {
|
18
18
|
FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::DirectoryCreateParams::Body]
|
@@ -22,7 +22,7 @@ module FinchAPI
|
|
22
22
|
# Some parameter documentations has been truncated, see
|
23
23
|
# {FinchAPI::Models::Sandbox::DirectoryCreateParams} for more details.
|
24
24
|
#
|
25
|
-
# @param body [Array<FinchAPI::Sandbox::DirectoryCreateParams::Body>] Array of individuals to create. Takes all combined fields from `/individual` and
|
25
|
+
# @param body [Array<FinchAPI::Models::Sandbox::DirectoryCreateParams::Body>] Array of individuals to create. Takes all combined fields from `/individual` and
|
26
26
|
#
|
27
27
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
|
28
28
|
|
@@ -38,7 +38,7 @@ module FinchAPI
|
|
38
38
|
# employer in the system. Custom fields are not currently supported for assisted
|
39
39
|
# connections.
|
40
40
|
#
|
41
|
-
# @return [Array<FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField>, nil]
|
41
|
+
# @return [Array<FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField>, nil]
|
42
42
|
optional :custom_fields,
|
43
43
|
-> {
|
44
44
|
FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField]
|
@@ -48,7 +48,7 @@ module FinchAPI
|
|
48
48
|
# @!attribute department
|
49
49
|
# The department object.
|
50
50
|
#
|
51
|
-
# @return [FinchAPI::Sandbox::DirectoryCreateParams::Body::Department, nil]
|
51
|
+
# @return [FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Department, nil]
|
52
52
|
optional :department, -> { FinchAPI::Sandbox::DirectoryCreateParams::Body::Department }, nil?: true
|
53
53
|
|
54
54
|
# @!attribute dob
|
@@ -58,7 +58,7 @@ module FinchAPI
|
|
58
58
|
|
59
59
|
# @!attribute emails
|
60
60
|
#
|
61
|
-
# @return [Array<FinchAPI::Sandbox::DirectoryCreateParams::Body::Email>, nil]
|
61
|
+
# @return [Array<FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email>, nil]
|
62
62
|
optional :emails,
|
63
63
|
-> {
|
64
64
|
FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::DirectoryCreateParams::Body::Email]
|
@@ -68,14 +68,14 @@ module FinchAPI
|
|
68
68
|
# @!attribute employment
|
69
69
|
# The employment object.
|
70
70
|
#
|
71
|
-
# @return [FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment, nil]
|
71
|
+
# @return [FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment, nil]
|
72
72
|
optional :employment, -> { FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment }, nil?: true
|
73
73
|
|
74
74
|
# @!attribute employment_status
|
75
75
|
# The detailed employment status of the individual. Available options: `active`,
|
76
76
|
# `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
|
77
77
|
#
|
78
|
-
# @return [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::EmploymentStatus, nil]
|
78
|
+
# @return [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus, nil]
|
79
79
|
optional :employment_status,
|
80
80
|
enum: -> { FinchAPI::Sandbox::DirectoryCreateParams::Body::EmploymentStatus },
|
81
81
|
nil?: true
|
@@ -96,7 +96,7 @@ module FinchAPI
|
|
96
96
|
# @!attribute ethnicity
|
97
97
|
# The EEOC-defined ethnicity of the individual.
|
98
98
|
#
|
99
|
-
# @return [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Ethnicity, nil]
|
99
|
+
# @return [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity, nil]
|
100
100
|
optional :ethnicity,
|
101
101
|
enum: -> {
|
102
102
|
FinchAPI::Sandbox::DirectoryCreateParams::Body::Ethnicity
|
@@ -112,7 +112,7 @@ module FinchAPI
|
|
112
112
|
# @!attribute gender
|
113
113
|
# The gender of the individual.
|
114
114
|
#
|
115
|
-
# @return [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Gender, nil]
|
115
|
+
# @return [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender, nil]
|
116
116
|
optional :gender, enum: -> { FinchAPI::Sandbox::DirectoryCreateParams::Body::Gender }, nil?: true
|
117
117
|
|
118
118
|
# @!attribute income
|
@@ -120,13 +120,13 @@ module FinchAPI
|
|
120
120
|
# annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc,
|
121
121
|
# depending on what information the provider returns.
|
122
122
|
#
|
123
|
-
# @return [FinchAPI::Income, nil]
|
123
|
+
# @return [FinchAPI::Models::Income, nil]
|
124
124
|
optional :income, -> { FinchAPI::Income }, nil?: true
|
125
125
|
|
126
126
|
# @!attribute income_history
|
127
127
|
# The array of income history.
|
128
128
|
#
|
129
|
-
# @return [Array<FinchAPI::Income, nil>, nil]
|
129
|
+
# @return [Array<FinchAPI::Models::Income, nil>, nil]
|
130
130
|
optional :income_history,
|
131
131
|
-> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Income, nil?: true] },
|
132
132
|
nil?: true
|
@@ -150,13 +150,13 @@ module FinchAPI
|
|
150
150
|
|
151
151
|
# @!attribute location
|
152
152
|
#
|
153
|
-
# @return [FinchAPI::Location, nil]
|
153
|
+
# @return [FinchAPI::Models::Location, nil]
|
154
154
|
optional :location, -> { FinchAPI::Location }, nil?: true
|
155
155
|
|
156
156
|
# @!attribute manager
|
157
157
|
# The manager object representing the manager of the individual within the org.
|
158
158
|
#
|
159
|
-
# @return [FinchAPI::Sandbox::DirectoryCreateParams::Body::Manager, nil]
|
159
|
+
# @return [FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Manager, nil]
|
160
160
|
optional :manager, -> { FinchAPI::Sandbox::DirectoryCreateParams::Body::Manager }, nil?: true
|
161
161
|
|
162
162
|
# @!attribute middle_name
|
@@ -167,7 +167,7 @@ module FinchAPI
|
|
167
167
|
|
168
168
|
# @!attribute phone_numbers
|
169
169
|
#
|
170
|
-
# @return [Array<FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber, nil>, nil]
|
170
|
+
# @return [Array<FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber, nil>, nil]
|
171
171
|
optional :phone_numbers,
|
172
172
|
-> {
|
173
173
|
FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber,
|
@@ -183,7 +183,7 @@ module FinchAPI
|
|
183
183
|
|
184
184
|
# @!attribute residence
|
185
185
|
#
|
186
|
-
# @return [FinchAPI::Location, nil]
|
186
|
+
# @return [FinchAPI::Models::Location, nil]
|
187
187
|
optional :residence, -> { FinchAPI::Location }, nil?: true
|
188
188
|
|
189
189
|
# @!attribute source_id
|
@@ -214,35 +214,35 @@ module FinchAPI
|
|
214
214
|
|
215
215
|
# @!method initialize(class_code: nil, custom_fields: nil, department: nil, dob: nil, emails: nil, employment: nil, employment_status: nil, encrypted_ssn: nil, end_date: nil, ethnicity: nil, first_name: nil, gender: nil, income: nil, income_history: nil, is_active: nil, last_name: nil, latest_rehire_date: nil, location: nil, manager: nil, middle_name: nil, phone_numbers: nil, preferred_name: nil, residence: nil, source_id: nil, ssn: nil, start_date: nil, title: nil)
|
216
216
|
# Some parameter documentations has been truncated, see
|
217
|
-
# {FinchAPI::Sandbox::DirectoryCreateParams::Body} for more details.
|
217
|
+
# {FinchAPI::Models::Sandbox::DirectoryCreateParams::Body} for more details.
|
218
218
|
#
|
219
219
|
# @param class_code [String, nil] Worker's compensation classification code for this employee
|
220
220
|
#
|
221
|
-
# @param custom_fields [Array<FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField>, nil] Custom fields for the individual. These are fields which are defined by the empl
|
221
|
+
# @param custom_fields [Array<FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField>, nil] Custom fields for the individual. These are fields which are defined by the empl
|
222
222
|
#
|
223
|
-
# @param department [FinchAPI::Sandbox::DirectoryCreateParams::Body::Department, nil] The department object.
|
223
|
+
# @param department [FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Department, nil] The department object.
|
224
224
|
#
|
225
225
|
# @param dob [String, nil]
|
226
226
|
#
|
227
|
-
# @param emails [Array<FinchAPI::Sandbox::DirectoryCreateParams::Body::Email>, nil]
|
227
|
+
# @param emails [Array<FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email>, nil]
|
228
228
|
#
|
229
|
-
# @param employment [FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment, nil] The employment object.
|
229
|
+
# @param employment [FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment, nil] The employment object.
|
230
230
|
#
|
231
|
-
# @param employment_status [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::EmploymentStatus, nil] The detailed employment status of the individual. Available options: `active`, `
|
231
|
+
# @param employment_status [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus, nil] The detailed employment status of the individual. Available options: `active`, `
|
232
232
|
#
|
233
233
|
# @param encrypted_ssn [String, nil] Social Security Number of the individual in **encrypted** format. This field is
|
234
234
|
#
|
235
235
|
# @param end_date [String, nil]
|
236
236
|
#
|
237
|
-
# @param ethnicity [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Ethnicity, nil] The EEOC-defined ethnicity of the individual.
|
237
|
+
# @param ethnicity [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity, nil] The EEOC-defined ethnicity of the individual.
|
238
238
|
#
|
239
239
|
# @param first_name [String, nil] The legal first name of the individual.
|
240
240
|
#
|
241
|
-
# @param gender [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Gender, nil] The gender of the individual.
|
241
|
+
# @param gender [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender, nil] The gender of the individual.
|
242
242
|
#
|
243
|
-
# @param income [FinchAPI::Income, nil] The employee's income as reported by the provider. This may not always be annual
|
243
|
+
# @param income [FinchAPI::Models::Income, nil] The employee's income as reported by the provider. This may not always be annual
|
244
244
|
#
|
245
|
-
# @param income_history [Array<FinchAPI::Income, nil>, nil] The array of income history.
|
245
|
+
# @param income_history [Array<FinchAPI::Models::Income, nil>, nil] The array of income history.
|
246
246
|
#
|
247
247
|
# @param is_active [Boolean, nil] `true` if the individual an an active employee or contractor at the company.
|
248
248
|
#
|
@@ -250,17 +250,17 @@ module FinchAPI
|
|
250
250
|
#
|
251
251
|
# @param latest_rehire_date [String, nil]
|
252
252
|
#
|
253
|
-
# @param location [FinchAPI::Location, nil]
|
253
|
+
# @param location [FinchAPI::Models::Location, nil]
|
254
254
|
#
|
255
|
-
# @param manager [FinchAPI::Sandbox::DirectoryCreateParams::Body::Manager, nil] The manager object representing the manager of the individual within the org.
|
255
|
+
# @param manager [FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Manager, nil] The manager object representing the manager of the individual within the org.
|
256
256
|
#
|
257
257
|
# @param middle_name [String, nil] The legal middle name of the individual.
|
258
258
|
#
|
259
|
-
# @param phone_numbers [Array<FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber, nil>, nil]
|
259
|
+
# @param phone_numbers [Array<FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber, nil>, nil]
|
260
260
|
#
|
261
261
|
# @param preferred_name [String, nil] The preferred name of the individual.
|
262
262
|
#
|
263
|
-
# @param residence [FinchAPI::Location, nil]
|
263
|
+
# @param residence [FinchAPI::Models::Location, nil]
|
264
264
|
#
|
265
265
|
# @param source_id [String, nil] The source system's unique employment identifier for this individual
|
266
266
|
#
|
@@ -286,7 +286,7 @@ module FinchAPI
|
|
286
286
|
# @param value [Object]
|
287
287
|
end
|
288
288
|
|
289
|
-
# @see FinchAPI::Sandbox::DirectoryCreateParams::Body#department
|
289
|
+
# @see FinchAPI::Models::Sandbox::DirectoryCreateParams::Body#department
|
290
290
|
class Department < FinchAPI::Internal::Type::BaseModel
|
291
291
|
# @!attribute name
|
292
292
|
# The name of the department associated with the individual.
|
@@ -308,7 +308,7 @@ module FinchAPI
|
|
308
308
|
|
309
309
|
# @!attribute type
|
310
310
|
#
|
311
|
-
# @return [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Email::Type, nil]
|
311
|
+
# @return [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type, nil]
|
312
312
|
optional :type,
|
313
313
|
enum: -> {
|
314
314
|
FinchAPI::Sandbox::DirectoryCreateParams::Body::Email::Type
|
@@ -317,9 +317,9 @@ module FinchAPI
|
|
317
317
|
|
318
318
|
# @!method initialize(data: nil, type: nil)
|
319
319
|
# @param data [String]
|
320
|
-
# @param type [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Email::Type, nil]
|
320
|
+
# @param type [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type, nil]
|
321
321
|
|
322
|
-
# @see FinchAPI::Sandbox::DirectoryCreateParams::Body::Email#type
|
322
|
+
# @see FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email#type
|
323
323
|
module Type
|
324
324
|
extend FinchAPI::Internal::Type::Enum
|
325
325
|
|
@@ -331,13 +331,13 @@ module FinchAPI
|
|
331
331
|
end
|
332
332
|
end
|
333
333
|
|
334
|
-
# @see FinchAPI::Sandbox::DirectoryCreateParams::Body#employment
|
334
|
+
# @see FinchAPI::Models::Sandbox::DirectoryCreateParams::Body#employment
|
335
335
|
class Employment < FinchAPI::Internal::Type::BaseModel
|
336
336
|
# @!attribute subtype
|
337
337
|
# The secondary employment type of the individual. Options: `full_time`,
|
338
338
|
# `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
|
339
339
|
#
|
340
|
-
# @return [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Subtype, nil]
|
340
|
+
# @return [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype, nil]
|
341
341
|
optional :subtype,
|
342
342
|
enum: -> { FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Subtype },
|
343
343
|
nil?: true
|
@@ -345,7 +345,7 @@ module FinchAPI
|
|
345
345
|
# @!attribute type
|
346
346
|
# The main employment type of the individual.
|
347
347
|
#
|
348
|
-
# @return [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Type, nil]
|
348
|
+
# @return [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type, nil]
|
349
349
|
optional :type,
|
350
350
|
enum: -> {
|
351
351
|
FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Type
|
@@ -354,18 +354,19 @@ module FinchAPI
|
|
354
354
|
|
355
355
|
# @!method initialize(subtype: nil, type: nil)
|
356
356
|
# Some parameter documentations has been truncated, see
|
357
|
-
# {FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment} for more
|
357
|
+
# {FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment} for more
|
358
|
+
# details.
|
358
359
|
#
|
359
360
|
# The employment object.
|
360
361
|
#
|
361
|
-
# @param subtype [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Subtype, nil] The secondary employment type of the individual. Options: `full_time`, `part_tim
|
362
|
+
# @param subtype [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype, nil] The secondary employment type of the individual. Options: `full_time`, `part_tim
|
362
363
|
#
|
363
|
-
# @param type [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Type, nil] The main employment type of the individual.
|
364
|
+
# @param type [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type, nil] The main employment type of the individual.
|
364
365
|
|
365
366
|
# The secondary employment type of the individual. Options: `full_time`,
|
366
367
|
# `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
|
367
368
|
#
|
368
|
-
# @see FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment#subtype
|
369
|
+
# @see FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment#subtype
|
369
370
|
module Subtype
|
370
371
|
extend FinchAPI::Internal::Type::Enum
|
371
372
|
|
@@ -382,7 +383,7 @@ module FinchAPI
|
|
382
383
|
|
383
384
|
# The main employment type of the individual.
|
384
385
|
#
|
385
|
-
# @see FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment#type
|
386
|
+
# @see FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment#type
|
386
387
|
module Type
|
387
388
|
extend FinchAPI::Internal::Type::Enum
|
388
389
|
|
@@ -397,7 +398,7 @@ module FinchAPI
|
|
397
398
|
# The detailed employment status of the individual. Available options: `active`,
|
398
399
|
# `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
|
399
400
|
#
|
400
|
-
# @see FinchAPI::Sandbox::DirectoryCreateParams::Body#employment_status
|
401
|
+
# @see FinchAPI::Models::Sandbox::DirectoryCreateParams::Body#employment_status
|
401
402
|
module EmploymentStatus
|
402
403
|
extend FinchAPI::Internal::Type::Enum
|
403
404
|
|
@@ -415,7 +416,7 @@ module FinchAPI
|
|
415
416
|
|
416
417
|
# The EEOC-defined ethnicity of the individual.
|
417
418
|
#
|
418
|
-
# @see FinchAPI::Sandbox::DirectoryCreateParams::Body#ethnicity
|
419
|
+
# @see FinchAPI::Models::Sandbox::DirectoryCreateParams::Body#ethnicity
|
419
420
|
module Ethnicity
|
420
421
|
extend FinchAPI::Internal::Type::Enum
|
421
422
|
|
@@ -434,7 +435,7 @@ module FinchAPI
|
|
434
435
|
|
435
436
|
# The gender of the individual.
|
436
437
|
#
|
437
|
-
# @see FinchAPI::Sandbox::DirectoryCreateParams::Body#gender
|
438
|
+
# @see FinchAPI::Models::Sandbox::DirectoryCreateParams::Body#gender
|
438
439
|
module Gender
|
439
440
|
extend FinchAPI::Internal::Type::Enum
|
440
441
|
|
@@ -447,7 +448,7 @@ module FinchAPI
|
|
447
448
|
# @return [Array<Symbol>]
|
448
449
|
end
|
449
450
|
|
450
|
-
# @see FinchAPI::Sandbox::DirectoryCreateParams::Body#manager
|
451
|
+
# @see FinchAPI::Models::Sandbox::DirectoryCreateParams::Body#manager
|
451
452
|
class Manager < FinchAPI::Internal::Type::BaseModel
|
452
453
|
# @!attribute id
|
453
454
|
# A stable Finch `id` (UUID v4) for an individual in the company.
|
@@ -469,7 +470,7 @@ module FinchAPI
|
|
469
470
|
|
470
471
|
# @!attribute type
|
471
472
|
#
|
472
|
-
# @return [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type, nil]
|
473
|
+
# @return [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type, nil]
|
473
474
|
optional :type,
|
474
475
|
enum: -> {
|
475
476
|
FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type
|
@@ -478,9 +479,9 @@ module FinchAPI
|
|
478
479
|
|
479
480
|
# @!method initialize(data: nil, type: nil)
|
480
481
|
# @param data [String, nil]
|
481
|
-
# @param type [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type, nil]
|
482
|
+
# @param type [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type, nil]
|
482
483
|
|
483
|
-
# @see FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber#type
|
484
|
+
# @see FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber#type
|
484
485
|
module Type
|
485
486
|
extend FinchAPI::Internal::Type::Enum
|
486
487
|
|