feat(client): support passing httpx.Timeout to method timeout argument (

#171)
Finch-API · Nov 8, 2023 · 5a59bd8 · 5a59bd8
1 parent 04e9c08
commit 5a59bd8
Show file tree

Hide file tree

Showing 12 changed files with 63 additions and 41 deletions.
diff --git a/src/finch/_base_client.py b/src/finch/_base_client.py
@@ -1537,7 +1537,7 @@ def make_request_options(
     extra_query: Query | None = None,
     extra_body: Body | None = None,
     idempotency_key: str | None = None,
-    timeout: float | None | NotGiven = NOT_GIVEN,
+    timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     post_parser: PostParser | NotGiven = NOT_GIVEN,
 ) -> RequestOptions:
     """Create a dict of type RequestOptions without keys of NotGiven values."""

diff --git a/src/finch/resources/account.py b/src/finch/resources/account.py
@@ -4,6 +4,8 @@
 
 from typing import TYPE_CHECKING
 
+import httpx
+
 from ..types import Introspection, DisconnectResponse
 from .._types import NOT_GIVEN, Body, Query, Headers, NotGiven
 from .._resource import SyncAPIResource, AsyncAPIResource
@@ -31,7 +33,7 @@ def disconnect(
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> DisconnectResponse:
         """
         Disconnect an employer from your application and invalidate all `access_token`s
@@ -54,7 +56,7 @@ def introspect(
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> Introspection:
         """Read account information associated with an `access_token`"""
         return self._get(
@@ -81,7 +83,7 @@ async def disconnect(
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> DisconnectResponse:
         """
         Disconnect an employer from your application and invalidate all `access_token`s
@@ -104,7 +106,7 @@ async def introspect(
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> Introspection:
         """Read account information associated with an `access_token`"""
         return await self._get(

diff --git a/src/finch/resources/hris/benefits/benefits.py b/src/finch/resources/hris/benefits/benefits.py
@@ -4,6 +4,8 @@
 
 from typing import TYPE_CHECKING, Optional
 
+import httpx
+
 from ...._types import NOT_GIVEN, Body, Query, Headers, NotGiven
 from ...._utils import maybe_transform
 from .individuals import (
@@ -53,7 +55,7 @@ def create(
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> CreateCompanyBenefitsResponse:
         """
         **Availability: Automated and Assisted Benefits providers**
@@ -97,7 +99,7 @@ def retrieve(
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> CompanyBenefit:
         """
         **Availability: Automated Benefits providers only**
@@ -131,7 +133,7 @@ def update(
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> UpdateCompanyBenefitResponse:
         """
         **Availability: Automated and Assisted Benefits providers**
@@ -166,7 +168,7 @@ def list(
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> SyncSinglePage[CompanyBenefit]:
         """
         **Availability: Automated Benefits providers only**
@@ -190,7 +192,7 @@ def list_supported_benefits(
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> SyncSinglePage[SupportedBenefit]:
         """
         **Availability: Automated and Assisted Benefits providers**
@@ -228,7 +230,7 @@ async def create(
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> CreateCompanyBenefitsResponse:
         """
         **Availability: Automated and Assisted Benefits providers**
@@ -272,7 +274,7 @@ async def retrieve(
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> CompanyBenefit:
         """
         **Availability: Automated Benefits providers only**
@@ -306,7 +308,7 @@ async def update(
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> UpdateCompanyBenefitResponse:
         """
         **Availability: Automated and Assisted Benefits providers**
@@ -341,7 +343,7 @@ def list(
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> AsyncPaginator[CompanyBenefit, AsyncSinglePage[CompanyBenefit]]:
         """
         **Availability: Automated Benefits providers only**
@@ -365,7 +367,7 @@ def list_supported_benefits(
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> AsyncPaginator[SupportedBenefit, AsyncSinglePage[SupportedBenefit]]:
         """
         **Availability: Automated and Assisted Benefits providers**

diff --git a/src/finch/resources/hris/benefits/individuals.py b/src/finch/resources/hris/benefits/individuals.py
@@ -4,6 +4,8 @@
 
 from typing import TYPE_CHECKING, List
 
+import httpx
+
 from ...._types import NOT_GIVEN, Body, Query, Headers, NotGiven
 from ...._utils import maybe_transform
 from ...._resource import SyncAPIResource, AsyncAPIResource
@@ -43,7 +45,7 @@ def enroll_many(
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> SyncSinglePage[EnrolledIndividual]:
         """
         **Availability: Automated and Assisted Benefits providers**
@@ -88,7 +90,7 @@ def enrolled_ids(
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> IndividualEnrolledIDsResponse:
         """
         **Availability: Automated Benefits providers only**
@@ -122,7 +124,7 @@ def retrieve_many_benefits(
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> SyncSinglePage[IndividualBenefit]:
         """
         **Availability: Automated Benefits providers only**
@@ -167,7 +169,7 @@ def unenroll_many(
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> SyncSinglePage[UnenrolledIndividual]:
         """
         **Availability: Automated and Assisted Benefits providers**
@@ -216,7 +218,7 @@ def enroll_many(
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> AsyncPaginator[EnrolledIndividual, AsyncSinglePage[EnrolledIndividual]]:
         """
         **Availability: Automated and Assisted Benefits providers**
@@ -261,7 +263,7 @@ async def enrolled_ids(
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> IndividualEnrolledIDsResponse:
         """
         **Availability: Automated Benefits providers only**
@@ -295,7 +297,7 @@ def retrieve_many_benefits(
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> AsyncPaginator[IndividualBenefit, AsyncSinglePage[IndividualBenefit]]:
         """
         **Availability: Automated Benefits providers only**
@@ -340,7 +342,7 @@ def unenroll_many(
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> AsyncPaginator[UnenrolledIndividual, AsyncSinglePage[UnenrolledIndividual]]:
         """
         **Availability: Automated and Assisted Benefits providers**

diff --git a/src/finch/resources/hris/company.py b/src/finch/resources/hris/company.py
@@ -4,6 +4,8 @@
 
 from typing import TYPE_CHECKING
 
+import httpx
+
 from ..._types import NOT_GIVEN, Body, Query, Headers, NotGiven
 from ..._resource import SyncAPIResource, AsyncAPIResource
 from ..._response import to_raw_response_wrapper, async_to_raw_response_wrapper
@@ -31,7 +33,7 @@ def retrieve(
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> Company:
         """Read basic company data"""
         return self._get(
@@ -58,7 +60,7 @@ async def retrieve(
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> Company:
         """Read basic company data"""
         return await self._get(

diff --git a/src/finch/resources/hris/directory.py b/src/finch/resources/hris/directory.py
@@ -5,6 +5,8 @@
 import typing_extensions
 from typing import TYPE_CHECKING
 
+import httpx
+
 from ..._types import NOT_GIVEN, Body, Query, Headers, NotGiven
 from ..._utils import maybe_transform
 from ..._resource import SyncAPIResource, AsyncAPIResource
@@ -36,7 +38,7 @@ def list(
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> SyncIndividualsPage[IndividualInDirectory]:
         """
         Read company directory and organization structure
@@ -84,7 +86,7 @@ def list_individuals(
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> SyncIndividualsPage[IndividualInDirectory]:
         """
         Read company directory and organization structure
@@ -129,7 +131,7 @@ def list(
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> AsyncPaginator[IndividualInDirectory, AsyncIndividualsPage[IndividualInDirectory]]:
         """
         Read company directory and organization structure
@@ -177,7 +179,7 @@ def list_individuals(
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> AsyncPaginator[IndividualInDirectory, AsyncIndividualsPage[IndividualInDirectory]]:
         """
         Read company directory and organization structure

diff --git a/src/finch/resources/hris/employments.py b/src/finch/resources/hris/employments.py
@@ -4,6 +4,8 @@
 
 from typing import TYPE_CHECKING, List
 
+import httpx
+
 from ..._types import NOT_GIVEN, Body, Query, Headers, NotGiven
 from ..._utils import maybe_transform
 from ..._resource import SyncAPIResource, AsyncAPIResource
@@ -34,7 +36,7 @@ def retrieve_many(
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> SyncResponsesPage[EmploymentDataResponse]:
         """
         Read individual employment and income data
@@ -82,7 +84,7 @@ def retrieve_many(
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> AsyncPaginator[EmploymentDataResponse, AsyncResponsesPage[EmploymentDataResponse]]:
         """
         Read individual employment and income data

diff --git a/src/finch/resources/hris/individuals.py b/src/finch/resources/hris/individuals.py
@@ -4,6 +4,8 @@
 
 from typing import TYPE_CHECKING, List, Optional
 
+import httpx
+
 from ..._types import NOT_GIVEN, Body, Query, Headers, NotGiven
 from ..._utils import maybe_transform
 from ..._resource import SyncAPIResource, AsyncAPIResource
@@ -35,7 +37,7 @@ def retrieve_many(
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> SyncResponsesPage[IndividualResponse]:
         """
         Read individual data, excluding income and employment data
@@ -84,7 +86,7 @@ def retrieve_many(
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> AsyncPaginator[IndividualResponse, AsyncResponsesPage[IndividualResponse]]:
         """
         Read individual data, excluding income and employment data

diff --git a/src/finch/resources/hris/pay_statements.py b/src/finch/resources/hris/pay_statements.py
@@ -4,6 +4,8 @@
 
 from typing import TYPE_CHECKING, List
 
+import httpx
+
 from ..._types import NOT_GIVEN, Body, Query, Headers, NotGiven
 from ..._utils import maybe_transform
 from ..._resource import SyncAPIResource, AsyncAPIResource
@@ -34,7 +36,7 @@ def retrieve_many(
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> SyncResponsesPage[PayStatementResponse]:
         """
         Read detailed pay statements for each individual.
@@ -83,7 +85,7 @@ def retrieve_many(
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> AsyncPaginator[PayStatementResponse, AsyncResponsesPage[PayStatementResponse]]:
         """
         Read detailed pay statements for each individual.