feat(api): added latest OpenAPI specification (#4)

Author: stainless-app[bot]

README.md

@@ -31,7 +31,7 @@ import os
 from isaacus import Isaacus
 
 client = Isaacus(
-    bearer_token=os.environ.get("ISAACUS_API_KEY"),  # This is the default and can be omitted
+    api_key=os.environ.get("ISAACUS_API_KEY"),  # This is the default and can be omitted
 )
 
 universal_classification = client.classifications.universal.create(
@@ -42,10 +42,10 @@ universal_classification = client.classifications.universal.create(
 print(universal_classification.chunks)
 ```
 
-While you can provide a `bearer_token` keyword argument,
+While you can provide an `api_key` keyword argument,
 we recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)
-to add `ISAACUS_API_KEY="My Bearer Token"` to your `.env` file
-so that your Bearer Token is not stored in source control.
+to add `ISAACUS_API_KEY="My API Key"` to your `.env` file
+so that your API Key is not stored in source control.
 
 ## Async usage
 
@@ -57,7 +57,7 @@ import asyncio
 from isaacus import AsyncIsaacus
 
 client = AsyncIsaacus(
-    bearer_token=os.environ.get("ISAACUS_API_KEY"),  # This is the default and can be omitted
+    api_key=os.environ.get("ISAACUS_API_KEY"),  # This is the default and can be omitted
 )
 
 

src/isaacus/_client.py

@@ -42,12 +42,12 @@ class Isaacus(SyncAPIClient):
     with_streaming_response: IsaacusWithStreamedResponse
 
     # client options
-    bearer_token: str
+    api_key: str
 
     def __init__(
         self,
         *,
-        bearer_token: str | None = None,
+        api_key: str | None = None,
         base_url: str | httpx.URL | None = None,
         timeout: Union[float, Timeout, None, NotGiven] = NOT_GIVEN,
         max_retries: int = DEFAULT_MAX_RETRIES,
@@ -69,15 +69,15 @@ def __init__(
     ) -> None:
         """Construct a new synchronous isaacus client instance.
 
-        This automatically infers the `bearer_token` argument from the `ISAACUS_API_KEY` environment variable if it is not provided.
+        This automatically infers the `api_key` argument from the `ISAACUS_API_KEY` environment variable if it is not provided.
         """
-        if bearer_token is None:
-            bearer_token = os.environ.get("ISAACUS_API_KEY")
-        if bearer_token is None:
+        if api_key is None:
+            api_key = os.environ.get("ISAACUS_API_KEY")
+        if api_key is None:
             raise IsaacusError(
-                "The bearer_token client option must be set either by passing bearer_token to the client or by setting the ISAACUS_API_KEY environment variable"
+                "The api_key client option must be set either by passing api_key to the client or by setting the ISAACUS_API_KEY environment variable"
             )
-        self.bearer_token = bearer_token
+        self.api_key = api_key
 
         if base_url is None:
             base_url = os.environ.get("ISAACUS_BASE_URL")
@@ -107,8 +107,8 @@ def qs(self) -> Querystring:
     @property
     @override
     def auth_headers(self) -> dict[str, str]:
-        bearer_token = self.bearer_token
-        return {"Authorization": f"Bearer {bearer_token}"}
+        api_key = self.api_key
+        return {"Authorization": f"Bearer {api_key}"}
 
     @property
     @override
@@ -122,7 +122,7 @@ def default_headers(self) -> dict[str, str | Omit]:
     def copy(
         self,
         *,
-        bearer_token: str | None = None,
+        api_key: str | None = None,
         base_url: str | httpx.URL | None = None,
         timeout: float | Timeout | None | NotGiven = NOT_GIVEN,
         http_client: httpx.Client | None = None,
@@ -156,7 +156,7 @@ def copy(
 
         http_client = http_client or self._client
         return self.__class__(
-            bearer_token=bearer_token or self.bearer_token,
+            api_key=api_key or self.api_key,
             base_url=base_url or self.base_url,
             timeout=self.timeout if isinstance(timeout, NotGiven) else timeout,
             http_client=http_client,
@@ -210,12 +210,12 @@ class AsyncIsaacus(AsyncAPIClient):
     with_streaming_response: AsyncIsaacusWithStreamedResponse
 
     # client options
-    bearer_token: str
+    api_key: str
 
     def __init__(
         self,
         *,
-        bearer_token: str | None = None,
+        api_key: str | None = None,
         base_url: str | httpx.URL | None = None,
         timeout: Union[float, Timeout, None, NotGiven] = NOT_GIVEN,
         max_retries: int = DEFAULT_MAX_RETRIES,
@@ -237,15 +237,15 @@ def __init__(
     ) -> None:
         """Construct a new async isaacus client instance.
 
-        This automatically infers the `bearer_token` argument from the `ISAACUS_API_KEY` environment variable if it is not provided.
+        This automatically infers the `api_key` argument from the `ISAACUS_API_KEY` environment variable if it is not provided.
         """
-        if bearer_token is None:
-            bearer_token = os.environ.get("ISAACUS_API_KEY")
-        if bearer_token is None:
+        if api_key is None:
+            api_key = os.environ.get("ISAACUS_API_KEY")
+        if api_key is None:
             raise IsaacusError(
-                "The bearer_token client option must be set either by passing bearer_token to the client or by setting the ISAACUS_API_KEY environment variable"
+                "The api_key client option must be set either by passing api_key to the client or by setting the ISAACUS_API_KEY environment variable"
             )
-        self.bearer_token = bearer_token
+        self.api_key = api_key
 
         if base_url is None:
             base_url = os.environ.get("ISAACUS_BASE_URL")
@@ -275,8 +275,8 @@ def qs(self) -> Querystring:
     @property
     @override
     def auth_headers(self) -> dict[str, str]:
-        bearer_token = self.bearer_token
-        return {"Authorization": f"Bearer {bearer_token}"}
+        api_key = self.api_key
+        return {"Authorization": f"Bearer {api_key}"}
 
     @property
     @override
@@ -290,7 +290,7 @@ def default_headers(self) -> dict[str, str | Omit]:
     def copy(
         self,
         *,
-        bearer_token: str | None = None,
+        api_key: str | None = None,
         base_url: str | httpx.URL | None = None,
         timeout: float | Timeout | None | NotGiven = NOT_GIVEN,
         http_client: httpx.AsyncClient | None = None,
@@ -324,7 +324,7 @@ def copy(
 
         http_client = http_client or self._client
         return self.__class__(
-            bearer_token=bearer_token or self.bearer_token,
+            api_key=api_key or self.api_key,
             base_url=base_url or self.base_url,
             timeout=self.timeout if isinstance(timeout, NotGiven) else timeout,
             http_client=http_client,

tests/conftest.py

@@ -28,7 +28,7 @@ def pytest_collection_modifyitems(items: list[pytest.Function]) -> None:
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
 
-bearer_token = "My Bearer Token"
+api_key = "My API Key"
 
 
 @pytest.fixture(scope="session")
@@ -37,7 +37,7 @@ def client(request: FixtureRequest) -> Iterator[Isaacus]:
     if not isinstance(strict, bool):
         raise TypeError(f"Unexpected fixture parameter type {type(strict)}, expected {bool}")
 
-    with Isaacus(base_url=base_url, bearer_token=bearer_token, _strict_response_validation=strict) as client:
+    with Isaacus(base_url=base_url, api_key=api_key, _strict_response_validation=strict) as client:
         yield client
 
 
@@ -47,5 +47,5 @@ async def async_client(request: FixtureRequest) -> AsyncIterator[AsyncIsaacus]:
     if not isinstance(strict, bool):
         raise TypeError(f"Unexpected fixture parameter type {type(strict)}, expected {bool}")
 
-    async with AsyncIsaacus(base_url=base_url, bearer_token=bearer_token, _strict_response_validation=strict) as client:
+    async with AsyncIsaacus(base_url=base_url, api_key=api_key, _strict_response_validation=strict) as client:
         yield client