finch-api 0.1.0.pre.alpha.1
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 +7 -0
- data/README.md +124 -0
- data/lib/finch-api/base_client.rb +464 -0
- data/lib/finch-api/base_model.rb +1188 -0
- data/lib/finch-api/base_page.rb +40 -0
- data/lib/finch-api/client.rb +145 -0
- data/lib/finch-api/errors.rb +188 -0
- data/lib/finch-api/extern.rb +10 -0
- data/lib/finch-api/individuals_page.rb +98 -0
- data/lib/finch-api/models/access_token_create_params.rb +54 -0
- data/lib/finch-api/models/account_disconnect_params.rb +18 -0
- data/lib/finch-api/models/account_introspect_params.rb +18 -0
- data/lib/finch-api/models/account_update_event.rb +1978 -0
- data/lib/finch-api/models/base_webhook_event.rb +41 -0
- data/lib/finch-api/models/company_event.rb +49 -0
- data/lib/finch-api/models/connect/session_new_params.rb +203 -0
- data/lib/finch-api/models/connect/session_new_response.rb +29 -0
- data/lib/finch-api/models/connect/session_reauthenticate_params.rb +90 -0
- data/lib/finch-api/models/connect/session_reauthenticate_response.rb +29 -0
- data/lib/finch-api/models/connection_status_type.rb +40 -0
- data/lib/finch-api/models/create_access_token_response.rb +163 -0
- data/lib/finch-api/models/directory_event.rb +78 -0
- data/lib/finch-api/models/disconnect_response.rb +20 -0
- data/lib/finch-api/models/employment_event.rb +78 -0
- data/lib/finch-api/models/hris/benefit_contribution.rb +54 -0
- data/lib/finch-api/models/hris/benefit_create_params.rb +46 -0
- data/lib/finch-api/models/hris/benefit_features_and_operations.rb +199 -0
- data/lib/finch-api/models/hris/benefit_frequency.rb +33 -0
- data/lib/finch-api/models/hris/benefit_list_params.rb +20 -0
- data/lib/finch-api/models/hris/benefit_list_supported_benefits_params.rb +20 -0
- data/lib/finch-api/models/hris/benefit_retrieve_params.rb +20 -0
- data/lib/finch-api/models/hris/benefit_type.rb +57 -0
- data/lib/finch-api/models/hris/benefit_update_params.rb +31 -0
- data/lib/finch-api/models/hris/benefits/enrolled_individual.rb +108 -0
- data/lib/finch-api/models/hris/benefits/individual_benefit.rb +127 -0
- data/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rb +268 -0
- data/lib/finch-api/models/hris/benefits/individual_enrolled_ids_params.rb +22 -0
- data/lib/finch-api/models/hris/benefits/individual_enrolled_ids_response.rb +29 -0
- data/lib/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rb +34 -0
- data/lib/finch-api/models/hris/benefits/individual_unenroll_many_params.rb +33 -0
- data/lib/finch-api/models/hris/benefits/unenrolled_individual.rb +77 -0
- data/lib/finch-api/models/hris/benefits_support.rb +106 -0
- data/lib/finch-api/models/hris/benfit_contribution.rb +9 -0
- data/lib/finch-api/models/hris/company.rb +290 -0
- data/lib/finch-api/models/hris/company_benefit.rb +40 -0
- data/lib/finch-api/models/hris/company_retrieve_params.rb +20 -0
- data/lib/finch-api/models/hris/create_company_benefits_response.rb +21 -0
- data/lib/finch-api/models/hris/directory_list_individuals_params.rb +42 -0
- data/lib/finch-api/models/hris/directory_list_params.rb +42 -0
- data/lib/finch-api/models/hris/document_list_params.rb +89 -0
- data/lib/finch-api/models/hris/document_list_response.rb +27 -0
- data/lib/finch-api/models/hris/document_response.rb +89 -0
- data/lib/finch-api/models/hris/document_retreive_params.rb +20 -0
- data/lib/finch-api/models/hris/document_retreive_response.rb +41 -0
- data/lib/finch-api/models/hris/employment_data.rb +380 -0
- data/lib/finch-api/models/hris/employment_data_response.rb +45 -0
- data/lib/finch-api/models/hris/employment_retrieve_many_params.rb +45 -0
- data/lib/finch-api/models/hris/individual.rb +290 -0
- data/lib/finch-api/models/hris/individual_in_directory.rb +117 -0
- data/lib/finch-api/models/hris/individual_response.rb +45 -0
- data/lib/finch-api/models/hris/individual_retrieve_many_params.rb +73 -0
- data/lib/finch-api/models/hris/pay_statement.rb +587 -0
- data/lib/finch-api/models/hris/pay_statement_response.rb +45 -0
- data/lib/finch-api/models/hris/pay_statement_response_body.rb +36 -0
- data/lib/finch-api/models/hris/pay_statement_retrieve_many_params.rb +65 -0
- data/lib/finch-api/models/hris/payment.rb +174 -0
- data/lib/finch-api/models/hris/payment_list_params.rb +36 -0
- data/lib/finch-api/models/hris/support_per_benefit_type.rb +35 -0
- data/lib/finch-api/models/hris/supported_benefit.rb +166 -0
- data/lib/finch-api/models/hris/update_company_benefit_response.rb +21 -0
- data/lib/finch-api/models/hris/w42005.rb +188 -0
- data/lib/finch-api/models/hris/w42020.rb +180 -0
- data/lib/finch-api/models/income.rb +87 -0
- data/lib/finch-api/models/individual_event.rb +78 -0
- data/lib/finch-api/models/introspection.rb +342 -0
- data/lib/finch-api/models/job_completion_event.rb +90 -0
- data/lib/finch-api/models/jobs/automated_async_job.rb +162 -0
- data/lib/finch-api/models/jobs/automated_create_params.rb +70 -0
- data/lib/finch-api/models/jobs/automated_create_response.rb +43 -0
- data/lib/finch-api/models/jobs/automated_list_params.rb +42 -0
- data/lib/finch-api/models/jobs/automated_retrieve_params.rb +20 -0
- data/lib/finch-api/models/jobs/manual_async_job.rb +63 -0
- data/lib/finch-api/models/jobs/manual_retrieve_params.rb +20 -0
- data/lib/finch-api/models/location.rb +79 -0
- data/lib/finch-api/models/money.rb +30 -0
- data/lib/finch-api/models/operation_support.rb +42 -0
- data/lib/finch-api/models/operation_support_matrix.rb +81 -0
- data/lib/finch-api/models/paging.rb +35 -0
- data/lib/finch-api/models/pay_statement_event.rb +89 -0
- data/lib/finch-api/models/payment_event.rb +81 -0
- data/lib/finch-api/models/payroll/pay_group_list_params.rb +40 -0
- data/lib/finch-api/models/payroll/pay_group_list_response.rb +87 -0
- data/lib/finch-api/models/payroll/pay_group_retrieve_params.rb +20 -0
- data/lib/finch-api/models/payroll/pay_group_retrieve_response.rb +81 -0
- data/lib/finch-api/models/provider.rb +2039 -0
- data/lib/finch-api/models/provider_list_params.rb +18 -0
- data/lib/finch-api/models/request_forwarding_forward_params.rb +60 -0
- data/lib/finch-api/models/request_forwarding_forward_response.rb +97 -0
- data/lib/finch-api/models/sandbox/company_update_params.rb +294 -0
- data/lib/finch-api/models/sandbox/company_update_response.rb +276 -0
- data/lib/finch-api/models/sandbox/connection_create_params.rb +90 -0
- data/lib/finch-api/models/sandbox/connection_create_response.rb +113 -0
- data/lib/finch-api/models/sandbox/connections/account_create_params.rb +87 -0
- data/lib/finch-api/models/sandbox/connections/account_create_response.rb +93 -0
- data/lib/finch-api/models/sandbox/connections/account_update_params.rb +32 -0
- data/lib/finch-api/models/sandbox/connections/account_update_response.rb +91 -0
- data/lib/finch-api/models/sandbox/directory_create_params.rb +642 -0
- data/lib/finch-api/models/sandbox/directory_create_response.rb +9 -0
- data/lib/finch-api/models/sandbox/employment_update_params.rb +372 -0
- data/lib/finch-api/models/sandbox/employment_update_response.rb +378 -0
- data/lib/finch-api/models/sandbox/individual_update_params.rb +292 -0
- data/lib/finch-api/models/sandbox/individual_update_response.rb +300 -0
- data/lib/finch-api/models/sandbox/job_create_params.rb +49 -0
- data/lib/finch-api/models/sandbox/job_create_response.rb +43 -0
- data/lib/finch-api/models/sandbox/jobs/configuration_retrieve_params.rb +22 -0
- data/lib/finch-api/models/sandbox/jobs/configuration_retrieve_response.rb +11 -0
- data/lib/finch-api/models/sandbox/jobs/configuration_update_params.rb +22 -0
- data/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rb +79 -0
- data/lib/finch-api/models/sandbox/payment_create_params.rb +646 -0
- data/lib/finch-api/models/sandbox/payment_create_response.rb +29 -0
- data/lib/finch-api/models/webhook_event.rb +48 -0
- data/lib/finch-api/page.rb +98 -0
- data/lib/finch-api/pooled_net_requester.rb +175 -0
- data/lib/finch-api/request_options.rb +115 -0
- data/lib/finch-api/resources/access_tokens.rb +40 -0
- data/lib/finch-api/resources/account.rb +47 -0
- data/lib/finch-api/resources/connect/sessions.rb +81 -0
- data/lib/finch-api/resources/connect.rb +17 -0
- data/lib/finch-api/resources/hris/benefits/individuals.rb +112 -0
- data/lib/finch-api/resources/hris/benefits.rb +125 -0
- data/lib/finch-api/resources/hris/company.rb +32 -0
- data/lib/finch-api/resources/hris/directory.rb +65 -0
- data/lib/finch-api/resources/hris/documents.rb +65 -0
- data/lib/finch-api/resources/hris/employments.rb +37 -0
- data/lib/finch-api/resources/hris/individuals.rb +39 -0
- data/lib/finch-api/resources/hris/pay_statements.rb +40 -0
- data/lib/finch-api/resources/hris/payments.rb +41 -0
- data/lib/finch-api/resources/hris.rb +45 -0
- data/lib/finch-api/resources/jobs/automated.rb +96 -0
- data/lib/finch-api/resources/jobs/manual.rb +35 -0
- data/lib/finch-api/resources/jobs.rb +21 -0
- data/lib/finch-api/resources/payroll/pay_groups.rb +58 -0
- data/lib/finch-api/resources/payroll.rb +17 -0
- data/lib/finch-api/resources/providers.rb +31 -0
- data/lib/finch-api/resources/request_forwarding.rb +52 -0
- data/lib/finch-api/resources/sandbox/company.rb +50 -0
- data/lib/finch-api/resources/sandbox/connections/accounts.rb +67 -0
- data/lib/finch-api/resources/sandbox/connections.rb +48 -0
- data/lib/finch-api/resources/sandbox/directory.rb +37 -0
- data/lib/finch-api/resources/sandbox/employment.rb +76 -0
- data/lib/finch-api/resources/sandbox/individual.rb +65 -0
- data/lib/finch-api/resources/sandbox/jobs/configuration.rb +57 -0
- data/lib/finch-api/resources/sandbox/jobs.rb +40 -0
- data/lib/finch-api/resources/sandbox/payment.rb +40 -0
- data/lib/finch-api/resources/sandbox.rb +41 -0
- data/lib/finch-api/resources/webhooks.rb +13 -0
- data/lib/finch-api/responses_page.rb +84 -0
- data/lib/finch-api/single_page.rb +82 -0
- data/lib/finch-api/util.rb +636 -0
- data/lib/finch-api/version.rb +5 -0
- data/lib/finch-api.rb +178 -0
- data/manifest.yaml +13 -0
- data/rbi/lib/finch-api/base_client.rbi +173 -0
- data/rbi/lib/finch-api/base_model.rbi +476 -0
- data/rbi/lib/finch-api/base_page.rbi +39 -0
- data/rbi/lib/finch-api/client.rbi +102 -0
- data/rbi/lib/finch-api/errors.rbi +146 -0
- data/rbi/lib/finch-api/extern.rbi +7 -0
- data/rbi/lib/finch-api/individuals_page.rbi +37 -0
- data/rbi/lib/finch-api/models/access_token_create_params.rbi +70 -0
- data/rbi/lib/finch-api/models/account_disconnect_params.rbi +18 -0
- data/rbi/lib/finch-api/models/account_introspect_params.rbi +18 -0
- data/rbi/lib/finch-api/models/account_update_event.rbi +2479 -0
- data/rbi/lib/finch-api/models/base_webhook_event.rbi +39 -0
- data/rbi/lib/finch-api/models/company_event.rbi +43 -0
- data/rbi/lib/finch-api/models/connect/session_new_params.rbi +203 -0
- data/rbi/lib/finch-api/models/connect/session_new_response.rbi +33 -0
- data/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi +95 -0
- data/rbi/lib/finch-api/models/connect/session_reauthenticate_response.rbi +33 -0
- data/rbi/lib/finch-api/models/connection_status_type.rbi +20 -0
- data/rbi/lib/finch-api/models/create_access_token_response.rbi +159 -0
- data/rbi/lib/finch-api/models/directory_event.rbi +61 -0
- data/rbi/lib/finch-api/models/disconnect_response.rbi +23 -0
- data/rbi/lib/finch-api/models/employment_event.rbi +61 -0
- data/rbi/lib/finch-api/models/hris/benefit_contribution.rbi +44 -0
- data/rbi/lib/finch-api/models/hris/benefit_create_params.rbi +62 -0
- data/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi +190 -0
- data/rbi/lib/finch-api/models/hris/benefit_frequency.rbi +19 -0
- data/rbi/lib/finch-api/models/hris/benefit_list_params.rbi +20 -0
- data/rbi/lib/finch-api/models/hris/benefit_list_supported_benefits_params.rbi +20 -0
- data/rbi/lib/finch-api/models/hris/benefit_retrieve_params.rbi +20 -0
- data/rbi/lib/finch-api/models/hris/benefit_type.rbi +35 -0
- data/rbi/lib/finch-api/models/hris/benefit_update_params.rbi +37 -0
- data/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi +115 -0
- data/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi +153 -0
- data/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi +281 -0
- data/rbi/lib/finch-api/models/hris/benefits/individual_enrolled_ids_params.rbi +22 -0
- data/rbi/lib/finch-api/models/hris/benefits/individual_enrolled_ids_response.rbi +35 -0
- data/rbi/lib/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi +36 -0
- data/rbi/lib/finch-api/models/hris/benefits/individual_unenroll_many_params.rbi +38 -0
- data/rbi/lib/finch-api/models/hris/benefits/unenrolled_individual.rbi +102 -0
- data/rbi/lib/finch-api/models/hris/benefits_support.rbi +196 -0
- data/rbi/lib/finch-api/models/hris/benfit_contribution.rbi +9 -0
- data/rbi/lib/finch-api/models/hris/company.rbi +338 -0
- data/rbi/lib/finch-api/models/hris/company_benefit.rbi +67 -0
- data/rbi/lib/finch-api/models/hris/company_retrieve_params.rbi +20 -0
- data/rbi/lib/finch-api/models/hris/create_company_benefits_response.rbi +25 -0
- data/rbi/lib/finch-api/models/hris/directory_list_individuals_params.rbi +43 -0
- data/rbi/lib/finch-api/models/hris/directory_list_params.rbi +43 -0
- data/rbi/lib/finch-api/models/hris/document_list_params.rbi +83 -0
- data/rbi/lib/finch-api/models/hris/document_list_response.rbi +42 -0
- data/rbi/lib/finch-api/models/hris/document_response.rbi +86 -0
- data/rbi/lib/finch-api/models/hris/document_retreive_params.rbi +20 -0
- data/rbi/lib/finch-api/models/hris/document_retreive_response.rbi +15 -0
- data/rbi/lib/finch-api/models/hris/employment_data.rbi +393 -0
- data/rbi/lib/finch-api/models/hris/employment_data_response.rbi +41 -0
- data/rbi/lib/finch-api/models/hris/employment_retrieve_many_params.rbi +63 -0
- data/rbi/lib/finch-api/models/hris/individual.rbi +281 -0
- data/rbi/lib/finch-api/models/hris/individual_in_directory.rbi +147 -0
- data/rbi/lib/finch-api/models/hris/individual_response.rbi +41 -0
- data/rbi/lib/finch-api/models/hris/individual_retrieve_many_params.rbi +94 -0
- data/rbi/lib/finch-api/models/hris/pay_statement.rbi +691 -0
- data/rbi/lib/finch-api/models/hris/pay_statement_response.rbi +47 -0
- data/rbi/lib/finch-api/models/hris/pay_statement_response_body.rbi +44 -0
- data/rbi/lib/finch-api/models/hris/pay_statement_retrieve_many_params.rbi +79 -0
- data/rbi/lib/finch-api/models/hris/payment.rbi +207 -0
- data/rbi/lib/finch-api/models/hris/payment_list_params.rbi +45 -0
- data/rbi/lib/finch-api/models/hris/support_per_benefit_type.rbi +47 -0
- data/rbi/lib/finch-api/models/hris/supported_benefit.rbi +155 -0
- data/rbi/lib/finch-api/models/hris/update_company_benefit_response.rbi +25 -0
- data/rbi/lib/finch-api/models/hris/w42005.rbi +150 -0
- data/rbi/lib/finch-api/models/hris/w42020.rbi +177 -0
- data/rbi/lib/finch-api/models/income.rbi +83 -0
- data/rbi/lib/finch-api/models/individual_event.rbi +61 -0
- data/rbi/lib/finch-api/models/introspection.rbi +350 -0
- data/rbi/lib/finch-api/models/job_completion_event.rbi +72 -0
- data/rbi/lib/finch-api/models/jobs/automated_async_job.rbi +174 -0
- data/rbi/lib/finch-api/models/jobs/automated_create_params.rbi +83 -0
- data/rbi/lib/finch-api/models/jobs/automated_create_response.rbi +64 -0
- data/rbi/lib/finch-api/models/jobs/automated_list_params.rbi +43 -0
- data/rbi/lib/finch-api/models/jobs/automated_retrieve_params.rbi +20 -0
- data/rbi/lib/finch-api/models/jobs/manual_async_job.rbi +54 -0
- data/rbi/lib/finch-api/models/jobs/manual_retrieve_params.rbi +20 -0
- data/rbi/lib/finch-api/models/location.rbi +114 -0
- data/rbi/lib/finch-api/models/money.rbi +31 -0
- data/rbi/lib/finch-api/models/operation_support.rbi +18 -0
- data/rbi/lib/finch-api/models/operation_support_matrix.rbi +47 -0
- data/rbi/lib/finch-api/models/paging.rbi +31 -0
- data/rbi/lib/finch-api/models/pay_statement_event.rbi +69 -0
- data/rbi/lib/finch-api/models/payment_event.rbi +69 -0
- data/rbi/lib/finch-api/models/payroll/pay_group_list_params.rbi +52 -0
- data/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi +59 -0
- data/rbi/lib/finch-api/models/payroll/pay_group_retrieve_params.rbi +20 -0
- data/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi +82 -0
- data/rbi/lib/finch-api/models/provider.rbi +2369 -0
- data/rbi/lib/finch-api/models/provider_list_params.rbi +18 -0
- data/rbi/lib/finch-api/models/request_forwarding_forward_params.rbi +80 -0
- data/rbi/lib/finch-api/models/request_forwarding_forward_response.rbi +138 -0
- data/rbi/lib/finch-api/models/sandbox/company_update_params.rbi +336 -0
- data/rbi/lib/finch-api/models/sandbox/company_update_response.rbi +330 -0
- data/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi +91 -0
- data/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi +129 -0
- data/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi +93 -0
- data/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi +120 -0
- data/rbi/lib/finch-api/models/sandbox/connections/account_update_params.rbi +36 -0
- data/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi +109 -0
- data/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi +629 -0
- data/rbi/lib/finch-api/models/sandbox/directory_create_response.rbi +9 -0
- data/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi +377 -0
- data/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi +382 -0
- data/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi +276 -0
- data/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi +283 -0
- data/rbi/lib/finch-api/models/sandbox/job_create_params.rbi +46 -0
- data/rbi/lib/finch-api/models/sandbox/job_create_response.rbi +64 -0
- data/rbi/lib/finch-api/models/sandbox/jobs/configuration_retrieve_params.rbi +22 -0
- data/rbi/lib/finch-api/models/sandbox/jobs/configuration_retrieve_response.rbi +11 -0
- data/rbi/lib/finch-api/models/sandbox/jobs/configuration_update_params.rbi +22 -0
- data/rbi/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbi +58 -0
- data/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi +876 -0
- data/rbi/lib/finch-api/models/sandbox/payment_create_response.rbi +33 -0
- data/rbi/lib/finch-api/models/webhook_event.rbi +18 -0
- data/rbi/lib/finch-api/page.rbi +37 -0
- data/rbi/lib/finch-api/pooled_net_requester.rbi +36 -0
- data/rbi/lib/finch-api/request_options.rbi +84 -0
- data/rbi/lib/finch-api/resources/access_tokens.rbi +24 -0
- data/rbi/lib/finch-api/resources/account.rbi +25 -0
- data/rbi/lib/finch-api/resources/connect/sessions.rbi +61 -0
- data/rbi/lib/finch-api/resources/connect.rbi +15 -0
- data/rbi/lib/finch-api/resources/hris/benefits/individuals.rbi +58 -0
- data/rbi/lib/finch-api/resources/hris/benefits.rbi +64 -0
- data/rbi/lib/finch-api/resources/hris/company.rbi +20 -0
- data/rbi/lib/finch-api/resources/hris/directory.rbi +35 -0
- data/rbi/lib/finch-api/resources/hris/documents.rbi +36 -0
- data/rbi/lib/finch-api/resources/hris/employments.rbi +23 -0
- data/rbi/lib/finch-api/resources/hris/individuals.rbi +24 -0
- data/rbi/lib/finch-api/resources/hris/pay_statements.rbi +23 -0
- data/rbi/lib/finch-api/resources/hris/payments.rbi +24 -0
- data/rbi/lib/finch-api/resources/hris.rbi +43 -0
- data/rbi/lib/finch-api/resources/jobs/automated.rbi +45 -0
- data/rbi/lib/finch-api/resources/jobs/manual.rbi +23 -0
- data/rbi/lib/finch-api/resources/jobs.rbi +19 -0
- data/rbi/lib/finch-api/resources/payroll/pay_groups.rbi +34 -0
- data/rbi/lib/finch-api/resources/payroll.rbi +15 -0
- data/rbi/lib/finch-api/resources/providers.rbi +18 -0
- data/rbi/lib/finch-api/resources/request_forwarding.rbi +25 -0
- data/rbi/lib/finch-api/resources/sandbox/company.rbi +40 -0
- data/rbi/lib/finch-api/resources/sandbox/connections/accounts.rbi +38 -0
- data/rbi/lib/finch-api/resources/sandbox/connections.rbi +36 -0
- data/rbi/lib/finch-api/resources/sandbox/directory.rbi +23 -0
- data/rbi/lib/finch-api/resources/sandbox/employment.rbi +62 -0
- data/rbi/lib/finch-api/resources/sandbox/individual.rbi +50 -0
- data/rbi/lib/finch-api/resources/sandbox/jobs/configuration.rbi +33 -0
- data/rbi/lib/finch-api/resources/sandbox/jobs.rbi +27 -0
- data/rbi/lib/finch-api/resources/sandbox/payment.rbi +25 -0
- data/rbi/lib/finch-api/resources/sandbox.rbi +39 -0
- data/rbi/lib/finch-api/resources/webhooks.rbi +11 -0
- data/rbi/lib/finch-api/responses_page.rbi +29 -0
- data/rbi/lib/finch-api/single_page.rbi +33 -0
- data/rbi/lib/finch-api/util.rbi +167 -0
- data/rbi/lib/finch-api/version.rbi +5 -0
- data/sig/finch-api/base_client.rbs +101 -0
- data/sig/finch-api/base_model.rbs +242 -0
- data/sig/finch-api/base_page.rbs +20 -0
- data/sig/finch-api/client.rbs +54 -0
- data/sig/finch-api/errors.rbs +99 -0
- data/sig/finch-api/extern.rbs +4 -0
- data/sig/finch-api/individuals_page.rbs +16 -0
- data/sig/finch-api/models/access_token_create_params.rbs +46 -0
- data/sig/finch-api/models/account_disconnect_params.rbs +19 -0
- data/sig/finch-api/models/account_introspect_params.rbs +19 -0
- data/sig/finch-api/models/account_update_event.rbs +1448 -0
- data/sig/finch-api/models/base_webhook_event.rbs +24 -0
- data/sig/finch-api/models/company_event.rbs +36 -0
- data/sig/finch-api/models/connect/session_new_params.rbs +129 -0
- data/sig/finch-api/models/connect/session_new_response.rbs +22 -0
- data/sig/finch-api/models/connect/session_reauthenticate_params.rbs +65 -0
- data/sig/finch-api/models/connect/session_reauthenticate_response.rbs +23 -0
- data/sig/finch-api/models/connection_status_type.rbs +22 -0
- data/sig/finch-api/models/create_access_token_response.rbs +80 -0
- data/sig/finch-api/models/directory_event.rbs +61 -0
- data/sig/finch-api/models/disconnect_response.rbs +17 -0
- data/sig/finch-api/models/employment_event.rbs +61 -0
- data/sig/finch-api/models/hris/benefit_contribution.rbs +38 -0
- data/sig/finch-api/models/hris/benefit_create_params.rbs +40 -0
- data/sig/finch-api/models/hris/benefit_features_and_operations.rbs +112 -0
- data/sig/finch-api/models/hris/benefit_frequency.rbs +15 -0
- data/sig/finch-api/models/hris/benefit_list_params.rbs +21 -0
- data/sig/finch-api/models/hris/benefit_list_supported_benefits_params.rbs +22 -0
- data/sig/finch-api/models/hris/benefit_retrieve_params.rbs +21 -0
- data/sig/finch-api/models/hris/benefit_type.rbs +50 -0
- data/sig/finch-api/models/hris/benefit_update_params.rbs +26 -0
- data/sig/finch-api/models/hris/benefits/enrolled_individual.rbs +75 -0
- data/sig/finch-api/models/hris/benefits/individual_benefit.rbs +91 -0
- data/sig/finch-api/models/hris/benefits/individual_enroll_many_params.rbs +203 -0
- data/sig/finch-api/models/hris/benefits/individual_enrolled_ids_params.rbs +24 -0
- data/sig/finch-api/models/hris/benefits/individual_enrolled_ids_response.rbs +25 -0
- data/sig/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rbs +31 -0
- data/sig/finch-api/models/hris/benefits/individual_unenroll_many_params.rbs +31 -0
- data/sig/finch-api/models/hris/benefits/unenrolled_individual.rbs +62 -0
- data/sig/finch-api/models/hris/benefits_support.rbs +68 -0
- data/sig/finch-api/models/hris/benfit_contribution.rbs +8 -0
- data/sig/finch-api/models/hris/company.rbs +195 -0
- data/sig/finch-api/models/hris/company_benefit.rbs +36 -0
- data/sig/finch-api/models/hris/company_retrieve_params.rbs +21 -0
- data/sig/finch-api/models/hris/create_company_benefits_response.rbs +20 -0
- data/sig/finch-api/models/hris/directory_list_individuals_params.rbs +34 -0
- data/sig/finch-api/models/hris/directory_list_params.rbs +34 -0
- data/sig/finch-api/models/hris/document_list_params.rbs +61 -0
- data/sig/finch-api/models/hris/document_list_response.rbs +29 -0
- data/sig/finch-api/models/hris/document_response.rbs +58 -0
- data/sig/finch-api/models/hris/document_retreive_params.rbs +21 -0
- data/sig/finch-api/models/hris/document_retreive_response.rbs +12 -0
- data/sig/finch-api/models/hris/employment_data.rbs +228 -0
- data/sig/finch-api/models/hris/employment_data_response.rbs +41 -0
- data/sig/finch-api/models/hris/employment_retrieve_many_params.rbs +45 -0
- data/sig/finch-api/models/hris/individual.rbs +176 -0
- data/sig/finch-api/models/hris/individual_in_directory.rbs +83 -0
- data/sig/finch-api/models/hris/individual_response.rbs +41 -0
- data/sig/finch-api/models/hris/individual_retrieve_many_params.rbs +72 -0
- data/sig/finch-api/models/hris/pay_statement.rbs +445 -0
- data/sig/finch-api/models/hris/pay_statement_response.rbs +41 -0
- data/sig/finch-api/models/hris/pay_statement_response_body.rbs +35 -0
- data/sig/finch-api/models/hris/pay_statement_retrieve_many_params.rbs +53 -0
- data/sig/finch-api/models/hris/payment.rbs +112 -0
- data/sig/finch-api/models/hris/payment_list_params.rbs +30 -0
- data/sig/finch-api/models/hris/support_per_benefit_type.rbs +37 -0
- data/sig/finch-api/models/hris/supported_benefit.rbs +84 -0
- data/sig/finch-api/models/hris/update_company_benefit_response.rbs +20 -0
- data/sig/finch-api/models/hris/w42005.rbs +111 -0
- data/sig/finch-api/models/hris/w42020.rbs +108 -0
- data/sig/finch-api/models/income.rbs +57 -0
- data/sig/finch-api/models/individual_event.rbs +61 -0
- data/sig/finch-api/models/introspection.rbs +204 -0
- data/sig/finch-api/models/job_completion_event.rbs +70 -0
- data/sig/finch-api/models/jobs/automated_async_job.rbs +102 -0
- data/sig/finch-api/models/jobs/automated_create_params.rbs +57 -0
- data/sig/finch-api/models/jobs/automated_create_response.rbs +37 -0
- data/sig/finch-api/models/jobs/automated_list_params.rbs +34 -0
- data/sig/finch-api/models/jobs/automated_retrieve_params.rbs +21 -0
- data/sig/finch-api/models/jobs/manual_async_job.rbs +43 -0
- data/sig/finch-api/models/jobs/manual_retrieve_params.rbs +21 -0
- data/sig/finch-api/models/location.rbs +48 -0
- data/sig/finch-api/models/money.rbs +19 -0
- data/sig/finch-api/models/operation_support.rbs +18 -0
- data/sig/finch-api/models/operation_support_matrix.rbs +50 -0
- data/sig/finch-api/models/paging.rbs +21 -0
- data/sig/finch-api/models/pay_statement_event.rbs +68 -0
- data/sig/finch-api/models/payment_event.rbs +59 -0
- data/sig/finch-api/models/payroll/pay_group_list_params.rbs +35 -0
- data/sig/finch-api/models/payroll/pay_group_list_response.rbs +66 -0
- data/sig/finch-api/models/payroll/pay_group_retrieve_params.rbs +21 -0
- data/sig/finch-api/models/payroll/pay_group_retrieve_response.rbs +62 -0
- data/sig/finch-api/models/provider.rbs +1455 -0
- data/sig/finch-api/models/provider_list_params.rbs +18 -0
- data/sig/finch-api/models/request_forwarding_forward_params.rbs +44 -0
- data/sig/finch-api/models/request_forwarding_forward_response.rbs +71 -0
- data/sig/finch-api/models/sandbox/company_update_params.rbs +197 -0
- data/sig/finch-api/models/sandbox/company_update_response.rbs +192 -0
- data/sig/finch-api/models/sandbox/connection_create_params.rbs +61 -0
- data/sig/finch-api/models/sandbox/connection_create_response.rbs +66 -0
- data/sig/finch-api/models/sandbox/connections/account_create_params.rbs +62 -0
- data/sig/finch-api/models/sandbox/connections/account_create_response.rbs +63 -0
- data/sig/finch-api/models/sandbox/connections/account_update_params.rbs +34 -0
- data/sig/finch-api/models/sandbox/connections/account_update_response.rbs +61 -0
- data/sig/finch-api/models/sandbox/directory_create_params.rbs +392 -0
- data/sig/finch-api/models/sandbox/directory_create_response.rbs +9 -0
- data/sig/finch-api/models/sandbox/employment_update_params.rbs +228 -0
- data/sig/finch-api/models/sandbox/employment_update_response.rbs +229 -0
- data/sig/finch-api/models/sandbox/individual_update_params.rbs +178 -0
- data/sig/finch-api/models/sandbox/individual_update_response.rbs +179 -0
- data/sig/finch-api/models/sandbox/job_create_params.rbs +36 -0
- data/sig/finch-api/models/sandbox/job_create_response.rbs +37 -0
- data/sig/finch-api/models/sandbox/jobs/configuration_retrieve_params.rbs +23 -0
- data/sig/finch-api/models/sandbox/jobs/configuration_retrieve_response.rbs +12 -0
- data/sig/finch-api/models/sandbox/jobs/configuration_update_params.rbs +23 -0
- data/sig/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbs +51 -0
- data/sig/finch-api/models/sandbox/payment_create_params.rbs +487 -0
- data/sig/finch-api/models/sandbox/payment_create_response.rbs +22 -0
- data/sig/finch-api/models/webhook_event.rbs +17 -0
- data/sig/finch-api/page.rbs +16 -0
- data/sig/finch-api/pooled_net_requester.rbs +28 -0
- data/sig/finch-api/request_options.rbs +40 -0
- data/sig/finch-api/resources/access_tokens.rbs +19 -0
- data/sig/finch-api/resources/account.rbs +25 -0
- data/sig/finch-api/resources/connect/sessions.rbs +40 -0
- data/sig/finch-api/resources/connect.rbs +9 -0
- data/sig/finch-api/resources/hris/benefits/individuals.rbs +58 -0
- data/sig/finch-api/resources/hris/benefits.rbs +64 -0
- data/sig/finch-api/resources/hris/company.rbs +18 -0
- data/sig/finch-api/resources/hris/directory.rbs +31 -0
- data/sig/finch-api/resources/hris/documents.rbs +33 -0
- data/sig/finch-api/resources/hris/employments.rbs +19 -0
- data/sig/finch-api/resources/hris/individuals.rbs +20 -0
- data/sig/finch-api/resources/hris/pay_statements.rbs +19 -0
- data/sig/finch-api/resources/hris/payments.rbs +20 -0
- data/sig/finch-api/resources/hris.rbs +23 -0
- data/sig/finch-api/resources/jobs/automated.rbs +42 -0
- data/sig/finch-api/resources/jobs/manual.rbs +20 -0
- data/sig/finch-api/resources/jobs.rbs +11 -0
- data/sig/finch-api/resources/payroll/pay_groups.rbs +31 -0
- data/sig/finch-api/resources/payroll.rbs +9 -0
- data/sig/finch-api/resources/providers.rbs +15 -0
- data/sig/finch-api/resources/request_forwarding.rbs +21 -0
- data/sig/finch-api/resources/sandbox/company.rbs +26 -0
- data/sig/finch-api/resources/sandbox/connections/accounts.rbs +34 -0
- data/sig/finch-api/resources/sandbox/connections.rbs +24 -0
- data/sig/finch-api/resources/sandbox/directory.rbs +19 -0
- data/sig/finch-api/resources/sandbox/employment.rbs +38 -0
- data/sig/finch-api/resources/sandbox/individual.rbs +32 -0
- data/sig/finch-api/resources/sandbox/jobs/configuration.rbs +31 -0
- data/sig/finch-api/resources/sandbox/jobs.rbs +21 -0
- data/sig/finch-api/resources/sandbox/payment.rbs +21 -0
- data/sig/finch-api/resources/sandbox.rbs +21 -0
- data/sig/finch-api/resources/webhooks.rbs +7 -0
- data/sig/finch-api/responses_page.rbs +14 -0
- data/sig/finch-api/single_page.rbs +18 -0
- data/sig/finch-api/util.rbs +109 -0
- data/sig/finch-api/version.rbs +3 -0
- metadata +536 -0
@@ -0,0 +1,91 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module FinchAPI
|
4
|
+
module Models
|
5
|
+
module Sandbox
|
6
|
+
module Connections
|
7
|
+
class AccountUpdateResponse < FinchAPI::BaseModel
|
8
|
+
# @!attribute account_id
|
9
|
+
# [DEPRECATED] Use `connection_id` to associate a connection with an access token
|
10
|
+
#
|
11
|
+
# @return [String]
|
12
|
+
required :account_id, String
|
13
|
+
|
14
|
+
# @!attribute authentication_type
|
15
|
+
#
|
16
|
+
# @return [Symbol, FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType]
|
17
|
+
required :authentication_type,
|
18
|
+
enum: -> { FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType }
|
19
|
+
|
20
|
+
# @!attribute company_id
|
21
|
+
# [DEPRECATED] Use `connection_id` to associate a connection with an access token
|
22
|
+
#
|
23
|
+
# @return [String]
|
24
|
+
required :company_id, String
|
25
|
+
|
26
|
+
# @!attribute products
|
27
|
+
#
|
28
|
+
# @return [Array<String>]
|
29
|
+
required :products, FinchAPI::ArrayOf[String]
|
30
|
+
|
31
|
+
# @!attribute provider_id
|
32
|
+
# The ID of the provider associated with the `access_token`
|
33
|
+
#
|
34
|
+
# @return [String]
|
35
|
+
required :provider_id, String
|
36
|
+
|
37
|
+
# @!attribute [r] connection_id
|
38
|
+
# The ID of the new connection
|
39
|
+
#
|
40
|
+
# @return [String, nil]
|
41
|
+
optional :connection_id, String
|
42
|
+
|
43
|
+
# @!parse
|
44
|
+
# # @return [String]
|
45
|
+
# attr_writer :connection_id
|
46
|
+
|
47
|
+
# @!parse
|
48
|
+
# # @param account_id [String]
|
49
|
+
# # @param authentication_type [Symbol, FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType]
|
50
|
+
# # @param company_id [String]
|
51
|
+
# # @param products [Array<String>]
|
52
|
+
# # @param provider_id [String]
|
53
|
+
# # @param connection_id [String]
|
54
|
+
# #
|
55
|
+
# def initialize(account_id:, authentication_type:, company_id:, products:, provider_id:, connection_id: nil, **) = super
|
56
|
+
|
57
|
+
# def initialize: (Hash | FinchAPI::BaseModel) -> void
|
58
|
+
|
59
|
+
# @abstract
|
60
|
+
#
|
61
|
+
# @example
|
62
|
+
# ```ruby
|
63
|
+
# case authentication_type
|
64
|
+
# in :credential
|
65
|
+
# # ...
|
66
|
+
# in :api_token
|
67
|
+
# # ...
|
68
|
+
# in :oauth
|
69
|
+
# # ...
|
70
|
+
# in :assisted
|
71
|
+
# # ...
|
72
|
+
# end
|
73
|
+
# ```
|
74
|
+
class AuthenticationType < FinchAPI::Enum
|
75
|
+
CREDENTIAL = :credential
|
76
|
+
API_TOKEN = :api_token
|
77
|
+
OAUTH = :oauth
|
78
|
+
ASSISTED = :assisted
|
79
|
+
|
80
|
+
finalize!
|
81
|
+
|
82
|
+
# @!parse
|
83
|
+
# # @return [Array<Symbol>]
|
84
|
+
# #
|
85
|
+
# def self.values; end
|
86
|
+
end
|
87
|
+
end
|
88
|
+
end
|
89
|
+
end
|
90
|
+
end
|
91
|
+
end
|