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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86ef7492bf27bfb2e1edbffdab311625678916983f954349ecd5f73d6ee6fa53
-  data.tar.gz: d03f0cee942683295a8c03b9b96bd2eeea75d7cf1ca147f6efa5e68f26019c20
+  metadata.gz: 1b2ec93a327103f7eea06fd294cadff34fb56bc6070a97efbdfee5b5b022e1c2
+  data.tar.gz: fbb9ca1192032ca4cc10b021772953b59d923a7ef8a884a972101eb49d883b39
 SHA512:
-  metadata.gz: 0b453b3e8c94ea657c9916a570f83baa3299da3a93099695b9bb75527c2df5538998fcb9d88fffe961f3a7093bdd70399dccfaee8bb02d2c7094c3c88334b81e
-  data.tar.gz: ed7db9de8c0c2178b060daecab36f07ff5fafd1ba3d2ee129ca6191dfa98eeea1851dd3d02c5ffffb47e7a27a115a6c6e1c3486c66245b94d6fc7acffb4964a8
+  metadata.gz: c6c7d9f866df262b2377ffb557a9925c2196318f94c5c69aeb9b8e03afe5e493c0f5c30de58ce124952275311caffe0d104bbaac4691cfd500127531e08a2fe1
+  data.tar.gz: 652ff028c7f18d80165b5bee650ed442d9f1e176297d06c3e4599897390021975570bbfb9e4ab92dfb223ae5f1a3b2bfd719b5447792d5d5ebed113dae41a18c

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 # 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)
+
+
+### Features
+
+* **employment:** expose benefit_eligibility_class on the API surface [INT-4092] ([5bd28e8](https://github.com/Finch-API/finch-api-ruby/commit/5bd28e84fe7d95f7731b0b4d752be7561e37172b))
+
+
+### Chores
+
+* **api:** rebuild SDK ([e544049](https://github.com/Finch-API/finch-api-ruby/commit/e544049748fe698fadb1615c36f7190fdd6eff8c))
+
 ## [0.1.0-alpha.59](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.58...v0.1.0-alpha.59) (2026-10-01)
 
 

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.59.pre.alpha.58"
+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/account_update_event.rb

@@ -42,7 +42,7 @@ module FinchAPI
           optional :benefits_support, -> { FinchAPI::HRIS::BenefitsSupport }, nil?: true
 
           # @!attribute supported_fields
-          #   The supported data fields returned by our HR and payroll endpoints
+          #   The supported data fields returned by our HR, payroll, and benefits endpoints
           #
           #   @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields, nil]
           optional :supported_fields,
@@ -62,7 +62,7 @@ module FinchAPI
           #
           #   @param benefits_support [FinchAPI::Models::HRIS::BenefitsSupport, nil] Each benefit type and their supported features. If the benefit type is not suppo
           #
-          #   @param supported_fields [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields, nil] The supported data fields returned by our HR and payroll endpoints
+          #   @param supported_fields [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields, nil] The supported data fields returned by our HR, payroll, and benefits endpoints
           #
           #   @param type [Symbol, FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type] The type of authentication method.
 
@@ -110,8 +110,25 @@ module FinchAPI
             optional :payment,
                      -> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment }
 
-            # @!method initialize(company: nil, directory: nil, employment: nil, individual: nil, pay_group: nil, pay_statement: nil, payment: nil)
-            #   The supported data fields returned by our HR and payroll endpoints
+            # @!attribute plan_dependents
+            #
+            #   @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanDependents, nil]
+            optional :plan_dependents,
+                     -> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanDependents }
+
+            # @!attribute plan_enrollments
+            #
+            #   @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanEnrollments, nil]
+            optional :plan_enrollments,
+                     -> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanEnrollments }
+
+            # @!attribute plans
+            #
+            #   @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Plans, nil]
+            optional :plans, -> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Plans }
+
+            # @!method initialize(company: nil, directory: nil, employment: nil, individual: nil, pay_group: nil, pay_statement: nil, payment: nil, plan_dependents: nil, plan_enrollments: nil, plans: nil)
+            #   The supported data fields returned by our HR, payroll, and benefits endpoints
             #
             #   @param company [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company]
             #   @param directory [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory]
