feat(api): api update (#9)

Author: stainless-app[bot]

.stats.yml

@@ -1,2 +1,2 @@
 configured_endpoints: 3
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/beats-ai-beatsfoundation%2Fbeats-foundation-a9c1eafa5562186e8548b92140925552d512f52e1b9cedd337bef8544e437c15.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/beats-ai-beatsfoundation%2Fbeats-foundation-9e8f99d19503143b44d679b3743fc6791e0f6ece45048c58926ed10376d78af5.yml

README.md

@@ -23,9 +23,14 @@ pip install --pre beats_foundation
 The full API of this library can be found in [api.md](api.md).
 
 ```python
+import os
 from beats_foundation import Beatsfoundation
 
-client = Beatsfoundation()
+client = Beatsfoundation(
+    bearer_token=os.environ.get(
+        "BEATSFOUNDATION_BEARER_TOKEN"
+    ),  # This is the default and can be omitted
+)
 
 song = client.songs.retrieve(
     "REPLACE_ME",
@@ -43,10 +48,15 @@ so that your Bearer Token is not stored in source control.
 Simply import `AsyncBeatsfoundation` instead of `Beatsfoundation` and use `await` with each API call:
 
 ```python
+import os
 import asyncio
 from beats_foundation import AsyncBeatsfoundation
 
-client = AsyncBeatsfoundation()
+client = AsyncBeatsfoundation(
+    bearer_token=os.environ.get(
+        "BEATSFOUNDATION_BEARER_TOKEN"
+    ),  # This is the default and can be omitted
+)
 
 
 async def main() -> None:

api.md

@@ -8,6 +8,6 @@ from beats_foundation.types import Song, SongCreateResponse, SongListResponse
 
 Methods:
 
-- <code title="post /api/songs">client.songs.<a href="./src/beats_foundation/resources/songs.py">create</a>(\*\*<a href="src/beats_foundation/types/song_create_params.py">params</a>) -> <a href="./src/beats_foundation/types/song_create_response.py">object</a></code>
+- <code title="post /api/songs">client.songs.<a href="./src/beats_foundation/resources/songs.py">create</a>(\*\*<a href="src/beats_foundation/types/song_create_params.py">params</a>) -> <a href="./src/beats_foundation/types/song_create_response.py">SongCreateResponse</a></code>
 - <code title="get /api/songs/{id}">client.songs.<a href="./src/beats_foundation/resources/songs.py">retrieve</a>(id) -> <a href="./src/beats_foundation/types/song.py">Song</a></code>
 - <code title="get /api/songs">client.songs.<a href="./src/beats_foundation/resources/songs.py">list</a>(\*\*<a href="src/beats_foundation/types/song_list_params.py">params</a>) -> <a href="./src/beats_foundation/types/song_list_response.py">SongListResponse</a></code>

src/beats_foundation/resources/songs.py

@@ -21,6 +21,7 @@
 from ..types.song import Song
 from .._base_client import make_request_options
 from ..types.song_list_response import SongListResponse
+from ..types.song_create_response import SongCreateResponse
 
 __all__ = ["SongsResource", "AsyncSongsResource"]
 
@@ -59,7 +60,7 @@ def create(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> object:
+    ) -> SongCreateResponse:
         """Generate a new AI song based on provided parameters.
 
         Rate limited to 2 calls per
@@ -101,7 +102,7 @@ def create(
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=object,
+            cast_to=SongCreateResponse,
         )
 
     def retrieve(
@@ -218,7 +219,7 @@ async def create(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> object:
+    ) -> SongCreateResponse:
         """Generate a new AI song based on provided parameters.
 
         Rate limited to 2 calls per
@@ -260,7 +261,7 @@ async def create(
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=object,
+            cast_to=SongCreateResponse,
         )
 
     async def retrieve(

src/beats_foundation/types/__init__.py

@@ -6,3 +6,4 @@
 from .song_list_params import SongListParams as SongListParams
 from .song_create_params import SongCreateParams as SongCreateParams
 from .song_list_response import SongListResponse as SongListResponse
+from .song_create_response import SongCreateResponse as SongCreateResponse

src/beats_foundation/types/song_create_response.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .song import Song
+from .._models import BaseModel
+
+__all__ = ["SongCreateResponse"]
+
+
+class SongCreateResponse(BaseModel):
+    song: Optional[Song] = None

tests/api_resources/test_songs.py

@@ -9,7 +9,7 @@
 
 from tests.utils import assert_matches_type
 from beats_foundation import Beatsfoundation, AsyncBeatsfoundation
-from beats_foundation.types import Song, SongListResponse
+from beats_foundation.types import Song, SongListResponse, SongCreateResponse
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
 
@@ -22,7 +22,7 @@ def test_method_create(self, client: Beatsfoundation) -> None:
         song = client.songs.create(
             prompt="prompt",
         )
-        assert_matches_type(object, song, path=["response"])
+        assert_matches_type(SongCreateResponse, song, path=["response"])
 
     @parametrize
     def test_method_create_with_all_params(self, client: Beatsfoundation) -> None:
@@ -33,7 +33,7 @@ def test_method_create_with_all_params(self, client: Beatsfoundation) -> None:
             lyrics="lyrics",
             mood="mood",
         )
-        assert_matches_type(object, song, path=["response"])
+        assert_matches_type(SongCreateResponse, song, path=["response"])
 
     @parametrize
     def test_raw_response_create(self, client: Beatsfoundation) -> None:
@@ -44,7 +44,7 @@ def test_raw_response_create(self, client: Beatsfoundation) -> None:
         assert response.is_closed is True
         assert response.http_request.headers.get("X-Stainless-Lang") == "python"
         song = response.parse()
-        assert_matches_type(object, song, path=["response"])
+        assert_matches_type(SongCreateResponse, song, path=["response"])
 
     @parametrize
     def test_streaming_response_create(self, client: Beatsfoundation) -> None:
@@ -55,7 +55,7 @@ def test_streaming_response_create(self, client: Beatsfoundation) -> None:
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
             song = response.parse()
-            assert_matches_type(object, song, path=["response"])
+            assert_matches_type(SongCreateResponse, song, path=["response"])
 
         assert cast(Any, response.is_closed) is True
 
@@ -139,7 +139,7 @@ async def test_method_create(self, async_client: AsyncBeatsfoundation) -> None:
         song = await async_client.songs.create(
             prompt="prompt",
         )
-        assert_matches_type(object, song, path=["response"])
+        assert_matches_type(SongCreateResponse, song, path=["response"])
 
     @parametrize
     async def test_method_create_with_all_params(self, async_client: AsyncBeatsfoundation) -> None:
@@ -150,7 +150,7 @@ async def test_method_create_with_all_params(self, async_client: AsyncBeatsfound
             lyrics="lyrics",
             mood="mood",
         )
-        assert_matches_type(object, song, path=["response"])
+        assert_matches_type(SongCreateResponse, song, path=["response"])
 
     @parametrize
     async def test_raw_response_create(self, async_client: AsyncBeatsfoundation) -> None:
@@ -161,7 +161,7 @@ async def test_raw_response_create(self, async_client: AsyncBeatsfoundation) ->
         assert response.is_closed is True
         assert response.http_request.headers.get("X-Stainless-Lang") == "python"
         song = await response.parse()
-        assert_matches_type(object, song, path=["response"])
+        assert_matches_type(SongCreateResponse, song, path=["response"])
 
     @parametrize
     async def test_streaming_response_create(self, async_client: AsyncBeatsfoundation) -> None:
@@ -172,7 +172,7 @@ async def test_streaming_response_create(self, async_client: AsyncBeatsfoundatio
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
             song = await response.parse()
-            assert_matches_type(object, song, path=["response"])
+            assert_matches_type(SongCreateResponse, song, path=["response"])
 
         assert cast(Any, response.is_closed) is True
 

tests/test_client.py

@@ -24,7 +24,12 @@
 from beats_foundation._types import Omit
 from beats_foundation._models import BaseModel, FinalRequestOptions
 from beats_foundation._constants import RAW_RESPONSE_HEADER
-from beats_foundation._exceptions import APIStatusError, APITimeoutError, APIResponseValidationError
+from beats_foundation._exceptions import (
+    APIStatusError,
+    APITimeoutError,
+    BeatsfoundationError,
+    APIResponseValidationError,
+)
 from beats_foundation._base_client import (
     DEFAULT_TIMEOUT,
     HTTPX_DEFAULT_TIMEOUT,
@@ -339,6 +344,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 = Beatsfoundation(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(BeatsfoundationError):
+            with update_env(**{"BEATSFOUNDATION_BEARER_TOKEN": Omit()}):
+                client2 = Beatsfoundation(base_url=base_url, bearer_token=None, _strict_response_validation=True)
+            _ = client2
+
     def test_default_query_option(self) -> None:
         client = Beatsfoundation(
             base_url=base_url,
@@ -1113,6 +1128,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 = AsyncBeatsfoundation(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(BeatsfoundationError):
+            with update_env(**{"BEATSFOUNDATION_BEARER_TOKEN": Omit()}):
+                client2 = AsyncBeatsfoundation(base_url=base_url, bearer_token=None, _strict_response_validation=True)
+            _ = client2
+
     def test_default_query_option(self) -> None:
         client = AsyncBeatsfoundation(
             base_url=base_url,