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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86ef7492bf27bfb2e1edbffdab311625678916983f954349ecd5f73d6ee6fa53
-  data.tar.gz: d03f0cee942683295a8c03b9b96bd2eeea75d7cf1ca147f6efa5e68f26019c20
+  metadata.gz: 5f5cb88b8975aae0a24fb06c065cf76417ee66e03e8db7221fb8b92e9b67b17d
+  data.tar.gz: 3dace0e8387c06d6c82541f4078d7c2d5c1941fb8fa11e09df7b71c4b0a7e966
 SHA512:
-  metadata.gz: 0b453b3e8c94ea657c9916a570f83baa3299da3a93099695b9bb75527c2df5538998fcb9d88fffe961f3a7093bdd70399dccfaee8bb02d2c7094c3c88334b81e
-  data.tar.gz: ed7db9de8c0c2178b060daecab36f07ff5fafd1ba3d2ee129ca6191dfa98eeea1851dd3d02c5ffffb47e7a27a115a6c6e1c3486c66245b94d6fc7acffb4964a8
+  metadata.gz: 9e84aa7dd599db34a4577e884fa714ec0ad5162eb38ea985fa78d82b6d4f61412b3d1ca561bf10118e28b7510e941d672fead59824a9231bf02137f6d84c8a32
+  data.tar.gz: c65456c96829458109ace2482577700bec8897814fd078e2c8771bd31b5775c388b0378c37ae867365259d30769c60c991f9e455dfa258d7ddecf6d63184cba2

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## [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.60.pre.alpha.59"
 ```
 
 <!-- x-release-please-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/hris/employment_data.rb

@@ -17,6 +17,14 @@ module FinchAPI
           #   @return [String]
           required :id, String
 
+          # @!attribute benefit_eligibility_class
+          #   The employer defined benefit eligibility class that groups an employee into a
+          #   set of eligible benefit plans, as stored by the provider. Null when not
+          #   configured.
+          #
+          #   @return [String, nil]
+          required :benefit_eligibility_class, String, nil?: true
+
           # @!attribute class_code
           #   Worker's compensation classification code for this employee
           #
@@ -185,13 +193,15 @@ module FinchAPI
           #   @return [String, nil]
           optional :work_id, String, nil?: true
 
-          # @!method initialize(id:, class_code:, department:, employment:, employment_status:, end_date:, first_name:, flsa_status:, highly_compensated_employee:, is_active:, key_employee:, last_name:, latest_rehire_date:, location:, manager:, middle_name:, start_date:, title:, union_code:, union_local:, custom_fields: nil, income: nil, income_history: nil, source_id: nil, work_id: nil)
+          # @!method initialize(id:, benefit_eligibility_class:, class_code:, department:, employment:, employment_status:, end_date:, first_name:, flsa_status:, highly_compensated_employee:, is_active:, key_employee:, last_name:, latest_rehire_date:, location:, manager:, middle_name:, start_date:, title:, union_code:, union_local:, custom_fields: nil, income: nil, income_history: nil, source_id: nil, work_id: nil)
           #   Some parameter documentations has been truncated, see
           #   {FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody} for more
           #   details.
           #
           #   @param id [String] A stable Finch `id` (UUID v4) for an individual in the company.
           #
+          #   @param benefit_eligibility_class [String, nil] The employer defined benefit eligibility class that groups an employee into a se
+          #
           #   @param class_code [String, nil] Worker's compensation classification code for this employee
           #
           #   @param department [FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody::Department, nil] The department object.