chore: add missing docstrings

Author: stainless-app[bot]

src/brapi/types/available_list_response.py

@@ -8,6 +8,8 @@
 
 
 class AvailableListResponse(BaseModel):
+    """Resposta do endpoint que lista todos os tickers disponíveis."""
+
     indexes: List[str]
     """Lista de tickers de **índices** disponíveis (ex: `^BVSP`, `^IFIX`)."""
 

src/brapi/types/balance_sheet_entry.py

@@ -12,6 +12,10 @@
 
 
 class BalanceSheetEntry(BaseModel):
+    """
+    Representa os dados de um Balanço Patrimonial para um período específico (anual ou trimestral).
+    """
+
     accounts_payable: Optional[float] = FieldInfo(alias="accountsPayable", default=None)
     """Contas a pagar (fornecedores)."""
 

src/brapi/types/cashflow_entry.py

@@ -12,6 +12,10 @@
 
 
 class CashflowEntry(BaseModel):
+    """
+    Representa os dados de uma Demonstração do Fluxo de Caixa (DFC) para um período específico (anual ou trimestral).
+    """
+
     adjustments_to_profit_or_loss: Optional[float] = FieldInfo(alias="adjustmentsToProfitOrLoss", default=None)
     """
     Ajustes ao lucro/prejuízo (depreciação, amortização, equivalência patrimonial,

src/brapi/types/default_key_statistics_entry.py

@@ -12,6 +12,10 @@
 
 
 class DefaultKeyStatisticsEntry(BaseModel):
+    """
+    Representa um conjunto de principais indicadores e estatísticas financeiras para um período (TTM, anual ou trimestral).
+    """
+
     api_52_week_change: Optional[float] = FieldInfo(alias="52WeekChange", default=None)
     """Variação percentual do preço da ação nas últimas 52 semanas."""
 

src/brapi/types/financial_data_entry.py

@@ -12,6 +12,10 @@
 
 
 class FinancialDataEntry(BaseModel):
+    """
+    Representa um conjunto de dados e indicadores financeiros calculados para um período (TTM, anual ou trimestral).
+    """
+
     current_price: Optional[float] = FieldInfo(alias="currentPrice", default=None)
     """Preço atual da ação (pode ser ligeiramente defasado)."""
 

src/brapi/types/income_statement_entry.py

@@ -12,6 +12,10 @@
 
 
 class IncomeStatementEntry(BaseModel):
+    """
+    Representa os dados de uma Demonstração do Resultado do Exercício (DRE) para um período específico (anual ou trimestral).
+    """
+
     id: Optional[str] = None
     """Identificador único deste registro de DRE (interno)."""
 

src/brapi/types/quote_list_response.py

@@ -11,6 +11,8 @@
 
 
 class Index(BaseModel):
+    """Resumo de informações de um índice, geralmente retornado em listas."""
+
     name: Optional[str] = None
     """Nome do índice (ex: `IBOVESPA`)."""
 
@@ -19,6 +21,10 @@ class Index(BaseModel):
 
 
 class Stock(BaseModel):
+    """
+    Resumo de informações de um ativo (ação, FII, BDR), geralmente retornado em listas.
+    """
+
     change: Optional[float] = None
     """Variação percentual do preço em relação ao fechamento anterior."""
 
@@ -57,6 +63,8 @@ class Stock(BaseModel):
 
 
 class QuoteListResponse(BaseModel):
+    """Resposta do endpoint de listagem de cotações (`/api/quote/list`)."""
+
     available_sectors: Optional[List[str]] = FieldInfo(alias="availableSectors", default=None)
     """
     Lista de todos os setores disponíveis que podem ser usados no parâmetro de

src/brapi/types/quote_retrieve_response.py

@@ -25,6 +25,8 @@
 
 
 class ResultDividendsDataCashDividend(BaseModel):
