finch-api 0.1.0.pre.alpha.48 → 0.1.0.pre.alpha.49

data/lib/finch_api/models/introspection.rb

@@ -70,10 +70,7 @@ module FinchAPI
                -> { 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 @@ module FinchAPI
       #
       #   @param authentication_methods [Array<FinchAPI::Models::Introspection::AuthenticationMethod>]
       #
-      #   @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
       #

data/lib/finch_api/models/payroll/pay_group_list_params.rb

@@ -9,7 +9,8 @@ module FinchAPI
         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<String>, nil]
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
@@ -25,7 +26,10 @@ module FinchAPI
         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<String>] 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<String>] The entity IDs to specify which entities' data to access. Provide exactly one en
         #
         #   @param individual_id [String]
         #

data/lib/finch_api/models/payroll/pay_group_retrieve_params.rb

@@ -14,15 +14,19 @@ module FinchAPI
         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<String>, 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<String>] The entity IDs to specify which entities' data to access.
+        #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access. Provide exactly one en
         #
         #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
       end

data/lib/finch_api/models/sandbox/connection_create_response.rb

@@ -25,9 +25,7 @@ module FinchAPI
                  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 @@ module FinchAPI
         #
         #   @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
         #

data/lib/finch_api/models/sandbox/connections/account_create_response.rb

@@ -26,9 +26,7 @@ module FinchAPI
                    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 @@ module FinchAPI
           #
           #   @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
           #

data/lib/finch_api/models/sandbox/connections/account_update_response.rb

@@ -21,9 +21,7 @@ module FinchAPI
                    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 @@ module FinchAPI
           #
           #   @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
           #

data/lib/finch_api/resources/hris/benefits/individuals.rb

@@ -5,6 +5,9 @@ module FinchAPI
     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 @@ module FinchAPI
           #
           # @param benefit_id [String] Path param
           #
-          # @param entity_ids [Array<String>] Query param: The entity IDs to specify which entities' data to access.
+          # @param entity_ids [Array<String>] Query param: The entity IDs to specify which entities' data to access. Provide e
           #
           # @param individuals [Array<FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual>] Body param: Array of the individual_id to enroll and a configuration object.
           #
@@ -37,13 +40,17 @@ module FinchAPI
             )
           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<String>] The entity IDs to specify which entities' data to access.
+          # @param entity_ids [Array<String>] 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 @@ module FinchAPI
           #
           # @param benefit_id [String]
           #
-          # @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+          # @param entity_ids [Array<String>] 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 @@ module FinchAPI
             )
           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<String>] Query param: The entity IDs to specify which entities' data to access.
+          # @param entity_ids [Array<String>] Query param: The entity IDs to specify which entities' data to access. Provide e
           #
           # @param individual_ids [Array<String>] Body param: Array of individual_ids to unenroll.
           #

data/lib/finch_api/resources/hris/benefits.rb

@@ -15,7 +15,7 @@ module FinchAPI
         #
         # @overload create(entity_ids: nil, company_contribution: nil, description: nil, frequency: nil, type: nil, request_options: {})
         #
-        # @param entity_ids [Array<String>] Query param: The entity IDs to specify which entities' data to access.
+        # @param entity_ids [Array<String>] 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 @@ module FinchAPI
           )
         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<String>] The entity IDs to specify which entities' data to access.
+        # @param entity_ids [Array<String>] 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 @@ module FinchAPI
           )
         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<String>] Query param: The entity IDs to specify which entities' data to access.
+        # @param entity_ids [Array<String>] 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 @@ module FinchAPI
           )
         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<String>] The entity IDs to specify which entities' data to access.
+        # @param entity_ids [Array<String>] 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 @@ module FinchAPI
           )
         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<String>] The entity IDs to specify which entities' data to access.
+        # @param entity_ids [Array<String>] 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 @@ module FinchAPI
           )
         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<String>] Query param: The entity IDs to specify which entities' data to access.
