finch-api 2.8.3__tar.gz → 2.9.0__tar.gz

finch_api-2.9.0/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "2.9.0"
+}

{finch_api-2.8.3 → finch_api-2.9.0}/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [2.9.0](https://github.com/Finch-API/finch-api-python/compare/v2.8.3...v2.9.0) (2026-10-13)
+
+
+### Features
+
+* **employment:** expose benefit_eligibility_class on the API surface [INT-4092] ([5ba11aa](https://github.com/Finch-API/finch-api-python/commit/5ba11aaeedc40af417d60457813fa971ae439197))
+
 ## [2.8.3](https://github.com/Finch-API/finch-api-python/compare/v2.8.2...v2.8.3) (2026-10-01)
 
 

{finch_api-2.8.3 → finch_api-2.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: finch-api
-Version: 2.8.3
+Version: 2.9.0
 Summary: The official Python library for the Finch API
 Project-URL: Homepage, https://github.com/Finch-API/finch-api-python
 Project-URL: Repository, https://github.com/Finch-API/finch-api-python

{finch_api-2.8.3 → finch_api-2.9.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "finch-api"
-version = "2.8.3"
+version = "2.9.0"
 description = "The official Python library for the Finch API"
 dynamic = ["readme"]
 license = "Apache-2.0"

{finch_api-2.8.3 → finch_api-2.9.0}/src/finch/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "finch"
-__version__ = "2.8.3"  # x-release-please-version
+__version__ = "2.9.0"  # x-release-please-version

{finch_api-2.8.3 → finch_api-2.9.0}/src/finch/resources/sandbox/employment.py

@@ -46,6 +46,7 @@ class Employment(SyncAPIResource):
         self,
         individual_id: str,
         *,
+        benefit_eligibility_class: Optional[str] | Omit = omit,
         class_code: Optional[str] | Omit = omit,
         custom_fields: Optional[Iterable[employment_update_params.CustomField]] | Omit = omit,
         department: Optional[employment_update_params.Department] | Omit = omit,
@@ -83,6 +84,10 @@ class Employment(SyncAPIResource):
         Update sandbox employment
 
         Args:
+          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.
+
           class_code: Worker's compensation classification code for this employee
 
           custom_fields: Custom fields for the individual. These are fields which are defined by the
@@ -145,6 +150,7 @@ class Employment(SyncAPIResource):
             path_template("/sandbox/employment/{individual_id}", individual_id=individual_id),
             body=maybe_transform(
                 {
+                    "benefit_eligibility_class": benefit_eligibility_class,
                     "class_code": class_code,
                     "custom_fields": custom_fields,
                     "department": department,
@@ -206,6 +212,7 @@ class AsyncEmployment(AsyncAPIResource):
         self,
         individual_id: str,
         *,
+        benefit_eligibility_class: Optional[str] | Omit = omit,
         class_code: Optional[str] | Omit = omit,
         custom_fields: Optional[Iterable[employment_update_params.CustomField]] | Omit = omit,
         department: Optional[employment_update_params.Department] | Omit = omit,
@@ -243,6 +250,10 @@ class AsyncEmployment(AsyncAPIResource):
         Update sandbox employment
 
         Args:
+          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.
+
           class_code: Worker's compensation classification code for this employee
 
           custom_fields: Custom fields for the individual. These are fields which are defined by the
@@ -305,6 +316,7 @@ class AsyncEmployment(AsyncAPIResource):
             path_template("/sandbox/employment/{individual_id}", individual_id=individual_id),
             body=await async_maybe_transform(
                 {
+                    "benefit_eligibility_class": benefit_eligibility_class,
                     "class_code": class_code,
                     "custom_fields": custom_fields,
                     "department": department,

{finch_api-2.8.3 → finch_api-2.9.0}/src/finch/types/account_update_event.py

@@ -43,6 +43,15 @@ __all__ = [
     "AccountUpdateEventDataAuthenticationMethodSupportedFieldsPayStatementPayStatementsTaxes",
     "AccountUpdateEventDataAuthenticationMethodSupportedFieldsPayment",
     "AccountUpdateEventDataAuthenticationMethodSupportedFieldsPaymentPayPeriod",
+    "AccountUpdateEventDataAuthenticationMethodSupportedFieldsPlanDependents",
+    "AccountUpdateEventDataAuthenticationMethodSupportedFieldsPlanDependentsCoverage",
+    "AccountUpdateEventDataAuthenticationMethodSupportedFieldsPlanDependentsCoverageEnrollments",
+    "AccountUpdateEventDataAuthenticationMethodSupportedFieldsPlanEnrollments",
+    "AccountUpdateEventDataAuthenticationMethodSupportedFieldsPlanEnrollmentsContributions",
+    "AccountUpdateEventDataAuthenticationMethodSupportedFieldsPlanEnrollmentsContributionsEmployeeContribution",
+    "AccountUpdateEventDataAuthenticationMethodSupportedFieldsPlanEnrollmentsContributionsEmployerContribution",
+    "AccountUpdateEventDataAuthenticationMethodSupportedFieldsPlans",
+    "AccountUpdateEventDataAuthenticationMethodSupportedFieldsPlansCarrier",
 ]
 
 
@@ -392,8 +401,120 @@ class AccountUpdateEventDataAuthenticationMethodSupportedFieldsPayment(BaseModel
     pay_period: Optional[AccountUpdateEventDataAuthenticationMethodSupportedFieldsPaymentPayPeriod] = None
 
 
+class AccountUpdateEventDataAuthenticationMethodSupportedFieldsPlanDependentsCoverageEnrollments(BaseModel):
+    id: Optional[bool] = None
+
+    type: Optional[bool] = None
+
+
+class AccountUpdateEventDataAuthenticationMethodSupportedFieldsPlanDependentsCoverage(BaseModel):
+    enrollments: Optional[
+        AccountUpdateEventDataAuthenticationMethodSupportedFieldsPlanDependentsCoverageEnrollments
+    ] = None
+
+    individual_id: Optional[bool] = None
+
+    relationship_to_individual: Optional[bool] = None
+
+
+class AccountUpdateEventDataAuthenticationMethodSupportedFieldsPlanDependents(BaseModel):
+    coverage: Optional[AccountUpdateEventDataAuthenticationMethodSupportedFieldsPlanDependentsCoverage] = None
+
+    date_of_birth: Optional[bool] = None
+
+    dependent_id: Optional[bool] = None
+
+    first_name: Optional[bool] = None
+
+    gender: Optional[bool] = None
+
+    last_name: Optional[bool] = None
+
+    middle_name: Optional[bool] = None
+
+    ssn: Optional[bool] = None
+
+
+class AccountUpdateEventDataAuthenticationMethodSupportedFieldsPlanEnrollmentsContributionsEmployeeContribution(
+    BaseModel
+):
+    amount: Optional[bool] = None
+
+    currency: Optional[bool] = None
+
+
+class AccountUpdateEventDataAuthenticationMethodSupportedFieldsPlanEnrollmentsContributionsEmployerContribution(
+    BaseModel
+):
+    amount: Optional[bool] = None
+
+    currency: Optional[bool] = None
+
+
+class AccountUpdateEventDataAuthenticationMethodSupportedFieldsPlanEnrollmentsContributions(BaseModel):
+    employee_contribution: Optional[
+        AccountUpdateEventDataAuthenticationMethodSupportedFieldsPlanEnrollmentsContributionsEmployeeContribution
+    ] = None
+
+    employer_contribution: Optional[
+        AccountUpdateEventDataAuthenticationMethodSupportedFieldsPlanEnrollmentsContributionsEmployerContribution
+    ] = None
+
+    frequency: Optional[bool] = None
+
+
+class AccountUpdateEventDataAuthenticationMethodSupportedFieldsPlanEnrollments(BaseModel):
+    id: Optional[bool] = None
+
+    contributions: Optional[AccountUpdateEventDataAuthenticationMethodSupportedFieldsPlanEnrollmentsContributions] = (
+        None
+    )
+
+    coverage_end_date: Optional[bool] = None
+
+    coverage_start_date: Optional[bool] = None
+
+    coverage_tier: Optional[bool] = None
+
+    dependent_ids: Optional[bool] = None
+
+    individual_id: Optional[bool] = None
+
+    plan_id: Optional[bool] = None
+
+    status: Optional[bool] = None
+
+
+class AccountUpdateEventDataAuthenticationMethodSupportedFieldsPlansCarrier(BaseModel):
+    id: Optional[bool] = None
+
+    name: Optional[bool] = None
+
+
+class AccountUpdateEventDataAuthenticationMethodSupportedFieldsPlans(BaseModel):
+    id: Optional[bool] = None
+
+    carrier: Optional[AccountUpdateEventDataAuthenticationMethodSupportedFieldsPlansCarrier] = None
+
+    coverage_tiers: Optional[bool] = None
+
+    deduction_codes: Optional[bool] = None
+
+    description: Optional[bool] = None
+
+    end_date: Optional[bool] = None
+
+    name: Optional[bool] = None
+
+    network_type: Optional[bool] = None
+
+    start_date: Optional[bool] = None
+
+    type: Optional[bool] = None
+
+
 class AccountUpdateEventDataAuthenticationMethodSupportedFields(BaseModel):
-    """The supported data fields returned by our HR and payroll endpoints"""
+    """The supported data fields returned by our HR, payroll, and benefits endpoints"""
 
     company: Optional[AccountUpdateEventDataAuthenticationMethodSupportedFieldsCompany] = None
 
@@ -409,6 +530,12 @@ class AccountUpdateEventDataAuthenticationMethodSupportedFields(BaseModel):
 
     payment: Optional[AccountUpdateEventDataAuthenticationMethodSupportedFieldsPayment] = None
 
+    plan_dependents: Optional[AccountUpdateEventDataAuthenticationMethodSupportedFieldsPlanDependents] = None
+
+    plan_enrollments: Optional[AccountUpdateEventDataAuthenticationMethodSupportedFieldsPlanEnrollments] = None
+
+    plans: Optional[AccountUpdateEventDataAuthenticationMethodSupportedFieldsPlans] = None
+
 
 class AccountUpdateEventDataAuthenticationMethod(BaseModel):
     benefits_support: Optional[BenefitsSupport] = None
@@ -418,7 +545,7 @@ class AccountUpdateEventDataAuthenticationMethod(BaseModel):
     """
 
     supported_fields: Optional[AccountUpdateEventDataAuthenticationMethodSupportedFields] = None
-    """The supported data fields returned by our HR and payroll endpoints"""
+    """The supported data fields returned by our HR, payroll, and benefits endpoints"""
 
     type: Optional[Literal["assisted", "credential", "api_token", "api_credential", "oauth"]] = None
     """The type of authentication method."""

{finch_api-2.8.3 → finch_api-2.9.0}/src/finch/types/hris/employment_data.py

@@ -56,6 +56,13 @@ class EmploymentDataResponseBody(BaseModel):
     id: str
     """A stable Finch `id` (UUID v4) for an individual in the company."""
 
+    benefit_eligibility_class: Optional[str] = None
+    """
+    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.
+    """
+
     class_code: Optional[str] = None
     """Worker's compensation classification code for this employee"""