feat(api): api update (#646)

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 46
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-14d375aab89e6b212fe459805a42d6ea7d7da8eae2037ae710a187d06911be1d.yml
-openapi_spec_hash: 08b86ecbec3323717d48e4aaee48ed54
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-8c83f0eae70d2a02ed3e2059fc251affdccd2f848f45445e4fed64dfd9ca5985.yml
+openapi_spec_hash: 2523952a32436e3c7fd3b55508c2e7ee
 config_hash: ce10384813f68ba3fed61c7b601b396b

api.md

@@ -163,6 +163,7 @@ from finch.types.hris import (
     SupportPerBenefitType,
     SupportedBenefit,
     UpdateCompanyBenefitResponse,
+    BenefitListSupportedBenefitsResponse,
     BenfitContribution,
 )
 ```
@@ -173,27 +174,27 @@ Methods:
 - <code title="get /employer/benefits/{benefit_id}">client.hris.benefits.<a href="./src/finch/resources/hris/benefits/benefits.py">retrieve</a>(benefit_id) -> <a href="./src/finch/types/hris/company_benefit.py">CompanyBenefit</a></code>
 - <code title="post /employer/benefits/{benefit_id}">client.hris.benefits.<a href="./src/finch/resources/hris/benefits/benefits.py">update</a>(benefit_id, \*\*<a href="src/finch/types/hris/benefit_update_params.py">params</a>) -> <a href="./src/finch/types/hris/update_company_benefit_response.py">UpdateCompanyBenefitResponse</a></code>
 - <code title="get /employer/benefits">client.hris.benefits.<a href="./src/finch/resources/hris/benefits/benefits.py">list</a>() -> <a href="./src/finch/types/hris/company_benefit.py">SyncSinglePage[CompanyBenefit]</a></code>
-- <code title="get /employer/benefits/meta">client.hris.benefits.<a href="./src/finch/resources/hris/benefits/benefits.py">list_supported_benefits</a>() -> <a href="./src/finch/types/hris/supported_benefit.py">SyncSinglePage[SupportedBenefit]</a></code>
+- <code title="get /employer/benefits/meta">client.hris.benefits.<a href="./src/finch/resources/hris/benefits/benefits.py">list_supported_benefits</a>() -> <a href="./src/finch/types/hris/benefit_list_supported_benefits_response.py">SyncSinglePage[BenefitListSupportedBenefitsResponse]</a></code>
 
 ### Individuals
 
 Types:
 
 ```python
 from finch.types.hris.benefits import (
-    EnrolledIndividual,
     IndividualBenefit,
-    UnenrolledIndividual,
+    IndividualEnrollManyResponse,
     IndividualEnrolledIDsResponse,
+    IndividualUnenrollManyResponse,
 )
 ```
 
 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="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/individual_enroll_many_response.py">IndividualEnrollManyResponse</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
 

src/finch/resources/hris/benefits/benefits.py

@@ -29,9 +29,9 @@
 from ....types.hris.benefit_type import BenefitType
 from ....types.hris.company_benefit import CompanyBenefit
 from ....types.hris.benefit_frequency import BenefitFrequency
-from ....types.hris.supported_benefit import SupportedBenefit
 from ....types.hris.update_company_benefit_response import UpdateCompanyBenefitResponse
 from ....types.hris.create_company_benefits_response import CreateCompanyBenefitsResponse
+from ....types.hris.benefit_list_supported_benefits_response import BenefitListSupportedBenefitsResponse
 
 __all__ = ["Benefits", "AsyncBenefits"]
 
@@ -210,15 +210,15 @@ def list_supported_benefits(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> SyncSinglePage[SupportedBenefit]:
+    ) -> SyncSinglePage[BenefitListSupportedBenefitsResponse]:
         """Get deductions metadata"""
         return self._get_api_list(
             "/employer/benefits/meta",
-            page=SyncSinglePage[SupportedBenefit],
+            page=SyncSinglePage[BenefitListSupportedBenefitsResponse],
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            model=SupportedBenefit,
+            model=BenefitListSupportedBenefitsResponse,
         )
 
 
@@ -396,15 +396,15 @@ def list_supported_benefits(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> AsyncPaginator[SupportedBenefit, AsyncSinglePage[SupportedBenefit]]:
+    ) -> AsyncPaginator[BenefitListSupportedBenefitsResponse, AsyncSinglePage[BenefitListSupportedBenefitsResponse]]:
         """Get deductions metadata"""
         return self._get_api_list(
             "/employer/benefits/meta",
-            page=AsyncSinglePage[SupportedBenefit],
+            page=AsyncSinglePage[BenefitListSupportedBenefitsResponse],
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            model=SupportedBenefit,
+            model=BenefitListSupportedBenefitsResponse,
         )
 
 

src/finch/resources/hris/benefits/individuals.py

@@ -8,7 +8,10 @@
 
 from .... import _legacy_response
 from ...._types import NOT_GIVEN, Body, Query, Headers, NotGiven
-from ...._utils import maybe_transform
+from ...._utils import (
+    maybe_transform,
+    async_maybe_transform,
+)
 from ...._compat import cached_property
 from ...._resource import SyncAPIResource, AsyncAPIResource
 from ...._response import to_streamed_response_wrapper, async_to_streamed_response_wrapper
@@ -20,8 +23,7 @@
     individual_retrieve_many_benefits_params,
 )
 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_enroll_many_response import IndividualEnrollManyResponse
 from ....types.hris.benefits.individual_enrolled_ids_response import IndividualEnrolledIDsResponse
 
 __all__ = ["Individuals", "AsyncIndividuals"]
@@ -58,7 +60,7 @@ def enroll_many(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> SyncSinglePage[EnrolledIndividual]:
+    ) -> IndividualEnrollManyResponse:
         """Enroll an individual into a deduction or contribution.
 
         This is an overwrite
@@ -79,15 +81,13 @@ def enroll_many(
         """
         if not benefit_id:
             raise ValueError(f"Expected a non-empty value for `benefit_id` but received {benefit_id!r}")
-        return self._get_api_list(
+        return self._post(
             f"/employer/benefits/{benefit_id}/individuals",
-            page=SyncSinglePage[EnrolledIndividual],
             body=maybe_transform(individuals, Iterable[individual_enroll_many_params.Individual]),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            model=EnrolledIndividual,
-            method="post",
+            cast_to=IndividualEnrollManyResponse,
         )
 
     def enrolled_ids(
@@ -179,7 +179,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 +198,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",
         )
 
@@ -230,7 +230,7 @@ def with_streaming_response(self) -> AsyncIndividualsWithStreamingResponse:
         """
         return AsyncIndividualsWithStreamingResponse(self)
 
-    def enroll_many(
+    async def enroll_many(
         self,
         benefit_id: str,
         *,
@@ -241,7 +241,7 @@ def enroll_many(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> AsyncPaginator[EnrolledIndividual, AsyncSinglePage[EnrolledIndividual]]:
+    ) -> IndividualEnrollManyResponse:
         """Enroll an individual into a deduction or contribution.
 
         This is an overwrite
@@ -262,15 +262,13 @@ def enroll_many(
         """
         if not benefit_id:
             raise ValueError(f"Expected a non-empty value for `benefit_id` but received {benefit_id!r}")
-        return self._get_api_list(
+        return await self._post(
             f"/employer/benefits/{benefit_id}/individuals",
-            page=AsyncSinglePage[EnrolledIndividual],
-            body=maybe_transform(individuals, Iterable[individual_enroll_many_params.Individual]),
+            body=await async_maybe_transform(individuals, Iterable[individual_enroll_many_params.Individual]),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            model=EnrolledIndividual,
-            method="post",
+            cast_to=IndividualEnrollManyResponse,
         )
 
     async def enrolled_ids(
@@ -362,7 +360,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 +379,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",
         )
 

src/finch/types/hris/__init__.py

@@ -14,7 +14,6 @@
 from .benefits_support import BenefitsSupport as BenefitsSupport
 from .benefit_frequency import BenefitFrequency as BenefitFrequency
 from .document_response import DocumentResponse as DocumentResponse
-from .supported_benefit import SupportedBenefit as SupportedBenefit
 from .benfit_contribution import BenfitContribution as BenfitContribution
 from .individual_response import IndividualResponse as IndividualResponse
 from .payment_list_params import PaymentListParams as PaymentListParams
@@ -37,3 +36,6 @@
 from .create_company_benefits_response import CreateCompanyBenefitsResponse as CreateCompanyBenefitsResponse
 from .directory_list_individuals_params import DirectoryListIndividualsParams as DirectoryListIndividualsParams
 from .pay_statement_retrieve_many_params import PayStatementRetrieveManyParams as PayStatementRetrieveManyParams
+from .benefit_list_supported_benefits_response import (
+    BenefitListSupportedBenefitsResponse as BenefitListSupportedBenefitsResponse,
+)

src/finch/types/hris/supported_benefit.py renamed to src/finch/types/hris/benefit_list_supported_benefits_response.py

@@ -4,13 +4,12 @@
 from typing_extensions import Literal
 
 from ..._models import BaseModel
-from .benefit_type import BenefitType
 from .benefit_frequency import BenefitFrequency
 
-__all__ = ["SupportedBenefit"]
+__all__ = ["BenefitListSupportedBenefitsResponse"]
 
 
-class SupportedBenefit(BaseModel):
+class BenefitListSupportedBenefitsResponse(BaseModel):
     annual_maximum: Optional[bool] = None
     """Whether the provider supports an annual maximum for this benefit."""
 
@@ -43,6 +42,3 @@ class SupportedBenefit(BaseModel):
     Empty if this feature is not supported for the benefit. This array only has
     values for HSA benefits.
     """
-
-    type: Optional[BenefitType] = None
-    """Type of benefit."""

src/finch/types/hris/benefits/__init__.py

@@ -3,9 +3,8 @@
 from __future__ import annotations
 
 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_enroll_many_response import IndividualEnrollManyResponse as IndividualEnrollManyResponse
 from .individual_unenroll_many_params import IndividualUnenrollManyParams as IndividualUnenrollManyParams
 from .individual_enrolled_ids_response import IndividualEnrolledIDsResponse as IndividualEnrolledIDsResponse
 from .individual_retrieve_many_benefits_params import (

src/finch/types/hris/benefits/enrolled_individual.py

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+
+from ...._models import BaseModel
+
+__all__ = ["IndividualEnrollManyResponse"]
+
+
+class IndividualEnrollManyResponse(BaseModel):
+    job_id: str

src/finch/types/hris/benefits/individual_enroll_many_response.py

@@ -9,3 +9,5 @@
 class CreateCompanyBenefitsResponse(BaseModel):
     benefit_id: str
     """The id of the benefit."""
+
+    job_id: str

src/finch/types/hris/benefits/unenrolled_individual.py

@@ -9,3 +9,5 @@
 class UpdateCompanyBenefitResponse(BaseModel):
     benefit_id: str
     """The id of the benefit."""
+
+    job_id: str