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
@@ -49,11 +49,8 @@ module FinchAPI
|
|
49
49
|
attr_writer :gross_pay
|
50
50
|
|
51
51
|
# A stable Finch `id` (UUID v4) for an individual in the company
|
52
|
-
sig { returns(
|
53
|
-
|
54
|
-
|
55
|
-
sig { params(individual_id: String).void }
|
56
|
-
attr_writer :individual_id
|
52
|
+
sig { returns(String) }
|
53
|
+
attr_accessor :individual_id
|
57
54
|
|
58
55
|
sig { returns(T.nilable(FinchAPI::Money)) }
|
59
56
|
attr_reader :net_pay
|
@@ -126,22 +123,22 @@ module FinchAPI
|
|
126
123
|
end
|
127
124
|
def self.new(
|
128
125
|
# The array of earnings objects associated with this pay statement
|
129
|
-
earnings
|
126
|
+
earnings:,
|
130
127
|
# The array of deductions objects associated with this pay statement.
|
131
|
-
employee_deductions
|
132
|
-
employer_contributions
|
133
|
-
gross_pay
|
128
|
+
employee_deductions:,
|
129
|
+
employer_contributions:,
|
130
|
+
gross_pay:,
|
134
131
|
# A stable Finch `id` (UUID v4) for an individual in the company
|
135
|
-
individual_id
|
136
|
-
net_pay
|
132
|
+
individual_id:,
|
133
|
+
net_pay:,
|
137
134
|
# The payment method.
|
138
|
-
payment_method
|
135
|
+
payment_method:,
|
139
136
|
# The array of taxes objects associated with this pay statement.
|
140
|
-
taxes
|
137
|
+
taxes:,
|
141
138
|
# The number of hours worked for this pay period
|
142
|
-
total_hours
|
139
|
+
total_hours:,
|
143
140
|
# The type of the payment associated with the pay statement.
|
144
|
-
type:
|
141
|
+
type:
|
145
142
|
)
|
146
143
|
end
|
147
144
|
|
@@ -198,23 +195,6 @@ module FinchAPI
|
|
198
195
|
sig { returns(T.nilable(Integer)) }
|
199
196
|
attr_accessor :amount
|
200
197
|
|
201
|
-
sig do
|
202
|
-
returns(
|
203
|
-
T.nilable(FinchAPI::HRIS::PayStatement::Earning::Attributes)
|
204
|
-
)
|
205
|
-
end
|
206
|
-
attr_reader :attributes
|
207
|
-
|
208
|
-
sig do
|
209
|
-
params(
|
210
|
-
attributes:
|
211
|
-
T.nilable(
|
212
|
-
FinchAPI::HRIS::PayStatement::Earning::Attributes::OrHash
|
213
|
-
)
|
214
|
-
).void
|
215
|
-
end
|
216
|
-
attr_writer :attributes
|
217
|
-
|
218
198
|
# The earnings currency code.
|
219
199
|
sig { returns(T.nilable(String)) }
|
220
200
|
attr_accessor :currency
|
@@ -238,33 +218,52 @@ module FinchAPI
|
|
238
218
|
end
|
239
219
|
attr_accessor :type
|
240
220
|
|
221
|
+
sig do
|
222
|
+
returns(
|
223
|
+
T.nilable(FinchAPI::HRIS::PayStatement::Earning::Attributes)
|
224
|
+
)
|
225
|
+
end
|
226
|
+
attr_reader :attributes
|
227
|
+
|
241
228
|
sig do
|
242
229
|
params(
|
243
|
-
amount: T.nilable(Integer),
|
244
230
|
attributes:
|
245
231
|
T.nilable(
|
246
232
|
FinchAPI::HRIS::PayStatement::Earning::Attributes::OrHash
|
247
|
-
)
|
233
|
+
)
|
234
|
+
).void
|
235
|
+
end
|
236
|
+
attr_writer :attributes
|
237
|
+
|
238
|
+
sig do
|
239
|
+
params(
|
240
|
+
amount: T.nilable(Integer),
|
248
241
|
currency: T.nilable(String),
|
249
242
|
hours: T.nilable(Float),
|
250
243
|
name: T.nilable(String),
|
251
244
|
type:
|
252
|
-
T.nilable(
|
245
|
+
T.nilable(
|
246
|
+
FinchAPI::HRIS::PayStatement::Earning::Type::OrSymbol
|
247
|
+
),
|
248
|
+
attributes:
|
249
|
+
T.nilable(
|
250
|
+
FinchAPI::HRIS::PayStatement::Earning::Attributes::OrHash
|
251
|
+
)
|
253
252
|
).returns(T.attached_class)
|
254
253
|
end
|
255
254
|
def self.new(
|
256
255
|
# The earnings amount in cents.
|
257
|
-
amount
|
258
|
-
attributes: nil,
|
256
|
+
amount:,
|
259
257
|
# The earnings currency code.
|
260
|
-
currency
|
258
|
+
currency:,
|
261
259
|
# The number of hours associated with this earning. (For salaried employees, this
|
262
260
|
# could be hours per pay period, `0` or `null`, depending on the provider).
|
263
|
-
hours
|
261
|
+
hours:,
|
264
262
|
# The exact name of the deduction from the pay statement.
|
265
|
-
name
|
263
|
+
name:,
|
266
264
|
# The type of earning.
|
267
|
-
type
|
265
|
+
type:,
|
266
|
+
attributes: nil
|
268
267
|
)
|
269
268
|
end
|
270
269
|
|
@@ -272,110 +271,21 @@ module FinchAPI
|
|
272
271
|
override.returns(
|
273
272
|
{
|
274
273
|
amount: T.nilable(Integer),
|
275
|
-
attributes:
|
276
|
-
T.nilable(FinchAPI::HRIS::PayStatement::Earning::Attributes),
|
277
274
|
currency: T.nilable(String),
|
278
275
|
hours: T.nilable(Float),
|
279
276
|
name: T.nilable(String),
|
280
277
|
type:
|
281
278
|
T.nilable(
|
282
279
|
FinchAPI::HRIS::PayStatement::Earning::Type::TaggedSymbol
|
283
|
-
)
|
280
|
+
),
|
281
|
+
attributes:
|
282
|
+
T.nilable(FinchAPI::HRIS::PayStatement::Earning::Attributes)
|
284
283
|
}
|
285
284
|
)
|
286
285
|
end
|
287
286
|
def to_hash
|
288
287
|
end
|
289
288
|
|
290
|
-
class Attributes < FinchAPI::Internal::Type::BaseModel
|
291
|
-
OrHash =
|
292
|
-
T.type_alias do
|
293
|
-
T.any(
|
294
|
-
FinchAPI::HRIS::PayStatement::Earning::Attributes,
|
295
|
-
FinchAPI::Internal::AnyHash
|
296
|
-
)
|
297
|
-
end
|
298
|
-
|
299
|
-
sig do
|
300
|
-
returns(
|
301
|
-
T.nilable(
|
302
|
-
FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata
|
303
|
-
)
|
304
|
-
)
|
305
|
-
end
|
306
|
-
attr_reader :metadata
|
307
|
-
|
308
|
-
sig do
|
309
|
-
params(
|
310
|
-
metadata:
|
311
|
-
FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata::OrHash
|
312
|
-
).void
|
313
|
-
end
|
314
|
-
attr_writer :metadata
|
315
|
-
|
316
|
-
sig do
|
317
|
-
params(
|
318
|
-
metadata:
|
319
|
-
FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata::OrHash
|
320
|
-
).returns(T.attached_class)
|
321
|
-
end
|
322
|
-
def self.new(metadata: nil)
|
323
|
-
end
|
324
|
-
|
325
|
-
sig do
|
326
|
-
override.returns(
|
327
|
-
{
|
328
|
-
metadata:
|
329
|
-
FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata
|
330
|
-
}
|
331
|
-
)
|
332
|
-
end
|
333
|
-
def to_hash
|
334
|
-
end
|
335
|
-
|
336
|
-
class Metadata < FinchAPI::Internal::Type::BaseModel
|
337
|
-
OrHash =
|
338
|
-
T.type_alias do
|
339
|
-
T.any(
|
340
|
-
FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata,
|
341
|
-
FinchAPI::Internal::AnyHash
|
342
|
-
)
|
343
|
-
end
|
344
|
-
|
345
|
-
# The metadata to be attached to the entity by existing rules. It is a key-value
|
346
|
-
# pairs where the values can be of any type (string, number, boolean, object,
|
347
|
-
# array, etc.).
|
348
|
-
sig { returns(T.nilable(T::Hash[Symbol, T.nilable(T.anything)])) }
|
349
|
-
attr_reader :metadata
|
350
|
-
|
351
|
-
sig do
|
352
|
-
params(metadata: T::Hash[Symbol, T.nilable(T.anything)]).void
|
353
|
-
end
|
354
|
-
attr_writer :metadata
|
355
|
-
|
356
|
-
sig do
|
357
|
-
params(
|
358
|
-
metadata: T::Hash[Symbol, T.nilable(T.anything)]
|
359
|
-
).returns(T.attached_class)
|
360
|
-
end
|
361
|
-
def self.new(
|
362
|
-
# The metadata to be attached to the entity by existing rules. It is a key-value
|
363
|
-
# pairs where the values can be of any type (string, number, boolean, object,
|
364
|
-
# array, etc.).
|
365
|
-
metadata: nil
|
366
|
-
)
|
367
|
-
end
|
368
|
-
|
369
|
-
sig do
|
370
|
-
override.returns(
|
371
|
-
{ metadata: T::Hash[Symbol, T.nilable(T.anything)] }
|
372
|
-
)
|
373
|
-
end
|
374
|
-
def to_hash
|
375
|
-
end
|
376
|
-
end
|
377
|
-
end
|
378
|
-
|
379
289
|
# The type of earning.
|
380
290
|
module Type
|
381
291
|
extend FinchAPI::Internal::Type::Enum
|
@@ -462,6 +372,88 @@ module FinchAPI
|
|
462
372
|
def self.values
|
463
373
|
end
|
464
374
|
end
|
375
|
+
|
376
|
+
class Attributes < FinchAPI::Internal::Type::BaseModel
|
377
|
+
OrHash =
|
378
|
+
T.type_alias do
|
379
|
+
T.any(
|
380
|
+
FinchAPI::HRIS::PayStatement::Earning::Attributes,
|
381
|
+
FinchAPI::Internal::AnyHash
|
382
|
+
)
|
383
|
+
end
|
384
|
+
|
385
|
+
sig do
|
386
|
+
returns(
|
387
|
+
FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata
|
388
|
+
)
|
389
|
+
end
|
390
|
+
attr_reader :metadata
|
391
|
+
|
392
|
+
sig do
|
393
|
+
params(
|
394
|
+
metadata:
|
395
|
+
FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata::OrHash
|
396
|
+
).void
|
397
|
+
end
|
398
|
+
attr_writer :metadata
|
399
|
+
|
400
|
+
sig do
|
401
|
+
params(
|
402
|
+
metadata:
|
403
|
+
FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata::OrHash
|
404
|
+
).returns(T.attached_class)
|
405
|
+
end
|
406
|
+
def self.new(metadata:)
|
407
|
+
end
|
408
|
+
|
409
|
+
sig do
|
410
|
+
override.returns(
|
411
|
+
{
|
412
|
+
metadata:
|
413
|
+
FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata
|
414
|
+
}
|
415
|
+
)
|
416
|
+
end
|
417
|
+
def to_hash
|
418
|
+
end
|
419
|
+
|
420
|
+
class Metadata < FinchAPI::Internal::Type::BaseModel
|
421
|
+
OrHash =
|
422
|
+
T.type_alias do
|
423
|
+
T.any(
|
424
|
+
FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata,
|
425
|
+
FinchAPI::Internal::AnyHash
|
426
|
+
)
|
427
|
+
end
|
428
|
+
|
429
|
+
# The metadata to be attached to the entity by existing rules. It is a key-value
|
430
|
+
# pairs where the values can be of any type (string, number, boolean, object,
|
431
|
+
# array, etc.).
|
432
|
+
sig { returns(T::Hash[Symbol, T.nilable(T.anything)]) }
|
433
|
+
attr_accessor :metadata
|
434
|
+
|
435
|
+
sig do
|
436
|
+
params(
|
437
|
+
metadata: T::Hash[Symbol, T.nilable(T.anything)]
|
438
|
+
).returns(T.attached_class)
|
439
|
+
end
|
440
|
+
def self.new(
|
441
|
+
# The metadata to be attached to the entity by existing rules. It is a key-value
|
442
|
+
# pairs where the values can be of any type (string, number, boolean, object,
|
443
|
+
# array, etc.).
|
444
|
+
metadata:
|
445
|
+
)
|
446
|
+
end
|
447
|
+
|
448
|
+
sig do
|
449
|
+
override.returns(
|
450
|
+
{ metadata: T::Hash[Symbol, T.nilable(T.anything)] }
|
451
|
+
)
|
452
|
+
end
|
453
|
+
def to_hash
|
454
|
+
end
|
455
|
+
end
|
456
|
+
end
|
465
457
|
end
|
466
458
|
|
467
459
|
class EmployeeDeduction < FinchAPI::Internal::Type::BaseModel
|
@@ -477,6 +469,22 @@ module FinchAPI
|
|
477
469
|
sig { returns(T.nilable(Integer)) }
|
478
470
|
attr_accessor :amount
|
479
471
|
|
472
|
+
# The deduction currency.
|
473
|
+
sig { returns(T.nilable(String)) }
|
474
|
+
attr_accessor :currency
|
475
|
+
|
476
|
+
# The deduction name from the pay statement.
|
477
|
+
sig { returns(T.nilable(String)) }
|
478
|
+
attr_accessor :name
|
479
|
+
|
480
|
+
# Boolean indicating if the deduction is pre-tax.
|
481
|
+
sig { returns(T.nilable(T::Boolean)) }
|
482
|
+
attr_accessor :pre_tax
|
483
|
+
|
484
|
+
# Type of benefit.
|
485
|
+
sig { returns(T.nilable(FinchAPI::HRIS::BenefitType::TaggedSymbol)) }
|
486
|
+
attr_accessor :type
|
487
|
+
|
480
488
|
sig do
|
481
489
|
returns(
|
482
490
|
T.nilable(
|
@@ -496,47 +504,31 @@ module FinchAPI
|
|
496
504
|
end
|
497
505
|
attr_writer :attributes
|
498
506
|
|
499
|
-
# The deduction currency.
|
500
|
-
sig { returns(T.nilable(String)) }
|
501
|
-
attr_accessor :currency
|
502
|
-
|
503
|
-
# The deduction name from the pay statement.
|
504
|
-
sig { returns(T.nilable(String)) }
|
505
|
-
attr_accessor :name
|
506
|
-
|
507
|
-
# Boolean indicating if the deduction is pre-tax.
|
508
|
-
sig { returns(T.nilable(T::Boolean)) }
|
509
|
-
attr_accessor :pre_tax
|
510
|
-
|
511
|
-
# Type of benefit.
|
512
|
-
sig { returns(T.nilable(FinchAPI::HRIS::BenefitType::TaggedSymbol)) }
|
513
|
-
attr_accessor :type
|
514
|
-
|
515
507
|
sig do
|
516
508
|
params(
|
517
509
|
amount: T.nilable(Integer),
|
518
|
-
attributes:
|
519
|
-
T.nilable(
|
520
|
-
FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes::OrHash
|
521
|
-
),
|
522
510
|
currency: T.nilable(String),
|
523
511
|
name: T.nilable(String),
|
524
512
|
pre_tax: T.nilable(T::Boolean),
|
525
|
-
type: T.nilable(FinchAPI::HRIS::BenefitType::OrSymbol)
|
513
|
+
type: T.nilable(FinchAPI::HRIS::BenefitType::OrSymbol),
|
514
|
+
attributes:
|
515
|
+
T.nilable(
|
516
|
+
FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes::OrHash
|
517
|
+
)
|
526
518
|
).returns(T.attached_class)
|
527
519
|
end
|
528
520
|
def self.new(
|
529
521
|
# The deduction amount in cents.
|
530
|
-
amount
|
531
|
-
attributes: nil,
|
522
|
+
amount:,
|
532
523
|
# The deduction currency.
|
533
|
-
currency
|
524
|
+
currency:,
|
534
525
|
# The deduction name from the pay statement.
|
535
|
-
name
|
526
|
+
name:,
|
536
527
|
# Boolean indicating if the deduction is pre-tax.
|
537
|
-
pre_tax
|
528
|
+
pre_tax:,
|
538
529
|
# Type of benefit.
|
539
|
-
type
|
530
|
+
type:,
|
531
|
+
attributes: nil
|
540
532
|
)
|
541
533
|
end
|
542
534
|
|
@@ -544,14 +536,14 @@ module FinchAPI
|
|
544
536
|
override.returns(
|
545
537
|
{
|
546
538
|
amount: T.nilable(Integer),
|
547
|
-
attributes:
|
548
|
-
T.nilable(
|
549
|
-
FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes
|
550
|
-
),
|
551
539
|
currency: T.nilable(String),
|
552
540
|
name: T.nilable(String),
|
553
541
|
pre_tax: T.nilable(T::Boolean),
|
554
|
-
type: T.nilable(FinchAPI::HRIS::BenefitType::TaggedSymbol)
|
542
|
+
type: T.nilable(FinchAPI::HRIS::BenefitType::TaggedSymbol),
|
543
|
+
attributes:
|
544
|
+
T.nilable(
|
545
|
+
FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes
|
546
|
+
)
|
555
547
|
}
|
556
548
|
)
|
557
549
|
end
|
@@ -569,9 +561,7 @@ module FinchAPI
|
|
569
561
|
|
570
562
|
sig do
|
571
563
|
returns(
|
572
|
-
|
573
|
-
FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata
|
574
|
-
)
|
564
|
+
FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata
|
575
565
|
)
|
576
566
|
end
|
577
567
|
attr_reader :metadata
|
@@ -590,7 +580,7 @@ module FinchAPI
|
|
590
580
|
FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata::OrHash
|
591
581
|
).returns(T.attached_class)
|
592
582
|
end
|
593
|
-
def self.new(metadata:
|
583
|
+
def self.new(metadata:)
|
594
584
|
end
|
595
585
|
|
596
586
|
sig do
|
@@ -616,13 +606,8 @@ module FinchAPI
|
|
616
606
|
# The metadata to be attached to the entity by existing rules. It is a key-value
|
617
607
|
# pairs where the values can be of any type (string, number, boolean, object,
|
618
608
|
# array, etc.).
|
619
|
-
sig { returns(T
|
620
|
-
|
621
|
-
|
622
|
-
sig do
|
623
|
-
params(metadata: T::Hash[Symbol, T.nilable(T.anything)]).void
|
624
|
-
end
|
625
|
-
attr_writer :metadata
|
609
|
+
sig { returns(T::Hash[Symbol, T.nilable(T.anything)]) }
|
610
|
+
attr_accessor :metadata
|
626
611
|
|
627
612
|
sig do
|
628
613
|
params(
|
@@ -633,7 +618,7 @@ module FinchAPI
|
|
633
618
|
# The metadata to be attached to the entity by existing rules. It is a key-value
|
634
619
|
# pairs where the values can be of any type (string, number, boolean, object,
|
635
620
|
# array, etc.).
|
636
|
-
metadata:
|
621
|
+
metadata:
|
637
622
|
)
|
638
623
|
end
|
639
624
|
|
@@ -657,6 +642,18 @@ module FinchAPI
|
|
657
642
|
)
|
658
643
|
end
|
659
644
|
|
645
|
+
# The contribution currency.
|
646
|
+
sig { returns(T.nilable(String)) }
|
647
|
+
attr_accessor :currency
|
648
|
+
|
649
|
+
# The contribution name from the pay statement.
|
650
|
+
sig { returns(T.nilable(String)) }
|
651
|
+
attr_accessor :name
|
652
|
+
|
653
|
+
# Type of benefit.
|
654
|
+
sig { returns(T.nilable(FinchAPI::HRIS::BenefitType::TaggedSymbol)) }
|
655
|
+
attr_accessor :type
|
656
|
+
|
660
657
|
# The contribution amount in cents.
|
661
658
|
sig { returns(T.nilable(Integer)) }
|
662
659
|
attr_accessor :amount
|
@@ -680,54 +677,42 @@ module FinchAPI
|
|
680
677
|
end
|
681
678
|
attr_writer :attributes
|
682
679
|
|
683
|
-
# The contribution currency.
|
684
|
-
sig { returns(T.nilable(String)) }
|
685
|
-
attr_accessor :currency
|
686
|
-
|
687
|
-
# The contribution name from the pay statement.
|
688
|
-
sig { returns(T.nilable(String)) }
|
689
|
-
attr_accessor :name
|
690
|
-
|
691
|
-
# Type of benefit.
|
692
|
-
sig { returns(T.nilable(FinchAPI::HRIS::BenefitType::TaggedSymbol)) }
|
693
|
-
attr_accessor :type
|
694
|
-
|
695
680
|
sig do
|
696
681
|
params(
|
682
|
+
currency: T.nilable(String),
|
683
|
+
name: T.nilable(String),
|
684
|
+
type: T.nilable(FinchAPI::HRIS::BenefitType::OrSymbol),
|
697
685
|
amount: T.nilable(Integer),
|
698
686
|
attributes:
|
699
687
|
T.nilable(
|
700
688
|
FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes::OrHash
|
701
|
-
)
|
702
|
-
currency: T.nilable(String),
|
703
|
-
name: T.nilable(String),
|
704
|
-
type: T.nilable(FinchAPI::HRIS::BenefitType::OrSymbol)
|
689
|
+
)
|
705
690
|
).returns(T.attached_class)
|
706
691
|
end
|
707
692
|
def self.new(
|
708
|
-
# The contribution amount in cents.
|
709
|
-
amount: nil,
|
710
|
-
attributes: nil,
|
711
693
|
# The contribution currency.
|
712
|
-
currency
|
694
|
+
currency:,
|
713
695
|
# The contribution name from the pay statement.
|
714
|
-
name
|
696
|
+
name:,
|
715
697
|
# Type of benefit.
|
716
|
-
type
|
698
|
+
type:,
|
699
|
+
# The contribution amount in cents.
|
700
|
+
amount: nil,
|
701
|
+
attributes: nil
|
717
702
|
)
|
718
703
|
end
|
719
704
|
|
720
705
|
sig do
|
721
706
|
override.returns(
|
722
707
|
{
|
708
|
+
currency: T.nilable(String),
|
709
|
+
name: T.nilable(String),
|
710
|
+
type: T.nilable(FinchAPI::HRIS::BenefitType::TaggedSymbol),
|
723
711
|
amount: T.nilable(Integer),
|
724
712
|
attributes:
|
725
713
|
T.nilable(
|
726
714
|
FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes
|
727
|
-
)
|
728
|
-
currency: T.nilable(String),
|
729
|
-
name: T.nilable(String),
|
730
|
-
type: T.nilable(FinchAPI::HRIS::BenefitType::TaggedSymbol)
|
715
|
+
)
|
731
716
|
}
|
732
717
|
)
|
733
718
|
end
|
@@ -745,9 +730,7 @@ module FinchAPI
|
|
745
730
|
|
746
731
|
sig do
|
747
732
|
returns(
|
748
|
-
|
749
|
-
FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes::Metadata
|
750
|
-
)
|
733
|
+
FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes::Metadata
|
751
734
|
)
|
752
735
|
end
|
753
736
|
attr_reader :metadata
|
@@ -766,7 +749,7 @@ module FinchAPI
|
|
766
749
|
FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes::Metadata::OrHash
|
767
750
|
).returns(T.attached_class)
|
768
751
|
end
|
769
|
-
def self.new(metadata:
|
752
|
+
def self.new(metadata:)
|
770
753
|
end
|
771
754
|
|
772
755
|
sig do
|
@@ -792,13 +775,8 @@ module FinchAPI
|
|
792
775
|
# The metadata to be attached to the entity by existing rules. It is a key-value
|
793
776
|
# pairs where the values can be of any type (string, number, boolean, object,
|
794
777
|
# array, etc.).
|
795
|
-
sig { returns(T
|
796
|
-
|
797
|
-
|
798
|
-
sig do
|
799
|
-
params(metadata: T::Hash[Symbol, T.nilable(T.anything)]).void
|
800
|
-
end
|
801
|
-
attr_writer :metadata
|
778
|
+
sig { returns(T::Hash[Symbol, T.nilable(T.anything)]) }
|
779
|
+
attr_accessor :metadata
|
802
780
|
|
803
781
|
sig do
|
804
782
|
params(
|
@@ -809,7 +787,7 @@ module FinchAPI
|
|
809
787
|
# The metadata to be attached to the entity by existing rules. It is a key-value
|
810
788
|
# pairs where the values can be of any type (string, number, boolean, object,
|
811
789
|
# array, etc.).
|
812
|
-
metadata:
|
790
|
+
metadata:
|
813
791
|
)
|
814
792
|
end
|
815
793
|
|
@@ -870,23 +848,6 @@ module FinchAPI
|
|
870
848
|
)
|
871
849
|
end
|
872
850
|
|
873
|
-
# The tax amount in cents.
|
874
|
-
sig { returns(T.nilable(Integer)) }
|
875
|
-
attr_accessor :amount
|
876
|
-
|
877
|
-
sig do
|
878
|
-
returns(T.nilable(FinchAPI::HRIS::PayStatement::Tax::Attributes))
|
879
|
-
end
|
880
|
-
attr_reader :attributes
|
881
|
-
|
882
|
-
sig do
|
883
|
-
params(
|
884
|
-
attributes:
|
885
|
-
T.nilable(FinchAPI::HRIS::PayStatement::Tax::Attributes::OrHash)
|
886
|
-
).void
|
887
|
-
end
|
888
|
-
attr_writer :attributes
|
889
|
-
|
890
851
|
# The currency code.
|
891
852
|
sig { returns(T.nilable(String)) }
|
892
853
|
attr_accessor :currency
|
@@ -907,53 +868,109 @@ module FinchAPI
|
|
907
868
|
end
|
908
869
|
attr_accessor :type
|
909
870
|
|
871
|
+
# The tax amount in cents.
|
872
|
+
sig { returns(T.nilable(Integer)) }
|
873
|
+
attr_accessor :amount
|
874
|
+
|
875
|
+
sig do
|
876
|
+
returns(T.nilable(FinchAPI::HRIS::PayStatement::Tax::Attributes))
|
877
|
+
end
|
878
|
+
attr_reader :attributes
|
879
|
+
|
910
880
|
sig do
|
911
881
|
params(
|
912
|
-
amount: T.nilable(Integer),
|
913
882
|
attributes:
|
914
|
-
T.nilable(
|
915
|
-
|
916
|
-
|
883
|
+
T.nilable(FinchAPI::HRIS::PayStatement::Tax::Attributes::OrHash)
|
884
|
+
).void
|
885
|
+
end
|
886
|
+
attr_writer :attributes
|
887
|
+
|
888
|
+
sig do
|
889
|
+
params(
|
917
890
|
currency: T.nilable(String),
|
918
891
|
employer: T.nilable(T::Boolean),
|
919
892
|
name: T.nilable(String),
|
920
|
-
type:
|
893
|
+
type:
|
894
|
+
T.nilable(FinchAPI::HRIS::PayStatement::Tax::Type::OrSymbol),
|
895
|
+
amount: T.nilable(Integer),
|
896
|
+
attributes:
|
897
|
+
T.nilable(FinchAPI::HRIS::PayStatement::Tax::Attributes::OrHash)
|
921
898
|
).returns(T.attached_class)
|
922
899
|
end
|
923
900
|
def self.new(
|
924
|
-
# The tax amount in cents.
|
925
|
-
amount: nil,
|
926
|
-
attributes: nil,
|
927
901
|
# The currency code.
|
928
|
-
currency
|
902
|
+
currency:,
|
929
903
|
# `true` if the amount is paid by the employers.
|
930
|
-
employer
|
904
|
+
employer:,
|
931
905
|
# The exact name of tax from the pay statement.
|
932
|
-
name
|
906
|
+
name:,
|
933
907
|
# The type of taxes.
|
934
|
-
type
|
908
|
+
type:,
|
909
|
+
# The tax amount in cents.
|
910
|
+
amount: nil,
|
911
|
+
attributes: nil
|
935
912
|
)
|
936
913
|
end
|
937
914
|
|
938
915
|
sig do
|
939
916
|
override.returns(
|
940
917
|
{
|
941
|
-
amount: T.nilable(Integer),
|
942
|
-
attributes:
|
943
|
-
T.nilable(FinchAPI::HRIS::PayStatement::Tax::Attributes),
|
944
918
|
currency: T.nilable(String),
|
945
919
|
employer: T.nilable(T::Boolean),
|
946
920
|
name: T.nilable(String),
|
947
921
|
type:
|
948
922
|
T.nilable(
|
949
923
|
FinchAPI::HRIS::PayStatement::Tax::Type::TaggedSymbol
|
950
|
-
)
|
924
|
+
),
|
925
|
+
amount: T.nilable(Integer),
|
926
|
+
attributes:
|
927
|
+
T.nilable(FinchAPI::HRIS::PayStatement::Tax::Attributes)
|
951
928
|
}
|
952
929
|
)
|
953
930
|
end
|
954
931
|
def to_hash
|
955
932
|
end
|
956
933
|
|
934
|
+
# The type of taxes.
|
935
|
+
module Type
|
936
|
+
extend FinchAPI::Internal::Type::Enum
|
937
|
+
|
938
|
+
TaggedSymbol =
|
939
|
+
T.type_alias do
|
940
|
+
T.all(Symbol, FinchAPI::HRIS::PayStatement::Tax::Type)
|
941
|
+
end
|
942
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
943
|
+
|
944
|
+
STATE =
|
945
|
+
T.let(
|
946
|
+
:state,
|
947
|
+
FinchAPI::HRIS::PayStatement::Tax::Type::TaggedSymbol
|
948
|
+
)
|
949
|
+
FEDERAL =
|
950
|
+
T.let(
|
951
|
+
:federal,
|
952
|
+
FinchAPI::HRIS::PayStatement::Tax::Type::TaggedSymbol
|
953
|
+
)
|
954
|
+
LOCAL =
|
955
|
+
T.let(
|
956
|
+
:local,
|
957
|
+
FinchAPI::HRIS::PayStatement::Tax::Type::TaggedSymbol
|
958
|
+
)
|
959
|
+
FICA =
|
960
|
+
T.let(
|
961
|
+
:fica,
|
962
|
+
FinchAPI::HRIS::PayStatement::Tax::Type::TaggedSymbol
|
963
|
+
)
|
964
|
+
|
965
|
+
sig do
|
966
|
+
override.returns(
|
967
|
+
T::Array[FinchAPI::HRIS::PayStatement::Tax::Type::TaggedSymbol]
|
968
|
+
)
|
969
|
+
end
|
970
|
+
def self.values
|
971
|
+
end
|
972
|
+
end
|
973
|
+
|
957
974
|
class Attributes < FinchAPI::Internal::Type::BaseModel
|
958
975
|
OrHash =
|
959
976
|
T.type_alias do
|
@@ -964,11 +981,7 @@ module FinchAPI
|
|
964
981
|
end
|
965
982
|
|
966
983
|
sig do
|
967
|
-
returns(
|
968
|
-
T.nilable(
|
969
|
-
FinchAPI::HRIS::PayStatement::Tax::Attributes::Metadata
|
970
|
-
)
|
971
|
-
)
|
984
|
+
returns(FinchAPI::HRIS::PayStatement::Tax::Attributes::Metadata)
|
972
985
|
end
|
973
986
|
attr_reader :metadata
|
974
987
|
|
@@ -986,7 +999,7 @@ module FinchAPI
|
|
986
999
|
FinchAPI::HRIS::PayStatement::Tax::Attributes::Metadata::OrHash
|
987
1000
|
).returns(T.attached_class)
|
988
1001
|
end
|
989
|
-
def self.new(metadata:
|
1002
|
+
def self.new(metadata:)
|
990
1003
|
end
|
991
1004
|
|
992
1005
|
sig do
|
@@ -1012,13 +1025,8 @@ module FinchAPI
|
|
1012
1025
|
# The metadata to be attached to the entity by existing rules. It is a key-value
|
1013
1026
|
# pairs where the values can be of any type (string, number, boolean, object,
|
1014
1027
|
# array, etc.).
|
1015
|
-
sig { returns(T
|
1016
|
-
|
1017
|
-
|
1018
|
-
sig do
|
1019
|
-
params(metadata: T::Hash[Symbol, T.nilable(T.anything)]).void
|
1020
|
-
end
|
1021
|
-
attr_writer :metadata
|
1028
|
+
sig { returns(T::Hash[Symbol, T.nilable(T.anything)]) }
|
1029
|
+
attr_accessor :metadata
|
1022
1030
|
|
1023
1031
|
sig do
|
1024
1032
|
params(
|
@@ -1029,7 +1037,7 @@ module FinchAPI
|
|
1029
1037
|
# The metadata to be attached to the entity by existing rules. It is a key-value
|
1030
1038
|
# pairs where the values can be of any type (string, number, boolean, object,
|
1031
1039
|
# array, etc.).
|
1032
|
-
metadata:
|
1040
|
+
metadata:
|
1033
1041
|
)
|
1034
1042
|
end
|
1035
1043
|
|
@@ -1042,46 +1050,6 @@ module FinchAPI
|
|
1042
1050
|
end
|
1043
1051
|
end
|
1044
1052
|
end
|
1045
|
-
|
1046
|
-
# The type of taxes.
|
1047
|
-
module Type
|
1048
|
-
extend FinchAPI::Internal::Type::Enum
|
1049
|
-
|
1050
|
-
TaggedSymbol =
|
1051
|
-
T.type_alias do
|
1052
|
-
T.all(Symbol, FinchAPI::HRIS::PayStatement::Tax::Type)
|
1053
|
-
end
|
1054
|
-
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
1055
|
-
|
1056
|
-
STATE =
|
1057
|
-
T.let(
|
1058
|
-
:state,
|
1059
|
-
FinchAPI::HRIS::PayStatement::Tax::Type::TaggedSymbol
|
1060
|
-
)
|
1061
|
-
FEDERAL =
|
1062
|
-
T.let(
|
1063
|
-
:federal,
|
1064
|
-
FinchAPI::HRIS::PayStatement::Tax::Type::TaggedSymbol
|
1065
|
-
)
|
1066
|
-
LOCAL =
|
1067
|
-
T.let(
|
1068
|
-
:local,
|
1069
|
-
FinchAPI::HRIS::PayStatement::Tax::Type::TaggedSymbol
|
1070
|
-
)
|
1071
|
-
FICA =
|
1072
|
-
T.let(
|
1073
|
-
:fica,
|
1074
|
-
FinchAPI::HRIS::PayStatement::Tax::Type::TaggedSymbol
|
1075
|
-
)
|
1076
|
-
|
1077
|
-
sig do
|
1078
|
-
override.returns(
|
1079
|
-
T::Array[FinchAPI::HRIS::PayStatement::Tax::Type::TaggedSymbol]
|
1080
|
-
)
|
1081
|
-
end
|
1082
|
-
def self.values
|
1083
|
-
end
|
1084
|
-
end
|
1085
1053
|
end
|
1086
1054
|
|
1087
1055
|
# The type of the payment associated with the pay statement.
|
@@ -1092,11 +1060,6 @@ module FinchAPI
|
|
1092
1060
|
T.type_alias { T.all(Symbol, FinchAPI::HRIS::PayStatement::Type) }
|
1093
1061
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
1094
1062
|
|
1095
|
-
REGULAR_PAYROLL =
|
1096
|
-
T.let(
|
1097
|
-
:regular_payroll,
|
1098
|
-
FinchAPI::HRIS::PayStatement::Type::TaggedSymbol
|
1099
|
-
)
|
1100
1063
|
OFF_CYCLE_PAYROLL =
|
1101
1064
|
T.let(
|
1102
1065
|
:off_cycle_payroll,
|
@@ -1107,6 +1070,11 @@ module FinchAPI
|
|
1107
1070
|
:one_time_payment,
|
1108
1071
|
FinchAPI::HRIS::PayStatement::Type::TaggedSymbol
|
1109
1072
|
)
|
1073
|
+
REGULAR_PAYROLL =
|
1074
|
+
T.let(
|
1075
|
+
:regular_payroll,
|
1076
|
+
FinchAPI::HRIS::PayStatement::Type::TaggedSymbol
|
1077
|
+
)
|
1110
1078
|
|
1111
1079
|
sig do
|
1112
1080
|
override.returns(
|