feat(api): add register benefits method

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/finch-82224679b895da7c7a5aae44d11b69fbe37d0316cd8e10aa0c89bc5a68f424de.yml
+configured_endpoints: 48
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch/finch-5092370ef89959c46138a85f9d6d3c919682a5492a0f9f85ac4421de702f35a8.yml
 openapi_spec_hash: a4ca94b3405fc83934c949068943e16c
-config_hash: fce67e71044aa4c3d0b8030052b3a20b
+config_hash: a1c4b7d897cbf8ed42c5f474b3161d79

api.md

@@ -172,6 +172,7 @@ from finch.types.hris import (
     BenefitsSupport,
     CompanyBenefit,
     CreateCompanyBenefitsResponse,
+    RegisterCompanyBenefitResponse,
     SupportPerBenefitType,
     SupportedBenefit,
     UpdateCompanyBenefitResponse,
@@ -186,6 +187,7 @@ Methods:
 - <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/benefit_list_params.py">params</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/benefit_list_supported_benefits_params.py">params</a>) -> <a href="./src/finch/types/hris/supported_benefit.py">SyncSinglePage[SupportedBenefit]</a></code>
+- <code title="post /employer/benefits/register">client.hris.benefits.<a href="./src/finch/resources/hris/benefits/benefits.py">register</a>(\*\*<a href="src/finch/types/hris/benefit_register_params.py">params</a>) -> <a href="./src/finch/types/hris/register_company_benefit_response.py">RegisterCompanyBenefitResponse</a></code>
 
 ### Individuals
 
@@ -224,12 +226,13 @@ Methods:
 Types:
 
 ```python
-from finch.types import DisconnectResponse, Introspection
+from finch.types import DisconnectEntityResponse, DisconnectResponse, Introspection
 ```
 
 Methods:
 
 - <code title="post /disconnect">client.account.<a href="./src/finch/resources/account.py">disconnect</a>() -> <a href="./src/finch/types/disconnect_response.py">DisconnectResponse</a></code>
+- <code title="post /disconnect-entity">client.account.<a href="./src/finch/resources/account.py">disconnect_entity</a>(\*\*<a href="src/finch/types/account_disconnect_entity_params.py">params</a>) -> <a href="./src/finch/types/disconnect_entity_response.py">DisconnectEntityResponse</a></code>
 - <code title="get /introspect">client.account.<a href="./src/finch/resources/account.py">introspect</a>() -> <a href="./src/finch/types/introspection.py">Introspection</a></code>
 
 # Webhooks

src/finch/resources/account.py

@@ -5,13 +5,16 @@
 import httpx
 
 from .. import _legacy_response
-from .._types import Body, Query, Headers, NotGiven, not_given
+from ..types import account_disconnect_entity_params
+from .._types import Body, Query, Headers, NotGiven, SequenceNotStr, not_given
+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
 from .._base_client import make_request_options
 from ..types.introspection import Introspection
 from ..types.disconnect_response import DisconnectResponse
+from ..types.disconnect_entity_response import DisconnectEntityResponse
 
 __all__ = ["Account", "AsyncAccount"]
 
@@ -59,6 +62,47 @@ def disconnect(
             cast_to=DisconnectResponse,
         )
 
