feat(api): api update (#636)

stainless-app[bot] · stainless-app[bot] · commit 4b822a0d8373 · 2025-04-02T16:21:08.000Z
diff --git a/.stats.yml b/.stats.yml
@@ -1,4 +1,4 @@
 configured_endpoints: 41
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-df94542d153a8558bbe63b273e8d6ae79f46b8d81df1ebeeacd07fee6f9ee22a.yml
-openapi_spec_hash: aeb92e382ee0a9b86e2ba39e54cdfe9a
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-972e563922dedeeb94dca9a3ca8bac536488fcee56b55fcf09e6af044d3740e3.yml
+openapi_spec_hash: 08b86ecbec3323717d48e4aaee48ed54
 config_hash: 8303e755d3e16cf28542d5f0aec83851
diff --git a/api.md b/api.md
@@ -158,8 +158,8 @@ Types:
 from finch.types.hris.benefits import (
     EnrolledIndividual,
     IndividualBenefit,
-    UnenrolledIndividual,
     IndividualEnrolledIDsResponse,
+    IndividualUnenrollManyResponse,
 )
 ```
 
@@ -168,7 +168,7 @@ Methods:
 - <code title="post /employer/benefits/{benefit_id}/individuals">client.hris.benefits.individuals.<a href="./src/finch/resources/hris/benefits/individuals.py">enroll_many</a>(benefit_id, \*\*<a href="src/finch/types/hris/benefits/individual_enroll_many_params.py">params</a>) -> <a href="./src/finch/types/hris/benefits/enrolled_individual.py">SyncSinglePage[EnrolledIndividual]</a></code>
 - <code title="get /employer/benefits/{benefit_id}/enrolled">client.hris.benefits.individuals.<a href="./src/finch/resources/hris/benefits/individuals.py">enrolled_ids</a>(benefit_id) -> <a href="./src/finch/types/hris/benefits/individual_enrolled_ids_response.py">IndividualEnrolledIDsResponse</a></code>
 - <code title="get /employer/benefits/{benefit_id}/individuals">client.hris.benefits.individuals.<a href="./src/finch/resources/hris/benefits/individuals.py">retrieve_many_benefits</a>(benefit_id, \*\*<a href="src/finch/types/hris/benefits/individual_retrieve_many_benefits_params.py">params</a>) -> <a href="./src/finch/types/hris/benefits/individual_benefit.py">SyncSinglePage[IndividualBenefit]</a></code>
-- <code title="delete /employer/benefits/{benefit_id}/individuals">client.hris.benefits.individuals.<a href="./src/finch/resources/hris/benefits/individuals.py">unenroll_many</a>(benefit_id, \*\*<a href="src/finch/types/hris/benefits/individual_unenroll_many_params.py">params</a>) -> <a href="./src/finch/types/hris/benefits/unenrolled_individual.py">SyncSinglePage[UnenrolledIndividual]</a></code>
+- <code title="delete /employer/benefits/{benefit_id}/individuals">client.hris.benefits.individuals.<a href="./src/finch/resources/hris/benefits/individuals.py">unenroll_many</a>(benefit_id, \*\*<a href="src/finch/types/hris/benefits/individual_unenroll_many_params.py">params</a>) -> <a href="./src/finch/types/hris/benefits/individual_unenroll_many_response.py">SyncSinglePage[object]</a></code>
 
 # Providers
 
diff --git a/src/finch/resources/hris/benefits/benefits.py b/src/finch/resources/hris/benefits/benefits.py
@@ -83,6 +83,8 @@ def create(
               limiting this to <30 characters due to limitations in specific providers (e.g.
               Justworks).
 
+          frequency: The frequency of the benefit deduction/contribution.
+
           type: Type of benefit.
 
           extra_headers: Send extra headers
@@ -267,6 +269,8 @@ async def create(
               limiting this to <30 characters due to limitations in specific providers (e.g.
               Justworks).
 
+          frequency: The frequency of the benefit deduction/contribution.
+
           type: Type of benefit.
 
           extra_headers: Send extra headers
diff --git a/src/finch/resources/hris/benefits/individuals.py b/src/finch/resources/hris/benefits/individuals.py
@@ -21,7 +21,6 @@
 )
 from ....types.hris.benefits.individual_benefit import IndividualBenefit
 from ....types.hris.benefits.enrolled_individual import EnrolledIndividual
-from ....types.hris.benefits.unenrolled_individual import UnenrolledIndividual
 from ....types.hris.benefits.individual_enrolled_ids_response import IndividualEnrolledIDsResponse
 
 __all__ = ["Individuals", "AsyncIndividuals"]
@@ -179,7 +178,7 @@ def unenroll_many(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> SyncSinglePage[UnenrolledIndividual]:
+    ) -> SyncSinglePage[object]:
         """
         Unenroll individuals from a deduction or contribution
 
@@ -198,14 +197,14 @@ def unenroll_many(
             raise ValueError(f"Expected a non-empty value for `benefit_id` but received {benefit_id!r}")
         return self._get_api_list(
             f"/employer/benefits/{benefit_id}/individuals",
-            page=SyncSinglePage[UnenrolledIndividual],
+            page=SyncSinglePage[object],
             body=maybe_transform(
                 {"individual_ids": individual_ids}, individual_unenroll_many_params.IndividualUnenrollManyParams
             ),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            model=UnenrolledIndividual,
+            model=object,
             method="delete",
         )
 
@@ -362,7 +361,7 @@ def unenroll_many(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> AsyncPaginator[UnenrolledIndividual, AsyncSinglePage[UnenrolledIndividual]]:
+    ) -> AsyncPaginator[object, AsyncSinglePage[object]]:
         """
         Unenroll individuals from a deduction or contribution
 
@@ -381,14 +380,14 @@ def unenroll_many(
             raise ValueError(f"Expected a non-empty value for `benefit_id` but received {benefit_id!r}")
         return self._get_api_list(
             f"/employer/benefits/{benefit_id}/individuals",
-            page=AsyncSinglePage[UnenrolledIndividual],
+            page=AsyncSinglePage[object],
             body=maybe_transform(
                 {"individual_ids": individual_ids}, individual_unenroll_many_params.IndividualUnenrollManyParams
             ),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            model=UnenrolledIndividual,
+            model=object,
             method="delete",
         )
 
diff --git a/src/finch/types/hris/benefit_create_params.py b/src/finch/types/hris/benefit_create_params.py
@@ -20,6 +20,7 @@ class BenefitCreateParams(TypedDict, total=False):
     """
 
     frequency: Optional[BenefitFrequency]
+    """The frequency of the benefit deduction/contribution."""
 
     type: Optional[BenefitType]
     """Type of benefit."""
diff --git a/src/finch/types/hris/benefits/__init__.py b/src/finch/types/hris/benefits/__init__.py
@@ -4,7 +4,6 @@
 
 from .individual_benefit import IndividualBenefit as IndividualBenefit
 from .enrolled_individual import EnrolledIndividual as EnrolledIndividual
-from .unenrolled_individual import UnenrolledIndividual as UnenrolledIndividual
 from .individual_enroll_many_params import IndividualEnrollManyParams as IndividualEnrollManyParams
 from .individual_unenroll_many_params import IndividualUnenrollManyParams as IndividualUnenrollManyParams
 from .individual_enrolled_ids_response import IndividualEnrolledIDsResponse as IndividualEnrolledIDsResponse
diff --git a/src/finch/types/hris/benefits/enrolled_individual.py b/src/finch/types/hris/benefits/enrolled_individual.py
@@ -10,7 +10,7 @@
 
 class Body(BaseModel):
     finch_code: Optional[str] = None
-    """A descriptive identifier for the response"""
+    """A descriptive identifier for the response."""
 
     message: Optional[str] = None
     """Short description in English that provides more information about the response."""
diff --git a/src/finch/types/hris/benefits/individual_enrolled_ids_response.py b/src/finch/types/hris/benefits/individual_enrolled_ids_response.py
@@ -9,5 +9,6 @@
 
 class IndividualEnrolledIDsResponse(BaseModel):
     benefit_id: str
+    """The id of the benefit."""
 
     individual_ids: List[str]
diff --git a/src/finch/types/hris/benefits/unenrolled_individual.py b/src/finch/types/hris/benefits/unenrolled_individual.py
diff --git a/src/finch/types/hris/company_benefit.py b/src/finch/types/hris/company_benefit.py
@@ -11,10 +11,12 @@
 
 class CompanyBenefit(BaseModel):
     benefit_id: str
+    """The id of the benefit."""
 
     description: Optional[str] = None
 
     frequency: Optional[BenefitFrequency] = None
+    """The frequency of the benefit deduction/contribution."""
 
     type: Optional[BenefitType] = None
     """Type of benefit."""
diff --git a/src/finch/types/hris/create_company_benefits_response.py b/src/finch/types/hris/create_company_benefits_response.py
@@ -8,3 +8,4 @@
 
 class CreateCompanyBenefitsResponse(BaseModel):
     benefit_id: str
+    """The id of the benefit."""
diff --git a/src/finch/types/hris/update_company_benefit_response.py b/src/finch/types/hris/update_company_benefit_response.py
@@ -8,3 +8,4 @@
 
 class UpdateCompanyBenefitResponse(BaseModel):
     benefit_id: str
+    """The id of the benefit."""
diff --git a/tests/api_resources/hris/benefits/test_individuals.py b/tests/api_resources/hris/benefits/test_individuals.py
@@ -14,7 +14,6 @@
 from finch.types.hris.benefits import (
     IndividualBenefit,
     EnrolledIndividual,
-    UnenrolledIndividual,
     IndividualEnrolledIDsResponse,
 )
 
@@ -177,15 +176,15 @@ def test_method_unenroll_many(self, client: Finch) -> None:
         individual = client.hris.benefits.individuals.unenroll_many(
             benefit_id="benefit_id",
         )
-        assert_matches_type(SyncSinglePage[UnenrolledIndividual], individual, path=["response"])
+        assert_matches_type(SyncSinglePage[object], individual, path=["response"])
 
     @parametrize
     def test_method_unenroll_many_with_all_params(self, client: Finch) -> None:
         individual = client.hris.benefits.individuals.unenroll_many(
             benefit_id="benefit_id",
             individual_ids=["string"],
         )
-        assert_matches_type(SyncSinglePage[UnenrolledIndividual], individual, path=["response"])
+        assert_matches_type(SyncSinglePage[object], individual, path=["response"])
 
     @parametrize
     def test_raw_response_unenroll_many(self, client: Finch) -> None:
@@ -196,7 +195,7 @@ def test_raw_response_unenroll_many(self, client: Finch) -> None:
         assert response.is_closed is True
         assert response.http_request.headers.get("X-Stainless-Lang") == "python"
         individual = response.parse()
-        assert_matches_type(SyncSinglePage[UnenrolledIndividual], individual, path=["response"])
+        assert_matches_type(SyncSinglePage[object], individual, path=["response"])
 
     @parametrize
     def test_streaming_response_unenroll_many(self, client: Finch) -> None:
@@ -207,7 +206,7 @@ def test_streaming_response_unenroll_many(self, client: Finch) -> None:
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
             individual = response.parse()
-            assert_matches_type(SyncSinglePage[UnenrolledIndividual], individual, path=["response"])
+            assert_matches_type(SyncSinglePage[object], individual, path=["response"])
 
         assert cast(Any, response.is_closed) is True
 
@@ -375,15 +374,15 @@ async def test_method_unenroll_many(self, async_client: AsyncFinch) -> None:
         individual = await async_client.hris.benefits.individuals.unenroll_many(
             benefit_id="benefit_id",
         )
-        assert_matches_type(AsyncSinglePage[UnenrolledIndividual], individual, path=["response"])
+        assert_matches_type(AsyncSinglePage[object], individual, path=["response"])
 
     @parametrize
     async def test_method_unenroll_many_with_all_params(self, async_client: AsyncFinch) -> None:
         individual = await async_client.hris.benefits.individuals.unenroll_many(
             benefit_id="benefit_id",
             individual_ids=["string"],
         )
-        assert_matches_type(AsyncSinglePage[UnenrolledIndividual], individual, path=["response"])
+        assert_matches_type(AsyncSinglePage[object], individual, path=["response"])
 
     @parametrize
     async def test_raw_response_unenroll_many(self, async_client: AsyncFinch) -> None:
@@ -394,7 +393,7 @@ async def test_raw_response_unenroll_many(self, async_client: AsyncFinch) -> Non
         assert response.is_closed is True
         assert response.http_request.headers.get("X-Stainless-Lang") == "python"
         individual = response.parse()
-        assert_matches_type(AsyncSinglePage[UnenrolledIndividual], individual, path=["response"])
+        assert_matches_type(AsyncSinglePage[object], individual, path=["response"])
 
     @parametrize
     async def test_streaming_response_unenroll_many(self, async_client: AsyncFinch) -> None:
@@ -405,7 +404,7 @@ async def test_streaming_response_unenroll_many(self, async_client: AsyncFinch)
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
             individual = await response.parse()
-            assert_matches_type(AsyncSinglePage[UnenrolledIndividual], individual, path=["response"])
+            assert_matches_type(AsyncSinglePage[object], individual, path=["response"])
 
         assert cast(Any, response.is_closed) is True
 
