release: 0.1.0-alpha.48

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.1.0-alpha.47"
+  ".": "0.1.0-alpha.48"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 48
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch/finch-3cd1346947fabfca2aa9c6f821170c8d945a82667fb20a15644d5c77f8e98c10.yml
-openapi_spec_hash: 642e04e90d37c0e4875d154abd06eb54
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch/finch-a6b05e51c46366a54466c2009f5fdde74e0fa40bbcc6568601a4e3342dd16937.yml
+openapi_spec_hash: 084797c220144df17d98eb984dd4cba2
 config_hash: 9ae56f40cec7304896138bfad5caf748

CHANGELOG.md

@@ -1,5 +1,13 @@
 # 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)

Gemfile.lock

@@ -11,7 +11,7 @@ GIT
 PATH
   remote: .
   specs:
-    finch-api (0.1.0.pre.alpha.47)
+    finch-api (0.1.0.pre.alpha.48)
       cgi
       connection_pool
 

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.47"
+gem "finch-api", "~> 0.1.0.pre.alpha.48"
 ```
 
 <!-- x-release-please-end -->

lib/finch_api/models/hris/directory_list_individuals_params.rb

@@ -15,7 +15,7 @@ class DirectoryListIndividualsParams < FinchAPI::Internal::Type::BaseModel
         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 @@ class DirectoryListIndividualsParams < FinchAPI::Internal::Type::BaseModel
         # @!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)
         #

lib/finch_api/models/hris/directory_list_params.rb

@@ -15,7 +15,7 @@ class DirectoryListParams < FinchAPI::Internal::Type::BaseModel
         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 @@ class DirectoryListParams < FinchAPI::Internal::Type::BaseModel
         # @!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)
         #

lib/finch_api/models/hris/employment_retrieve_many_params.rb

@@ -9,7 +9,7 @@ class EmploymentRetrieveManyParams < FinchAPI::Internal::Type::BaseModel
         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,27 +22,21 @@ class EmploymentRetrieveManyParams < FinchAPI::Internal::Type::BaseModel
         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.
         #
         #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
 
         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

lib/finch_api/models/hris/individual_retrieve_many_params.rb

@@ -8,6 +8,13 @@ class IndividualRetrieveManyParams < FinchAPI::Internal::Type::BaseModel
         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 @@ class IndividualRetrieveManyParams < FinchAPI::Internal::Type::BaseModel
         #   @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 @@ class Options < FinchAPI::Internal::Type::BaseModel
           # @!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

lib/finch_api/models/hris/pay_statement_retrieve_many_params.rb

@@ -9,7 +9,7 @@ class PayStatementRetrieveManyParams < FinchAPI::Internal::Type::BaseModel
         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 @@ class PayStatementRetrieveManyParams < FinchAPI::Internal::Type::BaseModel
         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 @@ class Request < FinchAPI::Internal::Type::BaseModel
           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 @@ class Request < FinchAPI::Internal::Type::BaseModel
           # @!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

lib/finch_api/resources/hris/directory.rb

@@ -10,7 +10,7 @@ class Directory
         #
         # @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)
         #

lib/finch_api/resources/hris/employments.rb

@@ -8,7 +8,7 @@ class Employments
         #
         # @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.
         #

lib/finch_api/resources/hris/individuals.rb

@@ -6,20 +6,20 @@ class HRIS
       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))

lib/finch_api/resources/hris/pay_statements.rb

@@ -11,7 +11,7 @@ class PayStatements
         #
         # @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.
         #

lib/finch_api/version.rb

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

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,

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,

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