release: 1.29.0 (#662)

* feat(api): api update

* release: 1.29.0

---------

Co-authored-by: stainless-app[bot] <142633134+stainless-app[bot]@users.noreply.github.com>

Author: stainless-app[bot]

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "1.28.0"
+  ".": "1.29.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 46
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-dbbf65e94ae7a53cd5a313974761102447ccda3096fd40967c137ad3f80f7154.yml
-openapi_spec_hash: 3cc9d87b60dc27283735d610d4b51a53
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-944a0f9d35f3b8ec2ba62fa12e551cf89f0b845f8ed1e3c7f67a9fb80b32d96f.yml
+openapi_spec_hash: 37c849e7b5dd941c011385b49467e077
 config_hash: 53778a0b839c4f6ad34fbba051f5e8a6

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.29.0 (2025-05-16)
+
+Full Changelog: [v1.28.0...v1.29.0](https://github.com/Finch-API/finch-api-python/compare/v1.28.0...v1.29.0)
+
+### Features
+
+* **api:** api update ([574a3f7](https://github.com/Finch-API/finch-api-python/commit/574a3f74cf52773916bf81bc036b6db2d8c6c55f))
+
 ## 1.28.0 (2025-05-16)
 
 Full Changelog: [v1.27.0...v1.28.0](https://github.com/Finch-API/finch-api-python/compare/v1.27.0...v1.28.0)

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "finch-api"
-version = "1.28.0"
+version = "1.29.0"
 description = "The official Python library for the Finch API"
 dynamic = ["readme"]
 license = "Apache-2.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__ = "1.28.0"  # x-release-please-version
+__version__ = "1.29.0"  # x-release-please-version

src/finch/resources/sandbox/employment.py

@@ -47,7 +47,7 @@ def update(
         individual_id: str,
         *,
         class_code: Optional[str] | NotGiven = NOT_GIVEN,
-        custom_fields: Iterable[employment_update_params.CustomField] | NotGiven = NOT_GIVEN,
+        custom_fields: Optional[Iterable[employment_update_params.CustomField]] | NotGiven = NOT_GIVEN,
         department: Optional[employment_update_params.Department] | NotGiven = NOT_GIVEN,
         employment: Optional[employment_update_params.Employment] | NotGiven = NOT_GIVEN,
         employment_status: Optional[
@@ -64,7 +64,7 @@ def update(
         location: Optional[LocationParam] | NotGiven = NOT_GIVEN,
         manager: Optional[employment_update_params.Manager] | NotGiven = NOT_GIVEN,
         middle_name: Optional[str] | NotGiven = NOT_GIVEN,
-        source_id: str | NotGiven = NOT_GIVEN,
+        source_id: Optional[str] | NotGiven = NOT_GIVEN,
         start_date: Optional[str] | NotGiven = NOT_GIVEN,
         title: Optional[str] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -88,7 +88,8 @@ def update(
 
           employment: The employment object.
 
-          employment_status: The detailed employment status of the individual.
+          employment_status: The detailed employment status of the individual. Available options: `active`,
+              `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
 
           first_name: The legal first name of the individual.
 
@@ -179,7 +180,7 @@ async def update(
         individual_id: str,
         *,
         class_code: Optional[str] | NotGiven = NOT_GIVEN,
-        custom_fields: Iterable[employment_update_params.CustomField] | NotGiven = NOT_GIVEN,
+        custom_fields: Optional[Iterable[employment_update_params.CustomField]] | NotGiven = NOT_GIVEN,
         department: Optional[employment_update_params.Department] | NotGiven = NOT_GIVEN,
         employment: Optional[employment_update_params.Employment] | NotGiven = NOT_GIVEN,
         employment_status: Optional[
@@ -196,7 +197,7 @@ async def update(
         location: Optional[LocationParam] | NotGiven = NOT_GIVEN,
         manager: Optional[employment_update_params.Manager] | NotGiven = NOT_GIVEN,
         middle_name: Optional[str] | NotGiven = NOT_GIVEN,
-        source_id: str | NotGiven = NOT_GIVEN,
+        source_id: Optional[str] | NotGiven = NOT_GIVEN,
         start_date: Optional[str] | NotGiven = NOT_GIVEN,
         title: Optional[str] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -220,7 +221,8 @@ async def update(
 
           employment: The employment object.
 
-          employment_status: The detailed employment status of the individual.
+          employment_status: The detailed employment status of the individual. Available options: `active`,
+              `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
 
           first_name: The legal first name of the individual.
 

src/finch/types/hris/employment_data.py

@@ -21,7 +21,7 @@
 class UnionMember0CustomField(BaseModel):
     name: Optional[str] = None
 
-    value: Union[str, List[object], float, bool, object, None] = None
+    value: Union[Optional[str], Optional[List[object]], Optional[float], Optional[bool], Optional[object], None] = None
 
 
 class UnionMember0Department(BaseModel):
@@ -56,7 +56,8 @@ class UnionMember0(BaseModel):
     custom_fields: Optional[List[UnionMember0CustomField]] = None
     """Custom fields for the individual.
 
-    These are fields which are defined by the employer in the system.
+    These are fields which are defined by the employer in the system. Custom fields
+    are not currently supported for assisted connections.
     """
 
     department: Optional[UnionMember0Department] = None

src/finch/types/sandbox/directory_create_params.py

@@ -73,7 +73,7 @@ class Body(TypedDict, total=False):
     class_code: Optional[str]
     """Worker's compensation classification code for this employee"""
 
-    custom_fields: Iterable[BodyCustomField]
+    custom_fields: Optional[Iterable[BodyCustomField]]
     """Custom fields for the individual.
 
     These are fields which are defined by the employer in the system. Custom fields
@@ -93,7 +93,11 @@ class Body(TypedDict, total=False):
     employment_status: Optional[
         Literal["active", "deceased", "leave", "onboarding", "prehire", "retired", "terminated"]
     ]
-    """The detailed employment status of the individual."""
+    """The detailed employment status of the individual.
+
+    Available options: `active`, `deceased`, `leave`, `onboarding`, `prehire`,
+    `retired`, `terminated`.
+    """
 
     encrypted_ssn: Optional[str]
     """Social Security Number of the individual in **encrypted** format.
@@ -157,7 +161,7 @@ class Body(TypedDict, total=False):
 
     residence: Optional[LocationParam]
 
-    source_id: str
+    source_id: Optional[str]
     """The source system's unique employment identifier for this individual"""
 
     ssn: Optional[str]

src/finch/types/sandbox/employment_update_params.py

@@ -15,7 +15,7 @@ class EmploymentUpdateParams(TypedDict, total=False):
     class_code: Optional[str]
     """Worker's compensation classification code for this employee"""
 
-    custom_fields: Iterable[CustomField]
+    custom_fields: Optional[Iterable[CustomField]]
     """Custom fields for the individual.
 
     These are fields which are defined by the employer in the system. Custom fields
@@ -31,7 +31,11 @@ class EmploymentUpdateParams(TypedDict, total=False):
     employment_status: Optional[
         Literal["active", "deceased", "leave", "onboarding", "prehire", "retired", "terminated"]
     ]
-    """The detailed employment status of the individual."""
+    """The detailed employment status of the individual.
+
+    Available options: `active`, `deceased`, `leave`, `onboarding`, `prehire`,
+    `retired`, `terminated`.
+    """
 
     end_date: Optional[str]
 
@@ -64,7 +68,7 @@ class EmploymentUpdateParams(TypedDict, total=False):
     middle_name: Optional[str]
     """The legal middle name of the individual."""
 
-    source_id: str
+    source_id: Optional[str]
     """The source system's unique employment identifier for this individual"""
 
     start_date: Optional[str]

src/finch/types/sandbox/employment_update_response.py

@@ -61,7 +61,11 @@ class EmploymentUpdateResponse(BaseModel):
     employment_status: Optional[
         Literal["active", "deceased", "leave", "onboarding", "prehire", "retired", "terminated"]
     ] = None
-    """The detailed employment status of the individual."""
+    """The detailed employment status of the individual.
+
+    Available options: `active`, `deceased`, `leave`, `onboarding`, `prehire`,
+    `retired`, `terminated`.
+    """
 
     end_date: Optional[str] = None