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
@@ -4,24 +4,16 @@ module FinchAPI
|
|
4
4
|
module Models
|
5
5
|
module Sandbox
|
6
6
|
class PaymentCreateResponse < FinchAPI::BaseModel
|
7
|
+
# The date of the payment.
|
7
8
|
sig { returns(String) }
|
8
|
-
|
9
|
-
end
|
10
|
-
|
11
|
-
sig { params(_: String).returns(String) }
|
12
|
-
def pay_date=(_)
|
13
|
-
end
|
9
|
+
attr_accessor :pay_date
|
14
10
|
|
11
|
+
# The ID of the payment.
|
15
12
|
sig { returns(String) }
|
16
|
-
|
17
|
-
end
|
18
|
-
|
19
|
-
sig { params(_: String).returns(String) }
|
20
|
-
def payment_id=(_)
|
21
|
-
end
|
13
|
+
attr_accessor :payment_id
|
22
14
|
|
23
|
-
sig { params(pay_date: String, payment_id: String).
|
24
|
-
def
|
15
|
+
sig { params(pay_date: String, payment_id: String).returns(T.attached_class) }
|
16
|
+
def self.new(pay_date:, payment_id:)
|
25
17
|
end
|
26
18
|
|
27
19
|
sig { override.returns({pay_date: String, payment_id: String}) }
|
@@ -2,16 +2,16 @@
|
|
2
2
|
|
3
3
|
module FinchAPI
|
4
4
|
module Models
|
5
|
-
|
6
|
-
|
5
|
+
module WebhookEvent
|
6
|
+
extend FinchAPI::Union
|
7
7
|
|
8
8
|
sig do
|
9
9
|
override
|
10
10
|
.returns(
|
11
|
-
[
|
11
|
+
[FinchAPI::Models::AccountUpdateEvent, FinchAPI::Models::CompanyEvent, FinchAPI::Models::JobCompletionEvent, FinchAPI::Models::DirectoryEvent, FinchAPI::Models::EmploymentEvent, FinchAPI::Models::IndividualEvent, FinchAPI::Models::PaymentEvent, FinchAPI::Models::PayStatementEvent]
|
12
12
|
)
|
13
13
|
end
|
14
|
-
|
14
|
+
def self.variants
|
15
15
|
end
|
16
16
|
end
|
17
17
|
end
|
data/rbi/lib/finch-api/page.rbi
CHANGED
@@ -6,32 +6,14 @@ module FinchAPI
|
|
6
6
|
|
7
7
|
Elem = type_member
|
8
8
|
|
9
|
-
sig { returns(T::Array[Elem]) }
|
10
|
-
|
11
|
-
end
|
12
|
-
|
13
|
-
sig { params(_: T::Array[Elem]).returns(T::Array[Elem]) }
|
14
|
-
def data=(_)
|
15
|
-
end
|
9
|
+
sig { returns(T.nilable(T::Array[Elem])) }
|
10
|
+
attr_accessor :data
|
16
11
|
|
17
12
|
sig { returns(FinchAPI::Models::Paging) }
|
18
|
-
|
19
|
-
end
|
13
|
+
attr_accessor :paging
|
20
14
|
|
21
|
-
sig {
|
22
|
-
def
|
23
|
-
end
|
24
|
-
|
25
|
-
sig do
|
26
|
-
params(
|
27
|
-
client: FinchAPI::BaseClient,
|
28
|
-
req: FinchAPI::BaseClient::RequestComponentsShape,
|
29
|
-
headers: T.any(T::Hash[String, String], Net::HTTPHeader),
|
30
|
-
unwrapped: T::Hash[Symbol, T.anything]
|
31
|
-
)
|
32
|
-
.void
|
33
|
-
end
|
34
|
-
def initialize(client:, req:, headers:, unwrapped:)
|
15
|
+
sig { returns(String) }
|
16
|
+
def inspect
|
35
17
|
end
|
36
18
|
end
|
37
19
|
end
|
@@ -1,36 +1,59 @@
|
|
1
1
|
# typed: strong
|
2
2
|
|
3
3
|
module FinchAPI
|
4
|
+
# @api private
|
4
5
|
class PooledNetRequester
|
5
|
-
RequestShape =
|
6
|
-
|
7
|
-
|
6
|
+
RequestShape =
|
7
|
+
T.type_alias do
|
8
|
+
{
|
9
|
+
method: Symbol,
|
10
|
+
url: URI::Generic,
|
11
|
+
headers: T::Hash[String, String],
|
12
|
+
body: T.anything,
|
13
|
+
deadline: Float
|
14
|
+
}
|
15
|
+
end
|
8
16
|
|
9
|
-
|
10
|
-
|
11
|
-
|
17
|
+
# from the golang stdlib
|
18
|
+
# https://github.com/golang/go/blob/c8eced8580028328fde7c03cbfcb720ce15b2358/src/net/http/transport.go#L49
|
19
|
+
KEEP_ALIVE_TIMEOUT = 30
|
12
20
|
|
13
|
-
|
14
|
-
|
15
|
-
|
21
|
+
class << self
|
22
|
+
# @api private
|
23
|
+
sig { params(url: URI::Generic).returns(Net::HTTP) }
|
24
|
+
def connect(url)
|
25
|
+
end
|
26
|
+
|
27
|
+
# @api private
|
28
|
+
sig { params(conn: Net::HTTP, deadline: Float).void }
|
29
|
+
def calibrate_socket_timeout(conn, deadline)
|
30
|
+
end
|
16
31
|
|
17
|
-
|
18
|
-
|
32
|
+
# @api private
|
33
|
+
sig do
|
34
|
+
params(request: FinchAPI::PooledNetRequester::RequestShape, blk: T.proc.params(arg0: String).void)
|
35
|
+
.returns(Net::HTTPGenericRequest)
|
36
|
+
end
|
37
|
+
def build_request(request, &blk)
|
38
|
+
end
|
19
39
|
end
|
20
40
|
|
21
|
-
|
22
|
-
|
41
|
+
# @api private
|
42
|
+
sig { params(url: URI::Generic, deadline: Float, blk: T.proc.params(arg0: Net::HTTP).void).void }
|
43
|
+
private def with_pool(url, deadline:, &blk)
|
23
44
|
end
|
24
45
|
|
46
|
+
# @api private
|
25
47
|
sig do
|
26
48
|
params(request: FinchAPI::PooledNetRequester::RequestShape)
|
27
|
-
.returns([Net::HTTPResponse, T::Enumerable[String]])
|
49
|
+
.returns([Integer, Net::HTTPResponse, T::Enumerable[String]])
|
28
50
|
end
|
29
51
|
def execute(request)
|
30
52
|
end
|
31
53
|
|
32
|
-
|
33
|
-
|
54
|
+
# @api private
|
55
|
+
sig { params(size: Integer).returns(T.attached_class) }
|
56
|
+
def self.new(size: Etc.nprocessors)
|
34
57
|
end
|
35
58
|
end
|
36
59
|
end
|
@@ -1,84 +1,63 @@
|
|
1
1
|
# typed: strong
|
2
2
|
|
3
3
|
module FinchAPI
|
4
|
+
# @api private
|
4
5
|
module RequestParameters
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
def request_options
|
9
|
-
end
|
10
|
-
|
11
|
-
sig do
|
12
|
-
params(_: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]))
|
13
|
-
.returns(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]))
|
14
|
-
end
|
15
|
-
def request_options=(_)
|
16
|
-
end
|
6
|
+
# Options to specify HTTP behaviour for this request.
|
7
|
+
sig { returns(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) }
|
8
|
+
attr_accessor :request_options
|
17
9
|
|
10
|
+
# @api private
|
18
11
|
module Converter
|
19
|
-
|
12
|
+
# @api private
|
13
|
+
sig { params(params: T.anything).returns([T.anything, FinchAPI::Util::AnyHash]) }
|
20
14
|
def dump_request(params)
|
21
15
|
end
|
22
16
|
end
|
23
17
|
end
|
24
18
|
|
19
|
+
# Specify HTTP behaviour to use for a specific request. These options supplement
|
20
|
+
# or override those provided at the client level.
|
21
|
+
#
|
22
|
+
# When making a request, you can pass an actual {RequestOptions} instance, or
|
23
|
+
# simply pass a Hash with symbol keys matching the attributes on this class.
|
25
24
|
class RequestOptions < FinchAPI::BaseModel
|
25
|
+
# @api private
|
26
26
|
sig { params(opts: T.any(T.self_type, T::Hash[Symbol, T.anything])).void }
|
27
27
|
def self.validate!(opts)
|
28
28
|
end
|
29
29
|
|
30
|
+
# Idempotency key to send with request and all associated retries. Will only be
|
31
|
+
# sent for write requests.
|
30
32
|
sig { returns(T.nilable(String)) }
|
31
|
-
|
32
|
-
end
|
33
|
-
|
34
|
-
sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
|
35
|
-
def idempotency_key=(_)
|
36
|
-
end
|
33
|
+
attr_accessor :idempotency_key
|
37
34
|
|
35
|
+
# Extra query params to send with the request. These are `.merge`’d into any
|
36
|
+
# `query` given at the client level.
|
38
37
|
sig { returns(T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))])) }
|
39
|
-
|
40
|
-
end
|
41
|
-
|
42
|
-
sig do
|
43
|
-
params(_: T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))]))
|
44
|
-
.returns(T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))]))
|
45
|
-
end
|
46
|
-
def extra_query=(_)
|
47
|
-
end
|
38
|
+
attr_accessor :extra_query
|
48
39
|
|
40
|
+
# Extra headers to send with the request. These are `.merged`’d into any
|
41
|
+
# `extra_headers` given at the client level.
|
49
42
|
sig { returns(T.nilable(T::Hash[String, T.nilable(String)])) }
|
50
|
-
|
51
|
-
end
|
52
|
-
|
53
|
-
sig do
|
54
|
-
params(_: T.nilable(T::Hash[String, T.nilable(String)]))
|
55
|
-
.returns(T.nilable(T::Hash[String, T.nilable(String)]))
|
56
|
-
end
|
57
|
-
def extra_headers=(_)
|
58
|
-
end
|
43
|
+
attr_accessor :extra_headers
|
59
44
|
|
60
|
-
|
61
|
-
|
62
|
-
|
63
|
-
|
64
|
-
sig { params(_: T.nilable(T::Hash[Symbol, T.anything])).returns(T.nilable(T::Hash[Symbol, T.anything])) }
|
65
|
-
def extra_body=(_)
|
66
|
-
end
|
45
|
+
# Extra data to send with the request. These are deep merged into any data
|
46
|
+
# generated as part of the normal request.
|
47
|
+
sig { returns(T.nilable(T.anything)) }
|
48
|
+
attr_accessor :extra_body
|
67
49
|
|
50
|
+
# Maximum number of retries to attempt after a failed initial request.
|
68
51
|
sig { returns(T.nilable(Integer)) }
|
69
|
-
|
70
|
-
end
|
71
|
-
|
72
|
-
sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) }
|
73
|
-
def max_retries=(_)
|
74
|
-
end
|
52
|
+
attr_accessor :max_retries
|
75
53
|
|
54
|
+
# Request timeout in seconds.
|
76
55
|
sig { returns(T.nilable(Float)) }
|
77
|
-
|
78
|
-
end
|
56
|
+
attr_accessor :timeout
|
79
57
|
|
80
|
-
|
81
|
-
|
58
|
+
# Returns a new instance of RequestOptions.
|
59
|
+
sig { params(values: FinchAPI::Util::AnyHash).returns(T.attached_class) }
|
60
|
+
def self.new(values = {})
|
82
61
|
end
|
83
62
|
end
|
84
63
|
end
|
@@ -3,21 +3,22 @@
|
|
3
3
|
module FinchAPI
|
4
4
|
module Resources
|
5
5
|
class AccessTokens
|
6
|
+
# Exchange the authorization code for an access token
|
6
7
|
sig do
|
7
8
|
params(
|
8
9
|
code: String,
|
9
10
|
client_id: String,
|
10
11
|
client_secret: String,
|
11
12
|
redirect_uri: String,
|
12
|
-
request_options: T.nilable(T.any(FinchAPI::RequestOptions,
|
13
|
+
request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash))
|
13
14
|
)
|
14
15
|
.returns(FinchAPI::Models::CreateAccessTokenResponse)
|
15
16
|
end
|
16
17
|
def create(code:, client_id: nil, client_secret: nil, redirect_uri: nil, request_options: {})
|
17
18
|
end
|
18
19
|
|
19
|
-
sig { params(client: FinchAPI::Client).
|
20
|
-
def
|
20
|
+
sig { params(client: FinchAPI::Client).returns(T.attached_class) }
|
21
|
+
def self.new(client:)
|
21
22
|
end
|
22
23
|
end
|
23
24
|
end
|
@@ -3,22 +3,24 @@
|
|
3
3
|
module FinchAPI
|
4
4
|
module Resources
|
5
5
|
class Account
|
6
|
+
# Disconnect one or more `access_token`s from your application.
|
6
7
|
sig do
|
7
|
-
params(request_options: T.nilable(T.any(FinchAPI::RequestOptions,
|
8
|
+
params(request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)))
|
8
9
|
.returns(FinchAPI::Models::DisconnectResponse)
|
9
10
|
end
|
10
11
|
def disconnect(request_options: {})
|
11
12
|
end
|
12
13
|
|
14
|
+
# Read account information associated with an `access_token`
|
13
15
|
sig do
|
14
|
-
params(request_options: T.nilable(T.any(FinchAPI::RequestOptions,
|
16
|
+
params(request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)))
|
15
17
|
.returns(FinchAPI::Models::Introspection)
|
16
18
|
end
|
17
19
|
def introspect(request_options: {})
|
18
20
|
end
|
19
21
|
|
20
|
-
sig { params(client: FinchAPI::Client).
|
21
|
-
def
|
22
|
+
sig { params(client: FinchAPI::Client).returns(T.attached_class) }
|
23
|
+
def self.new(client:)
|
22
24
|
end
|
23
25
|
end
|
24
26
|
end
|
@@ -4,18 +4,19 @@ module FinchAPI
|
|
4
4
|
module Resources
|
5
5
|
class Connect
|
6
6
|
class Sessions
|
7
|
+
# Create a new connect session for an employer
|
7
8
|
sig do
|
8
9
|
params(
|
9
10
|
customer_id: String,
|
10
11
|
customer_name: String,
|
11
|
-
products: T::Array[
|
12
|
+
products: T::Array[FinchAPI::Models::Connect::SessionNewParams::Product::OrSymbol],
|
12
13
|
customer_email: T.nilable(String),
|
13
|
-
integration: T.nilable(FinchAPI::Models::Connect::SessionNewParams::Integration),
|
14
|
+
integration: T.nilable(T.any(FinchAPI::Models::Connect::SessionNewParams::Integration, FinchAPI::Util::AnyHash)),
|
14
15
|
manual: T.nilable(T::Boolean),
|
15
16
|
minutes_to_expire: T.nilable(Float),
|
16
17
|
redirect_uri: T.nilable(String),
|
17
|
-
sandbox: T.nilable(
|
18
|
-
request_options: T.nilable(T.any(FinchAPI::RequestOptions,
|
18
|
+
sandbox: T.nilable(FinchAPI::Models::Connect::SessionNewParams::Sandbox::OrSymbol),
|
19
|
+
request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash))
|
19
20
|
)
|
20
21
|
.returns(FinchAPI::Models::Connect::SessionNewResponse)
|
21
22
|
end
|
@@ -26,6 +27,8 @@ module FinchAPI
|
|
26
27
|
customer_email: nil,
|
27
28
|
integration: nil,
|
28
29
|
manual: nil,
|
30
|
+
# The number of minutes until the session expires (defaults to 43,200, which is 30
|
31
|
+
# days)
|
29
32
|
minutes_to_expire: nil,
|
30
33
|
redirect_uri: nil,
|
31
34
|
sandbox: nil,
|
@@ -33,27 +36,33 @@ module FinchAPI
|
|
33
36
|
)
|
34
37
|
end
|
35
38
|
|
39
|
+
# Create a new Connect session for reauthenticating an existing connection
|
36
40
|
sig do
|
37
41
|
params(
|
38
42
|
connection_id: String,
|
39
43
|
minutes_to_expire: T.nilable(Integer),
|
40
|
-
products: T.nilable(T::Array[
|
44
|
+
products: T.nilable(T::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::Product::OrSymbol]),
|
41
45
|
redirect_uri: T.nilable(String),
|
42
|
-
request_options: T.nilable(T.any(FinchAPI::RequestOptions,
|
46
|
+
request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash))
|
43
47
|
)
|
44
48
|
.returns(FinchAPI::Models::Connect::SessionReauthenticateResponse)
|
45
49
|
end
|
46
50
|
def reauthenticate(
|
51
|
+
# The ID of the existing connection to reauthenticate
|
47
52
|
connection_id:,
|
53
|
+
# The number of minutes until the session expires (defaults to 43,200, which is 30
|
54
|
+
# days)
|
48
55
|
minutes_to_expire: nil,
|
56
|
+
# The products to request access to (optional for reauthentication)
|
49
57
|
products: nil,
|
58
|
+
# The URI to redirect to after the Connect flow is completed
|
50
59
|
redirect_uri: nil,
|
51
60
|
request_options: {}
|
52
61
|
)
|
53
62
|
end
|
54
63
|
|
55
|
-
sig { params(client: FinchAPI::Client).
|
56
|
-
def
|
64
|
+
sig { params(client: FinchAPI::Client).returns(T.attached_class) }
|
65
|
+
def self.new(client:)
|
57
66
|
end
|
58
67
|
end
|
59
68
|
end
|
@@ -4,11 +4,10 @@ module FinchAPI
|
|
4
4
|
module Resources
|
5
5
|
class Connect
|
6
6
|
sig { returns(FinchAPI::Resources::Connect::Sessions) }
|
7
|
-
|
8
|
-
end
|
7
|
+
attr_reader :sessions
|
9
8
|
|
10
|
-
sig { params(client: FinchAPI::Client).
|
11
|
-
def
|
9
|
+
sig { params(client: FinchAPI::Client).returns(T.attached_class) }
|
10
|
+
def self.new(client:)
|
12
11
|
end
|
13
12
|
end
|
14
13
|
end
|
@@ -5,51 +5,74 @@ module FinchAPI
|
|
5
5
|
class HRIS
|
6
6
|
class Benefits
|
7
7
|
class Individuals
|
8
|
+
# Enroll an individual into a deduction or contribution. This is an overwrite
|
9
|
+
# operation. If the employee is already enrolled, the enrollment amounts will be
|
10
|
+
# adjusted. Making the same request multiple times will not create new
|
11
|
+
# enrollments, but will continue to set the state of the existing enrollment.
|
8
12
|
sig do
|
9
13
|
params(
|
10
14
|
benefit_id: String,
|
11
|
-
individuals: T::Array[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual],
|
12
|
-
request_options: T.nilable(T.any(FinchAPI::RequestOptions,
|
15
|
+
individuals: T::Array[T.any(FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual, FinchAPI::Util::AnyHash)],
|
16
|
+
request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash))
|
13
17
|
)
|
14
18
|
.returns(FinchAPI::SinglePage[FinchAPI::Models::HRIS::Benefits::EnrolledIndividual])
|
15
19
|
end
|
16
|
-
def enroll_many(
|
20
|
+
def enroll_many(
|
21
|
+
benefit_id,
|
22
|
+
# Array of the individual_id to enroll and a configuration object.
|
23
|
+
individuals: nil,
|
24
|
+
request_options: {}
|
25
|
+
)
|
17
26
|
end
|
18
27
|
|
28
|
+
# Lists individuals currently enrolled in a given deduction.
|
19
29
|
sig do
|
20
30
|
params(
|
21
31
|
benefit_id: String,
|
22
|
-
request_options: T.nilable(T.any(FinchAPI::RequestOptions,
|
32
|
+
request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash))
|
23
33
|
)
|
24
34
|
.returns(FinchAPI::Models::HRIS::Benefits::IndividualEnrolledIDsResponse)
|
25
35
|
end
|
26
36
|
def enrolled_ids(benefit_id, request_options: {})
|
27
37
|
end
|
28
38
|
|
39
|
+
# Get enrollment information for the given individuals.
|
29
40
|
sig do
|
30
41
|
params(
|
31
42
|
benefit_id: String,
|
32
43
|
individual_ids: String,
|
33
|
-
request_options: T.nilable(T.any(FinchAPI::RequestOptions,
|
44
|
+
request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash))
|
34
45
|
)
|
35
46
|
.returns(FinchAPI::SinglePage[FinchAPI::Models::HRIS::Benefits::IndividualBenefit])
|
36
47
|
end
|
37
|
-
def retrieve_many_benefits(
|
48
|
+
def retrieve_many_benefits(
|
49
|
+
benefit_id,
|
50
|
+
# comma-delimited list of stable Finch uuids for each individual. If empty,
|
51
|
+
# defaults to all individuals
|
52
|
+
individual_ids: nil,
|
53
|
+
request_options: {}
|
54
|
+
)
|
38
55
|
end
|
39
56
|
|
57
|
+
# Unenroll individuals from a deduction or contribution
|
40
58
|
sig do
|
41
59
|
params(
|
42
60
|
benefit_id: String,
|
43
61
|
individual_ids: T::Array[String],
|
44
|
-
request_options: T.nilable(T.any(FinchAPI::RequestOptions,
|
62
|
+
request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash))
|
45
63
|
)
|
46
64
|
.returns(FinchAPI::SinglePage[FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual])
|
47
65
|
end
|
48
|
-
def unenroll_many(
|
66
|
+
def unenroll_many(
|
67
|
+
benefit_id,
|
68
|
+
# Array of individual_ids to unenroll.
|
69
|
+
individual_ids: nil,
|
70
|
+
request_options: {}
|
71
|
+
)
|
49
72
|
end
|
50
73
|
|
51
|
-
sig { params(client: FinchAPI::Client).
|
52
|
-
def
|
74
|
+
sig { params(client: FinchAPI::Client).returns(T.attached_class) }
|
75
|
+
def self.new(client:)
|
53
76
|
end
|
54
77
|
end
|
55
78
|
end
|
@@ -5,58 +5,77 @@ module FinchAPI
|
|
5
5
|
class HRIS
|
6
6
|
class Benefits
|
7
7
|
sig { returns(FinchAPI::Resources::HRIS::Benefits::Individuals) }
|
8
|
-
|
9
|
-
end
|
8
|
+
attr_reader :individuals
|
10
9
|
|
10
|
+
# Creates a new company-wide deduction or contribution. Please use the
|
11
|
+
# `/providers` endpoint to view available types for each provider.
|
11
12
|
sig do
|
12
13
|
params(
|
13
14
|
description: String,
|
14
|
-
frequency: T.nilable(
|
15
|
-
type: T.nilable(
|
16
|
-
request_options: T.nilable(T.any(FinchAPI::RequestOptions,
|
15
|
+
frequency: T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol),
|
16
|
+
type: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol),
|
17
|
+
request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash))
|
17
18
|
)
|
18
19
|
.returns(FinchAPI::Models::HRIS::CreateCompanyBenefitsResponse)
|
19
20
|
end
|
20
|
-
def create(
|
21
|
+
def create(
|
22
|
+
# Name of the benefit as it appears in the provider and pay statements. Recommend
|
23
|
+
# limiting this to <30 characters due to limitations in specific providers (e.g.
|
24
|
+
# Justworks).
|
25
|
+
description: nil,
|
26
|
+
frequency: nil,
|
27
|
+
# Type of benefit.
|
28
|
+
type: nil,
|
29
|
+
request_options: {}
|
30
|
+
)
|
21
31
|
end
|
22
32
|
|
33
|
+
# Lists deductions and contributions information for a given item
|
23
34
|
sig do
|
24
35
|
params(
|
25
36
|
benefit_id: String,
|
26
|
-
request_options: T.nilable(T.any(FinchAPI::RequestOptions,
|
37
|
+
request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash))
|
27
38
|
)
|
28
39
|
.returns(FinchAPI::Models::HRIS::CompanyBenefit)
|
29
40
|
end
|
30
41
|
def retrieve(benefit_id, request_options: {})
|
31
42
|
end
|
32
43
|
|
44
|
+
# Updates an existing company-wide deduction or contribution
|
33
45
|
sig do
|
34
46
|
params(
|
35
47
|
benefit_id: String,
|
36
48
|
description: String,
|
37
|
-
request_options: T.nilable(T.any(FinchAPI::RequestOptions,
|
49
|
+
request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash))
|
38
50
|
)
|
39
51
|
.returns(FinchAPI::Models::HRIS::UpdateCompanyBenefitResponse)
|
40
52
|
end
|
41
|
-
def update(
|
53
|
+
def update(
|
54
|
+
benefit_id,
|
55
|
+
# Updated name or description.
|
56
|
+
description: nil,
|
57
|
+
request_options: {}
|
58
|
+
)
|
42
59
|
end
|
43
60
|
|
61
|
+
# List all company-wide deductions and contributions.
|
44
62
|
sig do
|
45
|
-
params(request_options: T.nilable(T.any(FinchAPI::RequestOptions,
|
63
|
+
params(request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)))
|
46
64
|
.returns(FinchAPI::SinglePage[FinchAPI::Models::HRIS::CompanyBenefit])
|
47
65
|
end
|
48
66
|
def list(request_options: {})
|
49
67
|
end
|
50
68
|
|
69
|
+
# Get deductions metadata
|
51
70
|
sig do
|
52
|
-
params(request_options: T.nilable(T.any(FinchAPI::RequestOptions,
|
71
|
+
params(request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)))
|
53
72
|
.returns(FinchAPI::SinglePage[FinchAPI::Models::HRIS::SupportedBenefit])
|
54
73
|
end
|
55
74
|
def list_supported_benefits(request_options: {})
|
56
75
|
end
|
57
76
|
|
58
|
-
sig { params(client: FinchAPI::Client).
|
59
|
-
def
|
77
|
+
sig { params(client: FinchAPI::Client).returns(T.attached_class) }
|
78
|
+
def self.new(client:)
|
60
79
|
end
|
61
80
|
end
|
62
81
|
end
|
@@ -4,15 +4,16 @@ module FinchAPI
|
|
4
4
|
module Resources
|
5
5
|
class HRIS
|
6
6
|
class Company
|
7
|
+
# Read basic company data
|
7
8
|
sig do
|
8
|
-
params(request_options: T.nilable(T.any(FinchAPI::RequestOptions,
|
9
|
+
params(request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)))
|
9
10
|
.returns(FinchAPI::Models::HRIS::HRISCompany)
|
10
11
|
end
|
11
12
|
def retrieve(request_options: {})
|
12
13
|
end
|
13
14
|
|
14
|
-
sig { params(client: FinchAPI::Client).
|
15
|
-
def
|
15
|
+
sig { params(client: FinchAPI::Client).returns(T.attached_class) }
|
16
|
+
def self.new(client:)
|
16
17
|
end
|
17
18
|
end
|
18
19
|
end
|
@@ -4,30 +4,26 @@ module FinchAPI
|
|
4
4
|
module Resources
|
5
5
|
class HRIS
|
6
6
|
class Directory
|
7
|
+
# Read company directory and organization structure
|
7
8
|
sig do
|
8
9
|
params(
|
9
10
|
limit: Integer,
|
10
11
|
offset: Integer,
|
11
|
-
request_options: T.nilable(T.any(FinchAPI::RequestOptions,
|
12
|
+
request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash))
|
12
13
|
)
|
13
14
|
.returns(FinchAPI::IndividualsPage[FinchAPI::Models::HRIS::IndividualInDirectory])
|
14
15
|
end
|
15
|
-
def list(
|
16
|
+
def list(
|
17
|
+
# Number of employees to return (defaults to all)
|
18
|
+
limit: nil,
|
19
|
+
# Index to start from (defaults to 0)
|
20
|
+
offset: nil,
|
21
|
+
request_options: {}
|
22
|
+
)
|
16
23
|
end
|
17
24
|
|
18
|
-
sig
|
19
|
-
|
20
|
-
limit: Integer,
|
21
|
-
offset: Integer,
|
22
|
-
request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]))
|
23
|
-
)
|
24
|
-
.returns(FinchAPI::IndividualsPage[FinchAPI::Models::HRIS::IndividualInDirectory])
|
25
|
-
end
|
26
|
-
def list_individuals(limit: nil, offset: nil, request_options: {})
|
27
|
-
end
|
28
|
-
|
29
|
-
sig { params(client: FinchAPI::Client).void }
|
30
|
-
def initialize(client:)
|
25
|
+
sig { params(client: FinchAPI::Client).returns(T.attached_class) }
|
26
|
+
def self.new(client:)
|
31
27
|
end
|
32
28
|
end
|
33
29
|
end
|