feat(api): api update

Author: stainless-app[bot]

.github/workflows/ci.yml

@@ -1,12 +1,14 @@
 name: CI
 on:
   push:
-    branches-ignore:
-      - 'generated'
-      - 'codegen/**'
-      - 'integrated/**'
-      - 'stl-preview-head/**'
-      - 'stl-preview-base/**'
+    branches:
+      - '**'
+      - '!integrated/**'
+      - '!stl-preview-head/**'
+      - '!stl-preview-base/**'
+      - '!generated'
+      - '!codegen/**'
+      - 'codegen/stl/**'
   pull_request:
     branches-ignore:
       - 'stl-preview-head/**'
@@ -17,7 +19,7 @@ jobs:
     timeout-minutes: 10
     name: lint
     runs-on: ${{ github.repository == 'stainless-sdks/brapi-python' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
-    if: github.event_name == 'push' || github.event.pull_request.head.repo.fork
+    if: (github.event_name == 'push' || github.event.pull_request.head.repo.fork) && (github.event_name != 'push' || github.event.head_commit.message != 'codegen metadata')
     steps:
       - uses: actions/checkout@v6
 
@@ -36,7 +38,7 @@ jobs:
         run: ./scripts/lint
 
   build:
-    if: github.event_name == 'push' || github.event.pull_request.head.repo.fork
+    if: (github.event_name == 'push' || github.event.pull_request.head.repo.fork) && (github.event_name != 'push' || github.event.head_commit.message != 'codegen metadata')
     timeout-minutes: 10
     name: build
     permissions:
@@ -61,14 +63,18 @@ jobs:
         run: rye build
 
       - name: Get GitHub OIDC Token
-        if: github.repository == 'stainless-sdks/brapi-python'
+        if: |-
+          github.repository == 'stainless-sdks/brapi-python' &&
+          !startsWith(github.ref, 'refs/heads/stl/')
         id: github-oidc
         uses: actions/github-script@v8
         with:
           script: core.setOutput('github_token', await core.getIDToken());
 
       - name: Upload tarball
-        if: github.repository == 'stainless-sdks/brapi-python'
+        if: |-
+          github.repository == 'stainless-sdks/brapi-python' &&
+          !startsWith(github.ref, 'refs/heads/stl/')
         env:
           URL: https://pkg.stainless.com/s
           AUTH: ${{ steps.github-oidc.outputs.github_token }}

.gitignore

@@ -1,4 +1,5 @@
 .prism.log
+.stdy.log
 _dev
 
 __pycache__

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 11
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/alisson%2Fbrapi-1e2cbfa512cbc93a24e96be3befafd915d8e48fd046d625f6374525b0c135753.yml
-openapi_spec_hash: c2bcb76a765ec4725c2c22be89be8a81
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/alisson%2Fbrapi-19f807c15a2482f7cf7c1dfdc4e008daf730c16a513cea7d3d1a63c4c9bcc05b.yml
+openapi_spec_hash: 1370c6eb457d8332148785e64e33c695
 config_hash: 6f10a67950f65bf850612b59838ad03b

README.md

@@ -25,11 +25,10 @@ pip install brapi
 The full API of this library can be found in [api.md](api.md).
 
 ```python
-import os
 from brapi import Brapi
 
 client = Brapi(
-    api_key=os.environ.get("BRAPI_API_KEY"),  # This is the default and can be omitted
+    api_key="My API Key",
     # defaults to "production".
     environment="environment_1",
 )
@@ -40,22 +39,16 @@ quote = client.quote.retrieve(
 print(quote.requested_at)
 ```
 
-While you can provide an `api_key` keyword argument,
-we recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)
-to add `BRAPI_API_KEY="My API Key"` to your `.env` file
-so that your API Key is not stored in source control.
-
 ## Async usage
 
 Simply import `AsyncBrapi` instead of `Brapi` and use `await` with each API call:
 
 ```python
-import os
 import asyncio
 from brapi import AsyncBrapi
 
 client = AsyncBrapi(
-    api_key=os.environ.get("BRAPI_API_KEY"),  # This is the default and can be omitted
+    api_key="My API Key",
     # defaults to "production".
     environment="environment_1",
 )
@@ -87,15 +80,14 @@ pip install brapi[aiohttp]
 Then you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:
 
 ```python
-import os
 import asyncio
 from brapi import DefaultAioHttpClient
 from brapi import AsyncBrapi
 
 
 async def main() -> None:
     async with AsyncBrapi(
-        api_key=os.environ.get("BRAPI_API_KEY"),  # This is the default and can be omitted
+        api_key="My API Key",
         http_client=DefaultAioHttpClient(),
     ) as client:
         quote = await client.quote.retrieve(
@@ -129,7 +121,9 @@ All errors inherit from `brapi.APIError`.
 import brapi
 from brapi import Brapi
 
-client = Brapi()
+client = Brapi(
+    api_key="My API Key",
+)
 
 try:
     client.quote.retrieve(
@@ -172,6 +166,7 @@ from brapi import Brapi
 
 # Configure the default for all requests:
 client = Brapi(
+    api_key="My API Key",
     # default is 2
     max_retries=0,
 )
@@ -192,12 +187,14 @@ from brapi import Brapi
 
 # Configure the default for all requests:
 client = Brapi(
+    api_key="My API Key",
     # 20 seconds (default is 1 minute)
     timeout=20.0,
 )
 
 # More granular control:
 client = Brapi(
+    api_key="My API Key",
     timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),
 )
 
@@ -244,7 +241,9 @@ The "raw" Response object can be accessed by prefixing `.with_raw_response.` to
 ```py
 from brapi import Brapi
 
-client = Brapi()
+client = Brapi(
+    api_key="My API Key",
+)
 response = client.quote.with_raw_response.retrieve(
     tickers="REPLACE_ME",
 )
@@ -323,6 +322,7 @@ import httpx
 from brapi import Brapi, DefaultHttpxClient
 
 client = Brapi(
+    api_key="My API Key",
     # Or use the `BRAPI_BASE_URL` env var
     base_url="http://my.test.server.example.com:8083",
     http_client=DefaultHttpxClient(
@@ -345,7 +345,9 @@ By default the library closes underlying HTTP connections whenever the client is
 ```py
 from brapi import Brapi
 
-with Brapi() as client:
+with Brapi(
+    api_key="My API Key",
+) as client:
   # make requests here
   ...
 

api.md

@@ -5,11 +5,7 @@ Types:
 ```python
 from brapi.types import (
     BalanceSheetEntry,
-    CashflowEntry,
-    DefaultKeyStatisticsEntry,
     FinancialDataEntry,
-    IncomeStatementEntry,
-    ValueAddedEntry,
     QuoteRetrieveResponse,
     QuoteListResponse,
 )
@@ -71,7 +67,7 @@ from brapi.types.v2 import InflationRetrieveResponse, InflationListAvailableResp
 Methods:
 
 - <code title="get /api/v2/inflation">client.v2.inflation.<a href="./src/brapi/resources/v2/inflation.py">retrieve</a>(\*\*<a href="src/brapi/types/v2/inflation_retrieve_params.py">params</a>) -> <a href="./src/brapi/types/v2/inflation_retrieve_response.py">InflationRetrieveResponse</a></code>
-- <code title="get /api/v2/inflation/available">client.v2.inflation.<a href="./src/brapi/resources/v2/inflation.py">list_available</a>(\*\*<a href="src/brapi/types/v2/inflation_list_available_params.py">params</a>) -> <a href="./src/brapi/types/v2/inflation_list_available_response.py">InflationListAvailableResponse</a></code>
+- <code title="get /api/v2/inflation/available">client.v2.inflation.<a href="./src/brapi/resources/v2/inflation.py">list_available</a>() -> <a href="./src/brapi/types/v2/inflation_list_available_response.py">InflationListAvailableResponse</a></code>
 
 ## PrimeRate
 
@@ -84,4 +80,4 @@ from brapi.types.v2 import PrimeRateRetrieveResponse, PrimeRateListAvailableResp
 Methods:
 
 - <code title="get /api/v2/prime-rate">client.v2.prime_rate.<a href="./src/brapi/resources/v2/prime_rate.py">retrieve</a>(\*\*<a href="src/brapi/types/v2/prime_rate_retrieve_params.py">params</a>) -> <a href="./src/brapi/types/v2/prime_rate_retrieve_response.py">PrimeRateRetrieveResponse</a></code>
-- <code title="get /api/v2/prime-rate/available">client.v2.prime_rate.<a href="./src/brapi/resources/v2/prime_rate.py">list_available</a>(\*\*<a href="src/brapi/types/v2/prime_rate_list_available_params.py">params</a>) -> <a href="./src/brapi/types/v2/prime_rate_list_available_response.py">PrimeRateListAvailableResponse</a></code>
+- <code title="get /api/v2/prime-rate/available">client.v2.prime_rate.<a href="./src/brapi/resources/v2/prime_rate.py">list_available</a>() -> <a href="./src/brapi/types/v2/prime_rate_list_available_response.py">PrimeRateListAvailableResponse</a></code>

pyproject.toml

@@ -11,7 +11,7 @@ authors = [
 dependencies = [
   "httpx>=0.23.0, <1",
   "pydantic>=1.9.0, <3",
-  "typing-extensions>=4.10, <5",
+  "typing-extensions>=4.14, <5",
   "anyio>=3.5.0, <5",
   "distro>=1.7.0, <2",
   "sniffio",

src/brapi/_client.py

@@ -135,12 +135,19 @@ def __init__(
 
     @cached_property
     def quote(self) -> QuoteResource:
+        """Consulte informações detalhadas sobre ações, BDRs, ETFs e índices da B3.
+
+        Obtenha preços em tempo real, dados fundamentalistas, históricos e dividendos.
+        """
         from .resources.quote import QuoteResource
 
         return QuoteResource(self)
 
     @cached_property
     def available(self) -> AvailableResource:
+        """
+        Ferramentas auxiliares para descobrir ativos disponíveis e verificar a saúde da API.
+        """
         from .resources.available import AvailableResource
 
         return AvailableResource(self)
@@ -164,12 +171,6 @@ def with_streaming_response(self) -> BrapiWithStreamedResponse:
     def qs(self) -> Querystring:
         return Querystring(array_format="comma")
 
-    @property
-    @override
-    def auth_headers(self) -> dict[str, str]:
-        api_key = self.api_key
-        return {"Authorization": f"Bearer {api_key}"}
-
     @property
     @override
     def default_headers(self) -> dict[str, str | Omit]:
@@ -347,12 +348,19 @@ def __init__(
 
     @cached_property
     def quote(self) -> AsyncQuoteResource:
+        """Consulte informações detalhadas sobre ações, BDRs, ETFs e índices da B3.
+
+        Obtenha preços em tempo real, dados fundamentalistas, históricos e dividendos.
+        """
         from .resources.quote import AsyncQuoteResource
 
         return AsyncQuoteResource(self)
 
     @cached_property
     def available(self) -> AsyncAvailableResource:
+        """
+        Ferramentas auxiliares para descobrir ativos disponíveis e verificar a saúde da API.
+        """
         from .resources.available import AsyncAvailableResource
 
         return AsyncAvailableResource(self)
@@ -376,12 +384,6 @@ def with_streaming_response(self) -> AsyncBrapiWithStreamedResponse:
     def qs(self) -> Querystring:
         return Querystring(array_format="comma")
 
-    @property
-    @override
-    def auth_headers(self) -> dict[str, str]:
-        api_key = self.api_key
-        return {"Authorization": f"Bearer {api_key}"}
-
     @property
     @override
     def default_headers(self) -> dict[str, str | Omit]:
@@ -486,12 +488,19 @@ def __init__(self, client: Brapi) -> None:
 
     @cached_property
     def quote(self) -> quote.QuoteResourceWithRawResponse:
+        """Consulte informações detalhadas sobre ações, BDRs, ETFs e índices da B3.
+
+        Obtenha preços em tempo real, dados fundamentalistas, históricos e dividendos.
+        """
         from .resources.quote import QuoteResourceWithRawResponse
 
         return QuoteResourceWithRawResponse(self._client.quote)
 
     @cached_property
     def available(self) -> available.AvailableResourceWithRawResponse:
+        """
+        Ferramentas auxiliares para descobrir ativos disponíveis e verificar a saúde da API.
+        """
         from .resources.available import AvailableResourceWithRawResponse
 
         return AvailableResourceWithRawResponse(self._client.available)
@@ -511,12 +520,19 @@ def __init__(self, client: AsyncBrapi) -> None:
 
     @cached_property
     def quote(self) -> quote.AsyncQuoteResourceWithRawResponse:
+        """Consulte informações detalhadas sobre ações, BDRs, ETFs e índices da B3.
+
+        Obtenha preços em tempo real, dados fundamentalistas, históricos e dividendos.
+        """
         from .resources.quote import AsyncQuoteResourceWithRawResponse
 
         return AsyncQuoteResourceWithRawResponse(self._client.quote)
 
     @cached_property
     def available(self) -> available.AsyncAvailableResourceWithRawResponse:
+        """
+        Ferramentas auxiliares para descobrir ativos disponíveis e verificar a saúde da API.
+        """
         from .resources.available import AsyncAvailableResourceWithRawResponse
 
         return AsyncAvailableResourceWithRawResponse(self._client.available)
@@ -536,12 +552,19 @@ def __init__(self, client: Brapi) -> None:
 
     @cached_property
     def quote(self) -> quote.QuoteResourceWithStreamingResponse:
+        """Consulte informações detalhadas sobre ações, BDRs, ETFs e índices da B3.
+
+        Obtenha preços em tempo real, dados fundamentalistas, históricos e dividendos.
+        """
         from .resources.quote import QuoteResourceWithStreamingResponse
 
         return QuoteResourceWithStreamingResponse(self._client.quote)
 
     @cached_property
     def available(self) -> available.AvailableResourceWithStreamingResponse:
+        """
+        Ferramentas auxiliares para descobrir ativos disponíveis e verificar a saúde da API.
+        """
         from .resources.available import AvailableResourceWithStreamingResponse
 
         return AvailableResourceWithStreamingResponse(self._client.available)
@@ -561,12 +584,19 @@ def __init__(self, client: AsyncBrapi) -> None:
 
     @cached_property
     def quote(self) -> quote.AsyncQuoteResourceWithStreamingResponse:
+        """Consulte informações detalhadas sobre ações, BDRs, ETFs e índices da B3.
+
+        Obtenha preços em tempo real, dados fundamentalistas, históricos e dividendos.
+        """
         from .resources.quote import AsyncQuoteResourceWithStreamingResponse
 
         return AsyncQuoteResourceWithStreamingResponse(self._client.quote)
 
     @cached_property
     def available(self) -> available.AsyncAvailableResourceWithStreamingResponse:
+        """
+        Ferramentas auxiliares para descobrir ativos disponíveis e verificar a saúde da API.
+        """
         from .resources.available import AsyncAvailableResourceWithStreamingResponse
 
         return AsyncAvailableResourceWithStreamingResponse(self._client.available)