chore: security config

Author: stainless-app[bot]

Diff for: README.md

@@ -27,9 +27,12 @@ pip install git+ssh://[email protected]/stainless-sdks/gitpod-python.git
 The full API of this library can be found in [api.md](api.md).
 
 ```python
+import os
 from gitpod import Gitpod
 
-client = Gitpod()
+client = Gitpod(
+    bearer_token=os.environ.get("GITPOD_API_KEY"),  # This is the default and can be omitted
+)
 
 runner = client.runners.create(
     connect_protocol_version=1,
@@ -47,10 +50,13 @@ so that your Bearer Token is not stored in source control.
 Simply import `AsyncGitpod` instead of `Gitpod` and use `await` with each API call:
 
 ```python
+import os
 import asyncio
 from gitpod import AsyncGitpod
 
-client = AsyncGitpod()
+client = AsyncGitpod(
+    bearer_token=os.environ.get("GITPOD_API_KEY"),  # This is the default and can be omitted
+)
 
 
 async def main() -> None:

Diff for: tests/test_client.py

@@ -25,7 +25,7 @@
 from gitpod._types import Omit
 from gitpod._models import BaseModel, FinalRequestOptions
 from gitpod._constants import RAW_RESPONSE_HEADER
-from gitpod._exceptions import APIStatusError, APITimeoutError, APIResponseValidationError
+from gitpod._exceptions import GitpodError, APIStatusError, APITimeoutError, APIResponseValidationError
 from gitpod._base_client import DEFAULT_TIMEOUT, HTTPX_DEFAULT_TIMEOUT, BaseClient, make_request_options
 
 from .utils import update_env
@@ -335,6 +335,16 @@ def test_default_headers_option(self) -> None:
         assert request.headers.get("x-foo") == "stainless"
         assert request.headers.get("x-stainless-lang") == "my-overriding-header"
 
+    def test_validate_headers(self) -> None:
+        client = Gitpod(base_url=base_url, bearer_token=bearer_token, _strict_response_validation=True)
+        request = client._build_request(FinalRequestOptions(method="get", url="/foo"))
+        assert request.headers.get("Authorization") == f"Bearer {bearer_token}"
+
+        with pytest.raises(GitpodError):
+            with update_env(**{"GITPOD_API_KEY": Omit()}):
+                client2 = Gitpod(base_url=base_url, bearer_token=None, _strict_response_validation=True)
+            _ = client2
+
     def test_default_query_option(self) -> None:
         client = Gitpod(
             base_url=base_url,
@@ -1121,6 +1131,16 @@ def test_default_headers_option(self) -> None:
         assert request.headers.get("x-foo") == "stainless"
         assert request.headers.get("x-stainless-lang") == "my-overriding-header"
 
+    def test_validate_headers(self) -> None:
+        client = AsyncGitpod(base_url=base_url, bearer_token=bearer_token, _strict_response_validation=True)
+        request = client._build_request(FinalRequestOptions(method="get", url="/foo"))
+        assert request.headers.get("Authorization") == f"Bearer {bearer_token}"
+
+        with pytest.raises(GitpodError):
+            with update_env(**{"GITPOD_API_KEY": Omit()}):
+                client2 = AsyncGitpod(base_url=base_url, bearer_token=None, _strict_response_validation=True)
+            _ = client2
+
     def test_default_query_option(self) -> None:
         client = AsyncGitpod(
             base_url=base_url,