+    def disconnect_entity(
+        self,
+        *,
+        entity_ids: SequenceNotStr[str],
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> DisconnectEntityResponse:
+        """
+        Disconnect entity(s) from a connection without affecting other entities
+        associated with the same connection.
+
+        Args:
+          entity_ids: Array of entity UUIDs to disconnect. At least one entity ID must be provided.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return self._post(
+            "/disconnect-entity",
+            body=maybe_transform(
+                {"entity_ids": entity_ids}, account_disconnect_entity_params.AccountDisconnectEntityParams
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                security={"bearer_auth": True},
+            ),
+            cast_to=DisconnectEntityResponse,
+        )
+
     def introspect(
         self,
         *,
@@ -126,6 +170,47 @@ async def disconnect(
             cast_to=DisconnectResponse,
         )
 
+    async def disconnect_entity(
+        self,
+        *,
+        entity_ids: SequenceNotStr[str],
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> DisconnectEntityResponse:
+        """
+        Disconnect entity(s) from a connection without affecting other entities
+        associated with the same connection.
+
+        Args:
+          entity_ids: Array of entity UUIDs to disconnect. At least one entity ID must be provided.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return await self._post(
+            "/disconnect-entity",
+            body=await async_maybe_transform(
+                {"entity_ids": entity_ids}, account_disconnect_entity_params.AccountDisconnectEntityParams
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                security={"bearer_auth": True},
+            ),
+            cast_to=DisconnectEntityResponse,
+        )
+
     async def introspect(
         self,
         *,
@@ -157,6 +242,9 @@ def __init__(self, account: Account) -> None:
         self.disconnect = _legacy_response.to_raw_response_wrapper(
             account.disconnect,
         )
+        self.disconnect_entity = _legacy_response.to_raw_response_wrapper(
+            account.disconnect_entity,
+        )
         self.introspect = _legacy_response.to_raw_response_wrapper(
             account.introspect,
         )
@@ -169,6 +257,9 @@ def __init__(self, account: AsyncAccount) -> None:
         self.disconnect = _legacy_response.async_to_raw_response_wrapper(
             account.disconnect,
         )
+        self.disconnect_entity = _legacy_response.async_to_raw_response_wrapper(
+            account.disconnect_entity,
+        )
         self.introspect = _legacy_response.async_to_raw_response_wrapper(
             account.introspect,
         )
@@ -181,6 +272,9 @@ def __init__(self, account: Account) -> None:
         self.disconnect = to_streamed_response_wrapper(
             account.disconnect,
         )
+        self.disconnect_entity = to_streamed_response_wrapper(
+            account.disconnect_entity,
+        )
         self.introspect = to_streamed_response_wrapper(
             account.introspect,
         )
@@ -193,6 +287,9 @@ def __init__(self, account: AsyncAccount) -> None:
         self.disconnect = async_to_streamed_response_wrapper(
             account.disconnect,
         )
+        self.disconnect_entity = async_to_streamed_response_wrapper(
+            account.disconnect_entity,
+        )
         self.introspect = async_to_streamed_response_wrapper(
             account.introspect,
         )

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

@@ -27,6 +27,7 @@
     benefit_list_params,
     benefit_create_params,
     benefit_update_params,
+    benefit_register_params,
     benefit_retrieve_params,
     benefit_list_supported_benefits_params,
 )
@@ -37,6 +38,7 @@
 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.register_company_benefit_response import RegisterCompanyBenefitResponse
 
 __all__ = ["Benefits", "AsyncBenefits"]
 
@@ -295,6 +297,60 @@ def list_supported_benefits(
             model=SupportedBenefit,
         )
 
+    def register(
+        self,
+        *,
+        entity_ids: SequenceNotStr[str] | Omit = omit,
+        description: str | Omit = omit,
+        frequency: Optional[BenefitFrequency] | Omit = omit,
+        type: Optional[BenefitType] | Omit = omit,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> RegisterCompanyBenefitResponse:
+        """
+        Register existing benefits from the customer on the provider, on Finch's end.
+        Please use the `/provider` endpoint to view available types for each provider.
+
+        Args:
+          entity_ids: The entity IDs to specify which entities' data to access.
+
+          frequency: The frequency of the benefit deduction/contribution.
+
+          type: Type of benefit.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return self._post(
+            "/employer/benefits/register",
+            body=maybe_transform(
+                {
+                    "description": description,
+                    "frequency": frequency,
+                    "type": type,
+                },
+                benefit_register_params.BenefitRegisterParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform({"entity_ids": entity_ids}, benefit_register_params.BenefitRegisterParams),
+                security={"bearer_auth": True},
+            ),
+            cast_to=RegisterCompanyBenefitResponse,
+        )
+
 
 class AsyncBenefits(AsyncAPIResource):
     @cached_property
@@ -556,6 +612,62 @@ def list_supported_benefits(
             model=SupportedBenefit,
         )
 
+    async def register(
+        self,
+        *,
+        entity_ids: SequenceNotStr[str] | Omit = omit,
+        description: str | Omit = omit,
+        frequency: Optional[BenefitFrequency] | Omit = omit,
+        type: Optional[BenefitType] | Omit = omit,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> RegisterCompanyBenefitResponse:
+        """
+        Register existing benefits from the customer on the provider, on Finch's end.
+        Please use the `/provider` endpoint to view available types for each provider.
+
+        Args:
+          entity_ids: The entity IDs to specify which entities' data to access.
+
+          frequency: The frequency of the benefit deduction/contribution.
+
+          type: Type of benefit.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return await self._post(
+            "/employer/benefits/register",
+            body=await async_maybe_transform(
+                {
+                    "description": description,
+                    "frequency": frequency,
+                    "type": type,
+                },
+                benefit_register_params.BenefitRegisterParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=await async_maybe_transform(
+                    {"entity_ids": entity_ids}, benefit_register_params.BenefitRegisterParams
+                ),
+                security={"bearer_auth": True},
+            ),
+            cast_to=RegisterCompanyBenefitResponse,
+        )
+
 
 class BenefitsWithRawResponse:
     def __init__(self, benefits: Benefits) -> None:
@@ -576,6 +688,9 @@ def __init__(self, benefits: Benefits) -> None:
         self.list_supported_benefits = _legacy_response.to_raw_response_wrapper(
             benefits.list_supported_benefits,
         )
+        self.register = _legacy_response.to_raw_response_wrapper(
+            benefits.register,
+        )
 
     @cached_property
     def individuals(self) -> IndividualsWithRawResponse:
@@ -601,6 +716,9 @@ def __init__(self, benefits: AsyncBenefits) -> None:
         self.list_supported_benefits = _legacy_response.async_to_raw_response_wrapper(
             benefits.list_supported_benefits,
         )
+        self.register = _legacy_response.async_to_raw_response_wrapper(
+            benefits.register,
+        )
 
     @cached_property
     def individuals(self) -> AsyncIndividualsWithRawResponse:
@@ -626,6 +744,9 @@ def __init__(self, benefits: Benefits) -> None:
         self.list_supported_benefits = to_streamed_response_wrapper(
             benefits.list_supported_benefits,
         )
+        self.register = to_streamed_response_wrapper(
+            benefits.register,
+        )
 
     @cached_property
     def individuals(self) -> IndividualsWithStreamingResponse:
@@ -651,6 +772,9 @@ def __init__(self, benefits: AsyncBenefits) -> None:
         self.list_supported_benefits = async_to_streamed_response_wrapper(
             benefits.list_supported_benefits,
         )
+        self.register = async_to_streamed_response_wrapper(
+            benefits.register,
+        )
 
     @cached_property
     def individuals(self) -> AsyncIndividualsWithStreamingResponse:

src/finch/types/__init__.py

@@ -27,6 +27,8 @@
 from .job_completion_event import JobCompletionEvent as JobCompletionEvent
 from .provider_list_response import ProviderListResponse as ProviderListResponse
 from .access_token_create_params import AccessTokenCreateParams as AccessTokenCreateParams
+from .disconnect_entity_response import DisconnectEntityResponse as DisconnectEntityResponse
 from .create_access_token_response import CreateAccessTokenResponse as CreateAccessTokenResponse
+from .account_disconnect_entity_params import AccountDisconnectEntityParams as AccountDisconnectEntityParams
 from .request_forwarding_forward_params import RequestForwardingForwardParams as RequestForwardingForwardParams
 from .request_forwarding_forward_response import RequestForwardingForwardResponse as RequestForwardingForwardResponse

src/finch/types/account_disconnect_entity_params.py

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+from .._types import SequenceNotStr
+
+__all__ = ["AccountDisconnectEntityParams"]
+
+
+class AccountDisconnectEntityParams(TypedDict, total=False):
+    entity_ids: Required[SequenceNotStr[str]]
+    """Array of entity UUIDs to disconnect. At least one entity ID must be provided."""