finch-api 0.1.0.pre.alpha.1 → 0.1.0.pre.alpha.2
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/README.md +63 -20
- data/lib/finch-api/base_client.rb +52 -59
- data/lib/finch-api/base_model.rb +453 -415
- data/lib/finch-api/base_page.rb +34 -15
- data/lib/finch-api/client.rb +3 -7
- data/lib/finch-api/errors.rb +12 -17
- data/lib/finch-api/extern.rb +1 -4
- data/lib/finch-api/individuals_page.rb +28 -34
- data/lib/finch-api/models/account_update_event.rb +6 -31
- data/lib/finch-api/models/company_event.rb +3 -11
- data/lib/finch-api/models/connect/session_new_params.rb +9 -52
- data/lib/finch-api/models/connect/session_reauthenticate_params.rb +3 -22
- data/lib/finch-api/models/connection_status_type.rb +3 -21
- data/lib/finch-api/models/create_access_token_response.rb +6 -30
- data/lib/finch-api/models/directory_event.rb +3 -15
- data/lib/finch-api/models/employment_event.rb +3 -15
- data/lib/finch-api/models/hris/benefit_contribution.rb +3 -14
- data/lib/finch-api/models/hris/benefit_features_and_operations.rb +9 -39
- data/lib/finch-api/models/hris/benefit_frequency.rb +3 -15
- data/lib/finch-api/models/hris/benefit_type.rb +3 -22
- data/lib/finch-api/models/hris/benefits/enrolled_individual.rb +3 -18
- data/lib/finch-api/models/hris/benefits/individual_benefit.rb +3 -14
- data/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rb +9 -40
- data/lib/finch-api/models/hris/company.rb +9 -52
- data/lib/finch-api/models/hris/document_list_params.rb +3 -13
- data/lib/finch-api/models/hris/document_response.rb +3 -14
- data/lib/finch-api/models/hris/document_retreive_response.rb +7 -23
- data/lib/finch-api/models/hris/employment_data.rb +9 -58
- data/lib/finch-api/models/hris/individual.rb +12 -66
- data/lib/finch-api/models/hris/pay_statement.rb +12 -70
- data/lib/finch-api/models/hris/payment.rb +3 -21
- data/lib/finch-api/models/hris/supported_benefit.rb +9 -39
- data/lib/finch-api/models/hris/w42005.rb +12 -49
- data/lib/finch-api/models/hris/w42020.rb +8 -29
- data/lib/finch-api/models/income.rb +3 -22
- data/lib/finch-api/models/individual_event.rb +3 -15
- data/lib/finch-api/models/introspection.rb +9 -50
- data/lib/finch-api/models/job_completion_event.rb +3 -21
- data/lib/finch-api/models/jobs/automated_async_job.rb +6 -35
- data/lib/finch-api/models/jobs/automated_create_params.rb +3 -12
- data/lib/finch-api/models/jobs/automated_list_response.rb +100 -0
- data/lib/finch-api/models/jobs/manual_async_job.rb +3 -17
- data/lib/finch-api/models/operation_support.rb +3 -18
- data/lib/finch-api/models/pay_statement_event.rb +3 -15
- data/lib/finch-api/models/payment_event.rb +3 -15
- data/lib/finch-api/models/payroll/pay_group_list_response.rb +3 -21
- data/lib/finch-api/models/payroll/pay_group_retrieve_response.rb +3 -21
- data/lib/finch-api/models/provider.rb +3 -20
- data/lib/finch-api/models/sandbox/company_update_params.rb +9 -52
- data/lib/finch-api/models/sandbox/company_update_response.rb +9 -52
- data/lib/finch-api/models/sandbox/connection_create_params.rb +3 -17
- data/lib/finch-api/models/sandbox/connection_create_response.rb +3 -17
- data/lib/finch-api/models/sandbox/connections/account_create_params.rb +3 -17
- data/lib/finch-api/models/sandbox/connections/account_create_response.rb +3 -17
- data/lib/finch-api/models/sandbox/connections/account_update_response.rb +3 -17
- data/lib/finch-api/models/sandbox/directory_create_params.rb +21 -124
- data/lib/finch-api/models/sandbox/employment_update_params.rb +9 -58
- data/lib/finch-api/models/sandbox/employment_update_response.rb +9 -58
- data/lib/finch-api/models/sandbox/individual_update_params.rb +12 -66
- data/lib/finch-api/models/sandbox/individual_update_response.rb +12 -66
- data/lib/finch-api/models/sandbox/job_create_params.rb +3 -12
- data/lib/finch-api/models/sandbox/jobs/configuration_retrieve_response.rb +2 -1
- data/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rb +6 -28
- data/lib/finch-api/models/sandbox/payment_create_params.rb +12 -70
- data/lib/finch-api/models/webhook_event.rb +10 -27
- data/lib/finch-api/page.rb +28 -34
- data/lib/finch-api/pooled_net_requester.rb +51 -46
- data/lib/finch-api/request_options.rb +5 -12
- data/lib/finch-api/resources/access_tokens.rb +0 -2
- data/lib/finch-api/resources/account.rb +0 -3
- data/lib/finch-api/resources/connect/sessions.rb +0 -3
- data/lib/finch-api/resources/connect.rb +0 -1
- data/lib/finch-api/resources/hris/benefits/individuals.rb +2 -6
- data/lib/finch-api/resources/hris/benefits.rb +0 -6
- data/lib/finch-api/resources/hris/company.rb +0 -2
- data/lib/finch-api/resources/hris/directory.rb +1 -24
- data/lib/finch-api/resources/hris/documents.rb +4 -7
- data/lib/finch-api/resources/hris/employments.rb +0 -2
- data/lib/finch-api/resources/hris/individuals.rb +0 -2
- data/lib/finch-api/resources/hris/pay_statements.rb +0 -2
- data/lib/finch-api/resources/hris/payments.rb +0 -2
- data/lib/finch-api/resources/hris.rb +0 -1
- data/lib/finch-api/resources/jobs/automated.rb +2 -7
- data/lib/finch-api/resources/jobs/manual.rb +0 -2
- data/lib/finch-api/resources/jobs.rb +0 -1
- data/lib/finch-api/resources/payroll/pay_groups.rb +0 -3
- data/lib/finch-api/resources/payroll.rb +0 -1
- data/lib/finch-api/resources/providers.rb +0 -2
- data/lib/finch-api/resources/request_forwarding.rb +0 -2
- data/lib/finch-api/resources/sandbox/company.rb +0 -2
- data/lib/finch-api/resources/sandbox/connections/accounts.rb +0 -3
- data/lib/finch-api/resources/sandbox/connections.rb +0 -2
- data/lib/finch-api/resources/sandbox/directory.rb +0 -2
- data/lib/finch-api/resources/sandbox/employment.rb +0 -2
- data/lib/finch-api/resources/sandbox/individual.rb +0 -2
- data/lib/finch-api/resources/sandbox/jobs/configuration.rb +0 -3
- data/lib/finch-api/resources/sandbox/jobs.rb +0 -2
- data/lib/finch-api/resources/sandbox/payment.rb +0 -2
- data/lib/finch-api/resources/sandbox.rb +0 -1
- data/lib/finch-api/resources/webhooks.rb +0 -1
- data/lib/finch-api/responses_page.rb +24 -31
- data/lib/finch-api/single_page.rb +23 -31
- data/lib/finch-api/util.rb +216 -124
- data/lib/finch-api/version.rb +1 -1
- data/lib/finch-api.rb +17 -0
- data/manifest.yaml +1 -0
- data/rbi/lib/finch-api/base_client.rbi +89 -66
- data/rbi/lib/finch-api/base_model.rbi +403 -236
- data/rbi/lib/finch-api/base_page.rbi +3 -6
- data/rbi/lib/finch-api/client.rbi +23 -28
- data/rbi/lib/finch-api/errors.rbi +20 -22
- data/rbi/lib/finch-api/extern.rbi +1 -1
- data/rbi/lib/finch-api/individuals_page.rbi +5 -23
- data/rbi/lib/finch-api/models/access_token_create_params.rbi +13 -24
- data/rbi/lib/finch-api/models/account_disconnect_params.rbi +9 -2
- data/rbi/lib/finch-api/models/account_introspect_params.rbi +9 -2
- data/rbi/lib/finch-api/models/account_update_event.rbi +871 -983
- data/rbi/lib/finch-api/models/base_webhook_event.rbi +13 -19
- data/rbi/lib/finch-api/models/company_event.rbi +28 -20
- data/rbi/lib/finch-api/models/connect/session_new_params.rbi +90 -104
- data/rbi/lib/finch-api/models/connect/session_new_response.rbi +6 -14
- data/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi +37 -47
- data/rbi/lib/finch-api/models/connect/session_reauthenticate_response.rbi +6 -14
- data/rbi/lib/finch-api/models/connection_status_type.rbi +13 -9
- data/rbi/lib/finch-api/models/create_access_token_response.rbi +61 -78
- data/rbi/lib/finch-api/models/directory_event.rbi +42 -27
- data/rbi/lib/finch-api/models/disconnect_response.rbi +4 -8
- data/rbi/lib/finch-api/models/employment_event.rbi +42 -27
- data/rbi/lib/finch-api/models/hris/benefit_contribution.rbi +29 -21
- data/rbi/lib/finch-api/models/hris/benefit_create_params.rbi +18 -26
- data/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi +199 -86
- data/rbi/lib/finch-api/models/hris/benefit_frequency.rbi +9 -6
- data/rbi/lib/finch-api/models/hris/benefit_list_params.rbi +9 -2
- data/rbi/lib/finch-api/models/hris/benefit_list_supported_benefits_params.rbi +9 -2
- data/rbi/lib/finch-api/models/hris/benefit_retrieve_params.rbi +9 -2
- data/rbi/lib/finch-api/models/hris/benefit_type.rbi +26 -22
- data/rbi/lib/finch-api/models/hris/benefit_update_params.rbi +7 -11
- data/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi +43 -49
- data/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi +74 -63
- data/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi +249 -104
- data/rbi/lib/finch-api/models/hris/benefits/individual_enrolled_ids_params.rbi +9 -2
- data/rbi/lib/finch-api/models/hris/benefits/individual_enrolled_ids_response.rbi +4 -14
- data/rbi/lib/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi +11 -8
- data/rbi/lib/finch-api/models/hris/benefits/individual_unenroll_many_params.rbi +7 -8
- data/rbi/lib/finch-api/models/hris/benefits/unenrolled_individual.rbi +23 -39
- data/rbi/lib/finch-api/models/hris/benefits_support.rbi +88 -86
- data/rbi/lib/finch-api/models/hris/benfit_contribution.rbi +1 -1
- data/rbi/lib/finch-api/models/hris/company.rbi +119 -171
- data/rbi/lib/finch-api/models/hris/company_benefit.rbi +13 -32
- data/rbi/lib/finch-api/models/hris/company_retrieve_params.rbi +9 -2
- data/rbi/lib/finch-api/models/hris/create_company_benefits_response.rbi +3 -8
- data/rbi/lib/finch-api/models/hris/directory_list_individuals_params.rbi +11 -13
- data/rbi/lib/finch-api/models/hris/directory_list_params.rbi +11 -13
- data/rbi/lib/finch-api/models/hris/document_list_params.rbi +32 -31
- data/rbi/lib/finch-api/models/hris/document_list_response.rbi +10 -17
- data/rbi/lib/finch-api/models/hris/document_response.rbi +40 -43
- data/rbi/lib/finch-api/models/hris/document_retreive_params.rbi +9 -2
- data/rbi/lib/finch-api/models/hris/document_retreive_response.rbi +6 -4
- data/rbi/lib/finch-api/models/hris/employment_data.rbi +163 -205
- data/rbi/lib/finch-api/models/hris/employment_data_response.rbi +18 -17
- data/rbi/lib/finch-api/models/hris/employment_retrieve_many_params.rbi +12 -21
- data/rbi/lib/finch-api/models/hris/individual.rbi +126 -151
- data/rbi/lib/finch-api/models/hris/individual_in_directory.rbi +42 -68
- data/rbi/lib/finch-api/models/hris/individual_response.rbi +18 -17
- data/rbi/lib/finch-api/models/hris/individual_retrieve_many_params.rbi +27 -31
- data/rbi/lib/finch-api/models/hris/pay_statement.rbi +290 -341
- data/rbi/lib/finch-api/models/hris/pay_statement_response.rbi +18 -20
- data/rbi/lib/finch-api/models/hris/pay_statement_response_body.rbi +13 -16
- data/rbi/lib/finch-api/models/hris/pay_statement_retrieve_many_params.rbi +18 -31
- data/rbi/lib/finch-api/models/hris/payment.rbi +63 -103
- data/rbi/lib/finch-api/models/hris/payment_list_params.rbi +9 -15
- data/rbi/lib/finch-api/models/hris/support_per_benefit_type.rbi +10 -14
- data/rbi/lib/finch-api/models/hris/supported_benefit.rbi +83 -79
- data/rbi/lib/finch-api/models/hris/update_company_benefit_response.rbi +3 -8
- data/rbi/lib/finch-api/models/hris/w42005.rbi +86 -70
- data/rbi/lib/finch-api/models/hris/w42020.rbi +84 -86
- data/rbi/lib/finch-api/models/income.rbi +34 -41
- data/rbi/lib/finch-api/models/individual_event.rbi +42 -27
- data/rbi/lib/finch-api/models/introspection.rbi +138 -178
- data/rbi/lib/finch-api/models/job_completion_event.rbi +48 -37
- data/rbi/lib/finch-api/models/jobs/automated_async_job.rbi +66 -94
- data/rbi/lib/finch-api/models/jobs/automated_create_params.rbi +26 -33
- data/rbi/lib/finch-api/models/jobs/automated_create_response.rbi +11 -31
- data/rbi/lib/finch-api/models/jobs/automated_list_params.rbi +11 -13
- data/rbi/lib/finch-api/models/jobs/automated_list_response.rbi +126 -0
- data/rbi/lib/finch-api/models/jobs/automated_retrieve_params.rbi +9 -2
- data/rbi/lib/finch-api/models/jobs/manual_async_job.rbi +32 -27
- data/rbi/lib/finch-api/models/jobs/manual_retrieve_params.rbi +9 -2
- data/rbi/lib/finch-api/models/location.rbi +16 -59
- data/rbi/lib/finch-api/models/money.rbi +7 -13
- data/rbi/lib/finch-api/models/operation_support.rbi +18 -7
- data/rbi/lib/finch-api/models/operation_support_matrix.rbi +65 -27
- data/rbi/lib/finch-api/models/paging.rbi +10 -12
- data/rbi/lib/finch-api/models/pay_statement_event.rbi +46 -32
- data/rbi/lib/finch-api/models/payment_event.rbi +39 -34
- data/rbi/lib/finch-api/models/payroll/pay_group_list_params.rbi +9 -13
- data/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi +55 -30
- data/rbi/lib/finch-api/models/payroll/pay_group_retrieve_params.rbi +9 -2
- data/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi +45 -46
- data/rbi/lib/finch-api/models/provider.rbi +873 -964
- data/rbi/lib/finch-api/models/provider_list_params.rbi +9 -2
- data/rbi/lib/finch-api/models/request_forwarding_forward_params.rbi +20 -33
- data/rbi/lib/finch-api/models/request_forwarding_forward_response.rbi +40 -59
- data/rbi/lib/finch-api/models/sandbox/company_update_params.rbi +144 -166
- data/rbi/lib/finch-api/models/sandbox/company_update_response.rbi +145 -174
- data/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi +43 -39
- data/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi +38 -59
- data/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi +62 -39
- data/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi +54 -62
- data/rbi/lib/finch-api/models/sandbox/connections/account_update_params.rbi +17 -11
- data/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi +55 -54
- data/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi +380 -332
- data/rbi/lib/finch-api/models/sandbox/directory_create_response.rbi +1 -1
- data/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi +190 -194
- data/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi +195 -198
- data/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi +151 -145
- data/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi +163 -151
- data/rbi/lib/finch-api/models/sandbox/job_create_params.rbi +22 -19
- data/rbi/lib/finch-api/models/sandbox/job_create_response.rbi +11 -31
- data/rbi/lib/finch-api/models/sandbox/jobs/configuration_retrieve_params.rbi +9 -2
- data/rbi/lib/finch-api/models/sandbox/jobs/configuration_retrieve_response.rbi +2 -1
- data/rbi/lib/finch-api/models/sandbox/jobs/configuration_update_params.rbi +9 -2
- data/rbi/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbi +56 -26
- data/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi +409 -393
- data/rbi/lib/finch-api/models/sandbox/payment_create_response.rbi +6 -14
- data/rbi/lib/finch-api/models/webhook_event.rbi +4 -4
- data/rbi/lib/finch-api/page.rbi +5 -23
- data/rbi/lib/finch-api/pooled_net_requester.rbi +39 -16
- data/rbi/lib/finch-api/request_options.rbi +33 -54
- data/rbi/lib/finch-api/resources/access_tokens.rbi +4 -3
- data/rbi/lib/finch-api/resources/account.rbi +6 -4
- data/rbi/lib/finch-api/resources/connect/sessions.rbi +17 -8
- data/rbi/lib/finch-api/resources/connect.rbi +3 -4
- data/rbi/lib/finch-api/resources/hris/benefits/individuals.rbi +33 -10
- data/rbi/lib/finch-api/resources/hris/benefits.rbi +32 -13
- data/rbi/lib/finch-api/resources/hris/company.rbi +4 -3
- data/rbi/lib/finch-api/resources/hris/directory.rbi +11 -15
- data/rbi/lib/finch-api/resources/hris/documents.rbi +27 -7
- data/rbi/lib/finch-api/resources/hris/employments.rbi +10 -5
- data/rbi/lib/finch-api/resources/hris/individuals.rbi +6 -5
- data/rbi/lib/finch-api/resources/hris/pay_statements.rbi +13 -5
- data/rbi/lib/finch-api/resources/hris/payments.rbi +13 -4
- data/rbi/lib/finch-api/resources/hris.rbi +10 -18
- data/rbi/lib/finch-api/resources/jobs/automated.rbi +39 -10
- data/rbi/lib/finch-api/resources/jobs/manual.rbi +5 -3
- data/rbi/lib/finch-api/resources/jobs.rbi +4 -6
- data/rbi/lib/finch-api/resources/payroll/pay_groups.rbi +6 -4
- data/rbi/lib/finch-api/resources/payroll.rbi +3 -4
- data/rbi/lib/finch-api/resources/providers.rbi +4 -3
- data/rbi/lib/finch-api/resources/request_forwarding.rbi +27 -4
- data/rbi/lib/finch-api/resources/sandbox/company.rbi +19 -7
- data/rbi/lib/finch-api/resources/sandbox/connections/accounts.rbi +19 -7
- data/rbi/lib/finch-api/resources/sandbox/connections.rbi +10 -6
- data/rbi/lib/finch-api/resources/sandbox/directory.rbi +12 -6
- data/rbi/lib/finch-api/resources/sandbox/employment.rbi +30 -11
- data/rbi/lib/finch-api/resources/sandbox/individual.rbi +26 -8
- data/rbi/lib/finch-api/resources/sandbox/jobs/configuration.rbi +9 -7
- data/rbi/lib/finch-api/resources/sandbox/jobs.rbi +11 -7
- data/rbi/lib/finch-api/resources/sandbox/payment.rbi +5 -4
- data/rbi/lib/finch-api/resources/sandbox.rbi +9 -16
- data/rbi/lib/finch-api/resources/webhooks.rbi +2 -2
- data/rbi/lib/finch-api/responses_page.rbi +4 -17
- data/rbi/lib/finch-api/single_page.rbi +4 -12
- data/rbi/lib/finch-api/util.rbi +228 -115
- data/rbi/lib/finch-api/version.rbi +1 -1
- data/sig/finch-api/base_client.rbs +20 -15
- data/sig/finch-api/base_model.rbs +36 -18
- data/sig/finch-api/base_page.rbs +1 -1
- data/sig/finch-api/client.rbs +8 -8
- data/sig/finch-api/errors.rbs +21 -21
- data/sig/finch-api/individuals_page.rbs +2 -7
- data/sig/finch-api/models/access_token_create_params.rbs +7 -12
- data/sig/finch-api/models/account_disconnect_params.rbs +1 -6
- data/sig/finch-api/models/account_introspect_params.rbs +1 -6
- data/sig/finch-api/models/account_update_event.rbs +204 -361
- data/sig/finch-api/models/base_webhook_event.rbs +5 -5
- data/sig/finch-api/models/company_event.rbs +13 -11
- data/sig/finch-api/models/connect/session_new_params.rbs +28 -32
- data/sig/finch-api/models/connect/session_new_response.rbs +1 -6
- data/sig/finch-api/models/connect/session_reauthenticate_params.rbs +11 -14
- data/sig/finch-api/models/connect/session_reauthenticate_response.rbs +1 -6
- data/sig/finch-api/models/connection_status_type.rbs +4 -2
- data/sig/finch-api/models/create_access_token_response.rbs +20 -21
- data/sig/finch-api/models/directory_event.rbs +13 -19
- data/sig/finch-api/models/disconnect_response.rbs +1 -5
- data/sig/finch-api/models/employment_event.rbs +13 -19
- data/sig/finch-api/models/hris/benefit_contribution.rbs +8 -11
- data/sig/finch-api/models/hris/benefit_create_params.rbs +6 -11
- data/sig/finch-api/models/hris/benefit_features_and_operations.rbs +25 -29
- data/sig/finch-api/models/hris/benefit_frequency.rbs +4 -2
- data/sig/finch-api/models/hris/benefit_list_params.rbs +1 -6
- data/sig/finch-api/models/hris/benefit_list_supported_benefits_params.rbs +1 -6
- data/sig/finch-api/models/hris/benefit_retrieve_params.rbs +1 -6
- data/sig/finch-api/models/hris/benefit_type.rbs +4 -2
- data/sig/finch-api/models/hris/benefit_update_params.rbs +4 -6
- data/sig/finch-api/models/hris/benefits/enrolled_individual.rbs +14 -18
- data/sig/finch-api/models/hris/benefits/individual_benefit.rbs +16 -25
- data/sig/finch-api/models/hris/benefits/individual_enroll_many_params.rbs +35 -54
- data/sig/finch-api/models/hris/benefits/individual_enrolled_ids_params.rbs +1 -6
- data/sig/finch-api/models/hris/benefits/individual_enrolled_ids_response.rbs +4 -6
- data/sig/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rbs +4 -9
- data/sig/finch-api/models/hris/benefits/individual_unenroll_many_params.rbs +4 -9
- data/sig/finch-api/models/hris/benefits/unenrolled_individual.rbs +10 -16
- data/sig/finch-api/models/hris/benefits_support.rbs +14 -18
- data/sig/finch-api/models/hris/benfit_contribution.rbs +0 -1
- data/sig/finch-api/models/hris/company.rbs +39 -57
- data/sig/finch-api/models/hris/company_benefit.rbs +6 -10
- data/sig/finch-api/models/hris/company_retrieve_params.rbs +1 -6
- data/sig/finch-api/models/hris/create_company_benefits_response.rbs +1 -6
- data/sig/finch-api/models/hris/directory_list_individuals_params.rbs +5 -10
- data/sig/finch-api/models/hris/directory_list_params.rbs +5 -10
- data/sig/finch-api/models/hris/document_list_params.rbs +11 -14
- data/sig/finch-api/models/hris/document_list_response.rbs +4 -9
- data/sig/finch-api/models/hris/document_response.rbs +11 -14
- data/sig/finch-api/models/hris/document_retreive_params.rbs +1 -6
- data/sig/finch-api/models/hris/document_retreive_response.rbs +4 -2
- data/sig/finch-api/models/hris/employment_data.rbs +41 -59
- data/sig/finch-api/models/hris/employment_data_response.rbs +5 -10
- data/sig/finch-api/models/hris/employment_retrieve_many_params.rbs +5 -15
- data/sig/finch-api/models/hris/individual.rbs +39 -45
- data/sig/finch-api/models/hris/individual_in_directory.rbs +11 -26
- data/sig/finch-api/models/hris/individual_response.rbs +5 -10
- data/sig/finch-api/models/hris/individual_retrieve_many_params.rbs +7 -22
- data/sig/finch-api/models/hris/pay_statement.rbs +75 -131
- data/sig/finch-api/models/hris/pay_statement_response.rbs +5 -10
- data/sig/finch-api/models/hris/pay_statement_response_body.rbs +4 -9
- data/sig/finch-api/models/hris/pay_statement_retrieve_many_params.rbs +9 -15
- data/sig/finch-api/models/hris/payment.rbs +19 -26
- data/sig/finch-api/models/hris/payment_list_params.rbs +5 -10
- data/sig/finch-api/models/hris/support_per_benefit_type.rbs +4 -9
- data/sig/finch-api/models/hris/supported_benefit.rbs +22 -21
- data/sig/finch-api/models/hris/update_company_benefit_response.rbs +1 -6
- data/sig/finch-api/models/hris/w42005.rbs +26 -30
- data/sig/finch-api/models/hris/w42020.rbs +23 -25
- data/sig/finch-api/models/income.rbs +10 -10
- data/sig/finch-api/models/individual_event.rbs +13 -19
- data/sig/finch-api/models/introspection.rbs +43 -54
- data/sig/finch-api/models/job_completion_event.rbs +13 -20
- data/sig/finch-api/models/jobs/automated_async_job.rbs +20 -26
- data/sig/finch-api/models/jobs/automated_create_params.rbs +10 -18
- data/sig/finch-api/models/jobs/automated_create_response.rbs +6 -11
- data/sig/finch-api/models/jobs/automated_list_params.rbs +5 -10
- data/sig/finch-api/models/jobs/automated_list_response.rbs +82 -0
- data/sig/finch-api/models/jobs/automated_retrieve_params.rbs +1 -6
- data/sig/finch-api/models/jobs/manual_async_job.rbs +9 -11
- data/sig/finch-api/models/jobs/manual_retrieve_params.rbs +1 -6
- data/sig/finch-api/models/location.rbs +10 -12
- data/sig/finch-api/models/money.rbs +1 -3
- data/sig/finch-api/models/operation_support.rbs +4 -2
- data/sig/finch-api/models/operation_support_matrix.rbs +6 -10
- data/sig/finch-api/models/paging.rbs +1 -3
- data/sig/finch-api/models/pay_statement_event.rbs +13 -20
- data/sig/finch-api/models/payment_event.rbs +13 -17
- data/sig/finch-api/models/payroll/pay_group_list_params.rbs +5 -10
- data/sig/finch-api/models/payroll/pay_group_list_response.rbs +9 -12
- data/sig/finch-api/models/payroll/pay_group_retrieve_params.rbs +1 -6
- data/sig/finch-api/models/payroll/pay_group_retrieve_response.rbs +10 -13
- data/sig/finch-api/models/provider.rbs +200 -347
- data/sig/finch-api/models/provider_list_params.rbs +1 -5
- data/sig/finch-api/models/request_forwarding_forward_params.rbs +8 -13
- data/sig/finch-api/models/request_forwarding_forward_response.rbs +13 -23
- data/sig/finch-api/models/sandbox/company_update_params.rbs +39 -58
- data/sig/finch-api/models/sandbox/company_update_response.rbs +38 -57
- data/sig/finch-api/models/sandbox/connection_create_params.rbs +11 -14
- data/sig/finch-api/models/sandbox/connection_create_response.rbs +14 -17
- data/sig/finch-api/models/sandbox/connections/account_create_params.rbs +11 -14
- data/sig/finch-api/models/sandbox/connections/account_create_response.rbs +13 -16
- data/sig/finch-api/models/sandbox/connections/account_update_params.rbs +4 -9
- data/sig/finch-api/models/sandbox/connections/account_update_response.rbs +12 -15
- data/sig/finch-api/models/sandbox/directory_create_params.rbs +76 -102
- data/sig/finch-api/models/sandbox/employment_update_params.rbs +40 -59
- data/sig/finch-api/models/sandbox/employment_update_response.rbs +40 -59
- data/sig/finch-api/models/sandbox/individual_update_params.rbs +39 -46
- data/sig/finch-api/models/sandbox/individual_update_response.rbs +39 -46
- data/sig/finch-api/models/sandbox/job_create_params.rbs +8 -11
- data/sig/finch-api/models/sandbox/job_create_response.rbs +6 -11
- data/sig/finch-api/models/sandbox/jobs/configuration_retrieve_params.rbs +1 -6
- data/sig/finch-api/models/sandbox/jobs/configuration_update_params.rbs +1 -6
- data/sig/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbs +12 -13
- data/sig/finch-api/models/sandbox/payment_create_params.rbs +81 -143
- data/sig/finch-api/models/sandbox/payment_create_response.rbs +1 -6
- data/sig/finch-api/models/webhook_event.rbs +5 -3
- data/sig/finch-api/page.rbs +2 -7
- data/sig/finch-api/pooled_net_requester.rbs +13 -4
- data/sig/finch-api/request_options.rbs +6 -2
- data/sig/finch-api/resources/access_tokens.rbs +7 -11
- data/sig/finch-api/resources/account.rbs +6 -16
- data/sig/finch-api/resources/connect/sessions.rbs +19 -29
- data/sig/finch-api/resources/hris/benefits/individuals.rbs +19 -43
- data/sig/finch-api/resources/hris/benefits.rbs +21 -48
- data/sig/finch-api/resources/hris/company.rbs +3 -8
- data/sig/finch-api/resources/hris/directory.rbs +6 -20
- data/sig/finch-api/resources/hris/documents.rbs +11 -22
- data/sig/finch-api/resources/hris/employments.rbs +4 -9
- data/sig/finch-api/resources/hris/individuals.rbs +5 -10
- data/sig/finch-api/resources/hris/pay_statements.rbs +4 -9
- data/sig/finch-api/resources/hris/payments.rbs +5 -10
- data/sig/finch-api/resources/jobs/automated.rbs +14 -30
- data/sig/finch-api/resources/jobs/manual.rbs +4 -10
- data/sig/finch-api/resources/payroll/pay_groups.rbs +9 -20
- data/sig/finch-api/resources/providers.rbs +3 -7
- data/sig/finch-api/resources/request_forwarding.rbs +8 -13
- data/sig/finch-api/resources/sandbox/company.rbs +11 -16
- data/sig/finch-api/resources/sandbox/connections/accounts.rbs +11 -21
- data/sig/finch-api/resources/sandbox/connections.rbs +7 -12
- data/sig/finch-api/resources/sandbox/directory.rbs +4 -9
- data/sig/finch-api/resources/sandbox/employment.rbs +22 -28
- data/sig/finch-api/resources/sandbox/individual.rbs +16 -22
- data/sig/finch-api/resources/sandbox/jobs/configuration.rbs +8 -18
- data/sig/finch-api/resources/sandbox/jobs.rbs +4 -9
- data/sig/finch-api/resources/sandbox/payment.rbs +6 -11
- data/sig/finch-api/responses_page.rbs +2 -7
- data/sig/finch-api/single_page.rbs +2 -7
- data/sig/finch-api/util.rbs +37 -12
- data/sig/finch-api/version.rbs +1 -1
- metadata +7 -4
@@ -8,42 +8,38 @@ module FinchAPI
|
|
8
8
|
include FinchAPI::RequestParameters
|
9
9
|
|
10
10
|
sig { returns(T.nilable(String)) }
|
11
|
-
|
12
|
-
end
|
11
|
+
attr_reader :end_date
|
13
12
|
|
14
|
-
sig { params(
|
15
|
-
|
16
|
-
end
|
13
|
+
sig { params(end_date: String).void }
|
14
|
+
attr_writer :end_date
|
17
15
|
|
18
16
|
sig { returns(T.nilable(T::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement])) }
|
19
|
-
|
20
|
-
end
|
17
|
+
attr_reader :pay_statements
|
21
18
|
|
22
19
|
sig do
|
23
|
-
params(
|
24
|
-
|
25
|
-
|
26
|
-
|
20
|
+
params(
|
21
|
+
pay_statements: T::Array[T.any(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement, FinchAPI::Util::AnyHash)]
|
22
|
+
)
|
23
|
+
.void
|
27
24
|
end
|
25
|
+
attr_writer :pay_statements
|
28
26
|
|
29
27
|
sig { returns(T.nilable(String)) }
|
30
|
-
|
31
|
-
end
|
28
|
+
attr_reader :start_date
|
32
29
|
|
33
|
-
sig { params(
|
34
|
-
|
35
|
-
end
|
30
|
+
sig { params(start_date: String).void }
|
31
|
+
attr_writer :start_date
|
36
32
|
|
37
33
|
sig do
|
38
34
|
params(
|
39
35
|
end_date: String,
|
40
|
-
pay_statements: T::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement],
|
36
|
+
pay_statements: T::Array[T.any(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement, FinchAPI::Util::AnyHash)],
|
41
37
|
start_date: String,
|
42
|
-
request_options: T.any(FinchAPI::RequestOptions,
|
38
|
+
request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)
|
43
39
|
)
|
44
|
-
.
|
40
|
+
.returns(T.attached_class)
|
45
41
|
end
|
46
|
-
def
|
42
|
+
def self.new(end_date: nil, pay_statements: nil, start_date: nil, request_options: {})
|
47
43
|
end
|
48
44
|
|
49
45
|
sig do
|
@@ -61,25 +57,15 @@ module FinchAPI
|
|
61
57
|
end
|
62
58
|
|
63
59
|
class PayStatement < FinchAPI::BaseModel
|
60
|
+
# The array of earnings objects associated with this pay statement
|
64
61
|
sig do
|
65
62
|
returns(
|
66
63
|
T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning)])
|
67
64
|
)
|
68
65
|
end
|
69
|
-
|
70
|
-
end
|
71
|
-
|
72
|
-
sig do
|
73
|
-
params(
|
74
|
-
_: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning)])
|
75
|
-
)
|
76
|
-
.returns(
|
77
|
-
T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning)])
|
78
|
-
)
|
79
|
-
end
|
80
|
-
def earnings=(_)
|
81
|
-
end
|
66
|
+
attr_accessor :earnings
|
82
67
|
|
68
|
+
# The array of deductions objects associated with this pay statement.
|
83
69
|
sig do
|
84
70
|
returns(
|
85
71
|
T.nilable(
|
@@ -87,23 +73,7 @@ module FinchAPI
|
|
87
73
|
)
|
88
74
|
)
|
89
75
|
end
|
90
|
-
|
91
|
-
end
|
92
|
-
|
93
|
-
sig do
|
94
|
-
params(
|
95
|
-
_: T.nilable(
|
96
|
-
T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction)]
|
97
|
-
)
|
98
|
-
)
|
99
|
-
.returns(
|
100
|
-
T.nilable(
|
101
|
-
T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction)]
|
102
|
-
)
|
103
|
-
)
|
104
|
-
end
|
105
|
-
def employee_deductions=(_)
|
106
|
-
end
|
76
|
+
attr_accessor :employee_deductions
|
107
77
|
|
108
78
|
sig do
|
109
79
|
returns(
|
@@ -112,105 +82,89 @@ module FinchAPI
|
|
112
82
|
)
|
113
83
|
)
|
114
84
|
end
|
115
|
-
|
116
|
-
end
|
117
|
-
|
118
|
-
sig do
|
119
|
-
params(
|
120
|
-
_: T.nilable(
|
121
|
-
T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution)]
|
122
|
-
)
|
123
|
-
)
|
124
|
-
.returns(
|
125
|
-
T.nilable(
|
126
|
-
T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution)]
|
127
|
-
)
|
128
|
-
)
|
129
|
-
end
|
130
|
-
def employer_contributions=(_)
|
131
|
-
end
|
85
|
+
attr_accessor :employer_contributions
|
132
86
|
|
133
87
|
sig { returns(T.nilable(FinchAPI::Models::Money)) }
|
134
|
-
|
135
|
-
end
|
88
|
+
attr_reader :gross_pay
|
136
89
|
|
137
|
-
sig { params(
|
138
|
-
|
139
|
-
end
|
90
|
+
sig { params(gross_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))).void }
|
91
|
+
attr_writer :gross_pay
|
140
92
|
|
93
|
+
# A stable Finch `id` (UUID v4) for an individual in the company
|
141
94
|
sig { returns(T.nilable(String)) }
|
142
|
-
|
143
|
-
end
|
95
|
+
attr_reader :individual_id
|
144
96
|
|
145
|
-
sig { params(
|
146
|
-
|
147
|
-
end
|
97
|
+
sig { params(individual_id: String).void }
|
98
|
+
attr_writer :individual_id
|
148
99
|
|
149
100
|
sig { returns(T.nilable(FinchAPI::Models::Money)) }
|
150
|
-
|
151
|
-
end
|
152
|
-
|
153
|
-
sig { params(_: T.nilable(FinchAPI::Models::Money)).returns(T.nilable(FinchAPI::Models::Money)) }
|
154
|
-
def net_pay=(_)
|
155
|
-
end
|
101
|
+
attr_reader :net_pay
|
156
102
|
|
157
|
-
sig {
|
158
|
-
|
159
|
-
end
|
103
|
+
sig { params(net_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))).void }
|
104
|
+
attr_writer :net_pay
|
160
105
|
|
161
|
-
|
162
|
-
|
163
|
-
|
106
|
+
# The payment method.
|
107
|
+
sig { returns(T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::OrSymbol)) }
|
108
|
+
attr_accessor :payment_method
|
164
109
|
|
110
|
+
# The array of taxes objects associated with this pay statement.
|
165
111
|
sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax)])) }
|
166
|
-
|
167
|
-
end
|
168
|
-
|
169
|
-
sig do
|
170
|
-
params(
|
171
|
-
_: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax)])
|
172
|
-
)
|
173
|
-
.returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax)]))
|
174
|
-
end
|
175
|
-
def taxes=(_)
|
176
|
-
end
|
112
|
+
attr_accessor :taxes
|
177
113
|
|
114
|
+
# The number of hours worked for this pay period
|
178
115
|
sig { returns(T.nilable(Float)) }
|
179
|
-
|
180
|
-
end
|
116
|
+
attr_accessor :total_hours
|
181
117
|
|
182
|
-
|
183
|
-
|
184
|
-
|
185
|
-
|
186
|
-
sig { returns(T.nilable(Symbol)) }
|
187
|
-
def type
|
188
|
-
end
|
189
|
-
|
190
|
-
sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
|
191
|
-
def type=(_)
|
192
|
-
end
|
118
|
+
# The type of the payment associated with the pay statement.
|
119
|
+
sig { returns(T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::OrSymbol)) }
|
120
|
+
attr_accessor :type
|
193
121
|
|
194
122
|
sig do
|
195
123
|
params(
|
196
|
-
earnings: T.nilable(
|
124
|
+
earnings: T.nilable(
|
125
|
+
T::Array[
|
126
|
+
T.nilable(
|
127
|
+
T.any(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning, FinchAPI::Util::AnyHash)
|
128
|
+
)
|
129
|
+
]
|
130
|
+
),
|
197
131
|
employee_deductions: T.nilable(
|
198
|
-
T::Array[
|
132
|
+
T::Array[
|
133
|
+
T.nilable(
|
134
|
+
T.any(
|
135
|
+
FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction,
|
136
|
+
FinchAPI::Util::AnyHash
|
137
|
+
)
|
138
|
+
)
|
139
|
+
]
|
199
140
|
),
|
200
141
|
employer_contributions: T.nilable(
|
201
|
-
T::Array[
|
142
|
+
T::Array[
|
143
|
+
T.nilable(
|
144
|
+
T.any(
|
145
|
+
FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution,
|
146
|
+
FinchAPI::Util::AnyHash
|
147
|
+
)
|
148
|
+
)
|
149
|
+
]
|
202
150
|
),
|
203
|
-
gross_pay: T.nilable(FinchAPI::Models::Money),
|
151
|
+
gross_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash)),
|
204
152
|
individual_id: String,
|
205
|
-
net_pay: T.nilable(FinchAPI::Models::Money),
|
206
|
-
payment_method: T.nilable(
|
207
|
-
taxes: T.nilable(
|
153
|
+
net_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash)),
|
154
|
+
payment_method: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::OrSymbol),
|
155
|
+
taxes: T.nilable(
|
156
|
+
T::Array[
|
157
|
+
T.nilable(
|
158
|
+
T.any(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax, FinchAPI::Util::AnyHash)
|
159
|
+
)
|
160
|
+
]
|
161
|
+
),
|
208
162
|
total_hours: T.nilable(Float),
|
209
|
-
type: T.nilable(
|
163
|
+
type: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::OrSymbol)
|
210
164
|
)
|
211
|
-
.
|
165
|
+
.returns(T.attached_class)
|
212
166
|
end
|
213
|
-
def
|
167
|
+
def self.new(
|
214
168
|
earnings: nil,
|
215
169
|
employee_deductions: nil,
|
216
170
|
employer_contributions: nil,
|
@@ -238,10 +192,10 @@ module FinchAPI
|
|
238
192
|
gross_pay: T.nilable(FinchAPI::Models::Money),
|
239
193
|
individual_id: String,
|
240
194
|
net_pay: T.nilable(FinchAPI::Models::Money),
|
241
|
-
payment_method: T.nilable(
|
195
|
+
payment_method: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::OrSymbol),
|
242
196
|
taxes: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax)]),
|
243
197
|
total_hours: T.nilable(Float),
|
244
|
-
type: T.nilable(
|
198
|
+
type: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::OrSymbol)
|
245
199
|
}
|
246
200
|
)
|
247
201
|
end
|
@@ -249,69 +203,60 @@ module FinchAPI
|
|
249
203
|
end
|
250
204
|
|
251
205
|
class Earning < FinchAPI::BaseModel
|
206
|
+
# The earnings amount in cents.
|
252
207
|
sig { returns(T.nilable(Integer)) }
|
253
|
-
|
254
|
-
end
|
255
|
-
|
256
|
-
sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) }
|
257
|
-
def amount=(_)
|
258
|
-
end
|
208
|
+
attr_accessor :amount
|
259
209
|
|
260
210
|
sig { returns(T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes)) }
|
261
|
-
|
262
|
-
end
|
211
|
+
attr_reader :attributes
|
263
212
|
|
264
213
|
sig do
|
265
|
-
params(
|
266
|
-
|
267
|
-
|
268
|
-
|
214
|
+
params(
|
215
|
+
attributes: T.nilable(
|
216
|
+
T.any(
|
217
|
+
FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes,
|
218
|
+
FinchAPI::Util::AnyHash
|
219
|
+
)
|
220
|
+
)
|
221
|
+
)
|
222
|
+
.void
|
269
223
|
end
|
224
|
+
attr_writer :attributes
|
270
225
|
|
226
|
+
# The earnings currency code.
|
271
227
|
sig { returns(T.nilable(String)) }
|
272
|
-
|
273
|
-
end
|
274
|
-
|
275
|
-
sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
|
276
|
-
def currency=(_)
|
277
|
-
end
|
228
|
+
attr_accessor :currency
|
278
229
|
|
230
|
+
# The number of hours associated with this earning. (For salaried employees, this
|
231
|
+
# could be hours per pay period, `0` or `null`, depending on the provider).
|
279
232
|
sig { returns(T.nilable(Float)) }
|
280
|
-
|
281
|
-
end
|
282
|
-
|
283
|
-
sig { params(_: T.nilable(Float)).returns(T.nilable(Float)) }
|
284
|
-
def hours=(_)
|
285
|
-
end
|
233
|
+
attr_accessor :hours
|
286
234
|
|
235
|
+
# The exact name of the deduction from the pay statement.
|
287
236
|
sig { returns(T.nilable(String)) }
|
288
|
-
|
289
|
-
end
|
290
|
-
|
291
|
-
sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
|
292
|
-
def name=(_)
|
293
|
-
end
|
237
|
+
attr_accessor :name
|
294
238
|
|
295
|
-
|
296
|
-
|
297
|
-
|
298
|
-
|
299
|
-
sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
|
300
|
-
def type=(_)
|
301
|
-
end
|
239
|
+
# The type of earning.
|
240
|
+
sig { returns(T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol)) }
|
241
|
+
attr_accessor :type
|
302
242
|
|
303
243
|
sig do
|
304
244
|
params(
|
305
245
|
amount: T.nilable(Integer),
|
306
|
-
attributes: T.nilable(
|
246
|
+
attributes: T.nilable(
|
247
|
+
T.any(
|
248
|
+
FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes,
|
249
|
+
FinchAPI::Util::AnyHash
|
250
|
+
)
|
251
|
+
),
|
307
252
|
currency: T.nilable(String),
|
308
253
|
hours: T.nilable(Float),
|
309
254
|
name: T.nilable(String),
|
310
|
-
type: T.nilable(
|
255
|
+
type: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol)
|
311
256
|
)
|
312
|
-
.
|
257
|
+
.returns(T.attached_class)
|
313
258
|
end
|
314
|
-
def
|
259
|
+
def self.new(amount: nil, attributes: nil, currency: nil, hours: nil, name: nil, type: nil)
|
315
260
|
end
|
316
261
|
|
317
262
|
sig do
|
@@ -323,7 +268,7 @@ module FinchAPI
|
|
323
268
|
currency: T.nilable(String),
|
324
269
|
hours: T.nilable(Float),
|
325
270
|
name: T.nilable(String),
|
326
|
-
type: T.nilable(
|
271
|
+
type: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol)
|
327
272
|
}
|
328
273
|
)
|
329
274
|
end
|
@@ -336,23 +281,29 @@ module FinchAPI
|
|
336
281
|
T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata)
|
337
282
|
)
|
338
283
|
end
|
339
|
-
|
340
|
-
end
|
284
|
+
attr_reader :metadata
|
341
285
|
|
342
286
|
sig do
|
343
|
-
params(
|
344
|
-
.
|
345
|
-
|
346
|
-
|
287
|
+
params(
|
288
|
+
metadata: T.any(
|
289
|
+
FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata,
|
290
|
+
FinchAPI::Util::AnyHash
|
291
|
+
)
|
292
|
+
)
|
293
|
+
.void
|
347
294
|
end
|
295
|
+
attr_writer :metadata
|
348
296
|
|
349
297
|
sig do
|
350
298
|
params(
|
351
|
-
metadata:
|
299
|
+
metadata: T.any(
|
300
|
+
FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata,
|
301
|
+
FinchAPI::Util::AnyHash
|
302
|
+
)
|
352
303
|
)
|
353
|
-
.
|
304
|
+
.returns(T.attached_class)
|
354
305
|
end
|
355
|
-
def
|
306
|
+
def self.new(metadata: nil)
|
356
307
|
end
|
357
308
|
|
358
309
|
sig do
|
@@ -365,16 +316,17 @@ module FinchAPI
|
|
365
316
|
end
|
366
317
|
|
367
318
|
class Metadata < FinchAPI::BaseModel
|
319
|
+
# The metadata to be attached to the entity by existing rules. It is a key-value
|
320
|
+
# pairs where the values can be of any type (string, number, boolean, object,
|
321
|
+
# array, etc.).
|
368
322
|
sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
|
369
|
-
|
370
|
-
end
|
371
|
-
|
372
|
-
sig { params(_: T::Hash[Symbol, T.anything]).returns(T::Hash[Symbol, T.anything]) }
|
373
|
-
def metadata=(_)
|
374
|
-
end
|
323
|
+
attr_reader :metadata
|
375
324
|
|
376
325
|
sig { params(metadata: T::Hash[Symbol, T.anything]).void }
|
377
|
-
|
326
|
+
attr_writer :metadata
|
327
|
+
|
328
|
+
sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) }
|
329
|
+
def self.new(metadata: nil)
|
378
330
|
end
|
379
331
|
|
380
332
|
sig { override.returns({metadata: T::Hash[Symbol, T.anything]}) }
|
@@ -383,101 +335,126 @@ module FinchAPI
|
|
383
335
|
end
|
384
336
|
end
|
385
337
|
|
386
|
-
|
387
|
-
|
338
|
+
# The type of earning.
|
339
|
+
module Type
|
340
|
+
extend FinchAPI::Enum
|
388
341
|
|
389
|
-
|
390
|
-
|
391
|
-
|
392
|
-
|
393
|
-
SEVERANCE = T.let(:severance, T.nilable(Symbol))
|
394
|
-
DOUBLE_OVERTIME = T.let(:double_overtime, T.nilable(Symbol))
|
395
|
-
PTO = T.let(:pto, T.nilable(Symbol))
|
396
|
-
SICK = T.let(:sick, T.nilable(Symbol))
|
397
|
-
BONUS = T.let(:bonus, T.nilable(Symbol))
|
398
|
-
COMMISSION = T.let(:commission, T.nilable(Symbol))
|
399
|
-
TIPS = T.let(:tips, T.nilable(Symbol))
|
400
|
-
NUMBER_1099 = T.let(:"1099", T.nilable(Symbol))
|
401
|
-
OTHER = T.let(:other, T.nilable(Symbol))
|
342
|
+
TaggedSymbol =
|
343
|
+
T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type) }
|
344
|
+
OrSymbol =
|
345
|
+
T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol) }
|
402
346
|
|
403
|
-
|
347
|
+
SALARY =
|
348
|
+
T.let(:salary, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol)
|
349
|
+
WAGE =
|
350
|
+
T.let(:wage, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol)
|
351
|
+
REIMBURSEMENT =
|
352
|
+
T.let(
|
353
|
+
:reimbursement,
|
354
|
+
FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol
|
355
|
+
)
|
356
|
+
OVERTIME =
|
357
|
+
T.let(
|
358
|
+
:overtime,
|
359
|
+
FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol
|
360
|
+
)
|
361
|
+
SEVERANCE =
|
362
|
+
T.let(
|
363
|
+
:severance,
|
364
|
+
FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol
|
365
|
+
)
|
366
|
+
DOUBLE_OVERTIME =
|
367
|
+
T.let(
|
368
|
+
:double_overtime,
|
369
|
+
FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol
|
370
|
+
)
|
371
|
+
PTO =
|
372
|
+
T.let(:pto, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol)
|
373
|
+
SICK =
|
374
|
+
T.let(:sick, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol)
|
375
|
+
BONUS =
|
376
|
+
T.let(:bonus, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol)
|
377
|
+
COMMISSION =
|
378
|
+
T.let(
|
379
|
+
:commission,
|
380
|
+
FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol
|
381
|
+
)
|
382
|
+
TIPS =
|
383
|
+
T.let(:tips, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol)
|
384
|
+
NUMBER_1099 =
|
385
|
+
T.let(:"1099", FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol)
|
386
|
+
OTHER =
|
387
|
+
T.let(:other, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol)
|
388
|
+
|
389
|
+
sig do
|
390
|
+
override
|
391
|
+
.returns(
|
392
|
+
T::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol]
|
393
|
+
)
|
394
|
+
end
|
404
395
|
def self.values
|
405
396
|
end
|
406
397
|
end
|
407
398
|
end
|
408
399
|
|
409
400
|
class EmployeeDeduction < FinchAPI::BaseModel
|
401
|
+
# The deduction amount in cents.
|
410
402
|
sig { returns(T.nilable(Integer)) }
|
411
|
-
|
412
|
-
end
|
413
|
-
|
414
|
-
sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) }
|
415
|
-
def amount=(_)
|
416
|
-
end
|
403
|
+
attr_accessor :amount
|
417
404
|
|
418
405
|
sig do
|
419
406
|
returns(
|
420
407
|
T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes)
|
421
408
|
)
|
422
409
|
end
|
423
|
-
|
424
|
-
end
|
410
|
+
attr_reader :attributes
|
425
411
|
|
426
412
|
sig do
|
427
413
|
params(
|
428
|
-
|
429
|
-
|
430
|
-
|
431
|
-
|
414
|
+
attributes: T.nilable(
|
415
|
+
T.any(
|
416
|
+
FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes,
|
417
|
+
FinchAPI::Util::AnyHash
|
418
|
+
)
|
432
419
|
)
|
420
|
+
)
|
421
|
+
.void
|
433
422
|
end
|
434
|
-
|
435
|
-
end
|
423
|
+
attr_writer :attributes
|
436
424
|
|
425
|
+
# The deduction currency.
|
437
426
|
sig { returns(T.nilable(String)) }
|
438
|
-
|
439
|
-
end
|
440
|
-
|
441
|
-
sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
|
442
|
-
def currency=(_)
|
443
|
-
end
|
427
|
+
attr_accessor :currency
|
444
428
|
|
429
|
+
# The deduction name from the pay statement.
|
445
430
|
sig { returns(T.nilable(String)) }
|
446
|
-
|
447
|
-
end
|
448
|
-
|
449
|
-
sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
|
450
|
-
def name=(_)
|
451
|
-
end
|
431
|
+
attr_accessor :name
|
452
432
|
|
433
|
+
# Boolean indicating if the deduction is pre-tax.
|
453
434
|
sig { returns(T.nilable(T::Boolean)) }
|
454
|
-
|
455
|
-
end
|
456
|
-
|
457
|
-
sig { params(_: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
|
458
|
-
def pre_tax=(_)
|
459
|
-
end
|
435
|
+
attr_accessor :pre_tax
|
460
436
|
|
461
|
-
|
462
|
-
|
463
|
-
|
464
|
-
|
465
|
-
sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
|
466
|
-
def type=(_)
|
467
|
-
end
|
437
|
+
# Type of benefit.
|
438
|
+
sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol)) }
|
439
|
+
attr_accessor :type
|
468
440
|
|
469
441
|
sig do
|
470
442
|
params(
|
471
443
|
amount: T.nilable(Integer),
|
472
|
-
attributes: T.nilable(
|
444
|
+
attributes: T.nilable(
|
445
|
+
T.any(
|
446
|
+
FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes,
|
447
|
+
FinchAPI::Util::AnyHash
|
448
|
+
)
|
449
|
+
),
|
473
450
|
currency: T.nilable(String),
|
474
451
|
name: T.nilable(String),
|
475
452
|
pre_tax: T.nilable(T::Boolean),
|
476
|
-
type: T.nilable(
|
453
|
+
type: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol)
|
477
454
|
)
|
478
|
-
.
|
455
|
+
.returns(T.attached_class)
|
479
456
|
end
|
480
|
-
def
|
457
|
+
def self.new(amount: nil, attributes: nil, currency: nil, name: nil, pre_tax: nil, type: nil)
|
481
458
|
end
|
482
459
|
|
483
460
|
sig do
|
@@ -489,7 +466,7 @@ module FinchAPI
|
|
489
466
|
currency: T.nilable(String),
|
490
467
|
name: T.nilable(String),
|
491
468
|
pre_tax: T.nilable(T::Boolean),
|
492
|
-
type: T.nilable(
|
469
|
+
type: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol)
|
493
470
|
}
|
494
471
|
)
|
495
472
|
end
|
@@ -504,27 +481,29 @@ module FinchAPI
|
|
504
481
|
)
|
505
482
|
)
|
506
483
|
end
|
507
|
-
|
508
|
-
end
|
484
|
+
attr_reader :metadata
|
509
485
|
|
510
486
|
sig do
|
511
487
|
params(
|
512
|
-
|
513
|
-
|
514
|
-
|
515
|
-
FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata
|
488
|
+
metadata: T.any(
|
489
|
+
FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata,
|
490
|
+
FinchAPI::Util::AnyHash
|
516
491
|
)
|
492
|
+
)
|
493
|
+
.void
|
517
494
|
end
|
518
|
-
|
519
|
-
end
|
495
|
+
attr_writer :metadata
|
520
496
|
|
521
497
|
sig do
|
522
498
|
params(
|
523
|
-
metadata:
|
499
|
+
metadata: T.any(
|
500
|
+
FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata,
|
501
|
+
FinchAPI::Util::AnyHash
|
502
|
+
)
|
524
503
|
)
|
525
|
-
.
|
504
|
+
.returns(T.attached_class)
|
526
505
|
end
|
527
|
-
def
|
506
|
+
def self.new(metadata: nil)
|
528
507
|
end
|
529
508
|
|
530
509
|
sig do
|
@@ -539,16 +518,17 @@ module FinchAPI
|
|
539
518
|
end
|
540
519
|
|
541
520
|
class Metadata < FinchAPI::BaseModel
|
521
|
+
# The metadata to be attached to the entity by existing rules. It is a key-value
|
522
|
+
# pairs where the values can be of any type (string, number, boolean, object,
|
523
|
+
# array, etc.).
|
542
524
|
sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
|
543
|
-
|
544
|
-
end
|
545
|
-
|
546
|
-
sig { params(_: T::Hash[Symbol, T.anything]).returns(T::Hash[Symbol, T.anything]) }
|
547
|
-
def metadata=(_)
|
548
|
-
end
|
525
|
+
attr_reader :metadata
|
549
526
|
|
550
527
|
sig { params(metadata: T::Hash[Symbol, T.anything]).void }
|
551
|
-
|
528
|
+
attr_writer :metadata
|
529
|
+
|
530
|
+
sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) }
|
531
|
+
def self.new(metadata: nil)
|
552
532
|
end
|
553
533
|
|
554
534
|
sig { override.returns({metadata: T::Hash[Symbol, T.anything]}) }
|
@@ -559,68 +539,58 @@ module FinchAPI
|
|
559
539
|
end
|
560
540
|
|
561
541
|
class EmployerContribution < FinchAPI::BaseModel
|
542
|
+
# The contribution amount in cents.
|
562
543
|
sig { returns(T.nilable(Integer)) }
|
563
|
-
|
564
|
-
end
|
565
|
-
|
566
|
-
sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) }
|
567
|
-
def amount=(_)
|
568
|
-
end
|
544
|
+
attr_accessor :amount
|
569
545
|
|
570
546
|
sig do
|
571
547
|
returns(
|
572
548
|
T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes)
|
573
549
|
)
|
574
550
|
end
|
575
|
-
|
576
|
-
end
|
551
|
+
attr_reader :attributes
|
577
552
|
|
578
553
|
sig do
|
579
554
|
params(
|
580
|
-
|
581
|
-
|
582
|
-
|
583
|
-
|
555
|
+
attributes: T.nilable(
|
556
|
+
T.any(
|
557
|
+
FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes,
|
558
|
+
FinchAPI::Util::AnyHash
|
559
|
+
)
|
584
560
|
)
|
561
|
+
)
|
562
|
+
.void
|
585
563
|
end
|
586
|
-
|
587
|
-
end
|
564
|
+
attr_writer :attributes
|
588
565
|
|
566
|
+
# The contribution currency.
|
589
567
|
sig { returns(T.nilable(String)) }
|
590
|
-
|
591
|
-
end
|
592
|
-
|
593
|
-
sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
|
594
|
-
def currency=(_)
|
595
|
-
end
|
568
|
+
attr_accessor :currency
|
596
569
|
|
570
|
+
# The contribution name from the pay statement.
|
597
571
|
sig { returns(T.nilable(String)) }
|
598
|
-
|
599
|
-
end
|
572
|
+
attr_accessor :name
|
600
573
|
|
601
|
-
|
602
|
-
|
603
|
-
|
604
|
-
|
605
|
-
sig { returns(T.nilable(Symbol)) }
|
606
|
-
def type
|
607
|
-
end
|
608
|
-
|
609
|
-
sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
|
610
|
-
def type=(_)
|
611
|
-
end
|
574
|
+
# Type of benefit.
|
575
|
+
sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol)) }
|
576
|
+
attr_accessor :type
|
612
577
|
|
613
578
|
sig do
|
614
579
|
params(
|
615
580
|
amount: T.nilable(Integer),
|
616
|
-
attributes: T.nilable(
|
581
|
+
attributes: T.nilable(
|
582
|
+
T.any(
|
583
|
+
FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes,
|
584
|
+
FinchAPI::Util::AnyHash
|
585
|
+
)
|
586
|
+
),
|
617
587
|
currency: T.nilable(String),
|
618
588
|
name: T.nilable(String),
|
619
|
-
type: T.nilable(
|
589
|
+
type: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol)
|
620
590
|
)
|
621
|
-
.
|
591
|
+
.returns(T.attached_class)
|
622
592
|
end
|
623
|
-
def
|
593
|
+
def self.new(amount: nil, attributes: nil, currency: nil, name: nil, type: nil)
|
624
594
|
end
|
625
595
|
|
626
596
|
sig do
|
@@ -631,7 +601,7 @@ module FinchAPI
|
|
631
601
|
attributes: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes),
|
632
602
|
currency: T.nilable(String),
|
633
603
|
name: T.nilable(String),
|
634
|
-
type: T.nilable(
|
604
|
+
type: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol)
|
635
605
|
}
|
636
606
|
)
|
637
607
|
end
|
@@ -646,27 +616,29 @@ module FinchAPI
|
|
646
616
|
)
|
647
617
|
)
|
648
618
|
end
|
649
|
-
|
650
|
-
end
|
619
|
+
attr_reader :metadata
|
651
620
|
|
652
621
|
sig do
|
653
622
|
params(
|
654
|
-
|
655
|
-
|
656
|
-
|
657
|
-
FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata
|
623
|
+
metadata: T.any(
|
624
|
+
FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata,
|
625
|
+
FinchAPI::Util::AnyHash
|
658
626
|
)
|
627
|
+
)
|
628
|
+
.void
|
659
629
|
end
|
660
|
-
|
661
|
-
end
|
630
|
+
attr_writer :metadata
|
662
631
|
|
663
632
|
sig do
|
664
633
|
params(
|
665
|
-
metadata:
|
634
|
+
metadata: T.any(
|
635
|
+
FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata,
|
636
|
+
FinchAPI::Util::AnyHash
|
637
|
+
)
|
666
638
|
)
|
667
|
-
.
|
639
|
+
.returns(T.attached_class)
|
668
640
|
end
|
669
|
-
def
|
641
|
+
def self.new(metadata: nil)
|
670
642
|
end
|
671
643
|
|
672
644
|
sig do
|
@@ -681,16 +653,17 @@ module FinchAPI
|
|
681
653
|
end
|
682
654
|
|
683
655
|
class Metadata < FinchAPI::BaseModel
|
656
|
+
# The metadata to be attached to the entity by existing rules. It is a key-value
|
657
|
+
# pairs where the values can be of any type (string, number, boolean, object,
|
658
|
+
# array, etc.).
|
684
659
|
sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
|
685
|
-
|
686
|
-
end
|
687
|
-
|
688
|
-
sig { params(_: T::Hash[Symbol, T.anything]).returns(T::Hash[Symbol, T.anything]) }
|
689
|
-
def metadata=(_)
|
690
|
-
end
|
660
|
+
attr_reader :metadata
|
691
661
|
|
692
662
|
sig { params(metadata: T::Hash[Symbol, T.anything]).void }
|
693
|
-
|
663
|
+
attr_writer :metadata
|
664
|
+
|
665
|
+
sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) }
|
666
|
+
def self.new(metadata: nil)
|
694
667
|
end
|
695
668
|
|
696
669
|
sig { override.returns({metadata: T::Hash[Symbol, T.anything]}) }
|
@@ -700,81 +673,87 @@ module FinchAPI
|
|
700
673
|
end
|
701
674
|
end
|
702
675
|
|
703
|
-
|
704
|
-
|
676
|
+
# The payment method.
|
677
|
+
module PaymentMethod
|
678
|
+
extend FinchAPI::Enum
|
679
|
+
|
680
|
+
TaggedSymbol =
|
681
|
+
T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod) }
|
682
|
+
OrSymbol =
|
683
|
+
T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::TaggedSymbol) }
|
705
684
|
|
706
|
-
CHECK =
|
707
|
-
|
685
|
+
CHECK =
|
686
|
+
T.let(:check, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::TaggedSymbol)
|
687
|
+
DIRECT_DEPOSIT =
|
688
|
+
T.let(
|
689
|
+
:direct_deposit,
|
690
|
+
FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::TaggedSymbol
|
691
|
+
)
|
708
692
|
|
709
|
-
sig
|
693
|
+
sig do
|
694
|
+
override
|
695
|
+
.returns(
|
696
|
+
T::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::TaggedSymbol]
|
697
|
+
)
|
698
|
+
end
|
710
699
|
def self.values
|
711
700
|
end
|
712
701
|
end
|
713
702
|
|
714
703
|
class Tax < FinchAPI::BaseModel
|
704
|
+
# The tax amount in cents.
|
715
705
|
sig { returns(T.nilable(Integer)) }
|
716
|
-
|
717
|
-
end
|
718
|
-
|
719
|
-
sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) }
|
720
|
-
def amount=(_)
|
721
|
-
end
|
706
|
+
attr_accessor :amount
|
722
707
|
|
723
708
|
sig { returns(T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes)) }
|
724
|
-
|
725
|
-
end
|
709
|
+
attr_reader :attributes
|
726
710
|
|
727
711
|
sig do
|
728
|
-
params(
|
729
|
-
|
730
|
-
|
731
|
-
|
712
|
+
params(
|
713
|
+
attributes: T.nilable(
|
714
|
+
T.any(
|
715
|
+
FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes,
|
716
|
+
FinchAPI::Util::AnyHash
|
717
|
+
)
|
718
|
+
)
|
719
|
+
)
|
720
|
+
.void
|
732
721
|
end
|
722
|
+
attr_writer :attributes
|
733
723
|
|
724
|
+
# The currency code.
|
734
725
|
sig { returns(T.nilable(String)) }
|
735
|
-
|
736
|
-
end
|
737
|
-
|
738
|
-
sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
|
739
|
-
def currency=(_)
|
740
|
-
end
|
726
|
+
attr_accessor :currency
|
741
727
|
|
728
|
+
# `true` if the amount is paid by the employers.
|
742
729
|
sig { returns(T.nilable(T::Boolean)) }
|
743
|
-
|
744
|
-
end
|
745
|
-
|
746
|
-
sig { params(_: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
|
747
|
-
def employer=(_)
|
748
|
-
end
|
730
|
+
attr_accessor :employer
|
749
731
|
|
732
|
+
# The exact name of tax from the pay statement.
|
750
733
|
sig { returns(T.nilable(String)) }
|
751
|
-
|
752
|
-
end
|
753
|
-
|
754
|
-
sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
|
755
|
-
def name=(_)
|
756
|
-
end
|
757
|
-
|
758
|
-
sig { returns(T.nilable(Symbol)) }
|
759
|
-
def type
|
760
|
-
end
|
734
|
+
attr_accessor :name
|
761
735
|
|
762
|
-
|
763
|
-
|
764
|
-
|
736
|
+
# The type of taxes.
|
737
|
+
sig { returns(T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::OrSymbol)) }
|
738
|
+
attr_accessor :type
|
765
739
|
|
766
740
|
sig do
|
767
741
|
params(
|
768
742
|
amount: T.nilable(Integer),
|
769
|
-
attributes: T.nilable(
|
743
|
+
attributes: T.nilable(
|
744
|
+
T.any(
|
745
|
+
FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes,
|
746
|
+
FinchAPI::Util::AnyHash
|
747
|
+
)
|
748
|
+
),
|
770
749
|
currency: T.nilable(String),
|
771
750
|
employer: T.nilable(T::Boolean),
|
772
751
|
name: T.nilable(String),
|
773
|
-
type: T.nilable(
|
752
|
+
type: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::OrSymbol)
|
774
753
|
)
|
775
|
-
.
|
754
|
+
.returns(T.attached_class)
|
776
755
|
end
|
777
|
-
def
|
756
|
+
def self.new(amount: nil, attributes: nil, currency: nil, employer: nil, name: nil, type: nil)
|
778
757
|
end
|
779
758
|
|
780
759
|
sig do
|
@@ -786,7 +765,7 @@ module FinchAPI
|
|
786
765
|
currency: T.nilable(String),
|
787
766
|
employer: T.nilable(T::Boolean),
|
788
767
|
name: T.nilable(String),
|
789
|
-
type: T.nilable(
|
768
|
+
type: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::OrSymbol)
|
790
769
|
}
|
791
770
|
)
|
792
771
|
end
|
@@ -799,21 +778,29 @@ module FinchAPI
|
|
799
778
|
T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata)
|
800
779
|
)
|
801
780
|
end
|
802
|
-
|
803
|
-
end
|
781
|
+
attr_reader :metadata
|
804
782
|
|
805
783
|
sig do
|
806
|
-
params(
|
807
|
-
.
|
808
|
-
|
809
|
-
|
784
|
+
params(
|
785
|
+
metadata: T.any(
|
786
|
+
FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata,
|
787
|
+
FinchAPI::Util::AnyHash
|
788
|
+
)
|
789
|
+
)
|
790
|
+
.void
|
810
791
|
end
|
792
|
+
attr_writer :metadata
|
811
793
|
|
812
794
|
sig do
|
813
|
-
params(
|
814
|
-
.
|
795
|
+
params(
|
796
|
+
metadata: T.any(
|
797
|
+
FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata,
|
798
|
+
FinchAPI::Util::AnyHash
|
799
|
+
)
|
800
|
+
)
|
801
|
+
.returns(T.attached_class)
|
815
802
|
end
|
816
|
-
def
|
803
|
+
def self.new(metadata: nil)
|
817
804
|
end
|
818
805
|
|
819
806
|
sig do
|
@@ -826,16 +813,17 @@ module FinchAPI
|
|
826
813
|
end
|
827
814
|
|
828
815
|
class Metadata < FinchAPI::BaseModel
|
816
|
+
# The metadata to be attached to the entity by existing rules. It is a key-value
|
817
|
+
# pairs where the values can be of any type (string, number, boolean, object,
|
818
|
+
# array, etc.).
|
829
819
|
sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
|
830
|
-
|
831
|
-
end
|
832
|
-
|
833
|
-
sig { params(_: T::Hash[Symbol, T.anything]).returns(T::Hash[Symbol, T.anything]) }
|
834
|
-
def metadata=(_)
|
835
|
-
end
|
820
|
+
attr_reader :metadata
|
836
821
|
|
837
822
|
sig { params(metadata: T::Hash[Symbol, T.anything]).void }
|
838
|
-
|
823
|
+
attr_writer :metadata
|
824
|
+
|
825
|
+
sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) }
|
826
|
+
def self.new(metadata: nil)
|
839
827
|
end
|
840
828
|
|
841
829
|
sig { override.returns({metadata: T::Hash[Symbol, T.anything]}) }
|
@@ -844,28 +832,56 @@ module FinchAPI
|
|
844
832
|
end
|
845
833
|
end
|
846
834
|
|
847
|
-
|
848
|
-
|
835
|
+
# The type of taxes.
|
836
|
+
module Type
|
837
|
+
extend FinchAPI::Enum
|
849
838
|
|
850
|
-
|
851
|
-
|
852
|
-
|
853
|
-
|
839
|
+
TaggedSymbol =
|
840
|
+
T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type) }
|
841
|
+
OrSymbol =
|
842
|
+
T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::TaggedSymbol) }
|
854
843
|
|
855
|
-
|
844
|
+
STATE =
|
845
|
+
T.let(:state, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::TaggedSymbol)
|
846
|
+
FEDERAL =
|
847
|
+
T.let(:federal, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::TaggedSymbol)
|
848
|
+
LOCAL =
|
849
|
+
T.let(:local, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::TaggedSymbol)
|
850
|
+
FICA =
|
851
|
+
T.let(:fica, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::TaggedSymbol)
|
852
|
+
|
853
|
+
sig do
|
854
|
+
override
|
855
|
+
.returns(T::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::TaggedSymbol])
|
856
|
+
end
|
856
857
|
def self.values
|
857
858
|
end
|
858
859
|
end
|
859
860
|
end
|
860
861
|
|
861
|
-
|
862
|
-
|
862
|
+
# The type of the payment associated with the pay statement.
|
863
|
+
module Type
|
864
|
+
extend FinchAPI::Enum
|
863
865
|
|
864
|
-
|
865
|
-
|
866
|
-
|
866
|
+
TaggedSymbol =
|
867
|
+
T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type) }
|
868
|
+
OrSymbol =
|
869
|
+
T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::TaggedSymbol) }
|
870
|
+
|
871
|
+
REGULAR_PAYROLL =
|
872
|
+
T.let(:regular_payroll, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::TaggedSymbol)
|
873
|
+
OFF_CYCLE_PAYROLL =
|
874
|
+
T.let(
|
875
|
+
:off_cycle_payroll,
|
876
|
+
FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::TaggedSymbol
|
877
|
+
)
|
878
|
+
ONE_TIME_PAYMENT =
|
879
|
+
T.let(:one_time_payment, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::TaggedSymbol)
|
867
880
|
|
868
|
-
sig
|
881
|
+
sig do
|
882
|
+
override
|
883
|
+
.returns(T::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::TaggedSymbol])
|
884
|
+
end
|
869
885
|
def self.values
|
870
886
|
end
|
871
887
|
end
|