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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d72b85c28e95991506b4f4d20d1b1c8c8ae54b4ef656ec79210795b272a5e439
-  data.tar.gz: 146fdf2ddd617dec5c4d2529317f47bed9bc94fd75304a76eb2b796f82c96a85
+  metadata.gz: 6a516f81f01b9ea7b24c991040f7e588ce4f22f522774c44bda36f84fa4c0d95
+  data.tar.gz: 698f1bb3796033699051458fe674ee2c37c8054f57044b18be53d5a3083997c2
 SHA512:
-  metadata.gz: 0d9015997865fc43f4e58052e485f985d4cf835f5b2554ccc7d2ca6272788f3fa9758f58bd2661893cecd5516eef1123c0f1fdaaebb35f8975040d4e2a97b53a
-  data.tar.gz: 0f9c496781f22ece4bc691e06c43171d845a1b1f22efdc33ba9a9d576d0720711de6e0ede2df61e2306268a40d65c54a98b3871de38551991ebe9e1cb2d3243a
+  metadata.gz: '09ef57663d79aebd52343bc5c40e7120ae29687dfbf6e1a471c120ddae9dec213b544cb4fc0e0b3b9a14920f6cc3d13a48eb159b1f6e762d2d5a6fbcbf2c2359'
+  data.tar.gz: 8f1be6bedac4265bb4587fa9788d87c5a0278072772c196d5e55f7b7f1e8bbc03d980d69d4d7a7674fc14b6cb2dee1ab022b05c7eb8537eabc3531998144fe35

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 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)
+
+### Features
+
+* **api:** api update ([69e8027](https://github.com/Finch-API/finch-api-ruby/commit/69e8027b72120985c9e601d517162a0225f3dd6d))
+
+## 0.1.0-alpha.47 (2026-07-01)
+
+Full Changelog: [v0.1.0-alpha.46...v0.1.0-alpha.47](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.46...v0.1.0-alpha.47)
+
+### Features
+
+* **api:** api update ([7daf44a](https://github.com/Finch-API/finch-api-ruby/commit/7daf44ad7a23d25ef1a63499dd067be62dcdc0fd))
+
 ## 0.1.0-alpha.46 (2026-06-29)
 
 Full Changelog: [v0.1.0-alpha.45...v0.1.0-alpha.46](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.45...v0.1.0-alpha.46)

data/README.md

@@ -26,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "finch-api", "~> 0.1.0.pre.alpha.46"
+gem "finch-api", "~> 0.1.0.pre.alpha.48"
 ```
 
 <!-- x-release-please-end -->

data/lib/finch_api/models/hris/directory_list_individuals_params.rb

@@ -15,7 +15,7 @@ module FinchAPI
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
 
         # @!attribute limit
-        #   Number of employees to return (defaults to all)
+        #   Number of employees to return (defaults to 100, maximum 10000)
         #
         #   @return [Integer, nil]
         optional :limit, Integer
@@ -29,7 +29,7 @@ module FinchAPI
         # @!method initialize(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 limit [Integer] Number of employees to return (defaults to all)
+        #   @param limit [Integer] Number of employees to return (defaults to 100, maximum 10000)
         #
         #   @param offset [Integer] Index to start from (defaults to 0)
         #

data/lib/finch_api/models/hris/directory_list_params.rb

@@ -15,7 +15,7 @@ module FinchAPI
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
 
         # @!attribute limit
-        #   Number of employees to return (defaults to all)
+        #   Number of employees to return (defaults to 100, maximum 10000)
         #
         #   @return [Integer, nil]
         optional :limit, Integer
@@ -29,7 +29,7 @@ module FinchAPI
         # @!method initialize(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 limit [Integer] Number of employees to return (defaults to all)
+        #   @param limit [Integer] Number of employees to return (defaults to 100, maximum 10000)
         #
         #   @param offset [Integer] Index to start from (defaults to 0)
         #

data/lib/finch_api/models/hris/employment_retrieve_many_params.rb

@@ -9,7 +9,7 @@ module FinchAPI
         include FinchAPI::Internal::Type::RequestParameters
 
         # @!attribute requests
-        #   The array of batch requests.
+        #   The array of batch requests. Maximum 10000 items per request.
         #
         #   @return [Array<FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request>]
         required :requests,
@@ -22,7 +22,7 @@ module FinchAPI
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
 
         # @!method initialize(requests:, entity_ids: nil, request_options: {})
-        #   @param requests [Array<FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request>] The array of batch requests.
+        #   @param requests [Array<FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request>] The array of batch requests. Maximum 10000 items per request.
         #
         #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
         #
@@ -30,19 +30,13 @@ module FinchAPI
 
         class Request < FinchAPI::Internal::Type::BaseModel
           # @!attribute individual_id
-          #   A stable Finch `id` (UUID v4) for an individual in the company. There is no
-          #   limit to the number of `individual_id` to send per request. It is preferantial
-          #   to send all ids in a single request for Finch to optimize provider rate-limits.
+          #   A stable Finch `id` (UUID v4) for an individual in the company.
           #
           #   @return [String]
           required :individual_id, String
 
           # @!method initialize(individual_id:)
-          #   Some parameter documentations has been truncated, see
-          #   {FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request} for more
-          #   details.
-          #
-          #   @param individual_id [String] A stable Finch `id` (UUID v4) for an individual in the company. There is no limi
+          #   @param individual_id [String] A stable Finch `id` (UUID v4) for an individual in the company.
         end
       end
     end

data/lib/finch_api/models/hris/individual_retrieve_many_params.rb

@@ -8,6 +8,13 @@ module FinchAPI
         extend FinchAPI::Internal::Type::RequestParameters::Converter
         include FinchAPI::Internal::Type::RequestParameters
 
+        # @!attribute requests
+        #   The array of batch requests. Maximum 10000 items per request.
+        #
+        #   @return [Array<FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request>]
+        required :requests,
+                 -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::IndividualRetrieveManyParams::Request] }
+
         # @!attribute entity_ids
         #   The entity IDs to specify which entities' data to access.
         #
@@ -19,21 +26,25 @@ module FinchAPI
         #   @return [FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options, nil]
         optional :options, -> { FinchAPI::HRIS::IndividualRetrieveManyParams::Options }, nil?: true
 
-        # @!attribute requests
+        # @!method initialize(requests:, entity_ids: nil, options: nil, request_options: {})
+        #   @param requests [Array<FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request>] The array of batch requests. Maximum 10000 items per request.
         #
-        #   @return [Array<FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request>, nil]
-        optional :requests,
-                 -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::IndividualRetrieveManyParams::Request] }
-
-        # @!method initialize(entity_ids: nil, options: nil, requests: nil, request_options: {})
         #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
         #
         #   @param options [FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options, nil]
         #
-        #   @param requests [Array<FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request>]
-        #
         #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
 
+        class Request < FinchAPI::Internal::Type::BaseModel
+          # @!attribute individual_id
+          #
+          #   @return [String]
+          required :individual_id, String
+
+          # @!method initialize(individual_id:)
+          #   @param individual_id [String]
+        end
+
         class Options < FinchAPI::Internal::Type::BaseModel
           # @!attribute include
           #
@@ -43,16 +54,6 @@ module FinchAPI
           # @!method initialize(include: nil)
           #   @param include [Array<String>]
         end
-
-        class Request < FinchAPI::Internal::Type::BaseModel
-          # @!attribute individual_id
-          #
-          #   @return [String, nil]
-          optional :individual_id, String
-
-          # @!method initialize(individual_id: nil)
-          #   @param individual_id [String]
-        end
       end
     end
   end

data/lib/finch_api/models/hris/pay_statement.rb

@@ -113,7 +113,7 @@ module FinchAPI
           required :hours, Float, nil?: true
 
           # @!attribute name
-          #   The exact name of the deduction from the pay statement.
+          #   The exact name of the earning from the pay statement.
           #
           #   @return [String, nil]
           required :name, String, nil?: true
@@ -139,7 +139,7 @@ module FinchAPI
           #
           #   @param hours [Float, nil] The number of hours associated with this earning. (For salaried employees, this
           #
-          #   @param name [String, nil] The exact name of the deduction from the pay statement.
+          #   @param name [String, nil] The exact name of the earning from the pay statement.
           #
           #   @param type [Symbol, FinchAPI::Models::HRIS::PayStatement::Earning::Type, nil] The type of earning.
           #

data/lib/finch_api/models/hris/pay_statement_retrieve_many_params.rb

@@ -9,7 +9,7 @@ module FinchAPI
         include FinchAPI::Internal::Type::RequestParameters
 
         # @!attribute requests
-        #   The array of batch requests.
+        #   The array of batch requests. Maximum 10 payment_ids per request.
         #
         #   @return [Array<FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request>]
         required :requests,
@@ -22,7 +22,7 @@ module FinchAPI
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
 
         # @!method initialize(requests:, entity_ids: nil, request_options: {})
-        #   @param requests [Array<FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request>] The array of batch requests.
+        #   @param requests [Array<FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request>] The array of batch requests. Maximum 10 payment_ids per request.
         #
         #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
         #
@@ -36,7 +36,7 @@ module FinchAPI
           required :payment_id, String
 
           # @!attribute limit
-          #   Number of pay statements to return (defaults to all).
+          #   Number of pay statements to return (defaults to 100, maximum 5000).
           #
           #   @return [Integer, nil]
           optional :limit, Integer
@@ -50,7 +50,7 @@ module FinchAPI
           # @!method initialize(payment_id:, limit: nil, offset: nil)
           #   @param payment_id [String] A stable Finch `id` (UUID v4) for a payment.
           #
-          #   @param limit [Integer] Number of pay statements to return (defaults to all).
+          #   @param limit [Integer] Number of pay statements to return (defaults to 100, maximum 5000).
           #
           #   @param offset [Integer] Index to start from.
         end

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

@@ -10,7 +10,7 @@ module FinchAPI
         #
         # @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
         #
-        # @param limit [Integer] Number of employees to return (defaults to all)
+        # @param limit [Integer] Number of employees to return (defaults to 100, maximum 10000)
         #
         # @param offset [Integer] Index to start from (defaults to 0)
         #

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

@@ -8,7 +8,7 @@ module FinchAPI
         #
         # @overload retrieve_many(requests:, entity_ids: nil, request_options: {})
         #
-        # @param requests [Array<FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request>] Body param: The array of batch requests.
+        # @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.
         #

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

@@ -6,20 +6,20 @@ module FinchAPI
       class Individuals
         # Read individual data, excluding income and employment data
         #
-        # @overload retrieve_many(entity_ids: nil, options: nil, requests: nil, request_options: {})
+        # @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 options [FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options, nil] Body param
         #
-        # @param requests [Array<FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request>] Body param
-        #
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [FinchAPI::Internal::ResponsesPage<FinchAPI::Models::HRIS::IndividualResponse>]
         #
         # @see FinchAPI::Models::HRIS::IndividualRetrieveManyParams
-        def retrieve_many(params = {})
+        def retrieve_many(params)
           query_params = [:entity_ids]
           parsed, options = FinchAPI::HRIS::IndividualRetrieveManyParams.dump_request(params)
           query = FinchAPI::Internal::Util.encode_query_params(parsed.slice(*query_params))

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

@@ -11,7 +11,7 @@ module FinchAPI
         #
         # @overload retrieve_many(requests:, entity_ids: nil, request_options: {})
         #
-        # @param requests [Array<FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request>] Body param: The array of batch requests.
+        # @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.
         #

data/lib/finch_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FinchAPI
-  VERSION = "0.1.0.pre.alpha.46"
+  VERSION = "0.1.0.pre.alpha.48"
 end

data/rbi/finch_api/models/hris/directory_list_individuals_params.rbi

@@ -22,7 +22,7 @@ module FinchAPI
         sig { params(entity_ids: T::Array[String]).void }
         attr_writer :entity_ids
 
-        # Number of employees to return (defaults to all)
+        # Number of employees to return (defaults to 100, maximum 10000)
         sig { returns(T.nilable(Integer)) }
         attr_reader :limit
 
@@ -47,7 +47,7 @@ module FinchAPI
         def self.new(
           # The entity IDs to specify which entities' data to access.
           entity_ids: nil,
-          # Number of employees to return (defaults to all)
+          # Number of employees to return (defaults to 100, maximum 10000)
           limit: nil,
           # Index to start from (defaults to 0)
           offset: nil,

data/rbi/finch_api/models/hris/directory_list_params.rbi

@@ -22,7 +22,7 @@ module FinchAPI
         sig { params(entity_ids: T::Array[String]).void }
         attr_writer :entity_ids
 
-        # Number of employees to return (defaults to all)
+        # Number of employees to return (defaults to 100, maximum 10000)
         sig { returns(T.nilable(Integer)) }
         attr_reader :limit
 
@@ -47,7 +47,7 @@ module FinchAPI
         def self.new(
           # The entity IDs to specify which entities' data to access.
           entity_ids: nil,
-          # Number of employees to return (defaults to all)
+          # Number of employees to return (defaults to 100, maximum 10000)
           limit: nil,
           # Index to start from (defaults to 0)
           offset: nil,

data/rbi/finch_api/models/hris/employment_retrieve_many_params.rbi

@@ -15,7 +15,7 @@ module FinchAPI
             )
           end
 
-        # The array of batch requests.
+        # The array of batch requests. Maximum 10000 items per request.
         sig do
           returns(
             T::Array[FinchAPI::HRIS::EmploymentRetrieveManyParams::Request]
@@ -41,7 +41,7 @@ module FinchAPI
           ).returns(T.attached_class)
         end
         def self.new(
-          # The array of batch requests.
+          # The array of batch requests. Maximum 10000 items per request.
           requests:,
           # The entity IDs to specify which entities' data to access.
           entity_ids: nil,
@@ -71,17 +71,13 @@ module FinchAPI
               )
             end
 
-          # A stable Finch `id` (UUID v4) for an individual in the company. There is no
-          # limit to the number of `individual_id` to send per request. It is preferantial
-          # to send all ids in a single request for Finch to optimize provider rate-limits.
+          # A stable Finch `id` (UUID v4) for an individual in the company.
           sig { returns(String) }
           attr_accessor :individual_id
 
           sig { params(individual_id: String).returns(T.attached_class) }
           def self.new(
-            # A stable Finch `id` (UUID v4) for an individual in the company. There is no
-            # limit to the number of `individual_id` to send per request. It is preferantial
-            # to send all ids in a single request for Finch to optimize provider rate-limits.
+            # A stable Finch `id` (UUID v4) for an individual in the company.
             individual_id:
           )
           end

data/rbi/finch_api/models/hris/individual_retrieve_many_params.rbi

@@ -15,6 +15,14 @@ module FinchAPI
             )
           end
 
+        # The array of batch requests. Maximum 10000 items per request.
+        sig do
+          returns(
+            T::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request]
+          )
+        end
+        attr_accessor :requests
+
         # The entity IDs to specify which entities' data to access.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :entity_ids
@@ -39,44 +47,26 @@ module FinchAPI
         end
         attr_writer :options
 
-        sig do
-          returns(
-            T.nilable(
-              T::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request]
-            )
-          )
-        end
-        attr_reader :requests
-
         sig do
           params(
             requests:
               T::Array[
                 FinchAPI::HRIS::IndividualRetrieveManyParams::Request::OrHash
-              ]
-          ).void
-        end
-        attr_writer :requests
-
-        sig do
-          params(
+              ],
             entity_ids: T::Array[String],
             options:
               T.nilable(
                 FinchAPI::HRIS::IndividualRetrieveManyParams::Options::OrHash
               ),
-            requests:
-              T::Array[
-                FinchAPI::HRIS::IndividualRetrieveManyParams::Request::OrHash
-              ],
             request_options: FinchAPI::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
+          # The array of batch requests. Maximum 10000 items per request.
+          requests:,
           # The entity IDs to specify which entities' data to access.
           entity_ids: nil,
           options: nil,
-          requests: nil,
           request_options: {}
         )
         end
@@ -84,13 +74,13 @@ module FinchAPI
         sig do
           override.returns(
             {
+              requests:
+                T::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request],
               entity_ids: T::Array[String],
               options:
                 T.nilable(
                   FinchAPI::HRIS::IndividualRetrieveManyParams::Options
                 ),
-              requests:
-                T::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request],
               request_options: FinchAPI::RequestOptions
             }
           )
@@ -98,50 +88,47 @@ module FinchAPI
         def to_hash
         end
 
-        class Options < FinchAPI::Internal::Type::BaseModel
+        class Request < FinchAPI::Internal::Type::BaseModel
           OrHash =
             T.type_alias do
               T.any(
-                FinchAPI::HRIS::IndividualRetrieveManyParams::Options,
+                FinchAPI::HRIS::IndividualRetrieveManyParams::Request,
                 FinchAPI::Internal::AnyHash
               )
             end
 
-          sig { returns(T.nilable(T::Array[String])) }
-          attr_reader :include
+          sig { returns(String) }
+          attr_accessor :individual_id
 
-          sig { params(include: T::Array[String]).void }
-          attr_writer :include
-
-          sig { params(include: T::Array[String]).returns(T.attached_class) }
-          def self.new(include: nil)
+          sig { params(individual_id: String).returns(T.attached_class) }
+          def self.new(individual_id:)
           end
 
-          sig { override.returns({ include: T::Array[String] }) }
+          sig { override.returns({ individual_id: String }) }
           def to_hash
           end
         end
 
-        class Request < FinchAPI::Internal::Type::BaseModel
+        class Options < FinchAPI::Internal::Type::BaseModel
           OrHash =
             T.type_alias do
               T.any(
-                FinchAPI::HRIS::IndividualRetrieveManyParams::Request,
+                FinchAPI::HRIS::IndividualRetrieveManyParams::Options,
                 FinchAPI::Internal::AnyHash
               )
             end
 
-          sig { returns(T.nilable(String)) }
-          attr_reader :individual_id
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :include
 
-          sig { params(individual_id: String).void }
-          attr_writer :individual_id
+          sig { params(include: T::Array[String]).void }
+          attr_writer :include
 
-          sig { params(individual_id: String).returns(T.attached_class) }
-          def self.new(individual_id: nil)
+          sig { params(include: T::Array[String]).returns(T.attached_class) }
+          def self.new(include: nil)
           end
 
-          sig { override.returns({ individual_id: String }) }
+          sig { override.returns({ include: T::Array[String] }) }
           def to_hash
           end
         end

data/rbi/finch_api/models/hris/pay_statement.rbi

@@ -179,7 +179,7 @@ module FinchAPI
           sig { returns(T.nilable(Float)) }
           attr_accessor :hours
 
-          # The exact name of the deduction from the pay statement.
+          # The exact name of the earning from the pay statement.
           sig { returns(T.nilable(String)) }
           attr_accessor :name
 
@@ -234,7 +234,7 @@ module FinchAPI
             # The number of hours associated with this earning. (For salaried employees, this
             # could be hours per pay period, `0` or `null`, depending on the provider).
             hours:,
-            # The exact name of the deduction from the pay statement.
+            # The exact name of the earning from the pay statement.
             name:,
             # The type of earning.
             type:,

data/rbi/finch_api/models/hris/pay_statement_retrieve_many_params.rbi

@@ -15,7 +15,7 @@ module FinchAPI
             )
           end
 
-        # The array of batch requests.
+        # The array of batch requests. Maximum 10 payment_ids per request.
         sig do
           returns(
             T::Array[FinchAPI::HRIS::PayStatementRetrieveManyParams::Request]
@@ -41,7 +41,7 @@ module FinchAPI
           ).returns(T.attached_class)
         end
         def self.new(
-          # The array of batch requests.
+          # The array of batch requests. Maximum 10 payment_ids per request.
           requests:,
           # The entity IDs to specify which entities' data to access.
           entity_ids: nil,
@@ -77,7 +77,7 @@ module FinchAPI
           sig { returns(String) }
           attr_accessor :payment_id
 
-          # Number of pay statements to return (defaults to all).
+          # Number of pay statements to return (defaults to 100, maximum 5000).
           sig { returns(T.nilable(Integer)) }
           attr_reader :limit
 
@@ -99,7 +99,7 @@ module FinchAPI
           def self.new(
             # A stable Finch `id` (UUID v4) for a payment.
             payment_id:,
-            # Number of pay statements to return (defaults to all).
+            # Number of pay statements to return (defaults to 100, maximum 5000).
             limit: nil,
             # Index to start from.
             offset: nil

data/rbi/finch_api/resources/hris/directory.rbi

@@ -20,7 +20,7 @@ module FinchAPI
         def list(
           # The entity IDs to specify which entities' data to access.
           entity_ids: nil,
-          # Number of employees to return (defaults to all)
+          # Number of employees to return (defaults to 100, maximum 10000)
           limit: nil,
           # Index to start from (defaults to 0)
           offset: nil,

data/rbi/finch_api/resources/hris/employments.rbi

@@ -20,7 +20,7 @@ module FinchAPI
           )
         end
         def retrieve_many(
-          # Body param: The array of batch requests.
+          # 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.
           entity_ids: nil,

data/rbi/finch_api/resources/hris/individuals.rbi

@@ -7,15 +7,15 @@ module FinchAPI
         # Read individual data, excluding income and employment data
         sig do
           params(
+            requests:
+              T::Array[
+                FinchAPI::HRIS::IndividualRetrieveManyParams::Request::OrHash
+              ],
             entity_ids: T::Array[String],
             options:
               T.nilable(
                 FinchAPI::HRIS::IndividualRetrieveManyParams::Options::OrHash
               ),
-            requests:
-              T::Array[
-                FinchAPI::HRIS::IndividualRetrieveManyParams::Request::OrHash
-              ],
             request_options: FinchAPI::RequestOptions::OrHash
           ).returns(
             FinchAPI::Internal::ResponsesPage[
@@ -24,12 +24,12 @@ module FinchAPI
           )
         end
         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.
           entity_ids: nil,
           # Body param
           options: nil,
-          # Body param
-          requests: nil,
           request_options: {}
         )
         end

data/rbi/finch_api/resources/hris/pay_statements.rbi

@@ -23,7 +23,7 @@ module FinchAPI
           )
         end
         def retrieve_many(
-          # Body param: The array of batch requests.
+          # 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.
           entity_ids: nil,

data/sig/finch_api/models/hris/individual_retrieve_many_params.rbs

@@ -3,9 +3,9 @@ module FinchAPI
     module HRIS
       type individual_retrieve_many_params =
         {
+          requests: ::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request],
           entity_ids: ::Array[String],
-          options: FinchAPI::HRIS::IndividualRetrieveManyParams::Options?,
-          requests: ::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request]
+          options: FinchAPI::HRIS::IndividualRetrieveManyParams::Options?
         }
         & FinchAPI::Internal::Type::request_parameters
 
@@ -13,32 +13,38 @@ module FinchAPI
         extend FinchAPI::Internal::Type::RequestParameters::Converter
         include FinchAPI::Internal::Type::RequestParameters
 
+        attr_accessor requests: ::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request]
+
         attr_reader entity_ids: ::Array[String]?
 
         def entity_ids=: (::Array[String]) -> ::Array[String]
 
         attr_accessor options: FinchAPI::HRIS::IndividualRetrieveManyParams::Options?
 
-        attr_reader requests: ::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request]?
-
-        def requests=: (
-          ::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request]
-        ) -> ::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request]
-
         def initialize: (
+          requests: ::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request],
           ?entity_ids: ::Array[String],
           ?options: FinchAPI::HRIS::IndividualRetrieveManyParams::Options?,
-          ?requests: ::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request],
           ?request_options: FinchAPI::request_opts
         ) -> void
 
         def to_hash: -> {
+          requests: ::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request],
           entity_ids: ::Array[String],
           options: FinchAPI::HRIS::IndividualRetrieveManyParams::Options?,
-          requests: ::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request],
           request_options: FinchAPI::RequestOptions
         }
 
+        type request = { individual_id: String }
+
+        class Request < FinchAPI::Internal::Type::BaseModel
+          attr_accessor individual_id: String
+
+          def initialize: (individual_id: String) -> void
+
+          def to_hash: -> { individual_id: String }
+        end
+
         type options = { include: ::Array[String] }
 
         class Options < FinchAPI::Internal::Type::BaseModel
@@ -50,18 +56,6 @@ module FinchAPI
 
           def to_hash: -> { include: ::Array[String] }
         end
-
-        type request = { individual_id: String }
-
-        class Request < FinchAPI::Internal::Type::BaseModel
-          attr_reader individual_id: String?
-
-          def individual_id=: (String) -> String
-
-          def initialize: (?individual_id: String) -> void
-
-          def to_hash: -> { individual_id: String }
-        end
       end
     end
   end

data/sig/finch_api/resources/hris/individuals.rbs

@@ -3,9 +3,9 @@ module FinchAPI
     class HRIS
       class Individuals
         def retrieve_many: (
+          requests: ::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request],
           ?entity_ids: ::Array[String],
           ?options: FinchAPI::HRIS::IndividualRetrieveManyParams::Options?,
-          ?requests: ::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request],
           ?request_options: FinchAPI::request_opts
         ) -> FinchAPI::Internal::ResponsesPage[FinchAPI::HRIS::IndividualResponse]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finch-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.alpha.46
+  version: 0.1.0.pre.alpha.48
 platform: ruby
 authors:
 - Finch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-06-30 00:00:00.000000000 Z
+date: 2026-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi