From 41c1dd679e77e2a293321fbdff1d145149c3af5f Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 15 Jul 2026 17:36:59 +0000 Subject: [PATCH 1/2] feat(api): api update --- .stats.yml | 4 +-- lib/finch_api/models/base_webhook_event.rb | 7 ++--- .../models/create_access_token_response.rb | 7 ++--- .../models/hris/benefit_create_params.rb | 5 ++-- .../models/hris/benefit_list_params.rb | 8 ++++-- .../benefit_list_supported_benefits_params.rb | 8 ++++-- .../models/hris/benefit_register_params.rb | 8 ++++-- .../models/hris/benefit_retrieve_params.rb | 8 ++++-- .../models/hris/benefit_update_params.rb | 8 ++++-- .../benefits/individual_enroll_many_params.rb | 8 ++++-- .../individual_enrolled_ids_params.rb | 9 +++++-- ...ndividual_retrieve_many_benefits_params.rb | 5 ++-- .../individual_unenroll_many_params.rb | 9 +++++-- .../models/hris/company_retrieve_params.rb | 8 ++++-- .../hris/directory_list_individuals_params.rb | 8 ++++-- .../models/hris/directory_list_params.rb | 8 ++++-- .../models/hris/document_list_params.rb | 5 ++-- .../models/hris/document_retreive_params.rb | 8 ++++-- .../hris/employment_retrieve_many_params.rb | 8 ++++-- .../hris/individual_retrieve_many_params.rb | 8 ++++-- .../pay_statement_item/rule_create_params.rb | 8 ++++-- .../pay_statement_item/rule_delete_params.rb | 8 ++++-- .../pay_statement_item/rule_list_params.rb | 8 ++++-- .../pay_statement_item/rule_update_params.rb | 8 ++++-- .../hris/pay_statement_item_list_params.rb | 5 ++-- .../pay_statement_retrieve_many_params.rb | 8 ++++-- .../models/hris/payment_list_params.rb | 5 ++-- lib/finch_api/models/introspection.rb | 7 ++--- .../models/payroll/pay_group_list_params.rb | 8 ++++-- .../payroll/pay_group_retrieve_params.rb | 8 ++++-- .../sandbox/connection_create_response.rb | 6 ++--- .../connections/account_create_response.rb | 6 ++--- .../connections/account_update_response.rb | 6 ++--- lib/finch_api/resources/hris/benefits.rb | 27 ++++++++++++++----- .../resources/hris/benefits/individuals.rb | 19 ++++++++++--- lib/finch_api/resources/hris/company.rb | 5 +++- lib/finch_api/resources/hris/directory.rb | 5 +++- lib/finch_api/resources/hris/documents.rb | 7 +++-- lib/finch_api/resources/hris/employments.rb | 5 +++- lib/finch_api/resources/hris/individuals.rb | 5 +++- .../resources/hris/pay_statement_item.rb | 2 +- .../hris/pay_statement_item/rules.rb | 17 +++++++++--- .../resources/hris/pay_statements.rb | 5 +++- lib/finch_api/resources/hris/payments.rb | 2 +- lib/finch_api/resources/payroll/pay_groups.rb | 10 +++++-- rbi/finch_api/models/base_webhook_event.rbi | 6 ++--- .../models/create_access_token_response.rbi | 6 ++--- .../models/hris/benefit_create_params.rbi | 6 +++-- .../models/hris/benefit_list_params.rbi | 6 +++-- ...benefit_list_supported_benefits_params.rbi | 6 +++-- .../models/hris/benefit_register_params.rbi | 6 +++-- .../models/hris/benefit_retrieve_params.rbi | 6 +++-- .../models/hris/benefit_update_params.rbi | 6 +++-- .../individual_enroll_many_params.rbi | 6 +++-- .../individual_enrolled_ids_params.rbi | 6 +++-- ...dividual_retrieve_many_benefits_params.rbi | 6 +++-- .../individual_unenroll_many_params.rbi | 6 +++-- .../models/hris/company_retrieve_params.rbi | 6 +++-- .../directory_list_individuals_params.rbi | 6 +++-- .../models/hris/directory_list_params.rbi | 6 +++-- .../models/hris/document_list_params.rbi | 6 +++-- .../models/hris/document_retreive_params.rbi | 6 +++-- .../hris/employment_retrieve_many_params.rbi | 6 +++-- .../hris/individual_retrieve_many_params.rbi | 6 +++-- .../pay_statement_item/rule_create_params.rbi | 6 +++-- .../pay_statement_item/rule_delete_params.rbi | 6 +++-- .../pay_statement_item/rule_list_params.rbi | 6 +++-- .../pay_statement_item/rule_update_params.rbi | 6 +++-- .../hris/pay_statement_item_list_params.rbi | 6 +++-- .../pay_statement_retrieve_many_params.rbi | 6 +++-- .../models/hris/payment_list_params.rbi | 6 +++-- rbi/finch_api/models/introspection.rbi | 6 ++--- .../models/payroll/pay_group_list_params.rbi | 6 +++-- .../payroll/pay_group_retrieve_params.rbi | 6 +++-- .../sandbox/connection_create_response.rbi | 4 +-- .../connections/account_create_response.rbi | 4 +-- .../connections/account_update_response.rbi | 4 +-- rbi/finch_api/resources/hris/benefits.rbi | 18 ++++++++----- .../resources/hris/benefits/individuals.rbi | 12 ++++++--- rbi/finch_api/resources/hris/company.rbi | 3 ++- rbi/finch_api/resources/hris/directory.rbi | 3 ++- rbi/finch_api/resources/hris/documents.rbi | 6 +++-- rbi/finch_api/resources/hris/employments.rbi | 3 ++- rbi/finch_api/resources/hris/individuals.rbi | 3 ++- .../resources/hris/pay_statement_item.rbi | 3 ++- .../hris/pay_statement_item/rules.rbi | 12 ++++++--- .../resources/hris/pay_statements.rbi | 3 ++- rbi/finch_api/resources/hris/payments.rbi | 3 ++- .../resources/payroll/pay_groups.rbi | 6 +++-- 89 files changed, 407 insertions(+), 201 deletions(-) diff --git a/.stats.yml b/.stats.yml index 6d130acd..0fc8637f 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 48 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch/finch-a6b05e51c46366a54466c2009f5fdde74e0fa40bbcc6568601a4e3342dd16937.yml -openapi_spec_hash: 084797c220144df17d98eb984dd4cba2 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch/finch-166cc05754d8591beda094f4ee6f438f55d5f65d490ab364ea130c5100134375.yml +openapi_spec_hash: 4582a35bbe9fb5404d1e4f804c877fa8 config_hash: 9ae56f40cec7304896138bfad5caf748 diff --git a/lib/finch_api/models/base_webhook_event.rb b/lib/finch_api/models/base_webhook_event.rb index ac6eef04..005f27ff 100644 --- a/lib/finch_api/models/base_webhook_event.rb +++ b/lib/finch_api/models/base_webhook_event.rb @@ -14,10 +14,7 @@ class BaseWebhookEvent < FinchAPI::Internal::Type::BaseModel required :account_id, String # @!attribute company_id - # @deprecated - # - # [DEPRECATED] Unique Finch ID of the company for which data has been updated. Use - # `connection_id` instead to identify the connection associated with this event. + # Unique Finch ID of the company for which data has been updated. # # @return [String] required :company_id, String @@ -40,7 +37,7 @@ class BaseWebhookEvent < FinchAPI::Internal::Type::BaseModel # # @param account_id [String] [DEPRECATED] Unique Finch ID of the employer account used to make this connectio # - # @param company_id [String] [DEPRECATED] Unique Finch ID of the company for which data has been updated. Use + # @param company_id [String] Unique Finch ID of the company for which data has been updated. # # @param connection_id [String] Unique Finch ID of the connection associated with the webhook event. # diff --git a/lib/finch_api/models/create_access_token_response.rb b/lib/finch_api/models/create_access_token_response.rb index 08a07ad8..0ff75f7b 100644 --- a/lib/finch_api/models/create_access_token_response.rb +++ b/lib/finch_api/models/create_access_token_response.rb @@ -65,10 +65,7 @@ class CreateAccessTokenResponse < FinchAPI::Internal::Type::BaseModel optional :account_id, String # @!attribute company_id - # @deprecated - # - # [DEPRECATED] Use `connection_id` to identify the connection instead of this - # company ID + # The Finch UUID of the company associated with the `access_token`. # # @return [String, nil] optional :company_id, String @@ -109,7 +106,7 @@ class CreateAccessTokenResponse < FinchAPI::Internal::Type::BaseModel # # @param account_id [String] [DEPRECATED] Use `connection_id` to identify the connection instead of this acco # - # @param company_id [String] [DEPRECATED] Use `connection_id` to identify the connection instead of this comp + # @param company_id [String] The Finch UUID of the company associated with the `access_token`. # # @param customer_id [String, nil] The ID of your customer you provided to Finch when a connect session was created # diff --git a/lib/finch_api/models/hris/benefit_create_params.rb b/lib/finch_api/models/hris/benefit_create_params.rb index dde19103..4ca4e11e 100644 --- a/lib/finch_api/models/hris/benefit_create_params.rb +++ b/lib/finch_api/models/hris/benefit_create_params.rb @@ -9,7 +9,8 @@ class BenefitCreateParams < FinchAPI::Internal::Type::BaseModel include FinchAPI::Internal::Type::RequestParameters # @!attribute entity_ids - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. # # @return [Array, nil] optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String] @@ -46,7 +47,7 @@ class BenefitCreateParams < FinchAPI::Internal::Type::BaseModel # Some parameter documentations has been truncated, see # {FinchAPI::Models::HRIS::BenefitCreateParams} for more details. # - # @param entity_ids [Array] The entity IDs to specify which entities' data to access. + # @param entity_ids [Array] The entity IDs to specify which entities' data to access. Provide exactly one en # # @param company_contribution [FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution, nil] The company match for this benefit. # diff --git a/lib/finch_api/models/hris/benefit_list_params.rb b/lib/finch_api/models/hris/benefit_list_params.rb index 6cad646a..88800dd4 100644 --- a/lib/finch_api/models/hris/benefit_list_params.rb +++ b/lib/finch_api/models/hris/benefit_list_params.rb @@ -9,13 +9,17 @@ class BenefitListParams < FinchAPI::Internal::Type::BaseModel include FinchAPI::Internal::Type::RequestParameters # @!attribute entity_ids - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. # # @return [Array, nil] optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String] # @!method initialize(entity_ids: nil, request_options: {}) - # @param entity_ids [Array] The entity IDs to specify which entities' data to access. + # Some parameter documentations has been truncated, see + # {FinchAPI::Models::HRIS::BenefitListParams} for more details. + # + # @param entity_ids [Array] The entity IDs to specify which entities' data to access. Provide exactly one en # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}] end diff --git a/lib/finch_api/models/hris/benefit_list_supported_benefits_params.rb b/lib/finch_api/models/hris/benefit_list_supported_benefits_params.rb index e28d9c54..d7bae24b 100644 --- a/lib/finch_api/models/hris/benefit_list_supported_benefits_params.rb +++ b/lib/finch_api/models/hris/benefit_list_supported_benefits_params.rb @@ -9,13 +9,17 @@ class BenefitListSupportedBenefitsParams < FinchAPI::Internal::Type::BaseModel include FinchAPI::Internal::Type::RequestParameters # @!attribute entity_ids - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. # # @return [Array, nil] optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String] # @!method initialize(entity_ids: nil, request_options: {}) - # @param entity_ids [Array] The entity IDs to specify which entities' data to access. + # Some parameter documentations has been truncated, see + # {FinchAPI::Models::HRIS::BenefitListSupportedBenefitsParams} for more details. + # + # @param entity_ids [Array] The entity IDs to specify which entities' data to access. Provide exactly one en # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}] end diff --git a/lib/finch_api/models/hris/benefit_register_params.rb b/lib/finch_api/models/hris/benefit_register_params.rb index 148409a4..424f2289 100644 --- a/lib/finch_api/models/hris/benefit_register_params.rb +++ b/lib/finch_api/models/hris/benefit_register_params.rb @@ -9,7 +9,8 @@ class BenefitRegisterParams < FinchAPI::Internal::Type::BaseModel include FinchAPI::Internal::Type::RequestParameters # @!attribute entity_ids - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. # # @return [Array, nil] optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String] @@ -32,7 +33,10 @@ class BenefitRegisterParams < FinchAPI::Internal::Type::BaseModel optional :type, enum: -> { FinchAPI::HRIS::BenefitType }, nil?: true # @!method initialize(entity_ids: nil, description: nil, frequency: nil, type: nil, request_options: {}) - # @param entity_ids [Array] The entity IDs to specify which entities' data to access. + # Some parameter documentations has been truncated, see + # {FinchAPI::Models::HRIS::BenefitRegisterParams} for more details. + # + # @param entity_ids [Array] The entity IDs to specify which entities' data to access. Provide exactly one en # # @param description [String] # diff --git a/lib/finch_api/models/hris/benefit_retrieve_params.rb b/lib/finch_api/models/hris/benefit_retrieve_params.rb index 516ad2c9..6467210a 100644 --- a/lib/finch_api/models/hris/benefit_retrieve_params.rb +++ b/lib/finch_api/models/hris/benefit_retrieve_params.rb @@ -14,15 +14,19 @@ class BenefitRetrieveParams < FinchAPI::Internal::Type::BaseModel required :benefit_id, String # @!attribute entity_ids - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. # # @return [Array, nil] optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String] # @!method initialize(benefit_id:, entity_ids: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {FinchAPI::Models::HRIS::BenefitRetrieveParams} for more details. + # # @param benefit_id [String] # - # @param entity_ids [Array] The entity IDs to specify which entities' data to access. + # @param entity_ids [Array] The entity IDs to specify which entities' data to access. Provide exactly one en # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}] end diff --git a/lib/finch_api/models/hris/benefit_update_params.rb b/lib/finch_api/models/hris/benefit_update_params.rb index 87570857..1327b599 100644 --- a/lib/finch_api/models/hris/benefit_update_params.rb +++ b/lib/finch_api/models/hris/benefit_update_params.rb @@ -14,7 +14,8 @@ class BenefitUpdateParams < FinchAPI::Internal::Type::BaseModel required :benefit_id, String # @!attribute entity_ids - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. # # @return [Array, nil] optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String] @@ -26,9 +27,12 @@ class BenefitUpdateParams < FinchAPI::Internal::Type::BaseModel optional :description, String # @!method initialize(benefit_id:, entity_ids: nil, description: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {FinchAPI::Models::HRIS::BenefitUpdateParams} for more details. + # # @param benefit_id [String] # - # @param entity_ids [Array] The entity IDs to specify which entities' data to access. + # @param entity_ids [Array] The entity IDs to specify which entities' data to access. Provide exactly one en # # @param description [String] Updated name or description. # diff --git a/lib/finch_api/models/hris/benefits/individual_enroll_many_params.rb b/lib/finch_api/models/hris/benefits/individual_enroll_many_params.rb index 8d09b75b..388feca7 100644 --- a/lib/finch_api/models/hris/benefits/individual_enroll_many_params.rb +++ b/lib/finch_api/models/hris/benefits/individual_enroll_many_params.rb @@ -15,7 +15,8 @@ class IndividualEnrollManyParams < FinchAPI::Internal::Type::BaseModel required :benefit_id, String # @!attribute entity_ids - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. # # @return [Array, nil] optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String] @@ -28,9 +29,12 @@ class IndividualEnrollManyParams < FinchAPI::Internal::Type::BaseModel -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual] } # @!method initialize(benefit_id:, entity_ids: nil, individuals: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams} for more details. + # # @param benefit_id [String] # - # @param entity_ids [Array] The entity IDs to specify which entities' data to access. + # @param entity_ids [Array] The entity IDs to specify which entities' data to access. Provide exactly one en # # @param individuals [Array] Array of the individual_id to enroll and a configuration object. # diff --git a/lib/finch_api/models/hris/benefits/individual_enrolled_ids_params.rb b/lib/finch_api/models/hris/benefits/individual_enrolled_ids_params.rb index 73d88625..77318f2e 100644 --- a/lib/finch_api/models/hris/benefits/individual_enrolled_ids_params.rb +++ b/lib/finch_api/models/hris/benefits/individual_enrolled_ids_params.rb @@ -15,15 +15,20 @@ class IndividualEnrolledIDsParams < FinchAPI::Internal::Type::BaseModel required :benefit_id, String # @!attribute entity_ids - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. # # @return [Array, nil] optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String] # @!method initialize(benefit_id:, entity_ids: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {FinchAPI::Models::HRIS::Benefits::IndividualEnrolledIDsParams} for more + # details. + # # @param benefit_id [String] # - # @param entity_ids [Array] The entity IDs to specify which entities' data to access. + # @param entity_ids [Array] The entity IDs to specify which entities' data to access. Provide exactly one en # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}] end diff --git a/lib/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rb b/lib/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rb index 4fe70543..0b0ded60 100644 --- a/lib/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rb +++ b/lib/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rb @@ -15,7 +15,8 @@ class IndividualRetrieveManyBenefitsParams < FinchAPI::Internal::Type::BaseModel required :benefit_id, String # @!attribute entity_ids - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. # # @return [Array, nil] optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String] @@ -34,7 +35,7 @@ class IndividualRetrieveManyBenefitsParams < FinchAPI::Internal::Type::BaseModel # # @param benefit_id [String] # - # @param entity_ids [Array] The entity IDs to specify which entities' data to access. + # @param entity_ids [Array] The entity IDs to specify which entities' data to access. Provide exactly one en # # @param individual_ids [String] comma-delimited list of stable Finch uuids for each individual. If empty, defaul # diff --git a/lib/finch_api/models/hris/benefits/individual_unenroll_many_params.rb b/lib/finch_api/models/hris/benefits/individual_unenroll_many_params.rb index 11c46653..4deba73e 100644 --- a/lib/finch_api/models/hris/benefits/individual_unenroll_many_params.rb +++ b/lib/finch_api/models/hris/benefits/individual_unenroll_many_params.rb @@ -15,7 +15,8 @@ class IndividualUnenrollManyParams < FinchAPI::Internal::Type::BaseModel required :benefit_id, String # @!attribute entity_ids - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. # # @return [Array, nil] optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String] @@ -27,9 +28,13 @@ class IndividualUnenrollManyParams < FinchAPI::Internal::Type::BaseModel optional :individual_ids, FinchAPI::Internal::Type::ArrayOf[String] # @!method initialize(benefit_id:, entity_ids: nil, individual_ids: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {FinchAPI::Models::HRIS::Benefits::IndividualUnenrollManyParams} for more + # details. + # # @param benefit_id [String] # - # @param entity_ids [Array] The entity IDs to specify which entities' data to access. + # @param entity_ids [Array] The entity IDs to specify which entities' data to access. Provide exactly one en # # @param individual_ids [Array] Array of individual_ids to unenroll. # diff --git a/lib/finch_api/models/hris/company_retrieve_params.rb b/lib/finch_api/models/hris/company_retrieve_params.rb index b2f4523f..9c84e1b2 100644 --- a/lib/finch_api/models/hris/company_retrieve_params.rb +++ b/lib/finch_api/models/hris/company_retrieve_params.rb @@ -9,13 +9,17 @@ class CompanyRetrieveParams < FinchAPI::Internal::Type::BaseModel include FinchAPI::Internal::Type::RequestParameters # @!attribute entity_ids - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. # # @return [Array, nil] optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String] # @!method initialize(entity_ids: nil, request_options: {}) - # @param entity_ids [Array] The entity IDs to specify which entities' data to access. + # Some parameter documentations has been truncated, see + # {FinchAPI::Models::HRIS::CompanyRetrieveParams} for more details. + # + # @param entity_ids [Array] The entity IDs to specify which entities' data to access. Provide exactly one en # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}] end diff --git a/lib/finch_api/models/hris/directory_list_individuals_params.rb b/lib/finch_api/models/hris/directory_list_individuals_params.rb index 946567dc..9408d3b9 100644 --- a/lib/finch_api/models/hris/directory_list_individuals_params.rb +++ b/lib/finch_api/models/hris/directory_list_individuals_params.rb @@ -9,7 +9,8 @@ class DirectoryListIndividualsParams < FinchAPI::Internal::Type::BaseModel include FinchAPI::Internal::Type::RequestParameters # @!attribute entity_ids - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. # # @return [Array, nil] optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String] @@ -27,7 +28,10 @@ class DirectoryListIndividualsParams < FinchAPI::Internal::Type::BaseModel optional :offset, Integer # @!method initialize(entity_ids: nil, limit: nil, offset: nil, request_options: {}) - # @param entity_ids [Array] The entity IDs to specify which entities' data to access. + # Some parameter documentations has been truncated, see + # {FinchAPI::Models::HRIS::DirectoryListIndividualsParams} for more details. + # + # @param entity_ids [Array] The entity IDs to specify which entities' data to access. Provide exactly one en # # @param limit [Integer] Number of employees to return (defaults to 100, maximum 10000) # diff --git a/lib/finch_api/models/hris/directory_list_params.rb b/lib/finch_api/models/hris/directory_list_params.rb index 5f85aca0..3d7a7b9c 100644 --- a/lib/finch_api/models/hris/directory_list_params.rb +++ b/lib/finch_api/models/hris/directory_list_params.rb @@ -9,7 +9,8 @@ class DirectoryListParams < FinchAPI::Internal::Type::BaseModel include FinchAPI::Internal::Type::RequestParameters # @!attribute entity_ids - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. # # @return [Array, nil] optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String] @@ -27,7 +28,10 @@ class DirectoryListParams < FinchAPI::Internal::Type::BaseModel optional :offset, Integer # @!method initialize(entity_ids: nil, limit: nil, offset: nil, request_options: {}) - # @param entity_ids [Array] The entity IDs to specify which entities' data to access. + # Some parameter documentations has been truncated, see + # {FinchAPI::Models::HRIS::DirectoryListParams} for more details. + # + # @param entity_ids [Array] The entity IDs to specify which entities' data to access. Provide exactly one en # # @param limit [Integer] Number of employees to return (defaults to 100, maximum 10000) # diff --git a/lib/finch_api/models/hris/document_list_params.rb b/lib/finch_api/models/hris/document_list_params.rb index 5f1d264d..7a4d8947 100644 --- a/lib/finch_api/models/hris/document_list_params.rb +++ b/lib/finch_api/models/hris/document_list_params.rb @@ -9,7 +9,8 @@ class DocumentListParams < FinchAPI::Internal::Type::BaseModel include FinchAPI::Internal::Type::RequestParameters # @!attribute entity_ids - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. # # @return [Array, nil] optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String] @@ -44,7 +45,7 @@ class DocumentListParams < FinchAPI::Internal::Type::BaseModel # Some parameter documentations has been truncated, see # {FinchAPI::Models::HRIS::DocumentListParams} for more details. # - # @param entity_ids [Array] The entity IDs to specify which entities' data to access. + # @param entity_ids [Array] The entity IDs to specify which entities' data to access. Provide exactly one en # # @param individual_ids [Array] Comma-delimited list of stable Finch uuids for each individual. If empty, defaul # diff --git a/lib/finch_api/models/hris/document_retreive_params.rb b/lib/finch_api/models/hris/document_retreive_params.rb index 930d91eb..a781fcf2 100644 --- a/lib/finch_api/models/hris/document_retreive_params.rb +++ b/lib/finch_api/models/hris/document_retreive_params.rb @@ -14,15 +14,19 @@ class DocumentRetreiveParams < FinchAPI::Internal::Type::BaseModel required :document_id, String # @!attribute entity_ids - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. # # @return [Array, nil] optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String] # @!method initialize(document_id:, entity_ids: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {FinchAPI::Models::HRIS::DocumentRetreiveParams} for more details. + # # @param document_id [String] # - # @param entity_ids [Array] The entity IDs to specify which entities' data to access. + # @param entity_ids [Array] The entity IDs to specify which entities' data to access. Provide exactly one en # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}] end diff --git a/lib/finch_api/models/hris/employment_retrieve_many_params.rb b/lib/finch_api/models/hris/employment_retrieve_many_params.rb index d52eaf07..ed79e43c 100644 --- a/lib/finch_api/models/hris/employment_retrieve_many_params.rb +++ b/lib/finch_api/models/hris/employment_retrieve_many_params.rb @@ -16,15 +16,19 @@ class EmploymentRetrieveManyParams < FinchAPI::Internal::Type::BaseModel -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::EmploymentRetrieveManyParams::Request] } # @!attribute entity_ids - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. # # @return [Array, nil] optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String] # @!method initialize(requests:, entity_ids: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {FinchAPI::Models::HRIS::EmploymentRetrieveManyParams} for more details. + # # @param requests [Array] The array of batch requests. Maximum 10000 items per request. # - # @param entity_ids [Array] The entity IDs to specify which entities' data to access. + # @param entity_ids [Array] The entity IDs to specify which entities' data to access. Provide exactly one en # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}] diff --git a/lib/finch_api/models/hris/individual_retrieve_many_params.rb b/lib/finch_api/models/hris/individual_retrieve_many_params.rb index 3d11e454..db061498 100644 --- a/lib/finch_api/models/hris/individual_retrieve_many_params.rb +++ b/lib/finch_api/models/hris/individual_retrieve_many_params.rb @@ -16,7 +16,8 @@ class IndividualRetrieveManyParams < FinchAPI::Internal::Type::BaseModel -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::IndividualRetrieveManyParams::Request] } # @!attribute entity_ids - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. # # @return [Array, nil] optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String] @@ -27,9 +28,12 @@ class IndividualRetrieveManyParams < FinchAPI::Internal::Type::BaseModel optional :options, -> { FinchAPI::HRIS::IndividualRetrieveManyParams::Options }, nil?: true # @!method initialize(requests:, entity_ids: nil, options: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {FinchAPI::Models::HRIS::IndividualRetrieveManyParams} for more details. + # # @param requests [Array] The array of batch requests. Maximum 10000 items per request. # - # @param entity_ids [Array] The entity IDs to specify which entities' data to access. + # @param entity_ids [Array] The entity IDs to specify which entities' data to access. Provide exactly one en # # @param options [FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options, nil] # diff --git a/lib/finch_api/models/hris/pay_statement_item/rule_create_params.rb b/lib/finch_api/models/hris/pay_statement_item/rule_create_params.rb index 1a3d8073..449bc630 100644 --- a/lib/finch_api/models/hris/pay_statement_item/rule_create_params.rb +++ b/lib/finch_api/models/hris/pay_statement_item/rule_create_params.rb @@ -10,7 +10,8 @@ class RuleCreateParams < FinchAPI::Internal::Type::BaseModel include FinchAPI::Internal::Type::RequestParameters # @!attribute entity_ids - # The entity IDs to create the rule for. + # The entity IDs to create the rule for. Provide exactly one entity ID per + # request; a maximum of one is accepted. # # @return [Array, nil] optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String] @@ -46,7 +47,10 @@ class RuleCreateParams < FinchAPI::Internal::Type::BaseModel optional :entity_type, enum: -> { FinchAPI::HRIS::PayStatementItem::RuleCreateParams::EntityType } # @!method initialize(entity_ids: nil, attributes: nil, conditions: nil, effective_end_date: nil, effective_start_date: nil, entity_type: nil, request_options: {}) - # @param entity_ids [Array] The entity IDs to create the rule for. + # Some parameter documentations has been truncated, see + # {FinchAPI::Models::HRIS::PayStatementItem::RuleCreateParams} for more details. + # + # @param entity_ids [Array] The entity IDs to create the rule for. Provide exactly one entity ID per request # # @param attributes [FinchAPI::Models::HRIS::PayStatementItem::RuleCreateParams::Attributes] Specifies the fields to be applied when the condition is met. # diff --git a/lib/finch_api/models/hris/pay_statement_item/rule_delete_params.rb b/lib/finch_api/models/hris/pay_statement_item/rule_delete_params.rb index b1a007c4..d38d66c1 100644 --- a/lib/finch_api/models/hris/pay_statement_item/rule_delete_params.rb +++ b/lib/finch_api/models/hris/pay_statement_item/rule_delete_params.rb @@ -15,15 +15,19 @@ class RuleDeleteParams < FinchAPI::Internal::Type::BaseModel required :rule_id, String # @!attribute entity_ids - # The entity IDs to delete the rule for. + # The entity IDs to delete the rule for. Provide exactly one entity ID per + # request; a maximum of one is accepted. # # @return [Array, nil] optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String] # @!method initialize(rule_id:, entity_ids: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {FinchAPI::Models::HRIS::PayStatementItem::RuleDeleteParams} for more details. + # # @param rule_id [String] # - # @param entity_ids [Array] The entity IDs to delete the rule for. + # @param entity_ids [Array] The entity IDs to delete the rule for. Provide exactly one entity ID per request # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}] end diff --git a/lib/finch_api/models/hris/pay_statement_item/rule_list_params.rb b/lib/finch_api/models/hris/pay_statement_item/rule_list_params.rb index 422e1c6e..c883fe2f 100644 --- a/lib/finch_api/models/hris/pay_statement_item/rule_list_params.rb +++ b/lib/finch_api/models/hris/pay_statement_item/rule_list_params.rb @@ -10,13 +10,17 @@ class RuleListParams < FinchAPI::Internal::Type::BaseModel include FinchAPI::Internal::Type::RequestParameters # @!attribute entity_ids - # The entity IDs to retrieve rules for. + # The entity IDs to retrieve rules for. Provide exactly one entity ID per request; + # a maximum of one is accepted. # # @return [Array, nil] optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String] # @!method initialize(entity_ids: nil, request_options: {}) - # @param entity_ids [Array] The entity IDs to retrieve rules for. + # Some parameter documentations has been truncated, see + # {FinchAPI::Models::HRIS::PayStatementItem::RuleListParams} for more details. + # + # @param entity_ids [Array] The entity IDs to retrieve rules for. Provide exactly one entity ID per request; # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}] end diff --git a/lib/finch_api/models/hris/pay_statement_item/rule_update_params.rb b/lib/finch_api/models/hris/pay_statement_item/rule_update_params.rb index 40cb9396..13d4cd08 100644 --- a/lib/finch_api/models/hris/pay_statement_item/rule_update_params.rb +++ b/lib/finch_api/models/hris/pay_statement_item/rule_update_params.rb @@ -15,7 +15,8 @@ class RuleUpdateParams < FinchAPI::Internal::Type::BaseModel required :rule_id, String # @!attribute entity_ids - # The entity IDs to update the rule for. + # The entity IDs to update the rule for. Provide exactly one entity ID per + # request; a maximum of one is accepted. # # @return [Array, nil] optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String] @@ -26,9 +27,12 @@ class RuleUpdateParams < FinchAPI::Internal::Type::BaseModel optional :optional_property, FinchAPI::Internal::Type::Unknown, api_name: :optionalProperty # @!method initialize(rule_id:, entity_ids: nil, optional_property: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateParams} for more details. + # # @param rule_id [String] # - # @param entity_ids [Array] The entity IDs to update the rule for. + # @param entity_ids [Array] The entity IDs to update the rule for. Provide exactly one entity ID per request # # @param optional_property [Object] # diff --git a/lib/finch_api/models/hris/pay_statement_item_list_params.rb b/lib/finch_api/models/hris/pay_statement_item_list_params.rb index 4a06e669..f54f3917 100644 --- a/lib/finch_api/models/hris/pay_statement_item_list_params.rb +++ b/lib/finch_api/models/hris/pay_statement_item_list_params.rb @@ -24,7 +24,8 @@ class PayStatementItemListParams < FinchAPI::Internal::Type::BaseModel optional :end_date, Date # @!attribute entity_ids - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. # # @return [Array, nil] optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String] @@ -56,7 +57,7 @@ class PayStatementItemListParams < FinchAPI::Internal::Type::BaseModel # # @param end_date [Date] The end date to retrieve pay statement items by via their last seen pay date in # - # @param entity_ids [Array] The entity IDs to specify which entities' data to access. + # @param entity_ids [Array] The entity IDs to specify which entities' data to access. Provide exactly one en # # @param name [String] Case-insensitive partial match search by pay statement item name. # diff --git a/lib/finch_api/models/hris/pay_statement_retrieve_many_params.rb b/lib/finch_api/models/hris/pay_statement_retrieve_many_params.rb index 87ae6960..fa065d0a 100644 --- a/lib/finch_api/models/hris/pay_statement_retrieve_many_params.rb +++ b/lib/finch_api/models/hris/pay_statement_retrieve_many_params.rb @@ -16,15 +16,19 @@ class PayStatementRetrieveManyParams < FinchAPI::Internal::Type::BaseModel -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::PayStatementRetrieveManyParams::Request] } # @!attribute entity_ids - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. # # @return [Array, nil] optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String] # @!method initialize(requests:, entity_ids: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {FinchAPI::Models::HRIS::PayStatementRetrieveManyParams} for more details. + # # @param requests [Array] The array of batch requests. Maximum 10 payment_ids per request. # - # @param entity_ids [Array] The entity IDs to specify which entities' data to access. + # @param entity_ids [Array] The entity IDs to specify which entities' data to access. Provide exactly one en # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}] diff --git a/lib/finch_api/models/hris/payment_list_params.rb b/lib/finch_api/models/hris/payment_list_params.rb index deadad30..d5af5a4b 100644 --- a/lib/finch_api/models/hris/payment_list_params.rb +++ b/lib/finch_api/models/hris/payment_list_params.rb @@ -23,7 +23,8 @@ class PaymentListParams < FinchAPI::Internal::Type::BaseModel required :start_date, Date # @!attribute entity_ids - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. # # @return [Array, nil] optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String] @@ -36,7 +37,7 @@ class PaymentListParams < FinchAPI::Internal::Type::BaseModel # # @param start_date [Date] The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` for # - # @param entity_ids [Array] The entity IDs to specify which entities' data to access. + # @param entity_ids [Array] The entity IDs to specify which entities' data to access. Provide exactly one en # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}] end diff --git a/lib/finch_api/models/introspection.rb b/lib/finch_api/models/introspection.rb index c7dea96c..cf4cb8ca 100644 --- a/lib/finch_api/models/introspection.rb +++ b/lib/finch_api/models/introspection.rb @@ -70,10 +70,7 @@ class Introspection < FinchAPI::Internal::Type::BaseModel -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Introspection::AuthenticationMethod] } # @!attribute company_id - # @deprecated - # - # [DEPRECATED] Use `connection_id` to associate tokens with a Finch connection - # instead of this company ID + # The Finch UUID of the company associated with the `access_token`. # # @return [String, nil] optional :company_id, String @@ -153,7 +150,7 @@ class Introspection < FinchAPI::Internal::Type::BaseModel # # @param authentication_methods [Array] # - # @param company_id [String] [DEPRECATED] Use `connection_id` to associate tokens with a Finch connection ins + # @param company_id [String] The Finch UUID of the company associated with the `access_token`. # # @param customer_email [String, nil] The email of your customer you provided to Finch when a connect session was crea # diff --git a/lib/finch_api/models/payroll/pay_group_list_params.rb b/lib/finch_api/models/payroll/pay_group_list_params.rb index b6bcc91b..e250ba66 100644 --- a/lib/finch_api/models/payroll/pay_group_list_params.rb +++ b/lib/finch_api/models/payroll/pay_group_list_params.rb @@ -9,7 +9,8 @@ class PayGroupListParams < FinchAPI::Internal::Type::BaseModel include FinchAPI::Internal::Type::RequestParameters # @!attribute entity_ids - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. # # @return [Array, nil] optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String] @@ -25,7 +26,10 @@ class PayGroupListParams < FinchAPI::Internal::Type::BaseModel optional :pay_frequencies, FinchAPI::Internal::Type::ArrayOf[String] # @!method initialize(entity_ids: nil, individual_id: nil, pay_frequencies: nil, request_options: {}) - # @param entity_ids [Array] The entity IDs to specify which entities' data to access. + # Some parameter documentations has been truncated, see + # {FinchAPI::Models::Payroll::PayGroupListParams} for more details. + # + # @param entity_ids [Array] The entity IDs to specify which entities' data to access. Provide exactly one en # # @param individual_id [String] # diff --git a/lib/finch_api/models/payroll/pay_group_retrieve_params.rb b/lib/finch_api/models/payroll/pay_group_retrieve_params.rb index 6f1b7b55..e11ba24a 100644 --- a/lib/finch_api/models/payroll/pay_group_retrieve_params.rb +++ b/lib/finch_api/models/payroll/pay_group_retrieve_params.rb @@ -14,15 +14,19 @@ class PayGroupRetrieveParams < FinchAPI::Internal::Type::BaseModel required :pay_group_id, String # @!attribute entity_ids - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. # # @return [Array, nil] optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String] # @!method initialize(pay_group_id:, entity_ids: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {FinchAPI::Models::Payroll::PayGroupRetrieveParams} for more details. + # # @param pay_group_id [String] # - # @param entity_ids [Array] The entity IDs to specify which entities' data to access. + # @param entity_ids [Array] The entity IDs to specify which entities' data to access. Provide exactly one en # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}] end diff --git a/lib/finch_api/models/sandbox/connection_create_response.rb b/lib/finch_api/models/sandbox/connection_create_response.rb index d8861b36..c0700eeb 100644 --- a/lib/finch_api/models/sandbox/connection_create_response.rb +++ b/lib/finch_api/models/sandbox/connection_create_response.rb @@ -25,9 +25,7 @@ class ConnectionCreateResponse < FinchAPI::Internal::Type::BaseModel enum: -> { FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType } # @!attribute company_id - # @deprecated - # - # [DEPRECATED] Use `connection_id` to associate a connection with an access token + # The Finch UUID of the company associated with the `access_token`. # # @return [String] required :company_id, String @@ -67,7 +65,7 @@ class ConnectionCreateResponse < FinchAPI::Internal::Type::BaseModel # # @param authentication_type [Symbol, FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType] # - # @param company_id [String] [DEPRECATED] Use `connection_id` to associate a connection with an access token + # @param company_id [String] The Finch UUID of the company associated with the `access_token`. # # @param connection_id [String] The ID of the new connection # diff --git a/lib/finch_api/models/sandbox/connections/account_create_response.rb b/lib/finch_api/models/sandbox/connections/account_create_response.rb index 5b07d676..23cfd96f 100644 --- a/lib/finch_api/models/sandbox/connections/account_create_response.rb +++ b/lib/finch_api/models/sandbox/connections/account_create_response.rb @@ -26,9 +26,7 @@ class AccountCreateResponse < FinchAPI::Internal::Type::BaseModel enum: -> { FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType } # @!attribute company_id - # @deprecated - # - # [DEPRECATED] Use `connection_id` to associate a connection with an access token + # The Finch UUID of the company associated with the `access_token`. # # @return [String] required :company_id, String @@ -63,7 +61,7 @@ class AccountCreateResponse < FinchAPI::Internal::Type::BaseModel # # @param authentication_type [Symbol, FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType] # - # @param company_id [String] [DEPRECATED] Use `connection_id` to associate a connection with an access token + # @param company_id [String] The Finch UUID of the company associated with the `access_token`. # # @param connection_id [String] The ID of the new connection # diff --git a/lib/finch_api/models/sandbox/connections/account_update_response.rb b/lib/finch_api/models/sandbox/connections/account_update_response.rb index 00c71171..120b5ea3 100644 --- a/lib/finch_api/models/sandbox/connections/account_update_response.rb +++ b/lib/finch_api/models/sandbox/connections/account_update_response.rb @@ -21,9 +21,7 @@ class AccountUpdateResponse < FinchAPI::Internal::Type::BaseModel enum: -> { FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType } # @!attribute company_id - # @deprecated - # - # [DEPRECATED] Use `connection_id` to associate a connection with an access token + # The Finch UUID of the company associated with the `access_token`. # # @return [String] required :company_id, String @@ -56,7 +54,7 @@ class AccountUpdateResponse < FinchAPI::Internal::Type::BaseModel # # @param authentication_type [Symbol, FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType] # - # @param company_id [String] [DEPRECATED] Use `connection_id` to associate a connection with an access token + # @param company_id [String] The Finch UUID of the company associated with the `access_token`. # # @param connection_id [String] The ID of the new connection # diff --git a/lib/finch_api/resources/hris/benefits.rb b/lib/finch_api/resources/hris/benefits.rb index c1545826..69d16094 100644 --- a/lib/finch_api/resources/hris/benefits.rb +++ b/lib/finch_api/resources/hris/benefits.rb @@ -15,7 +15,7 @@ class Benefits # # @overload create(entity_ids: nil, company_contribution: nil, description: nil, frequency: nil, type: nil, request_options: {}) # - # @param entity_ids [Array] Query param: The entity IDs to specify which entities' data to access. + # @param entity_ids [Array] Query param: The entity IDs to specify which entities' data to access. Provide e # # @param company_contribution [FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution, nil] Body param: The company match for this benefit. # @@ -45,13 +45,16 @@ def create(params = {}) ) end + # Some parameter documentations has been truncated, see + # {FinchAPI::Models::HRIS::BenefitRetrieveParams} for more details. + # # Lists deductions and contributions information for a given item # # @overload retrieve(benefit_id, entity_ids: nil, request_options: {}) # # @param benefit_id [String] # - # @param entity_ids [Array] The entity IDs to specify which entities' data to access. + # @param entity_ids [Array] The entity IDs to specify which entities' data to access. Provide exactly one en # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # @@ -71,13 +74,16 @@ def retrieve(benefit_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {FinchAPI::Models::HRIS::BenefitUpdateParams} for more details. + # # Updates an existing company-wide deduction or contribution # # @overload update(benefit_id, entity_ids: nil, description: nil, request_options: {}) # # @param benefit_id [String] Path param # - # @param entity_ids [Array] Query param: The entity IDs to specify which entities' data to access. + # @param entity_ids [Array] Query param: The entity IDs to specify which entities' data to access. Provide e # # @param description [String] Body param: Updated name or description. # @@ -101,11 +107,14 @@ def update(benefit_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {FinchAPI::Models::HRIS::BenefitListParams} for more details. + # # List all company-wide deductions and contributions. # # @overload list(entity_ids: nil, request_options: {}) # - # @param entity_ids [Array] The entity IDs to specify which entities' data to access. + # @param entity_ids [Array] The entity IDs to specify which entities' data to access. Provide exactly one en # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # @@ -126,11 +135,14 @@ def list(params = {}) ) end + # Some parameter documentations has been truncated, see + # {FinchAPI::Models::HRIS::BenefitListSupportedBenefitsParams} for more details. + # # Get deductions metadata # # @overload list_supported_benefits(entity_ids: nil, request_options: {}) # - # @param entity_ids [Array] The entity IDs to specify which entities' data to access. + # @param entity_ids [Array] The entity IDs to specify which entities' data to access. Provide exactly one en # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # @@ -151,12 +163,15 @@ def list_supported_benefits(params = {}) ) end + # Some parameter documentations has been truncated, see + # {FinchAPI::Models::HRIS::BenefitRegisterParams} for more details. + # # Register existing benefits from the customer on the provider, on Finch's end. # Please use the `/provider` endpoint to view available types for each provider. # # @overload register(entity_ids: nil, description: nil, frequency: nil, type: nil, request_options: {}) # - # @param entity_ids [Array] Query param: The entity IDs to specify which entities' data to access. + # @param entity_ids [Array] Query param: The entity IDs to specify which entities' data to access. Provide e # # @param description [String] Body param # diff --git a/lib/finch_api/resources/hris/benefits/individuals.rb b/lib/finch_api/resources/hris/benefits/individuals.rb index fc4666c4..2dba0676 100644 --- a/lib/finch_api/resources/hris/benefits/individuals.rb +++ b/lib/finch_api/resources/hris/benefits/individuals.rb @@ -5,6 +5,9 @@ module Resources class HRIS class Benefits class Individuals + # Some parameter documentations has been truncated, see + # {FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams} for more details. + # # Enroll an individual into a deduction or contribution. This is an overwrite # operation. If the employee is already enrolled, the enrollment amounts will be # adjusted. Making the same request multiple times will not create new @@ -14,7 +17,7 @@ class Individuals # # @param benefit_id [String] Path param # - # @param entity_ids [Array] Query param: The entity IDs to specify which entities' data to access. + # @param entity_ids [Array] Query param: The entity IDs to specify which entities' data to access. Provide e # # @param individuals [Array] Body param: Array of the individual_id to enroll and a configuration object. # @@ -37,13 +40,17 @@ def enroll_many(benefit_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {FinchAPI::Models::HRIS::Benefits::IndividualEnrolledIDsParams} for more + # details. + # # Lists individuals currently enrolled in a given deduction. # # @overload enrolled_ids(benefit_id, entity_ids: nil, request_options: {}) # # @param benefit_id [String] # - # @param entity_ids [Array] The entity IDs to specify which entities' data to access. + # @param entity_ids [Array] The entity IDs to specify which entities' data to access. Provide exactly one en # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # @@ -73,7 +80,7 @@ def enrolled_ids(benefit_id, params = {}) # # @param benefit_id [String] # - # @param entity_ids [Array] The entity IDs to specify which entities' data to access. + # @param entity_ids [Array] The entity IDs to specify which entities' data to access. Provide exactly one en # # @param individual_ids [String] comma-delimited list of stable Finch uuids for each individual. If empty, defaul # @@ -96,13 +103,17 @@ def retrieve_many_benefits(benefit_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {FinchAPI::Models::HRIS::Benefits::IndividualUnenrollManyParams} for more + # details. + # # Unenroll individuals from a deduction or contribution # # @overload unenroll_many(benefit_id, entity_ids: nil, individual_ids: nil, request_options: {}) # # @param benefit_id [String] Path param # - # @param entity_ids [Array] Query param: The entity IDs to specify which entities' data to access. + # @param entity_ids [Array] Query param: The entity IDs to specify which entities' data to access. Provide e # # @param individual_ids [Array] Body param: Array of individual_ids to unenroll. # diff --git a/lib/finch_api/resources/hris/company.rb b/lib/finch_api/resources/hris/company.rb index 5359fa47..ac278288 100644 --- a/lib/finch_api/resources/hris/company.rb +++ b/lib/finch_api/resources/hris/company.rb @@ -4,11 +4,14 @@ module FinchAPI module Resources class HRIS class Company + # Some parameter documentations has been truncated, see + # {FinchAPI::Models::HRIS::CompanyRetrieveParams} for more details. + # # Read basic company data # # @overload retrieve(entity_ids: nil, request_options: {}) # - # @param entity_ids [Array] The entity IDs to specify which entities' data to access. + # @param entity_ids [Array] The entity IDs to specify which entities' data to access. Provide exactly one en # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # diff --git a/lib/finch_api/resources/hris/directory.rb b/lib/finch_api/resources/hris/directory.rb index a85f5fc3..16fcf6dd 100644 --- a/lib/finch_api/resources/hris/directory.rb +++ b/lib/finch_api/resources/hris/directory.rb @@ -4,11 +4,14 @@ module FinchAPI module Resources class HRIS class Directory + # Some parameter documentations has been truncated, see + # {FinchAPI::Models::HRIS::DirectoryListParams} for more details. + # # Read company directory and organization structure # # @overload list(entity_ids: nil, limit: nil, offset: nil, request_options: {}) # - # @param entity_ids [Array] The entity IDs to specify which entities' data to access. + # @param entity_ids [Array] The entity IDs to specify which entities' data to access. Provide exactly one en # # @param limit [Integer] Number of employees to return (defaults to 100, maximum 10000) # diff --git a/lib/finch_api/resources/hris/documents.rb b/lib/finch_api/resources/hris/documents.rb index aa1bdbd9..cdbf1bc5 100644 --- a/lib/finch_api/resources/hris/documents.rb +++ b/lib/finch_api/resources/hris/documents.rb @@ -12,7 +12,7 @@ class Documents # # @overload list(entity_ids: nil, individual_ids: nil, limit: nil, offset: nil, types: nil, request_options: {}) # - # @param entity_ids [Array] The entity IDs to specify which entities' data to access. + # @param entity_ids [Array] The entity IDs to specify which entities' data to access. Provide exactly one en # # @param individual_ids [Array] Comma-delimited list of stable Finch uuids for each individual. If empty, defaul # @@ -40,6 +40,9 @@ def list(params = {}) ) end + # Some parameter documentations has been truncated, see + # {FinchAPI::Models::HRIS::DocumentRetreiveParams} for more details. + # # **Beta:** This endpoint is in beta and may change. Retrieve details of a # specific document by its ID. # @@ -47,7 +50,7 @@ def list(params = {}) # # @param document_id [String] The unique identifier of the document. # - # @param entity_ids [Array] The entity IDs to specify which entities' data to access. + # @param entity_ids [Array] The entity IDs to specify which entities' data to access. Provide exactly one en # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # diff --git a/lib/finch_api/resources/hris/employments.rb b/lib/finch_api/resources/hris/employments.rb index 75457678..0787119d 100644 --- a/lib/finch_api/resources/hris/employments.rb +++ b/lib/finch_api/resources/hris/employments.rb @@ -4,13 +4,16 @@ module FinchAPI module Resources class HRIS class Employments + # Some parameter documentations has been truncated, see + # {FinchAPI::Models::HRIS::EmploymentRetrieveManyParams} for more details. + # # Read individual employment and income data # # @overload retrieve_many(requests:, entity_ids: nil, request_options: {}) # # @param requests [Array] Body param: The array of batch requests. Maximum 10000 items per request. # - # @param entity_ids [Array] Query param: The entity IDs to specify which entities' data to access. + # @param entity_ids [Array] Query param: The entity IDs to specify which entities' data to access. Provide e # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # diff --git a/lib/finch_api/resources/hris/individuals.rb b/lib/finch_api/resources/hris/individuals.rb index 1baa4ba6..d9c310eb 100644 --- a/lib/finch_api/resources/hris/individuals.rb +++ b/lib/finch_api/resources/hris/individuals.rb @@ -4,13 +4,16 @@ module FinchAPI module Resources class HRIS class Individuals + # Some parameter documentations has been truncated, see + # {FinchAPI::Models::HRIS::IndividualRetrieveManyParams} for more details. + # # Read individual data, excluding income and employment data # # @overload retrieve_many(requests:, entity_ids: nil, options: nil, request_options: {}) # # @param requests [Array] Body param: The array of batch requests. Maximum 10000 items per request. # - # @param entity_ids [Array] Query param: The entity IDs to specify which entities' data to access. + # @param entity_ids [Array] Query param: The entity IDs to specify which entities' data to access. Provide e # # @param options [FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options, nil] Body param # diff --git a/lib/finch_api/resources/hris/pay_statement_item.rb b/lib/finch_api/resources/hris/pay_statement_item.rb index 33caba8c..9e64e782 100644 --- a/lib/finch_api/resources/hris/pay_statement_item.rb +++ b/lib/finch_api/resources/hris/pay_statement_item.rb @@ -19,7 +19,7 @@ class PayStatementItem # # @param end_date [Date] The end date to retrieve pay statement items by via their last seen pay date in # - # @param entity_ids [Array] The entity IDs to specify which entities' data to access. + # @param entity_ids [Array] The entity IDs to specify which entities' data to access. Provide exactly one en # # @param name [String] Case-insensitive partial match search by pay statement item name. # diff --git a/lib/finch_api/resources/hris/pay_statement_item/rules.rb b/lib/finch_api/resources/hris/pay_statement_item/rules.rb index 3684b7df..d6874273 100644 --- a/lib/finch_api/resources/hris/pay_statement_item/rules.rb +++ b/lib/finch_api/resources/hris/pay_statement_item/rules.rb @@ -15,7 +15,7 @@ class Rules # # @overload create(entity_ids: nil, attributes: nil, conditions: nil, effective_end_date: nil, effective_start_date: nil, entity_type: nil, request_options: {}) # - # @param entity_ids [Array] Query param: The entity IDs to create the rule for. + # @param entity_ids [Array] Query param: The entity IDs to create the rule for. Provide exactly one entity I # # @param attributes [FinchAPI::Models::HRIS::PayStatementItem::RuleCreateParams::Attributes] Body param: Specifies the fields to be applied when the condition is met. # @@ -47,13 +47,16 @@ def create(params = {}) ) end + # Some parameter documentations has been truncated, see + # {FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateParams} for more details. + # # Update a rule for a pay statement item. # # @overload update(rule_id, entity_ids: nil, optional_property: nil, request_options: {}) # # @param rule_id [String] Path param # - # @param entity_ids [Array] Query param: The entity IDs to update the rule for. + # @param entity_ids [Array] Query param: The entity IDs to update the rule for. Provide exactly one entity I # # @param optional_property [Object] Body param # @@ -77,11 +80,14 @@ def update(rule_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {FinchAPI::Models::HRIS::PayStatementItem::RuleListParams} for more details. + # # List all rules of a connection account. # # @overload list(entity_ids: nil, request_options: {}) # - # @param entity_ids [Array] The entity IDs to retrieve rules for. + # @param entity_ids [Array] The entity IDs to retrieve rules for. Provide exactly one entity ID per request; # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # @@ -102,13 +108,16 @@ def list(params = {}) ) end + # Some parameter documentations has been truncated, see + # {FinchAPI::Models::HRIS::PayStatementItem::RuleDeleteParams} for more details. + # # Delete a rule for a pay statement item. # # @overload delete(rule_id, entity_ids: nil, request_options: {}) # # @param rule_id [String] # - # @param entity_ids [Array] The entity IDs to delete the rule for. + # @param entity_ids [Array] The entity IDs to delete the rule for. Provide exactly one entity ID per request # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # diff --git a/lib/finch_api/resources/hris/pay_statements.rb b/lib/finch_api/resources/hris/pay_statements.rb index e1e599ba..390a5a1e 100644 --- a/lib/finch_api/resources/hris/pay_statements.rb +++ b/lib/finch_api/resources/hris/pay_statements.rb @@ -4,6 +4,9 @@ module FinchAPI module Resources class HRIS class PayStatements + # Some parameter documentations has been truncated, see + # {FinchAPI::Models::HRIS::PayStatementRetrieveManyParams} for more details. + # # Read detailed pay statements for each individual. # # Deduction and contribution types are supported by the payroll systems that @@ -13,7 +16,7 @@ class PayStatements # # @param requests [Array] Body param: The array of batch requests. Maximum 10 payment_ids per request. # - # @param entity_ids [Array] Query param: The entity IDs to specify which entities' data to access. + # @param entity_ids [Array] Query param: The entity IDs to specify which entities' data to access. Provide e # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # diff --git a/lib/finch_api/resources/hris/payments.rb b/lib/finch_api/resources/hris/payments.rb index ef2f5059..fc516c60 100644 --- a/lib/finch_api/resources/hris/payments.rb +++ b/lib/finch_api/resources/hris/payments.rb @@ -15,7 +15,7 @@ class Payments # # @param start_date [Date] The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` for # - # @param entity_ids [Array] The entity IDs to specify which entities' data to access. + # @param entity_ids [Array] The entity IDs to specify which entities' data to access. Provide exactly one en # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # diff --git a/lib/finch_api/resources/payroll/pay_groups.rb b/lib/finch_api/resources/payroll/pay_groups.rb index f887f8ac..f97de552 100644 --- a/lib/finch_api/resources/payroll/pay_groups.rb +++ b/lib/finch_api/resources/payroll/pay_groups.rb @@ -4,13 +4,16 @@ module FinchAPI module Resources class Payroll class PayGroups + # Some parameter documentations has been truncated, see + # {FinchAPI::Models::Payroll::PayGroupRetrieveParams} for more details. + # # Read information from a single pay group # # @overload retrieve(pay_group_id, entity_ids: nil, request_options: {}) # # @param pay_group_id [String] # - # @param entity_ids [Array] The entity IDs to specify which entities' data to access. + # @param entity_ids [Array] The entity IDs to specify which entities' data to access. Provide exactly one en # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # @@ -30,11 +33,14 @@ def retrieve(pay_group_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {FinchAPI::Models::Payroll::PayGroupListParams} for more details. + # # Read company pay groups and frequencies # # @overload list(entity_ids: nil, individual_id: nil, pay_frequencies: nil, request_options: {}) # - # @param entity_ids [Array] The entity IDs to specify which entities' data to access. + # @param entity_ids [Array] The entity IDs to specify which entities' data to access. Provide exactly one en # # @param individual_id [String] # diff --git a/rbi/finch_api/models/base_webhook_event.rbi b/rbi/finch_api/models/base_webhook_event.rbi index abcb661e..7bc94755 100644 --- a/rbi/finch_api/models/base_webhook_event.rbi +++ b/rbi/finch_api/models/base_webhook_event.rbi @@ -14,8 +14,7 @@ module FinchAPI sig { returns(String) } attr_accessor :account_id - # [DEPRECATED] Unique Finch ID of the company for which data has been updated. Use - # `connection_id` instead to identify the connection associated with this event. + # Unique Finch ID of the company for which data has been updated. sig { returns(String) } attr_accessor :company_id @@ -46,8 +45,7 @@ module FinchAPI # connection. Use `connection_id` instead to identify the connection associated # with this event. account_id:, - # [DEPRECATED] Unique Finch ID of the company for which data has been updated. Use - # `connection_id` instead to identify the connection associated with this event. + # Unique Finch ID of the company for which data has been updated. company_id:, # Unique Finch ID of the connection associated with the webhook event. connection_id: nil, diff --git a/rbi/finch_api/models/create_access_token_response.rbi b/rbi/finch_api/models/create_access_token_response.rbi index 42c8950c..924cdaf1 100644 --- a/rbi/finch_api/models/create_access_token_response.rbi +++ b/rbi/finch_api/models/create_access_token_response.rbi @@ -60,8 +60,7 @@ module FinchAPI sig { params(account_id: String).void } attr_writer :account_id - # [DEPRECATED] Use `connection_id` to identify the connection instead of this - # company ID + # The Finch UUID of the company associated with the `access_token`. sig { returns(T.nilable(String)) } attr_reader :company_id @@ -119,8 +118,7 @@ module FinchAPI # [DEPRECATED] Use `connection_id` to identify the connection instead of this # account ID account_id: nil, - # [DEPRECATED] Use `connection_id` to identify the connection instead of this - # company ID + # The Finch UUID of the company associated with the `access_token`. company_id: nil, # The ID of your customer you provided to Finch when a connect session was created # for this connection diff --git a/rbi/finch_api/models/hris/benefit_create_params.rbi b/rbi/finch_api/models/hris/benefit_create_params.rbi index 9c783a5c..d625b7ea 100644 --- a/rbi/finch_api/models/hris/benefit_create_params.rbi +++ b/rbi/finch_api/models/hris/benefit_create_params.rbi @@ -15,7 +15,8 @@ module FinchAPI ) end - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. sig { returns(T.nilable(T::Array[String])) } attr_reader :entity_ids @@ -71,7 +72,8 @@ module FinchAPI ).returns(T.attached_class) end def self.new( - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. entity_ids: nil, # The company match for this benefit. company_contribution: nil, diff --git a/rbi/finch_api/models/hris/benefit_list_params.rbi b/rbi/finch_api/models/hris/benefit_list_params.rbi index 973457c0..9817c8b5 100644 --- a/rbi/finch_api/models/hris/benefit_list_params.rbi +++ b/rbi/finch_api/models/hris/benefit_list_params.rbi @@ -15,7 +15,8 @@ module FinchAPI ) end - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. sig { returns(T.nilable(T::Array[String])) } attr_reader :entity_ids @@ -29,7 +30,8 @@ module FinchAPI ).returns(T.attached_class) end def self.new( - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. entity_ids: nil, request_options: {} ) diff --git a/rbi/finch_api/models/hris/benefit_list_supported_benefits_params.rbi b/rbi/finch_api/models/hris/benefit_list_supported_benefits_params.rbi index 740a87ac..60219a38 100644 --- a/rbi/finch_api/models/hris/benefit_list_supported_benefits_params.rbi +++ b/rbi/finch_api/models/hris/benefit_list_supported_benefits_params.rbi @@ -15,7 +15,8 @@ module FinchAPI ) end - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. sig { returns(T.nilable(T::Array[String])) } attr_reader :entity_ids @@ -29,7 +30,8 @@ module FinchAPI ).returns(T.attached_class) end def self.new( - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. entity_ids: nil, request_options: {} ) diff --git a/rbi/finch_api/models/hris/benefit_register_params.rbi b/rbi/finch_api/models/hris/benefit_register_params.rbi index 8e6b1e9f..d4fe598e 100644 --- a/rbi/finch_api/models/hris/benefit_register_params.rbi +++ b/rbi/finch_api/models/hris/benefit_register_params.rbi @@ -15,7 +15,8 @@ module FinchAPI ) end - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. sig { returns(T.nilable(T::Array[String])) } attr_reader :entity_ids @@ -46,7 +47,8 @@ module FinchAPI ).returns(T.attached_class) end def self.new( - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. entity_ids: nil, description: nil, # The frequency of the benefit deduction/contribution. diff --git a/rbi/finch_api/models/hris/benefit_retrieve_params.rbi b/rbi/finch_api/models/hris/benefit_retrieve_params.rbi index 35fbf017..d07edb6d 100644 --- a/rbi/finch_api/models/hris/benefit_retrieve_params.rbi +++ b/rbi/finch_api/models/hris/benefit_retrieve_params.rbi @@ -18,7 +18,8 @@ module FinchAPI sig { returns(String) } attr_accessor :benefit_id - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. sig { returns(T.nilable(T::Array[String])) } attr_reader :entity_ids @@ -34,7 +35,8 @@ module FinchAPI end def self.new( benefit_id:, - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. entity_ids: nil, request_options: {} ) diff --git a/rbi/finch_api/models/hris/benefit_update_params.rbi b/rbi/finch_api/models/hris/benefit_update_params.rbi index 5fa0d03f..59fe167f 100644 --- a/rbi/finch_api/models/hris/benefit_update_params.rbi +++ b/rbi/finch_api/models/hris/benefit_update_params.rbi @@ -18,7 +18,8 @@ module FinchAPI sig { returns(String) } attr_accessor :benefit_id - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. sig { returns(T.nilable(T::Array[String])) } attr_reader :entity_ids @@ -42,7 +43,8 @@ module FinchAPI end def self.new( benefit_id:, - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. entity_ids: nil, # Updated name or description. description: nil, diff --git a/rbi/finch_api/models/hris/benefits/individual_enroll_many_params.rbi b/rbi/finch_api/models/hris/benefits/individual_enroll_many_params.rbi index 4686034c..ac6a8b1d 100644 --- a/rbi/finch_api/models/hris/benefits/individual_enroll_many_params.rbi +++ b/rbi/finch_api/models/hris/benefits/individual_enroll_many_params.rbi @@ -19,7 +19,8 @@ module FinchAPI sig { returns(String) } attr_accessor :benefit_id - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. sig { returns(T.nilable(T::Array[String])) } attr_reader :entity_ids @@ -61,7 +62,8 @@ module FinchAPI end def self.new( benefit_id:, - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. entity_ids: nil, # Array of the individual_id to enroll and a configuration object. individuals: nil, diff --git a/rbi/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbi b/rbi/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbi index db6afa40..fa10ec0d 100644 --- a/rbi/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbi +++ b/rbi/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbi @@ -19,7 +19,8 @@ module FinchAPI sig { returns(String) } attr_accessor :benefit_id - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. sig { returns(T.nilable(T::Array[String])) } attr_reader :entity_ids @@ -35,7 +36,8 @@ module FinchAPI end def self.new( benefit_id:, - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. entity_ids: nil, request_options: {} ) diff --git a/rbi/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi b/rbi/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi index c6c49169..ceeb5d64 100644 --- a/rbi/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi +++ b/rbi/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi @@ -19,7 +19,8 @@ module FinchAPI sig { returns(String) } attr_accessor :benefit_id - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. sig { returns(T.nilable(T::Array[String])) } attr_reader :entity_ids @@ -44,7 +45,8 @@ module FinchAPI end def self.new( benefit_id:, - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. entity_ids: nil, # comma-delimited list of stable Finch uuids for each individual. If empty, # defaults to all individuals diff --git a/rbi/finch_api/models/hris/benefits/individual_unenroll_many_params.rbi b/rbi/finch_api/models/hris/benefits/individual_unenroll_many_params.rbi index c284593f..dd3706cb 100644 --- a/rbi/finch_api/models/hris/benefits/individual_unenroll_many_params.rbi +++ b/rbi/finch_api/models/hris/benefits/individual_unenroll_many_params.rbi @@ -19,7 +19,8 @@ module FinchAPI sig { returns(String) } attr_accessor :benefit_id - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. sig { returns(T.nilable(T::Array[String])) } attr_reader :entity_ids @@ -43,7 +44,8 @@ module FinchAPI end def self.new( benefit_id:, - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. entity_ids: nil, # Array of individual_ids to unenroll. individual_ids: nil, diff --git a/rbi/finch_api/models/hris/company_retrieve_params.rbi b/rbi/finch_api/models/hris/company_retrieve_params.rbi index 216e94d7..5c8435a3 100644 --- a/rbi/finch_api/models/hris/company_retrieve_params.rbi +++ b/rbi/finch_api/models/hris/company_retrieve_params.rbi @@ -15,7 +15,8 @@ module FinchAPI ) end - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. sig { returns(T.nilable(T::Array[String])) } attr_reader :entity_ids @@ -29,7 +30,8 @@ module FinchAPI ).returns(T.attached_class) end def self.new( - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. entity_ids: nil, request_options: {} ) diff --git a/rbi/finch_api/models/hris/directory_list_individuals_params.rbi b/rbi/finch_api/models/hris/directory_list_individuals_params.rbi index 4a1c62d0..f0910cc3 100644 --- a/rbi/finch_api/models/hris/directory_list_individuals_params.rbi +++ b/rbi/finch_api/models/hris/directory_list_individuals_params.rbi @@ -15,7 +15,8 @@ module FinchAPI ) end - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. sig { returns(T.nilable(T::Array[String])) } attr_reader :entity_ids @@ -45,7 +46,8 @@ module FinchAPI ).returns(T.attached_class) end def self.new( - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. entity_ids: nil, # Number of employees to return (defaults to 100, maximum 10000) limit: nil, diff --git a/rbi/finch_api/models/hris/directory_list_params.rbi b/rbi/finch_api/models/hris/directory_list_params.rbi index 078b9688..a5e3c691 100644 --- a/rbi/finch_api/models/hris/directory_list_params.rbi +++ b/rbi/finch_api/models/hris/directory_list_params.rbi @@ -15,7 +15,8 @@ module FinchAPI ) end - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. sig { returns(T.nilable(T::Array[String])) } attr_reader :entity_ids @@ -45,7 +46,8 @@ module FinchAPI ).returns(T.attached_class) end def self.new( - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. entity_ids: nil, # Number of employees to return (defaults to 100, maximum 10000) limit: nil, diff --git a/rbi/finch_api/models/hris/document_list_params.rbi b/rbi/finch_api/models/hris/document_list_params.rbi index adf48d2e..581947f9 100644 --- a/rbi/finch_api/models/hris/document_list_params.rbi +++ b/rbi/finch_api/models/hris/document_list_params.rbi @@ -15,7 +15,8 @@ module FinchAPI ) end - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. sig { returns(T.nilable(T::Array[String])) } attr_reader :entity_ids @@ -73,7 +74,8 @@ module FinchAPI ).returns(T.attached_class) end def self.new( - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. entity_ids: nil, # Comma-delimited list of stable Finch uuids for each individual. If empty, # defaults to all individuals diff --git a/rbi/finch_api/models/hris/document_retreive_params.rbi b/rbi/finch_api/models/hris/document_retreive_params.rbi index b9d28283..f72ecca1 100644 --- a/rbi/finch_api/models/hris/document_retreive_params.rbi +++ b/rbi/finch_api/models/hris/document_retreive_params.rbi @@ -18,7 +18,8 @@ module FinchAPI sig { returns(String) } attr_accessor :document_id - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. sig { returns(T.nilable(T::Array[String])) } attr_reader :entity_ids @@ -34,7 +35,8 @@ module FinchAPI end def self.new( document_id:, - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. entity_ids: nil, request_options: {} ) diff --git a/rbi/finch_api/models/hris/employment_retrieve_many_params.rbi b/rbi/finch_api/models/hris/employment_retrieve_many_params.rbi index b9e47d3b..9772efed 100644 --- a/rbi/finch_api/models/hris/employment_retrieve_many_params.rbi +++ b/rbi/finch_api/models/hris/employment_retrieve_many_params.rbi @@ -23,7 +23,8 @@ module FinchAPI end attr_accessor :requests - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. sig { returns(T.nilable(T::Array[String])) } attr_reader :entity_ids @@ -43,7 +44,8 @@ module FinchAPI def self.new( # The array of batch requests. Maximum 10000 items per request. requests:, - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. entity_ids: nil, request_options: {} ) diff --git a/rbi/finch_api/models/hris/individual_retrieve_many_params.rbi b/rbi/finch_api/models/hris/individual_retrieve_many_params.rbi index 91e36601..79705580 100644 --- a/rbi/finch_api/models/hris/individual_retrieve_many_params.rbi +++ b/rbi/finch_api/models/hris/individual_retrieve_many_params.rbi @@ -23,7 +23,8 @@ module FinchAPI end attr_accessor :requests - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. sig { returns(T.nilable(T::Array[String])) } attr_reader :entity_ids @@ -64,7 +65,8 @@ module FinchAPI def self.new( # The array of batch requests. Maximum 10000 items per request. requests:, - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. entity_ids: nil, options: nil, request_options: {} diff --git a/rbi/finch_api/models/hris/pay_statement_item/rule_create_params.rbi b/rbi/finch_api/models/hris/pay_statement_item/rule_create_params.rbi index f6553029..88da4b9f 100644 --- a/rbi/finch_api/models/hris/pay_statement_item/rule_create_params.rbi +++ b/rbi/finch_api/models/hris/pay_statement_item/rule_create_params.rbi @@ -16,7 +16,8 @@ module FinchAPI ) end - # The entity IDs to create the rule for. + # The entity IDs to create the rule for. Provide exactly one entity ID per + # request; a maximum of one is accepted. sig { returns(T.nilable(T::Array[String])) } attr_reader :entity_ids @@ -105,7 +106,8 @@ module FinchAPI ).returns(T.attached_class) end def self.new( - # The entity IDs to create the rule for. + # The entity IDs to create the rule for. Provide exactly one entity ID per + # request; a maximum of one is accepted. entity_ids: nil, # Specifies the fields to be applied when the condition is met. attributes: nil, diff --git a/rbi/finch_api/models/hris/pay_statement_item/rule_delete_params.rbi b/rbi/finch_api/models/hris/pay_statement_item/rule_delete_params.rbi index 1e02b6bd..816cd4f1 100644 --- a/rbi/finch_api/models/hris/pay_statement_item/rule_delete_params.rbi +++ b/rbi/finch_api/models/hris/pay_statement_item/rule_delete_params.rbi @@ -19,7 +19,8 @@ module FinchAPI sig { returns(String) } attr_accessor :rule_id - # The entity IDs to delete the rule for. + # The entity IDs to delete the rule for. Provide exactly one entity ID per + # request; a maximum of one is accepted. sig { returns(T.nilable(T::Array[String])) } attr_reader :entity_ids @@ -35,7 +36,8 @@ module FinchAPI end def self.new( rule_id:, - # The entity IDs to delete the rule for. + # The entity IDs to delete the rule for. Provide exactly one entity ID per + # request; a maximum of one is accepted. entity_ids: nil, request_options: {} ) diff --git a/rbi/finch_api/models/hris/pay_statement_item/rule_list_params.rbi b/rbi/finch_api/models/hris/pay_statement_item/rule_list_params.rbi index d2d6cfb5..ca90fa36 100644 --- a/rbi/finch_api/models/hris/pay_statement_item/rule_list_params.rbi +++ b/rbi/finch_api/models/hris/pay_statement_item/rule_list_params.rbi @@ -16,7 +16,8 @@ module FinchAPI ) end - # The entity IDs to retrieve rules for. + # The entity IDs to retrieve rules for. Provide exactly one entity ID per request; + # a maximum of one is accepted. sig { returns(T.nilable(T::Array[String])) } attr_reader :entity_ids @@ -30,7 +31,8 @@ module FinchAPI ).returns(T.attached_class) end def self.new( - # The entity IDs to retrieve rules for. + # The entity IDs to retrieve rules for. Provide exactly one entity ID per request; + # a maximum of one is accepted. entity_ids: nil, request_options: {} ) diff --git a/rbi/finch_api/models/hris/pay_statement_item/rule_update_params.rbi b/rbi/finch_api/models/hris/pay_statement_item/rule_update_params.rbi index 73631bf9..f421431b 100644 --- a/rbi/finch_api/models/hris/pay_statement_item/rule_update_params.rbi +++ b/rbi/finch_api/models/hris/pay_statement_item/rule_update_params.rbi @@ -19,7 +19,8 @@ module FinchAPI sig { returns(String) } attr_accessor :rule_id - # The entity IDs to update the rule for. + # The entity IDs to update the rule for. Provide exactly one entity ID per + # request; a maximum of one is accepted. sig { returns(T.nilable(T::Array[String])) } attr_reader :entity_ids @@ -42,7 +43,8 @@ module FinchAPI end def self.new( rule_id:, - # The entity IDs to update the rule for. + # The entity IDs to update the rule for. Provide exactly one entity ID per + # request; a maximum of one is accepted. entity_ids: nil, optional_property: nil, request_options: {} diff --git a/rbi/finch_api/models/hris/pay_statement_item_list_params.rbi b/rbi/finch_api/models/hris/pay_statement_item_list_params.rbi index e157c1ea..af0ab0ef 100644 --- a/rbi/finch_api/models/hris/pay_statement_item_list_params.rbi +++ b/rbi/finch_api/models/hris/pay_statement_item_list_params.rbi @@ -46,7 +46,8 @@ module FinchAPI sig { params(end_date: Date).void } attr_writer :end_date - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. sig { returns(T.nilable(T::Array[String])) } attr_reader :entity_ids @@ -96,7 +97,8 @@ module FinchAPI # The end date to retrieve pay statement items by via their last seen pay date in # `YYYY-MM-DD` format. end_date: nil, - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. entity_ids: nil, # Case-insensitive partial match search by pay statement item name. name: nil, diff --git a/rbi/finch_api/models/hris/pay_statement_retrieve_many_params.rbi b/rbi/finch_api/models/hris/pay_statement_retrieve_many_params.rbi index cb66ca44..7c5037d1 100644 --- a/rbi/finch_api/models/hris/pay_statement_retrieve_many_params.rbi +++ b/rbi/finch_api/models/hris/pay_statement_retrieve_many_params.rbi @@ -23,7 +23,8 @@ module FinchAPI end attr_accessor :requests - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. sig { returns(T.nilable(T::Array[String])) } attr_reader :entity_ids @@ -43,7 +44,8 @@ module FinchAPI def self.new( # The array of batch requests. Maximum 10 payment_ids per request. requests:, - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. entity_ids: nil, request_options: {} ) diff --git a/rbi/finch_api/models/hris/payment_list_params.rbi b/rbi/finch_api/models/hris/payment_list_params.rbi index d5c9c193..0f4d9cb6 100644 --- a/rbi/finch_api/models/hris/payment_list_params.rbi +++ b/rbi/finch_api/models/hris/payment_list_params.rbi @@ -25,7 +25,8 @@ module FinchAPI sig { returns(Date) } attr_accessor :start_date - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. sig { returns(T.nilable(T::Array[String])) } attr_reader :entity_ids @@ -47,7 +48,8 @@ module FinchAPI # The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` # format. Filters payments by their **pay_date** field. start_date:, - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. entity_ids: nil, request_options: {} ) diff --git a/rbi/finch_api/models/introspection.rbi b/rbi/finch_api/models/introspection.rbi index c3202d56..79de2d3a 100644 --- a/rbi/finch_api/models/introspection.rbi +++ b/rbi/finch_api/models/introspection.rbi @@ -72,8 +72,7 @@ module FinchAPI end attr_writer :authentication_methods - # [DEPRECATED] Use `connection_id` to associate tokens with a Finch connection - # instead of this company ID + # The Finch UUID of the company associated with the `access_token`. sig { returns(T.nilable(String)) } attr_reader :company_id @@ -172,8 +171,7 @@ module FinchAPI # instead of this account ID account_id: nil, authentication_methods: nil, - # [DEPRECATED] Use `connection_id` to associate tokens with a Finch connection - # instead of this company ID + # The Finch UUID of the company associated with the `access_token`. company_id: nil, # The email of your customer you provided to Finch when a connect session was # created for this connection diff --git a/rbi/finch_api/models/payroll/pay_group_list_params.rbi b/rbi/finch_api/models/payroll/pay_group_list_params.rbi index 75a4c03d..f88013ed 100644 --- a/rbi/finch_api/models/payroll/pay_group_list_params.rbi +++ b/rbi/finch_api/models/payroll/pay_group_list_params.rbi @@ -15,7 +15,8 @@ module FinchAPI ) end - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. sig { returns(T.nilable(T::Array[String])) } attr_reader :entity_ids @@ -43,7 +44,8 @@ module FinchAPI ).returns(T.attached_class) end def self.new( - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. entity_ids: nil, individual_id: nil, pay_frequencies: nil, diff --git a/rbi/finch_api/models/payroll/pay_group_retrieve_params.rbi b/rbi/finch_api/models/payroll/pay_group_retrieve_params.rbi index 1ba66d74..12f6d660 100644 --- a/rbi/finch_api/models/payroll/pay_group_retrieve_params.rbi +++ b/rbi/finch_api/models/payroll/pay_group_retrieve_params.rbi @@ -18,7 +18,8 @@ module FinchAPI sig { returns(String) } attr_accessor :pay_group_id - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. sig { returns(T.nilable(T::Array[String])) } attr_reader :entity_ids @@ -34,7 +35,8 @@ module FinchAPI end def self.new( pay_group_id:, - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. entity_ids: nil, request_options: {} ) diff --git a/rbi/finch_api/models/sandbox/connection_create_response.rbi b/rbi/finch_api/models/sandbox/connection_create_response.rbi index 1709fe3e..45add9b0 100644 --- a/rbi/finch_api/models/sandbox/connection_create_response.rbi +++ b/rbi/finch_api/models/sandbox/connection_create_response.rbi @@ -26,7 +26,7 @@ module FinchAPI end attr_accessor :authentication_type - # [DEPRECATED] Use `connection_id` to associate a connection with an access token + # The Finch UUID of the company associated with the `access_token`. sig { returns(String) } attr_accessor :company_id @@ -70,7 +70,7 @@ module FinchAPI # [DEPRECATED] Use `connection_id` to associate a connection with an access token account_id:, authentication_type:, - # [DEPRECATED] Use `connection_id` to associate a connection with an access token + # The Finch UUID of the company associated with the `access_token`. company_id:, # The ID of the new connection connection_id:, diff --git a/rbi/finch_api/models/sandbox/connections/account_create_response.rbi b/rbi/finch_api/models/sandbox/connections/account_create_response.rbi index 28441fa0..ae9e80c1 100644 --- a/rbi/finch_api/models/sandbox/connections/account_create_response.rbi +++ b/rbi/finch_api/models/sandbox/connections/account_create_response.rbi @@ -27,7 +27,7 @@ module FinchAPI end attr_accessor :authentication_type - # [DEPRECATED] Use `connection_id` to associate a connection with an access token + # The Finch UUID of the company associated with the `access_token`. sig { returns(String) } attr_accessor :company_id @@ -64,7 +64,7 @@ module FinchAPI # [DEPRECATED] Use `connection_id` to associate a connection with an access token account_id:, authentication_type:, - # [DEPRECATED] Use `connection_id` to associate a connection with an access token + # The Finch UUID of the company associated with the `access_token`. company_id:, # The ID of the new connection connection_id:, diff --git a/rbi/finch_api/models/sandbox/connections/account_update_response.rbi b/rbi/finch_api/models/sandbox/connections/account_update_response.rbi index bace5d56..01954523 100644 --- a/rbi/finch_api/models/sandbox/connections/account_update_response.rbi +++ b/rbi/finch_api/models/sandbox/connections/account_update_response.rbi @@ -24,7 +24,7 @@ module FinchAPI end attr_accessor :authentication_type - # [DEPRECATED] Use `connection_id` to associate a connection with an access token + # The Finch UUID of the company associated with the `access_token`. sig { returns(String) } attr_accessor :company_id @@ -59,7 +59,7 @@ module FinchAPI # [DEPRECATED] Use `connection_id` to associate a connection with an access token account_id:, authentication_type:, - # [DEPRECATED] Use `connection_id` to associate a connection with an access token + # The Finch UUID of the company associated with the `access_token`. company_id:, # The ID of the new connection connection_id:, diff --git a/rbi/finch_api/resources/hris/benefits.rbi b/rbi/finch_api/resources/hris/benefits.rbi index 1330c68a..0621941f 100644 --- a/rbi/finch_api/resources/hris/benefits.rbi +++ b/rbi/finch_api/resources/hris/benefits.rbi @@ -23,7 +23,8 @@ module FinchAPI ).returns(FinchAPI::HRIS::CreateCompanyBenefitsResponse) end def create( - # Query param: The entity IDs to specify which entities' data to access. + # Query param: The entity IDs to specify which entities' data to access. Provide + # exactly one entity ID per request; a maximum of one is accepted. entity_ids: nil, # Body param: The company match for this benefit. company_contribution: nil, @@ -49,7 +50,8 @@ module FinchAPI end def retrieve( benefit_id, - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. entity_ids: nil, request_options: {} ) @@ -67,7 +69,8 @@ module FinchAPI def update( # Path param benefit_id, - # Query param: The entity IDs to specify which entities' data to access. + # Query param: The entity IDs to specify which entities' data to access. Provide + # exactly one entity ID per request; a maximum of one is accepted. entity_ids: nil, # Body param: Updated name or description. description: nil, @@ -85,7 +88,8 @@ module FinchAPI ) end def list( - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. entity_ids: nil, request_options: {} ) @@ -101,7 +105,8 @@ module FinchAPI ) end def list_supported_benefits( - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. entity_ids: nil, request_options: {} ) @@ -119,7 +124,8 @@ module FinchAPI ).returns(FinchAPI::HRIS::RegisterCompanyBenefitResponse) end def register( - # Query param: The entity IDs to specify which entities' data to access. + # Query param: The entity IDs to specify which entities' data to access. Provide + # exactly one entity ID per request; a maximum of one is accepted. entity_ids: nil, # Body param description: nil, diff --git a/rbi/finch_api/resources/hris/benefits/individuals.rbi b/rbi/finch_api/resources/hris/benefits/individuals.rbi index 1e0aa718..c99eaff7 100644 --- a/rbi/finch_api/resources/hris/benefits/individuals.rbi +++ b/rbi/finch_api/resources/hris/benefits/individuals.rbi @@ -25,7 +25,8 @@ module FinchAPI def enroll_many( # Path param benefit_id, - # Query param: The entity IDs to specify which entities' data to access. + # Query param: The entity IDs to specify which entities' data to access. Provide + # exactly one entity ID per request; a maximum of one is accepted. entity_ids: nil, # Body param: Array of the individual_id to enroll and a configuration object. individuals: nil, @@ -45,7 +46,8 @@ module FinchAPI end def enrolled_ids( benefit_id, - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. entity_ids: nil, request_options: {} ) @@ -66,7 +68,8 @@ module FinchAPI end def retrieve_many_benefits( benefit_id, - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. entity_ids: nil, # comma-delimited list of stable Finch uuids for each individual. If empty, # defaults to all individuals @@ -89,7 +92,8 @@ module FinchAPI def unenroll_many( # Path param benefit_id, - # Query param: The entity IDs to specify which entities' data to access. + # Query param: The entity IDs to specify which entities' data to access. Provide + # exactly one entity ID per request; a maximum of one is accepted. entity_ids: nil, # Body param: Array of individual_ids to unenroll. individual_ids: nil, diff --git a/rbi/finch_api/resources/hris/company.rbi b/rbi/finch_api/resources/hris/company.rbi index d5e5de23..8618da47 100644 --- a/rbi/finch_api/resources/hris/company.rbi +++ b/rbi/finch_api/resources/hris/company.rbi @@ -12,7 +12,8 @@ module FinchAPI ).returns(FinchAPI::HRIS::HRISCompany) end def retrieve( - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. entity_ids: nil, request_options: {} ) diff --git a/rbi/finch_api/resources/hris/directory.rbi b/rbi/finch_api/resources/hris/directory.rbi index 900809ea..5a104455 100644 --- a/rbi/finch_api/resources/hris/directory.rbi +++ b/rbi/finch_api/resources/hris/directory.rbi @@ -18,7 +18,8 @@ module FinchAPI ) end def list( - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. entity_ids: nil, # Number of employees to return (defaults to 100, maximum 10000) limit: nil, diff --git a/rbi/finch_api/resources/hris/documents.rbi b/rbi/finch_api/resources/hris/documents.rbi index 5b59035c..28cd0904 100644 --- a/rbi/finch_api/resources/hris/documents.rbi +++ b/rbi/finch_api/resources/hris/documents.rbi @@ -17,7 +17,8 @@ module FinchAPI ).returns(FinchAPI::Models::HRIS::DocumentListResponse) end def list( - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. entity_ids: nil, # Comma-delimited list of stable Finch uuids for each individual. If empty, # defaults to all individuals @@ -45,7 +46,8 @@ module FinchAPI def retreive( # The unique identifier of the document. document_id, - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. entity_ids: nil, request_options: {} ) diff --git a/rbi/finch_api/resources/hris/employments.rbi b/rbi/finch_api/resources/hris/employments.rbi index 40b109a5..ff48468a 100644 --- a/rbi/finch_api/resources/hris/employments.rbi +++ b/rbi/finch_api/resources/hris/employments.rbi @@ -22,7 +22,8 @@ module FinchAPI def retrieve_many( # Body param: The array of batch requests. Maximum 10000 items per request. requests:, - # Query param: The entity IDs to specify which entities' data to access. + # Query param: The entity IDs to specify which entities' data to access. Provide + # exactly one entity ID per request; a maximum of one is accepted. entity_ids: nil, request_options: {} ) diff --git a/rbi/finch_api/resources/hris/individuals.rbi b/rbi/finch_api/resources/hris/individuals.rbi index 7d0e40b1..49e6bb14 100644 --- a/rbi/finch_api/resources/hris/individuals.rbi +++ b/rbi/finch_api/resources/hris/individuals.rbi @@ -26,7 +26,8 @@ module FinchAPI def retrieve_many( # Body param: The array of batch requests. Maximum 10000 items per request. requests:, - # Query param: The entity IDs to specify which entities' data to access. + # Query param: The entity IDs to specify which entities' data to access. Provide + # exactly one entity ID per request; a maximum of one is accepted. entity_ids: nil, # Body param options: nil, diff --git a/rbi/finch_api/resources/hris/pay_statement_item.rbi b/rbi/finch_api/resources/hris/pay_statement_item.rbi index 3ae3a13b..db45c72a 100644 --- a/rbi/finch_api/resources/hris/pay_statement_item.rbi +++ b/rbi/finch_api/resources/hris/pay_statement_item.rbi @@ -34,7 +34,8 @@ module FinchAPI # The end date to retrieve pay statement items by via their last seen pay date in # `YYYY-MM-DD` format. end_date: nil, - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. entity_ids: nil, # Case-insensitive partial match search by pay statement item name. name: nil, diff --git a/rbi/finch_api/resources/hris/pay_statement_item/rules.rbi b/rbi/finch_api/resources/hris/pay_statement_item/rules.rbi index 12f37958..77cbe4b9 100644 --- a/rbi/finch_api/resources/hris/pay_statement_item/rules.rbi +++ b/rbi/finch_api/resources/hris/pay_statement_item/rules.rbi @@ -28,7 +28,8 @@ module FinchAPI ) end def create( - # Query param: The entity IDs to create the rule for. + # Query param: The entity IDs to create the rule for. Provide exactly one entity + # ID per request; a maximum of one is accepted. entity_ids: nil, # Body param: Specifies the fields to be applied when the condition is met. attributes: nil, @@ -59,7 +60,8 @@ module FinchAPI def update( # Path param rule_id, - # Query param: The entity IDs to update the rule for. + # Query param: The entity IDs to update the rule for. Provide exactly one entity + # ID per request; a maximum of one is accepted. entity_ids: nil, # Body param optional_property: nil, @@ -79,7 +81,8 @@ module FinchAPI ) end def list( - # The entity IDs to retrieve rules for. + # The entity IDs to retrieve rules for. Provide exactly one entity ID per request; + # a maximum of one is accepted. entity_ids: nil, request_options: {} ) @@ -97,7 +100,8 @@ module FinchAPI end def delete( rule_id, - # The entity IDs to delete the rule for. + # The entity IDs to delete the rule for. Provide exactly one entity ID per + # request; a maximum of one is accepted. entity_ids: nil, request_options: {} ) diff --git a/rbi/finch_api/resources/hris/pay_statements.rbi b/rbi/finch_api/resources/hris/pay_statements.rbi index 96679354..3b80a749 100644 --- a/rbi/finch_api/resources/hris/pay_statements.rbi +++ b/rbi/finch_api/resources/hris/pay_statements.rbi @@ -25,7 +25,8 @@ module FinchAPI def retrieve_many( # Body param: The array of batch requests. Maximum 10 payment_ids per request. requests:, - # Query param: The entity IDs to specify which entities' data to access. + # Query param: The entity IDs to specify which entities' data to access. Provide + # exactly one entity ID per request; a maximum of one is accepted. entity_ids: nil, request_options: {} ) diff --git a/rbi/finch_api/resources/hris/payments.rbi b/rbi/finch_api/resources/hris/payments.rbi index 0fdc717a..97399638 100644 --- a/rbi/finch_api/resources/hris/payments.rbi +++ b/rbi/finch_api/resources/hris/payments.rbi @@ -20,7 +20,8 @@ module FinchAPI # The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` # format. Filters payments by their **pay_date** field. start_date:, - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. entity_ids: nil, request_options: {} ) diff --git a/rbi/finch_api/resources/payroll/pay_groups.rbi b/rbi/finch_api/resources/payroll/pay_groups.rbi index a31fdc15..c27d428d 100644 --- a/rbi/finch_api/resources/payroll/pay_groups.rbi +++ b/rbi/finch_api/resources/payroll/pay_groups.rbi @@ -14,7 +14,8 @@ module FinchAPI end def retrieve( pay_group_id, - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. entity_ids: nil, request_options: {} ) @@ -34,7 +35,8 @@ module FinchAPI ) end def list( - # The entity IDs to specify which entities' data to access. + # The entity IDs to specify which entities' data to access. Provide exactly one + # entity ID per request; a maximum of one is accepted. entity_ids: nil, individual_id: nil, pay_frequencies: nil, From 5c6d5c6f3ac4eb9137f3763c013b39c1be15e40b Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 15 Jul 2026 17:37:19 +0000 Subject: [PATCH 2/2] release: 0.1.0-alpha.49 --- .release-please-manifest.json | 2 +- CHANGELOG.md | 8 ++++++++ Gemfile.lock | 2 +- README.md | 2 +- lib/finch_api/version.rb | 2 +- 5 files changed, 12 insertions(+), 4 deletions(-) diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 21a705e3..1916b020 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "0.1.0-alpha.48" + ".": "0.1.0-alpha.49" } \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 1d44f202..64d8c190 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Changelog +## 0.1.0-alpha.49 (2026-07-15) + +Full Changelog: [v0.1.0-alpha.48...v0.1.0-alpha.49](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.48...v0.1.0-alpha.49) + +### Features + +* **api:** api update ([41c1dd6](https://github.com/Finch-API/finch-api-ruby/commit/41c1dd679e77e2a293321fbdff1d145149c3af5f)) + ## 0.1.0-alpha.48 (2026-07-13) Full Changelog: [v0.1.0-alpha.47...v0.1.0-alpha.48](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.47...v0.1.0-alpha.48) diff --git a/Gemfile.lock b/Gemfile.lock index 4b53d247..b7b49596 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -11,7 +11,7 @@ GIT PATH remote: . specs: - finch-api (0.1.0.pre.alpha.48) + finch-api (0.1.0.pre.alpha.49) cgi connection_pool diff --git a/README.md b/README.md index 3fbaec0f..6e959d64 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application ```ruby -gem "finch-api", "~> 0.1.0.pre.alpha.48" +gem "finch-api", "~> 0.1.0.pre.alpha.49" ``` diff --git a/lib/finch_api/version.rb b/lib/finch_api/version.rb index 8895b174..c3ccfa44 100644 --- a/lib/finch_api/version.rb +++ b/lib/finch_api/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module FinchAPI - VERSION = "0.1.0.pre.alpha.48" + VERSION = "0.1.0.pre.alpha.49" end