@@ -120,6 +137,9 @@ module FinchAPI
             #   @param pay_group [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayGroup]
             #   @param pay_statement [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement]
             #   @param payment [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment]
+            #   @param plan_dependents [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanDependents]
+            #   @param plan_enrollments [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanEnrollments]
+            #   @param plans [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Plans]
 
             # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields#company
             class Company < FinchAPI::Internal::Type::BaseModel
@@ -334,7 +354,7 @@ module FinchAPI
                 # @!attribute department
                 #
                 #   @return [Boolean, nil]
-                optional :department, FinchAPI::Internal::Type::Boolean
+                optional :department, FinchAPI::Internal::Type::Boolean, nil?: true
 
                 # @!attribute first_name
                 #
@@ -364,7 +384,7 @@ module FinchAPI
 
                 # @!method initialize(id: nil, department: nil, first_name: nil, is_active: nil, last_name: nil, manager: nil, middle_name: nil)
                 #   @param id [Boolean]
-                #   @param department [Boolean]
+                #   @param department [Boolean, nil]
                 #   @param first_name [Boolean]
                 #   @param is_active [Boolean]
                 #   @param last_name [Boolean]
@@ -476,7 +496,10 @@ module FinchAPI
               #
               #   @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager, nil]
               optional :manager,
-                       -> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager }
+                       -> {
+                         FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager
+                       },
+                       nil?: true
 
               # @!attribute middle_name
               #
@@ -507,7 +530,7 @@ module FinchAPI
               #   @param is_active [Boolean]
               #   @param last_name [Boolean]
               #   @param location [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Location]
-              #   @param manager [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager]
+              #   @param manager [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager, nil]
               #   @param middle_name [Boolean]
               #   @param start_date [Boolean]
               #   @param title [Boolean]
@@ -1127,6 +1150,303 @@ module FinchAPI
                 #   @param start_date [Boolean]
               end
             end
