finch-api 0.1.0.pre.alpha.60 → 0.1.0.pre.alpha.61

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f5cb88b8975aae0a24fb06c065cf76417ee66e03e8db7221fb8b92e9b67b17d
-  data.tar.gz: 3dace0e8387c06d6c82541f4078d7c2d5c1941fb8fa11e09df7b71c4b0a7e966
+  metadata.gz: 1b2ec93a327103f7eea06fd294cadff34fb56bc6070a97efbdfee5b5b022e1c2
+  data.tar.gz: fbb9ca1192032ca4cc10b021772953b59d923a7ef8a884a972101eb49d883b39
 SHA512:
-  metadata.gz: 9e84aa7dd599db34a4577e884fa714ec0ad5162eb38ea985fa78d82b6d4f61412b3d1ca561bf10118e28b7510e941d672fead59824a9231bf02137f6d84c8a32
-  data.tar.gz: c65456c96829458109ace2482577700bec8897814fd078e2c8771bd31b5775c388b0378c37ae867365259d30769c60c991f9e455dfa258d7ddecf6d63184cba2
+  metadata.gz: c6c7d9f866df262b2377ffb557a9925c2196318f94c5c69aeb9b8e03afe5e493c0f5c30de58ce124952275311caffe0d104bbaac4691cfd500127531e08a2fe1
+  data.tar.gz: 652ff028c7f18d80165b5bee650ed442d9f1e176297d06c3e4599897390021975570bbfb9e4ab92dfb223ae5f1a3b2bfd719b5447792d5d5ebed113dae41a18c

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## [0.1.0-alpha.61](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.60...v0.1.0-alpha.61) (2026-10-22)
+
+
+### Chores
+
+* **api:** rebuild SDK ([d232b31](https://github.com/Finch-API/finch-api-ruby/commit/d232b3150eab252a1dc56de39201fe316938db71))
+
+
+### Documentation
+
+* **spec:** clarify redirect_uri requirement on connect and token endpoints [DDR-1050] ([d5ea0da](https://github.com/Finch-API/finch-api-ruby/commit/d5ea0dac0b4270a4e4929c9bfe20d4b394713c2d))
+* **spec:** document missing entity_ids error for multi-entity connections [DDR-1051] ([7bb4ab7](https://github.com/Finch-API/finch-api-ruby/commit/7bb4ab7e788b6f5b078257838876a10e73ca8446))
+
 ## [0.1.0-alpha.60](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.59...v0.1.0-alpha.60) (2026-10-13)
 
 

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

data/lib/finch_api/models/access_token_create_params.rb

@@ -26,19 +26,25 @@ module FinchAPI
       optional :client_secret, String
 
       # @!attribute redirect_uri
-      #   The redirect URI used in the authorization request (optional)
+      #   The redirect URI used when creating the Connect session. Required if the
+      #   authorization code came from the redirect flow, and it must match the
+      #   `redirect_uri` used to create the session. Omit it if the code came from the
+      #   embedded flow (Connect SDK).
       #
       #   @return [String, nil]
       optional :redirect_uri, String
 
       # @!method initialize(code:, client_id: nil, client_secret: nil, redirect_uri: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {FinchAPI::Models::AccessTokenCreateParams} for more details.
+      #
       #   @param code [String] The authorization code received from the authorization server
       #
       #   @param client_id [String] The client ID for your application
       #
       #   @param client_secret [String] The client secret for your application
       #
-      #   @param redirect_uri [String] The redirect URI used in the authorization request (optional)
+      #   @param redirect_uri [String] The redirect URI used when creating the Connect session. Required if the authori
       #
       #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/finch_api/models/connect/session_new_params.rb

@@ -63,7 +63,9 @@ module FinchAPI
         optional :recordkeeping, -> { FinchAPI::Connect::SessionNewParams::Recordkeeping }, nil?: true
 
         # @!attribute redirect_uri
-        #   The URI to redirect to after the Connect flow is completed
+        #   The URI to redirect to after the Connect flow is completed. Required if you use
+        #   the redirect flow, and it must be registered on the Credentials tab of the Finch
+        #   Developer Dashboard. Omit it for the embedded flow (Connect SDK).
         #
         #   @return [String, nil]
         optional :redirect_uri, String, nil?: true
@@ -94,7 +96,7 @@ module FinchAPI
         #
         #   @param recordkeeping [FinchAPI::Models::Connect::SessionNewParams::Recordkeeping, nil] Optional recordkeeping configuration. Can only be provided when the `recordkeepi
         #
-        #   @param redirect_uri [String, nil] The URI to redirect to after the Connect flow is completed
+        #   @param redirect_uri [String, nil] The URI to redirect to after the Connect flow is completed. Required if you use
         #
         #   @param sandbox [Symbol, FinchAPI::Models::Connect::SessionNewParams::Sandbox, nil] Sandbox mode for testing
         #

data/lib/finch_api/models/connect/session_reauthenticate_params.rb

@@ -34,7 +34,9 @@ module FinchAPI
                  nil?: true
 
         # @!attribute redirect_uri
-        #   The URI to redirect to after the Connect flow is completed
+        #   The URI to redirect to after the Connect flow is completed. Required if you use
+        #   the redirect flow, and it must be registered on the Credentials tab of the Finch
+        #   Developer Dashboard. Omit it for the embedded flow (Connect SDK).
         #
         #   @return [String, nil]
         optional :redirect_uri, String, nil?: true
@@ -49,7 +51,7 @@ module FinchAPI
         #
         #   @param products [Array<Symbol, FinchAPI::Models::Connect::SessionReauthenticateParams::Product>, nil] The products to request access to (optional for reauthentication). Use `benefits
         #
-        #   @param redirect_uri [String, nil] The URI to redirect to after the Connect flow is completed
+        #   @param redirect_uri [String, nil] The URI to redirect to after the Connect flow is completed. Required if you use
         #
         #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
 

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

@@ -10,7 +10,9 @@ module FinchAPI
 
         # @!attribute entity_ids
         #   The entity IDs to specify which entities' data to access. Provide exactly one
-        #   entity ID per request; a maximum of one is accepted.
+        #   entity ID per request; a maximum of one is accepted. Required when the
+        #   connection has more than one entity — omitting it returns a `400`
+        #   `invalid_request_error`. Optional for single-entity connections.
         #
         #   @return [Array<String>, nil]
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

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

@@ -10,7 +10,9 @@ module FinchAPI
 
         # @!attribute entity_ids
         #   The entity IDs to specify which entities' data to access. Provide exactly one
-        #   entity ID per request; a maximum of one is accepted.
+        #   entity ID per request; a maximum of one is accepted. Required when the
+        #   connection has more than one entity — omitting it returns a `400`
+        #   `invalid_request_error`. Optional for single-entity connections.
         #
         #   @return [Array<String>, nil]
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

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

@@ -10,7 +10,9 @@ module FinchAPI
 
         # @!attribute entity_ids
         #   The entity IDs to specify which entities' data to access. Provide exactly one
-        #   entity ID per request; a maximum of one is accepted.
+        #   entity ID per request; a maximum of one is accepted. Required when the
+        #   connection has more than one entity — omitting it returns a `400`
+        #   `invalid_request_error`. Optional for single-entity connections.
         #
         #   @return [Array<String>, nil]
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

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

@@ -10,7 +10,9 @@ module FinchAPI
 
         # @!attribute entity_ids
         #   The entity IDs to specify which entities' data to access. Provide exactly one
-        #   entity ID per request; a maximum of one is accepted.
+        #   entity ID per request; a maximum of one is accepted. Required when the
+        #   connection has more than one entity — omitting it returns a `400`
+        #   `invalid_request_error`. Optional for single-entity connections.
         #
         #   @return [Array<String>, nil]
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

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

@@ -15,7 +15,9 @@ module FinchAPI
 
         # @!attribute entity_ids
         #   The entity IDs to specify which entities' data to access. Provide exactly one
-        #   entity ID per request; a maximum of one is accepted.
+        #   entity ID per request; a maximum of one is accepted. Required when the
+        #   connection has more than one entity — omitting it returns a `400`
+        #   `invalid_request_error`. Optional for single-entity connections.
         #
         #   @return [Array<String>, nil]
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

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

@@ -15,7 +15,9 @@ module FinchAPI
 
         # @!attribute entity_ids
         #   The entity IDs to specify which entities' data to access. Provide exactly one
-        #   entity ID per request; a maximum of one is accepted.
+        #   entity ID per request; a maximum of one is accepted. Required when the
+        #   connection has more than one entity — omitting it returns a `400`
+        #   `invalid_request_error`. Optional for single-entity connections.
         #
         #   @return [Array<String>, nil]
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

data/lib/finch_api/models/hris/benefits/individual_enroll_many_params.rb

@@ -16,7 +16,9 @@ module FinchAPI
 
           # @!attribute entity_ids
           #   The entity IDs to specify which entities' data to access. Provide exactly one
-          #   entity ID per request; a maximum of one is accepted.
+          #   entity ID per request; a maximum of one is accepted. Required when the
+          #   connection has more than one entity — omitting it returns a `400`
+          #   `invalid_request_error`. Optional for single-entity connections.
           #
           #   @return [Array<String>, nil]
           optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

data/lib/finch_api/models/hris/benefits/individual_enrolled_ids_params.rb

@@ -16,7 +16,9 @@ module FinchAPI
 
           # @!attribute entity_ids
           #   The entity IDs to specify which entities' data to access. Provide exactly one
-          #   entity ID per request; a maximum of one is accepted.
+          #   entity ID per request; a maximum of one is accepted. Required when the
+          #   connection has more than one entity — omitting it returns a `400`
+          #   `invalid_request_error`. Optional for single-entity connections.
           #
           #   @return [Array<String>, nil]
           optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

data/lib/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rb

@@ -16,7 +16,9 @@ module FinchAPI
 
           # @!attribute entity_ids
           #   The entity IDs to specify which entities' data to access. Provide exactly one
-          #   entity ID per request; a maximum of one is accepted.
+          #   entity ID per request; a maximum of one is accepted. Required when the
+          #   connection has more than one entity — omitting it returns a `400`
+          #   `invalid_request_error`. Optional for single-entity connections.
           #
           #   @return [Array<String>, nil]
           optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

data/lib/finch_api/models/hris/benefits/individual_unenroll_many_params.rb

@@ -16,7 +16,9 @@ module FinchAPI
 
           # @!attribute entity_ids
           #   The entity IDs to specify which entities' data to access. Provide exactly one
-          #   entity ID per request; a maximum of one is accepted.
+          #   entity ID per request; a maximum of one is accepted. Required when the
+          #   connection has more than one entity — omitting it returns a `400`
+          #   `invalid_request_error`. Optional for single-entity connections.
           #
           #   @return [Array<String>, nil]
           optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

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

@@ -10,7 +10,9 @@ module FinchAPI
 
         # @!attribute entity_ids
         #   The entity IDs to specify which entities' data to access. Provide exactly one
-        #   entity ID per request; a maximum of one is accepted.
+        #   entity ID per request; a maximum of one is accepted. Required when the
+        #   connection has more than one entity — omitting it returns a `400`
+        #   `invalid_request_error`. Optional for single-entity connections.
         #
         #   @return [Array<String>, nil]
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

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

@@ -10,7 +10,9 @@ module FinchAPI
 
         # @!attribute entity_ids
         #   The entity IDs to specify which entities' data to access. Provide exactly one
-        #   entity ID per request; a maximum of one is accepted.
+        #   entity ID per request; a maximum of one is accepted. Required when the
+        #   connection has more than one entity — omitting it returns a `400`
+        #   `invalid_request_error`. Optional for single-entity connections.
         #
         #   @return [Array<String>, nil]
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

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

@@ -10,7 +10,9 @@ module FinchAPI
 
         # @!attribute entity_ids
         #   The entity IDs to specify which entities' data to access. Provide exactly one
-        #   entity ID per request; a maximum of one is accepted.
+        #   entity ID per request; a maximum of one is accepted. Required when the
+        #   connection has more than one entity — omitting it returns a `400`
+        #   `invalid_request_error`. Optional for single-entity connections.
         #
         #   @return [Array<String>, nil]
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

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

@@ -10,7 +10,9 @@ module FinchAPI
 
         # @!attribute entity_ids
         #   The entity IDs to specify which entities' data to access. Provide exactly one
-        #   entity ID per request; a maximum of one is accepted.
+        #   entity ID per request; a maximum of one is accepted. Required when the
+        #   connection has more than one entity — omitting it returns a `400`
+        #   `invalid_request_error`. Optional for single-entity connections.
         #
         #   @return [Array<String>, nil]
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

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

@@ -15,7 +15,9 @@ module FinchAPI
 
         # @!attribute entity_ids
         #   The entity IDs to specify which entities' data to access. Provide exactly one
-        #   entity ID per request; a maximum of one is accepted.
+        #   entity ID per request; a maximum of one is accepted. Required when the
+        #   connection has more than one entity — omitting it returns a `400`
+        #   `invalid_request_error`. Optional for single-entity connections.
         #
         #   @return [Array<String>, nil]
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

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

@@ -17,7 +17,9 @@ module FinchAPI
 
         # @!attribute entity_ids
         #   The entity IDs to specify which entities' data to access. Provide exactly one
-        #   entity ID per request; a maximum of one is accepted.
+        #   entity ID per request; a maximum of one is accepted. Required when the
+        #   connection has more than one entity — omitting it returns a `400`
+        #   `invalid_request_error`. Optional for single-entity connections.
         #
         #   @return [Array<String>, nil]
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

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

@@ -17,7 +17,9 @@ module FinchAPI
 
         # @!attribute entity_ids
         #   The entity IDs to specify which entities' data to access. Provide exactly one
-        #   entity ID per request; a maximum of one is accepted.
+        #   entity ID per request; a maximum of one is accepted. Required when the
+        #   connection has more than one entity — omitting it returns a `400`
+        #   `invalid_request_error`. Optional for single-entity connections.
         #
         #   @return [Array<String>, nil]
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

data/lib/finch_api/models/hris/pay_statement_item/rule_create_params.rb

@@ -11,7 +11,9 @@ module FinchAPI
 
           # @!attribute entity_ids
           #   The entity IDs to create the rule for. Provide exactly one entity ID per
-          #   request; a maximum of one is accepted.
+          #   request; a maximum of one is accepted. Required when the connection has more
+          #   than one entity — omitting it returns a `400` `invalid_request_error`. Optional
+          #   for single-entity connections.
           #
           #   @return [Array<String>, nil]
           optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

data/lib/finch_api/models/hris/pay_statement_item/rule_delete_params.rb

@@ -16,7 +16,9 @@ module FinchAPI
 
           # @!attribute entity_ids
           #   The entity IDs to delete the rule for. Provide exactly one entity ID per
-          #   request; a maximum of one is accepted.
+          #   request; a maximum of one is accepted. Required when the connection has more
+          #   than one entity — omitting it returns a `400` `invalid_request_error`. Optional
+          #   for single-entity connections.
           #
           #   @return [Array<String>, nil]
           optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

data/lib/finch_api/models/hris/pay_statement_item/rule_list_params.rb

@@ -11,7 +11,9 @@ module FinchAPI
 
           # @!attribute entity_ids
           #   The entity IDs to retrieve rules for. Provide exactly one entity ID per request;
-          #   a maximum of one is accepted.
+          #   a maximum of one is accepted. Required when the connection has more than one
+          #   entity — omitting it returns a `400` `invalid_request_error`. Optional for
+          #   single-entity connections.
           #
           #   @return [Array<String>, nil]
           optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

data/lib/finch_api/models/hris/pay_statement_item/rule_update_params.rb

@@ -16,7 +16,9 @@ module FinchAPI
 
           # @!attribute entity_ids
           #   The entity IDs to update the rule for. Provide exactly one entity ID per
-          #   request; a maximum of one is accepted.
+          #   request; a maximum of one is accepted. Required when the connection has more
+          #   than one entity — omitting it returns a `400` `invalid_request_error`. Optional
+          #   for single-entity connections.
           #
           #   @return [Array<String>, nil]
           optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

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

@@ -25,7 +25,9 @@ module FinchAPI
 
         # @!attribute entity_ids
         #   The entity IDs to specify which entities' data to access. Provide exactly one
-        #   entity ID per request; a maximum of one is accepted.
+        #   entity ID per request; a maximum of one is accepted. Required when the
+        #   connection has more than one entity — omitting it returns a `400`
+        #   `invalid_request_error`. Optional for single-entity connections.
         #
         #   @return [Array<String>, nil]
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

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

@@ -17,7 +17,9 @@ module FinchAPI
 
         # @!attribute entity_ids
         #   The entity IDs to specify which entities' data to access. Provide exactly one
-        #   entity ID per request; a maximum of one is accepted.
+        #   entity ID per request; a maximum of one is accepted. Required when the
+        #   connection has more than one entity — omitting it returns a `400`
+        #   `invalid_request_error`. Optional for single-entity connections.
         #
         #   @return [Array<String>, nil]
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

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

@@ -24,7 +24,9 @@ module FinchAPI
 
         # @!attribute entity_ids
         #   The entity IDs to specify which entities' data to access. Provide exactly one
-        #   entity ID per request; a maximum of one is accepted.
+        #   entity ID per request; a maximum of one is accepted. Required when the
+        #   connection has more than one entity — omitting it returns a `400`
+        #   `invalid_request_error`. Optional for single-entity connections.
         #
         #   @return [Array<String>, nil]
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

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

@@ -10,7 +10,9 @@ module FinchAPI
 
         # @!attribute entity_ids
         #   The entity IDs to specify which entities' data to access. Provide exactly one
-        #   entity ID per request; a maximum of one is accepted.
+        #   entity ID per request; a maximum of one is accepted. Required when the
+        #   connection has more than one entity — omitting it returns a `400`
+        #   `invalid_request_error`. Optional for single-entity connections.
         #
         #   @return [Array<String>, nil]
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

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

@@ -15,7 +15,9 @@ module FinchAPI
 
         # @!attribute entity_ids
         #   The entity IDs to specify which entities' data to access. Provide exactly one
-        #   entity ID per request; a maximum of one is accepted.
+        #   entity ID per request; a maximum of one is accepted. Required when the
+        #   connection has more than one entity — omitting it returns a `400`
+        #   `invalid_request_error`. Optional for single-entity connections.
         #
         #   @return [Array<String>, nil]
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

data/lib/finch_api/resources/access_tokens.rb

@@ -3,6 +3,9 @@
 module FinchAPI
   module Resources
     class AccessTokens
+      # Some parameter documentations has been truncated, see
+      # {FinchAPI::Models::AccessTokenCreateParams} for more details.
+      #
       # Exchange the authorization code for an access token
       #
       # @overload create(code:, client_id: nil, client_secret: nil, redirect_uri: nil, request_options: {})
@@ -13,7 +16,7 @@ module FinchAPI
       #
       # @param client_secret [String] The client secret for your application
       #
-      # @param redirect_uri [String] The redirect URI used in the authorization request (optional)
+      # @param redirect_uri [String] The redirect URI used when creating the Connect session. Required if the authori
       #
       # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/finch_api/resources/connect/sessions.rb

@@ -27,7 +27,7 @@ module FinchAPI
         #
         # @param recordkeeping [FinchAPI::Models::Connect::SessionNewParams::Recordkeeping, nil] Optional recordkeeping configuration. Can only be provided when the `recordkeepi
         #
-        # @param redirect_uri [String, nil] The URI to redirect to after the Connect flow is completed
+        # @param redirect_uri [String, nil] The URI to redirect to after the Connect flow is completed. Required if you use
         #
         # @param sandbox [Symbol, FinchAPI::Models::Connect::SessionNewParams::Sandbox, nil] Sandbox mode for testing
         #
@@ -61,7 +61,7 @@ module FinchAPI
         #
         # @param products [Array<Symbol, FinchAPI::Models::Connect::SessionReauthenticateParams::Product>, nil] The products to request access to (optional for reauthentication). Use `benefits
         #
-        # @param redirect_uri [String, nil] The URI to redirect to after the Connect flow is completed
+        # @param redirect_uri [String, nil] The URI to redirect to after the Connect flow is completed. Required if you use
         #
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #

data/lib/finch_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FinchAPI
-  VERSION = "0.1.0-alpha.60"
+  VERSION = "0.1.0-alpha.61"
 end

data/rbi/finch_api/models/access_token_create_params.rbi

@@ -29,7 +29,10 @@ module FinchAPI
       sig { params(client_secret: String).void }
       attr_writer :client_secret
 
-      # The redirect URI used in the authorization request (optional)
+      # The redirect URI used when creating the Connect session. Required if the
+      # authorization code came from the redirect flow, and it must match the
+      # `redirect_uri` used to create the session. Omit it if the code came from the
+      # embedded flow (Connect SDK).
       sig { returns(T.nilable(String)) }
       attr_reader :redirect_uri
 
@@ -52,7 +55,10 @@ module FinchAPI
         client_id: nil,
         # The client secret for your application
         client_secret: nil,
-        # The redirect URI used in the authorization request (optional)
+        # The redirect URI used when creating the Connect session. Required if the
+        # authorization code came from the redirect flow, and it must match the
+        # `redirect_uri` used to create the session. Omit it if the code came from the
+        # embedded flow (Connect SDK).
         redirect_uri: nil,
         request_options: {}
       )

data/rbi/finch_api/models/connect/session_new_params.rbi

@@ -80,7 +80,9 @@ module FinchAPI
         end
         attr_writer :recordkeeping
 
-        # The URI to redirect to after the Connect flow is completed
+        # The URI to redirect to after the Connect flow is completed. Required if you use
+        # the redirect flow, and it must be registered on the Credentials tab of the Finch
+        # Developer Dashboard. Omit it for the embedded flow (Connect SDK).
         sig { returns(T.nilable(String)) }
         attr_accessor :redirect_uri
 
@@ -137,7 +139,9 @@ module FinchAPI
           # `recordkeeping` product is requested. Currently supports `recordkeeper` set to
           # `voya`, `empower`, `fidelity`, or `transamerica`.
           recordkeeping: nil,
-          # The URI to redirect to after the Connect flow is completed
+          # The URI to redirect to after the Connect flow is completed. Required if you use
+          # the redirect flow, and it must be registered on the Credentials tab of the Finch
+          # Developer Dashboard. Omit it for the embedded flow (Connect SDK).
           redirect_uri: nil,
           # Sandbox mode for testing
           sandbox: nil,

data/rbi/finch_api/models/connect/session_reauthenticate_params.rbi

@@ -41,7 +41,9 @@ module FinchAPI
         end
         attr_accessor :products
 
-        # The URI to redirect to after the Connect flow is completed
+        # The URI to redirect to after the Connect flow is completed. Required if you use
+        # the redirect flow, and it must be registered on the Credentials tab of the Finch
+        # Developer Dashboard. Omit it for the embedded flow (Connect SDK).
         sig { returns(T.nilable(String)) }
         attr_accessor :redirect_uri
 
@@ -69,7 +71,9 @@ module FinchAPI
           # `benefits` to access deductions endpoints — `deduction` is a deprecated alias
           # that is still accepted but should not be combined with `benefits`.
           products: nil,
-          # The URI to redirect to after the Connect flow is completed
+          # The URI to redirect to after the Connect flow is completed. Required if you use
+          # the redirect flow, and it must be registered on the Credentials tab of the Finch
+          # Developer Dashboard. Omit it for the embedded flow (Connect SDK).
           redirect_uri: nil,
           request_options: {}
         )

data/rbi/finch_api/models/hris/benefit_create_params.rbi

@@ -16,7 +16,9 @@ module FinchAPI
           end
 
         # The entity IDs to specify which entities' data to access. Provide exactly one
-        # entity ID per request; a maximum of one is accepted.
+        # entity ID per request; a maximum of one is accepted. Required when the
+        # connection has more than one entity — omitting it returns a `400`
+        # `invalid_request_error`. Optional for single-entity connections.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :entity_ids
 
@@ -73,7 +75,9 @@ module FinchAPI
         end
         def self.new(
           # The entity IDs to specify which entities' data to access. Provide exactly one
-          # entity ID per request; a maximum of one is accepted.
+          # entity ID per request; a maximum of one is accepted. Required when the
+          # connection has more than one entity — omitting it returns a `400`
+          # `invalid_request_error`. Optional for single-entity connections.
           entity_ids: nil,
           # The company match for this benefit.
           company_contribution: nil,

data/rbi/finch_api/models/hris/benefit_list_params.rbi

@@ -16,7 +16,9 @@ module FinchAPI
           end
 
         # The entity IDs to specify which entities' data to access. Provide exactly one
-        # entity ID per request; a maximum of one is accepted.
+        # entity ID per request; a maximum of one is accepted. Required when the
+        # connection has more than one entity — omitting it returns a `400`
+        # `invalid_request_error`. Optional for single-entity connections.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :entity_ids
 
@@ -31,7 +33,9 @@ module FinchAPI
         end
         def self.new(
           # The entity IDs to specify which entities' data to access. Provide exactly one
-          # entity ID per request; a maximum of one is accepted.
+          # entity ID per request; a maximum of one is accepted. Required when the
+          # connection has more than one entity — omitting it returns a `400`
+          # `invalid_request_error`. Optional for single-entity connections.
           entity_ids: nil,
           request_options: {}
         )

data/rbi/finch_api/models/hris/benefit_list_supported_benefits_params.rbi

@@ -16,7 +16,9 @@ module FinchAPI
           end
 
         # The entity IDs to specify which entities' data to access. Provide exactly one
-        # entity ID per request; a maximum of one is accepted.
+        # entity ID per request; a maximum of one is accepted. Required when the
+        # connection has more than one entity — omitting it returns a `400`
+        # `invalid_request_error`. Optional for single-entity connections.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :entity_ids
 
@@ -31,7 +33,9 @@ module FinchAPI
         end
         def self.new(
           # The entity IDs to specify which entities' data to access. Provide exactly one
-          # entity ID per request; a maximum of one is accepted.
+          # entity ID per request; a maximum of one is accepted. Required when the
+          # connection has more than one entity — omitting it returns a `400`
+          # `invalid_request_error`. Optional for single-entity connections.
           entity_ids: nil,
           request_options: {}
         )