+    """Detalhes sobre um pagamento de provento em dinheiro (Dividendo ou JCP)."""
+
     approved_on: Optional[datetime] = FieldInfo(alias="approvedOn", default=None)
     """Data em que o pagamento do provento foi aprovado pela empresa.
 
@@ -76,6 +78,10 @@ class ResultDividendsDataCashDividend(BaseModel):
 
 
 class ResultDividendsDataStockDividend(BaseModel):
+    """
+    Detalhes sobre um evento corporativo que afeta a quantidade de ações (Desdobramento/Split, Grupamento/Inplit, Bonificação).
+    """
+
     approved_on: Optional[datetime] = FieldInfo(alias="approvedOn", default=None)
     """Data em que o evento foi aprovado. Formato ISO 8601."""
 
@@ -109,6 +115,11 @@ class ResultDividendsDataStockDividend(BaseModel):
 
 
 class ResultDividendsData(BaseModel):
+    """Objeto contendo informações sobre dividendos, JCP e outros eventos corporativos.
+
+    Retornado apenas se `dividends=true` for especificado na requisição.
+    """
+
     cash_dividends: Optional[List[ResultDividendsDataCashDividend]] = FieldInfo(alias="cashDividends", default=None)
     """Lista de proventos pagos em dinheiro (Dividendos e JCP)."""
 
@@ -120,6 +131,8 @@ class ResultDividendsData(BaseModel):
 
 
 class ResultHistoricalDataPrice(BaseModel):
+    """Representa um ponto na série histórica de preços de um ativo."""
+
     adjusted_close: Optional[float] = FieldInfo(alias="adjustedClose", default=None)
     """
     Preço de fechamento ajustado para proventos (dividendos, JCP, bonificações,
@@ -149,6 +162,11 @@ class ResultHistoricalDataPrice(BaseModel):
 
 
 class ResultSummaryProfile(BaseModel):
+    """Resumo do perfil da empresa.
+
+    Retornado apenas se `modules` incluir `summaryProfile`.
+    """
+
     address1: Optional[str] = None
     """Linha 1 do endereço da sede da empresa."""
 
@@ -205,6 +223,10 @@ class ResultSummaryProfile(BaseModel):
 
 
 class Result(BaseModel):
+    """
+    Contém os dados detalhados de um ativo específico retornado pelo endpoint `/api/quote/{tickers}`.
+    """
+
     average_daily_volume10_day: Optional[float] = FieldInfo(alias="averageDailyVolume10Day", default=None)
     """Média do volume financeiro diário negociado nos últimos 10 dias."""
 
@@ -460,6 +482,8 @@ class Result(BaseModel):
 
 
 class QuoteRetrieveResponse(BaseModel):
+    """Resposta principal do endpoint `/api/quote/{tickers}`."""
+
     requested_at: Optional[datetime] = FieldInfo(alias="requestedAt", default=None)
     """Timestamp indicando quando a requisição foi recebida pelo servidor.
 

src/brapi/types/v2/crypto_list_available_response.py

@@ -8,6 +8,8 @@
 
 
 class CryptoListAvailableResponse(BaseModel):
+    """Resposta do endpoint que lista todas as criptomoedas disponíveis."""
+
     coins: Optional[List[str]] = None
     """
     Lista de siglas (tickers) das criptomoedas disponíveis (ex: `BTC`, `ETH`,

src/brapi/types/v2/crypto_retrieve_response.py

@@ -11,6 +11,8 @@
 
 
 class CoinHistoricalDataPrice(BaseModel):
+    """Representa um ponto na série histórica de preços de uma criptomoeda."""
+
     adjusted_close: Optional[float] = FieldInfo(alias="adjustedClose", default=None)
     """Preço de fechamento ajustado (geralmente igual ao `close` para cripto)."""
 
@@ -37,6 +39,10 @@ class CoinHistoricalDataPrice(BaseModel):
 
 
 class Coin(BaseModel):
+    """
+    Contém os dados detalhados de uma criptomoeda específica retornada pelo endpoint `/api/v2/crypto`.
+    """
+
     coin: Optional[str] = None
     """Sigla (ticker) da criptomoeda (ex: `BTC`, `ETH`)."""
 
@@ -113,5 +119,7 @@ class Coin(BaseModel):
 
 
 class CryptoRetrieveResponse(BaseModel):
+    """Resposta principal do endpoint `/api/v2/crypto`."""
+
     coins: Optional[List[Coin]] = None
     """Array contendo os resultados detalhados para cada criptomoeda solicitada."""