+
+            # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields#plan_dependents
+            class PlanDependents < FinchAPI::Internal::Type::BaseModel
+              # @!attribute coverage
+              #
+              #   @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanDependents::Coverage, nil]
+              optional :coverage,
+                       -> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanDependents::Coverage }
+
+              # @!attribute date_of_birth
+              #
+              #   @return [Boolean, nil]
+              optional :date_of_birth, FinchAPI::Internal::Type::Boolean
+
+              # @!attribute dependent_id
+              #
+              #   @return [Boolean, nil]
+              optional :dependent_id, FinchAPI::Internal::Type::Boolean
+
+              # @!attribute first_name
+              #
+              #   @return [Boolean, nil]
+              optional :first_name, FinchAPI::Internal::Type::Boolean
+
+              # @!attribute gender
+              #
+              #   @return [Boolean, nil]
+              optional :gender, FinchAPI::Internal::Type::Boolean
+
+              # @!attribute last_name
+              #
+              #   @return [Boolean, nil]
+              optional :last_name, FinchAPI::Internal::Type::Boolean
+
+              # @!attribute middle_name
+              #
+              #   @return [Boolean, nil]
+              optional :middle_name, FinchAPI::Internal::Type::Boolean
+
+              # @!attribute ssn
+              #
+              #   @return [Boolean, nil]
+              optional :ssn, FinchAPI::Internal::Type::Boolean
+
+              # @!method initialize(coverage: nil, date_of_birth: nil, dependent_id: nil, first_name: nil, gender: nil, last_name: nil, middle_name: nil, ssn: nil)
+              #   @param coverage [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanDependents::Coverage]
+              #   @param date_of_birth [Boolean]
+              #   @param dependent_id [Boolean]
+              #   @param first_name [Boolean]
+              #   @param gender [Boolean]
+              #   @param last_name [Boolean]
+              #   @param middle_name [Boolean]
+              #   @param ssn [Boolean]
+
+              # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanDependents#coverage
+              class Coverage < FinchAPI::Internal::Type::BaseModel
+                # @!attribute enrollments
+                #
+                #   @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanDependents::Coverage::Enrollments, nil]
+                optional :enrollments,
+                         -> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanDependents::Coverage::Enrollments }
+
+                # @!attribute individual_id
+                #
+                #   @return [Boolean, nil]
+                optional :individual_id, FinchAPI::Internal::Type::Boolean
+
+                # @!attribute relationship_to_individual
+                #
+                #   @return [Boolean, nil]
+                optional :relationship_to_individual, FinchAPI::Internal::Type::Boolean
+
+                # @!method initialize(enrollments: nil, individual_id: nil, relationship_to_individual: nil)
+                #   @param enrollments [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanDependents::Coverage::Enrollments]
+                #   @param individual_id [Boolean]
+                #   @param relationship_to_individual [Boolean]
+
+                # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanDependents::Coverage#enrollments
+                class Enrollments < FinchAPI::Internal::Type::BaseModel
+                  # @!attribute id
+                  #
+                  #   @return [Boolean, nil]
+                  optional :id, FinchAPI::Internal::Type::Boolean
+
+                  # @!attribute type
+                  #
+                  #   @return [Boolean, nil]
+                  optional :type, FinchAPI::Internal::Type::Boolean
+
+                  # @!method initialize(id: nil, type: nil)
+                  #   @param id [Boolean]
+                  #   @param type [Boolean]
+                end
+              end
+            end
+
+            # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields#plan_enrollments
+            class PlanEnrollments < FinchAPI::Internal::Type::BaseModel
+              # @!attribute id
+              #
+              #   @return [Boolean, nil]
+              optional :id, FinchAPI::Internal::Type::Boolean
+
+              # @!attribute contributions
+              #
+              #   @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions, nil]
+              optional :contributions,
+                       -> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions }
+
+              # @!attribute coverage_end_date
+              #
+              #   @return [Boolean, nil]
+              optional :coverage_end_date, FinchAPI::Internal::Type::Boolean
+
+              # @!attribute coverage_start_date
+              #
+              #   @return [Boolean, nil]
+              optional :coverage_start_date, FinchAPI::Internal::Type::Boolean
+
+              # @!attribute coverage_tier
+              #
+              #   @return [Boolean, nil]
+              optional :coverage_tier, FinchAPI::Internal::Type::Boolean
+
+              # @!attribute dependent_ids
+              #
+              #   @return [Boolean, nil]
+              optional :dependent_ids, FinchAPI::Internal::Type::Boolean
+
+              # @!attribute individual_id
+              #
+              #   @return [Boolean, nil]
+              optional :individual_id, FinchAPI::Internal::Type::Boolean
+
+              # @!attribute plan_id
+              #
+              #   @return [Boolean, nil]
+              optional :plan_id, FinchAPI::Internal::Type::Boolean
+
+              # @!attribute status
+              #
+              #   @return [Boolean, nil]
+              optional :status, FinchAPI::Internal::Type::Boolean
+
+              # @!method initialize(id: nil, contributions: nil, coverage_end_date: nil, coverage_start_date: nil, coverage_tier: nil, dependent_ids: nil, individual_id: nil, plan_id: nil, status: nil)
+              #   @param id [Boolean]
+              #   @param contributions [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions]
+              #   @param coverage_end_date [Boolean]
+              #   @param coverage_start_date [Boolean]
+              #   @param coverage_tier [Boolean]
+              #   @param dependent_ids [Boolean]
+              #   @param individual_id [Boolean]
+              #   @param plan_id [Boolean]
+              #   @param status [Boolean]
+
+              # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanEnrollments#contributions
+              class Contributions < FinchAPI::Internal::Type::BaseModel
+                # @!attribute employee_contribution
+                #
+                #   @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions::EmployeeContribution, nil]
+                optional :employee_contribution,
+                         -> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions::EmployeeContribution }
+
+                # @!attribute employer_contribution
+                #
+                #   @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions::EmployerContribution, nil]
+                optional :employer_contribution,
+                         -> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions::EmployerContribution }
+
+                # @!attribute frequency
+                #
+                #   @return [Boolean, nil]
+                optional :frequency, FinchAPI::Internal::Type::Boolean
+
+                # @!method initialize(employee_contribution: nil, employer_contribution: nil, frequency: nil)
+                #   @param employee_contribution [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions::EmployeeContribution]
+                #   @param employer_contribution [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions::EmployerContribution]
+                #   @param frequency [Boolean]
+
+                # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions#employee_contribution
+                class EmployeeContribution < FinchAPI::Internal::Type::BaseModel
+                  # @!attribute amount
+                  #
+                  #   @return [Boolean, nil]
+                  optional :amount, FinchAPI::Internal::Type::Boolean
+
+                  # @!attribute currency
+                  #
+                  #   @return [Boolean, nil]
+                  optional :currency, FinchAPI::Internal::Type::Boolean
+
+                  # @!method initialize(amount: nil, currency: nil)
+                  #   @param amount [Boolean]
+                  #   @param currency [Boolean]
+                end
+
+                # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions#employer_contribution
+                class EmployerContribution < FinchAPI::Internal::Type::BaseModel
+                  # @!attribute amount
+                  #
+                  #   @return [Boolean, nil]
+                  optional :amount, FinchAPI::Internal::Type::Boolean
+
+                  # @!attribute currency
+                  #
+                  #   @return [Boolean, nil]
+                  optional :currency, FinchAPI::Internal::Type::Boolean
+
+                  # @!method initialize(amount: nil, currency: nil)
+                  #   @param amount [Boolean]
+                  #   @param currency [Boolean]
+                end
+              end
+            end
+
+            # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields#plans
+            class Plans < FinchAPI::Internal::Type::BaseModel
+              # @!attribute id
+              #
+              #   @return [Boolean, nil]
+              optional :id, FinchAPI::Internal::Type::Boolean
+
+              # @!attribute carrier
+              #
+              #   @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Plans::Carrier, nil]
+              optional :carrier,
+                       -> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Plans::Carrier }
+
+              # @!attribute coverage_tiers
+              #
+              #   @return [Boolean, nil]
+              optional :coverage_tiers, FinchAPI::Internal::Type::Boolean
+
+              # @!attribute deduction_codes
+              #
+              #   @return [Boolean, nil]
+              optional :deduction_codes, FinchAPI::Internal::Type::Boolean
+
+              # @!attribute description
+              #
+              #   @return [Boolean, nil]
+              optional :description, FinchAPI::Internal::Type::Boolean
+
+              # @!attribute end_date
+              #
+              #   @return [Boolean, nil]
+              optional :end_date, FinchAPI::Internal::Type::Boolean
+
+              # @!attribute name
+              #
+              #   @return [Boolean, nil]
+              optional :name, FinchAPI::Internal::Type::Boolean
+
+              # @!attribute network_type
+              #
+              #   @return [Boolean, nil]
+              optional :network_type, FinchAPI::Internal::Type::Boolean
+
+              # @!attribute start_date
+              #
+              #   @return [Boolean, nil]
+              optional :start_date, FinchAPI::Internal::Type::Boolean
+
+              # @!attribute type
+              #
+              #   @return [Boolean, nil]
+              optional :type, FinchAPI::Internal::Type::Boolean
+
+              # @!method initialize(id: nil, carrier: nil, coverage_tiers: nil, deduction_codes: nil, description: nil, end_date: nil, name: nil, network_type: nil, start_date: nil, type: nil)
+              #   @param id [Boolean]
+              #   @param carrier [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Plans::Carrier]
+              #   @param coverage_tiers [Boolean]
+              #   @param deduction_codes [Boolean]
+              #   @param description [Boolean]
+              #   @param end_date [Boolean]
+              #   @param name [Boolean]
+              #   @param network_type [Boolean]
+              #   @param start_date [Boolean]
+              #   @param type [Boolean]
+
+              # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Plans#carrier
+              class Carrier < FinchAPI::Internal::Type::BaseModel
+                # @!attribute id
+                #
+                #   @return [Boolean, nil]
+                optional :id, FinchAPI::Internal::Type::Boolean
+
+                # @!attribute name
+                #
+                #   @return [Boolean, nil]
+                optional :name, FinchAPI::Internal::Type::Boolean
+
+                # @!method initialize(id: nil, name: nil)
+                #   @param id [Boolean]
+                #   @param name [Boolean]
+              end
+            end
           end
 
           # The type of authentication method.

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]