+        # @param entity_ids [Array<String>] Query param: The entity IDs to specify which entities' data to access. Provide e
         #
         # @param description [String] Body param
         #

data/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<String>] The entity IDs to specify which entities' data to access.
+        # @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access. Provide exactly one en
         #
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #

data/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<String>] The entity IDs to specify which entities' data to access.
+        # @param entity_ids [Array<String>] 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)
         #

data/lib/finch_api/resources/hris/documents.rb

@@ -12,7 +12,7 @@ module FinchAPI
         #
         # @overload list(entity_ids: nil, individual_ids: nil, limit: nil, offset: nil, types: nil, request_options: {})
         #
-        # @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+        # @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access. Provide exactly one en
         #
         # @param individual_ids [Array<String>] Comma-delimited list of stable Finch uuids for each individual. If empty, defaul
         #
@@ -40,6 +40,9 @@ module FinchAPI
           )
         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 @@ module FinchAPI
         #
         # @param document_id [String] The unique identifier of the document.
         #
-        # @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+        # @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access. Provide exactly one en
         #
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #

data/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<FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request>] Body param: The array of batch requests. Maximum 10000 items per request.
         #
-        # @param entity_ids [Array<String>] Query param: The entity IDs to specify which entities' data to access.
+        # @param entity_ids [Array<String>] Query param: The entity IDs to specify which entities' data to access. Provide e
         #
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #

data/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<FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request>] Body param: The array of batch requests. Maximum 10000 items per request.
         #
-        # @param entity_ids [Array<String>] Query param: The entity IDs to specify which entities' data to access.
+        # @param entity_ids [Array<String>] Query param: The entity IDs to specify which entities' data to access. Provide e
         #
         # @param options [FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options, nil] Body param
         #

data/lib/finch_api/resources/hris/pay_statement_item/rules.rb

@@ -15,7 +15,7 @@ module FinchAPI
           #
           # @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<String>] Query param: The entity IDs to create the rule for.
+          # @param entity_ids [Array<String>] 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 @@ module FinchAPI
             )
           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<String>] Query param: The entity IDs to update the rule for.
+          # @param entity_ids [Array<String>] 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 @@ module FinchAPI
             )
           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<String>] The entity IDs to retrieve rules for.
+          # @param entity_ids [Array<String>] 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 @@ module FinchAPI
             )
           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<String>] The entity IDs to delete the rule for.
+          # @param entity_ids [Array<String>] The entity IDs to delete the rule for. Provide exactly one entity ID per request
           #
           # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
           #

data/lib/finch_api/resources/hris/pay_statement_item.rb

@@ -19,7 +19,7 @@ module FinchAPI
         #
         # @param end_date [Date] The end date to retrieve pay statement items by via their last seen pay date in
         #
-        # @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+        # @param entity_ids [Array<String>] 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.
         #

data/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 @@ module FinchAPI
         #
         # @param requests [Array<FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request>] Body param: The array of batch requests. Maximum 10 payment_ids per request.
         #
-        # @param entity_ids [Array<String>] Query param: The entity IDs to specify which entities' data to access.
+        # @param entity_ids [Array<String>] Query param: The entity IDs to specify which entities' data to access. Provide e
         #
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #

data/lib/finch_api/resources/hris/payments.rb

@@ -15,7 +15,7 @@ module FinchAPI
         #
         # @param start_date [Date] The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` for
         #
-        # @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+        # @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access. Provide exactly one en
         #
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #

data/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<String>] The entity IDs to specify which entities' data to access.
+        # @param entity_ids [Array<String>] 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 @@ module FinchAPI
           )
         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<String>] The entity IDs to specify which entities' data to access.
+        # @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access. Provide exactly one en
         #
         # @param individual_id [String]
         #

data/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

data/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,

data/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

data/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,

data/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: {}
         )

data/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: {}
         )