feat(api): update via SDK Studio

Author: stainless-app[bot]

README.md

@@ -29,7 +29,9 @@ The full API of this library can be found in [api.md](api.md).
 ```python
 from gitpod import Gitpod
 
-client = Gitpod()
+client = Gitpod(
+    auth_token="My Auth Token",
+)
 
 runner = client.runners.create(
     connect_protocol_version=1,
@@ -45,7 +47,9 @@ Simply import `AsyncGitpod` instead of `Gitpod` and use `await` with each API ca
 import asyncio
 from gitpod import AsyncGitpod
 
-client = AsyncGitpod()
+client = AsyncGitpod(
+    auth_token="My Auth Token",
+)
 
 
 async def main() -> None:
@@ -82,7 +86,9 @@ All errors inherit from `gitpod.APIError`.
 import gitpod
 from gitpod import Gitpod
 
-client = Gitpod()
+client = Gitpod(
+    auth_token="My Auth Token",
+)
 
 try:
     client.runners.create(
@@ -127,6 +133,7 @@ from gitpod import Gitpod
 client = Gitpod(
     # default is 2
     max_retries=0,
+    auth_token="My Auth Token",
 )
 
 # Or, configure per-request:
@@ -147,11 +154,13 @@ from gitpod import Gitpod
 client = Gitpod(
     # 20 seconds (default is 1 minute)
     timeout=20.0,
+    auth_token="My Auth Token",
 )
 
 # More granular control:
 client = Gitpod(
     timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),
+    auth_token="My Auth Token",
 )
 
 # Override per-request:
@@ -197,7 +206,9 @@ The "raw" Response object can be accessed by prefixing `.with_raw_response.` to
 ```py
 from gitpod import Gitpod
 
-client = Gitpod()
+client = Gitpod(
+    auth_token="My Auth Token",
+)
 response = client.runners.with_raw_response.create(
     connect_protocol_version=1,
 )
@@ -282,6 +293,7 @@ client = Gitpod(
         proxy="http://my.test.proxy.example.com",
         transport=httpx.HTTPTransport(local_address="0.0.0.0"),
     ),
+    auth_token="My Auth Token",
 )
 ```
 
@@ -298,7 +310,9 @@ By default the library closes underlying HTTP connections whenever the client is
 ```py
 from gitpod import Gitpod
 
-with Gitpod() as client:
+with Gitpod(
+    auth_token="My Auth Token",
+) as client:
   # make requests here
   ...
 

src/gitpod/_client.py

@@ -26,7 +26,7 @@
 from ._version import __version__
 from .resources import editors, projects, automations_files, environment_classes, personal_access_tokens
 from ._streaming import Stream as Stream, AsyncStream as AsyncStream
-from ._exceptions import APIStatusError
+from ._exceptions import GitpodError, APIStatusError
 from ._base_client import (
     DEFAULT_MAX_RETRIES,
     SyncAPIClient,
@@ -54,10 +54,12 @@ class Gitpod(SyncAPIClient):
     with_streaming_response: GitpodWithStreamedResponse
 
     # client options
+    auth_token: str
 
     def __init__(
         self,
         *,
+        auth_token: str | None = None,
         base_url: str | httpx.URL | None = None,
         timeout: Union[float, Timeout, None, NotGiven] = NOT_GIVEN,
         max_retries: int = DEFAULT_MAX_RETRIES,
@@ -77,7 +79,18 @@ def __init__(
         # part of our public interface in the future.
         _strict_response_validation: bool = False,
     ) -> None:
-        """Construct a new synchronous gitpod client instance."""
+        """Construct a new synchronous gitpod client instance.
+
+        This automatically infers the `auth_token` argument from the `GITPOD_API_KEY` environment variable if it is not provided.
+        """
+        if auth_token is None:
+            auth_token = os.environ.get("GITPOD_API_KEY")
+        if auth_token is None:
+            raise GitpodError(
+                "The auth_token client option must be set either by passing auth_token to the client or by setting the GITPOD_API_KEY environment variable"
+            )
+        self.auth_token = auth_token
+
         if base_url is None:
             base_url = os.environ.get("GITPOD_BASE_URL")
         if base_url is None:
@@ -123,6 +136,7 @@ def default_headers(self) -> dict[str, str | Omit]:
     def copy(
         self,
         *,
+        auth_token: str | None = None,
         base_url: str | httpx.URL | None = None,
         timeout: float | Timeout | None | NotGiven = NOT_GIVEN,
         http_client: httpx.Client | None = None,
@@ -156,6 +170,7 @@ def copy(
 
         http_client = http_client or self._client
         return self.__class__(
+            auth_token=auth_token or self.auth_token,
             base_url=base_url or self.base_url,
             timeout=self.timeout if isinstance(timeout, NotGiven) else timeout,
             http_client=http_client,
@@ -217,10 +232,12 @@ class AsyncGitpod(AsyncAPIClient):
     with_streaming_response: AsyncGitpodWithStreamedResponse
 
     # client options
+    auth_token: str
 
     def __init__(
         self,
         *,
+        auth_token: str | None = None,
         base_url: str | httpx.URL | None = None,
         timeout: Union[float, Timeout, None, NotGiven] = NOT_GIVEN,
         max_retries: int = DEFAULT_MAX_RETRIES,
@@ -240,7 +257,18 @@ def __init__(
         # part of our public interface in the future.
         _strict_response_validation: bool = False,
     ) -> None:
-        """Construct a new async gitpod client instance."""
+        """Construct a new async gitpod client instance.
+
+        This automatically infers the `auth_token` argument from the `GITPOD_API_KEY` environment variable if it is not provided.
+        """
+        if auth_token is None:
+            auth_token = os.environ.get("GITPOD_API_KEY")
+        if auth_token is None:
+            raise GitpodError(
+                "The auth_token client option must be set either by passing auth_token to the client or by setting the GITPOD_API_KEY environment variable"
+            )
+        self.auth_token = auth_token
+
         if base_url is None:
             base_url = os.environ.get("GITPOD_BASE_URL")
         if base_url is None:
@@ -286,6 +314,7 @@ def default_headers(self) -> dict[str, str | Omit]:
     def copy(
         self,
         *,
+        auth_token: str | None = None,
         base_url: str | httpx.URL | None = None,
         timeout: float | Timeout | None | NotGiven = NOT_GIVEN,
         http_client: httpx.AsyncClient | None = None,
@@ -319,6 +348,7 @@ def copy(
 
         http_client = http_client or self._client
         return self.__class__(
+            auth_token=auth_token or self.auth_token,
             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,14 +28,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")
 
+auth_token = "My Auth Token"
+
 
 @pytest.fixture(scope="session")
 def client(request: FixtureRequest) -> Iterator[Gitpod]:
     strict = getattr(request, "param", True)
     if not isinstance(strict, bool):
         raise TypeError(f"Unexpected fixture parameter type {type(strict)}, expected {bool}")
 
-    with Gitpod(base_url=base_url, _strict_response_validation=strict) as client:
+    with Gitpod(base_url=base_url, auth_token=auth_token, _strict_response_validation=strict) as client:
         yield client
 
 
@@ -45,5 +47,5 @@ async def async_client(request: FixtureRequest) -> AsyncIterator[AsyncGitpod]:
     if not isinstance(strict, bool):
         raise TypeError(f"Unexpected fixture parameter type {type(strict)}, expected {bool}")
 
-    async with AsyncGitpod(base_url=base_url, _strict_response_validation=strict) as client:
+    async with AsyncGitpod(base_url=base_url, auth_token=auth_token, _strict_response_validation=strict) as client:
         yield client