feat(api): update via SDK Studio

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 12
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hyperspell%2Fhyperspell-4066d19206db91d6b4e638e78240ed568844eb3065b073126f0161fc95c39adc.yml
 openapi_spec_hash: 13b1fddffd88cb50d29b54280f58e526
-config_hash: 9caa9e9d4032cee9312e4eda8f5e78b2
+config_hash: 622ee9dc59ed885f4eceb7dc1bc2232c

src/hyperspell/_client.py

@@ -13,7 +13,6 @@
 from ._types import (
     NOT_GIVEN,
     Omit,
-    Headers,
     Timeout,
     NotGiven,
     Transport,
@@ -24,7 +23,7 @@
 from ._version import __version__
 from .resources import auth, query, documents, collections
 from ._streaming import Stream as Stream, AsyncStream as AsyncStream
-from ._exceptions import APIStatusError
+from ._exceptions import APIStatusError, HyperspellError
 from ._base_client import (
     DEFAULT_MAX_RETRIES,
     SyncAPIClient,
@@ -54,12 +53,14 @@ class Hyperspell(SyncAPIClient):
     with_streaming_response: HyperspellWithStreamedResponse
 
     # client options
-    api_key: str | None
+    api_key: str
+    user_id: str | None
 
     def __init__(
         self,
         *,
         api_key: str | None = None,
+        user_id: str | None = None,
         base_url: str | httpx.URL | None = None,
         timeout: Union[float, Timeout, None, NotGiven] = NOT_GIVEN,
         max_retries: int = DEFAULT_MAX_RETRIES,
@@ -85,8 +86,14 @@ def __init__(
         """
         if api_key is None:
             api_key = os.environ.get("HYPERSPELL_TOKEN")
+        if api_key is None:
+            raise HyperspellError(
+                "The api_key client option must be set either by passing api_key to the client or by setting the HYPERSPELL_TOKEN environment variable"
+            )
         self.api_key = api_key
 
+        self.user_id = user_id
+
         if base_url is None:
             base_url = os.environ.get("HYPERSPELL_BASE_URL")
         if base_url is None:
@@ -120,8 +127,6 @@ def qs(self) -> Querystring:
     @override
     def auth_headers(self) -> dict[str, str]:
         api_key = self.api_key
-        if api_key is None:
-            return {}
         return {"Authorization": f"Bearer {api_key}"}
 
     @property
@@ -133,21 +138,11 @@ def default_headers(self) -> dict[str, str | Omit]:
             **self._custom_headers,
         }
 
-    @override
-    def _validate_headers(self, headers: Headers, custom_headers: Headers) -> None:
-        if self.api_key and headers.get("Authorization"):
-            return
-        if isinstance(custom_headers.get("Authorization"), Omit):
-            return
-
-        raise TypeError(
-            '"Could not resolve authentication method. Expected the api_key to be set. Or for the `Authorization` headers to be explicitly omitted"'
-        )
-
     def copy(
         self,
         *,
         api_key: str | None = None,
+        user_id: str | None = None,
         base_url: str | httpx.URL | None = None,
         timeout: float | Timeout | None | NotGiven = NOT_GIVEN,
         http_client: httpx.Client | None = None,
@@ -182,6 +177,7 @@ def copy(
         http_client = http_client or self._client
         return self.__class__(
             api_key=api_key or self.api_key,
+            user_id=user_id or self.user_id,
             base_url=base_url or self.base_url,
             timeout=self.timeout if isinstance(timeout, NotGiven) else timeout,
             http_client=http_client,
@@ -239,12 +235,14 @@ class AsyncHyperspell(AsyncAPIClient):
     with_streaming_response: AsyncHyperspellWithStreamedResponse
 
     # client options
-    api_key: str | None
+    api_key: str
+    user_id: str | None
 
     def __init__(
         self,
         *,
         api_key: str | None = None,
+        user_id: str | None = None,
         base_url: str | httpx.URL | None = None,
         timeout: Union[float, Timeout, None, NotGiven] = NOT_GIVEN,
         max_retries: int = DEFAULT_MAX_RETRIES,
@@ -270,8 +268,14 @@ def __init__(
         """
         if api_key is None:
             api_key = os.environ.get("HYPERSPELL_TOKEN")
+        if api_key is None:
+            raise HyperspellError(
+                "The api_key client option must be set either by passing api_key to the client or by setting the HYPERSPELL_TOKEN environment variable"
+            )
         self.api_key = api_key
 
+        self.user_id = user_id
+
         if base_url is None:
             base_url = os.environ.get("HYPERSPELL_BASE_URL")
         if base_url is None:
@@ -305,8 +309,6 @@ def qs(self) -> Querystring:
     @override
     def auth_headers(self) -> dict[str, str]:
         api_key = self.api_key
-        if api_key is None:
-            return {}
         return {"Authorization": f"Bearer {api_key}"}
 
     @property
@@ -318,21 +320,11 @@ def default_headers(self) -> dict[str, str | Omit]:
             **self._custom_headers,
         }
 
-    @override
-    def _validate_headers(self, headers: Headers, custom_headers: Headers) -> None:
-        if self.api_key and headers.get("Authorization"):
-            return
-        if isinstance(custom_headers.get("Authorization"), Omit):
-            return
-
-        raise TypeError(
-            '"Could not resolve authentication method. Expected the api_key to be set. Or for the `Authorization` headers to be explicitly omitted"'
-        )
-
     def copy(
         self,
         *,
         api_key: str | None = None,
+        user_id: str | None = None,
         base_url: str | httpx.URL | None = None,
         timeout: float | Timeout | None | NotGiven = NOT_GIVEN,
         http_client: httpx.AsyncClient | None = None,
@@ -367,6 +359,7 @@ def copy(
         http_client = http_client or self._client
         return self.__class__(
             api_key=api_key or self.api_key,
+            user_id=user_id or self.user_id,
             base_url=base_url or self.base_url,
             timeout=self.timeout if isinstance(timeout, NotGiven) else timeout,
             http_client=http_client,

tests/conftest.py

@@ -30,14 +30,16 @@ def pytest_collection_modifyitems(items: list[pytest.Function]) -> None:
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
 
+api_key = "My API Key"
+
 
 @pytest.fixture(scope="session")
 def client(request: FixtureRequest) -> Iterator[Hyperspell]:
     strict = getattr(request, "param", True)
     if not isinstance(strict, bool):
         raise TypeError(f"Unexpected fixture parameter type {type(strict)}, expected {bool}")
 
-    with Hyperspell(base_url=base_url, _strict_response_validation=strict) as client:
+    with Hyperspell(base_url=base_url, api_key=api_key, _strict_response_validation=strict) as client:
         yield client
 
 
@@ -47,5 +49,5 @@ async def async_client(request: FixtureRequest) -> AsyncIterator[AsyncHyperspell
     if not isinstance(strict, bool):
         raise TypeError(f"Unexpected fixture parameter type {type(strict)}, expected {bool}")
 
-    async with AsyncHyperspell(base_url=base_url, _strict_response_validation=strict) as client:
+    async with AsyncHyperspell(base_url=base_url, api_key=api_key, _strict_response_validation=strict) as client:
         yield client