feat(api): rename /markets/tvl endpoint, fix market state pool fields, nest market listings under content

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 50
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cryptech%2Fneptune-api-v2-40d8045cda417d4c8a7a4a0d014345cdeb273fb5fdfa48eea08493bc5a5079ce.yml
-openapi_spec_hash: 71ca66dcf6e775aae3f49b42cd6ce2cc
+configured_endpoints: 49
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cryptech%2Fneptune-api-v2-05e0ec4b9b945a8c8e3542d34f0759f4eed2046a37750700fd40619f8a0cd6d7.yml
+openapi_spec_hash: 3911018927f898449898cc6cc5685273
 config_hash: f5ca3bc259f95069f0db4114d34e29ef

api.md

@@ -68,7 +68,6 @@ from neptune_api_v2.types import (
     MarketGetMergedByAssetResponse,
     MarketGetOverviewResponse,
     MarketGetParamsResponse,
-    MarketGetTvlResponse,
 )
 ```
 
@@ -78,7 +77,6 @@ Methods:
 - <code title="get /api/v1/markets/merged/lookup">client.markets.<a href="./src/neptune_api_v2/resources/markets/markets.py">get_merged_by_asset</a>(\*\*<a href="src/neptune_api_v2/types/market_get_merged_by_asset_params.py">params</a>) -> <a href="./src/neptune_api_v2/types/market_get_merged_by_asset_response.py">MarketGetMergedByAssetResponse</a></code>
 - <code title="get /api/v1/markets">client.markets.<a href="./src/neptune_api_v2/resources/markets/markets.py">get_overview</a>(\*\*<a href="src/neptune_api_v2/types/market_get_overview_params.py">params</a>) -> <a href="./src/neptune_api_v2/types/market_get_overview_response.py">MarketGetOverviewResponse</a></code>
 - <code title="get /api/v1/markets/config">client.markets.<a href="./src/neptune_api_v2/resources/markets/markets.py">get_params</a>(\*\*<a href="src/neptune_api_v2/types/market_get_params_params.py">params</a>) -> <a href="./src/neptune_api_v2/types/market_get_params_response.py">MarketGetParamsResponse</a></code>
-- <code title="get /api/v1/markets/tvl">client.markets.<a href="./src/neptune_api_v2/resources/markets/markets.py">get_tvl</a>(\*\*<a href="src/neptune_api_v2/types/market_get_tvl_params.py">params</a>) -> <a href="./src/neptune_api_v2/types/market_get_tvl_response.py">MarketGetTvlResponse</a></code>
 
 ## Lend
 

src/neptune_api_v2/resources/markets/borrow/collaterals.py

@@ -55,7 +55,7 @@ def list(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> CollateralListResponse:
         """
-        Get borrowing collateral markets
+        Get borrowing collateral markets overview
 
         Args:
           with_text: Include text variation fields
@@ -172,7 +172,7 @@ async def list(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> CollateralListResponse:
         """
-        Get borrowing collateral markets
+        Get borrowing collateral markets overview
 
         Args:
           with_text: Include text variation fields

src/neptune_api_v2/resources/markets/borrow/debts.py

@@ -55,7 +55,7 @@ def list(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> DebtListResponse:
         """
-        Get borrowing debt markets
+        Get borrowing debt markets overview
 
         Args:
           with_text: Include text variation fields
@@ -172,7 +172,7 @@ async def list(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> DebtListResponse:
         """
-        Get borrowing debt markets
+        Get borrowing debt markets overview
 
         Args:
           with_text: Include text variation fields

src/neptune_api_v2/resources/markets/markets.py

@@ -13,7 +13,6 @@
     AsyncLendResourceWithStreamingResponse,
 )
 from ...types import (
-    market_get_tvl_params,
     market_get_merged_params,
     market_get_params_params,
     market_get_overview_params,
@@ -38,7 +37,6 @@
     AsyncBorrowResourceWithStreamingResponse,
 )
 from ..._base_client import make_request_options
-from ...types.market_get_tvl_response import MarketGetTvlResponse
 from ...types.market_get_merged_response import MarketGetMergedResponse
 from ...types.market_get_params_response import MarketGetParamsResponse
 from ...types.market_get_overview_response import MarketGetOverviewResponse
@@ -254,43 +252,6 @@ def get_params(
             cast_to=MarketGetParamsResponse,
         )
 
-    def get_tvl(
-        self,
-        *,
-        with_text: bool | Omit = omit,
-        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
-        # The extra values given here take precedence over values defined on the client or passed to this method.
-        extra_headers: Headers | None = None,
-        extra_query: Query | None = None,
-        extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> MarketGetTvlResponse:
-        """
-        Get market TVL
-
-        Args:
-          with_text: Include text variation fields
-
-          extra_headers: Send extra headers
-
-          extra_query: Add additional query parameters to the request
-
-          extra_body: Add additional JSON properties to the request
-
-          timeout: Override the client-level default timeout for this request, in seconds
-        """
-        return self._get(
-            "/api/v1/markets/tvl",
-            options=make_request_options(
-                extra_headers=extra_headers,
-                extra_query=extra_query,
-                extra_body=extra_body,
-                timeout=timeout,
-                query=maybe_transform({"with_text": with_text}, market_get_tvl_params.MarketGetTvlParams),
-            ),
-            cast_to=MarketGetTvlResponse,
-        )
-
 
 class AsyncMarketsResource(AsyncAPIResource):
     @cached_property
@@ -501,43 +462,6 @@ async def get_params(
             cast_to=MarketGetParamsResponse,
         )
 
-    async def get_tvl(
-        self,
-        *,
-        with_text: bool | Omit = omit,
-        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
-        # The extra values given here take precedence over values defined on the client or passed to this method.
-        extra_headers: Headers | None = None,
-        extra_query: Query | None = None,
-        extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> MarketGetTvlResponse:
-        """
-        Get market TVL
-
-        Args:
-          with_text: Include text variation fields
-
-          extra_headers: Send extra headers
-
-          extra_query: Add additional query parameters to the request
-
-          extra_body: Add additional JSON properties to the request
-
-          timeout: Override the client-level default timeout for this request, in seconds
-        """
-        return await self._get(
-            "/api/v1/markets/tvl",
-            options=make_request_options(
-                extra_headers=extra_headers,
-                extra_query=extra_query,
-                extra_body=extra_body,
-                timeout=timeout,
-                query=await async_maybe_transform({"with_text": with_text}, market_get_tvl_params.MarketGetTvlParams),
-            ),
-            cast_to=MarketGetTvlResponse,
-        )
-
 
 class MarketsResourceWithRawResponse:
     def __init__(self, markets: MarketsResource) -> None:
@@ -555,9 +479,6 @@ def __init__(self, markets: MarketsResource) -> None:
         self.get_params = to_raw_response_wrapper(
             markets.get_params,
         )
-        self.get_tvl = to_raw_response_wrapper(
-            markets.get_tvl,
-        )
 
     @cached_property
     def lend(self) -> LendResourceWithRawResponse:
@@ -584,9 +505,6 @@ def __init__(self, markets: AsyncMarketsResource) -> None:
         self.get_params = async_to_raw_response_wrapper(
             markets.get_params,
         )
-        self.get_tvl = async_to_raw_response_wrapper(
-            markets.get_tvl,
-        )
 
     @cached_property
     def lend(self) -> AsyncLendResourceWithRawResponse:
@@ -613,9 +531,6 @@ def __init__(self, markets: MarketsResource) -> None:
         self.get_params = to_streamed_response_wrapper(
             markets.get_params,
         )
-        self.get_tvl = to_streamed_response_wrapper(
-            markets.get_tvl,
-        )
 
     @cached_property
     def lend(self) -> LendResourceWithStreamingResponse:
@@ -642,9 +557,6 @@ def __init__(self, markets: AsyncMarketsResource) -> None:
         self.get_params = async_to_streamed_response_wrapper(
             markets.get_params,
         )
-        self.get_tvl = async_to_streamed_response_wrapper(
-            markets.get_tvl,
-        )
 
     @cached_property
     def lend(self) -> AsyncLendResourceWithStreamingResponse:

src/neptune_api_v2/types/__init__.py

@@ -27,11 +27,9 @@
 from .asset_classification import AssetClassification as AssetClassification
 from .global_market_config import GlobalMarketConfig as GlobalMarketConfig
 from .user_get_user_params import UserGetUserParams as UserGetUserParams
-from .market_get_tvl_params import MarketGetTvlParams as MarketGetTvlParams
 from .nept_get_state_params import NeptGetStateParams as NeptGetStateParams
 from .nept_get_params_params import NeptGetParamsParams as NeptGetParamsParams
 from .user_get_user_response import UserGetUserResponse as UserGetUserResponse
-from .market_get_tvl_response import MarketGetTvlResponse as MarketGetTvlResponse
 from .nept_get_state_response import NeptGetStateResponse as NeptGetStateResponse
 from .validation_field_source import ValidationFieldSource as ValidationFieldSource
 from .asset_list_prices_params import AssetListPricesParams as AssetListPricesParams

src/neptune_api_v2/types/market_get_overview_response.py

@@ -1,14 +1,57 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import List
+from typing import List, Optional
 
 from .tvl import Tvl
 from .._models import BaseModel
 from .markets.lend_market import LendMarket
 from .global_market_config import GlobalMarketConfig
 from .markets.borrow_market_overview import BorrowMarketOverview
 
-__all__ = ["MarketGetOverviewResponse", "Data"]
+__all__ = [
+    "MarketGetOverviewResponse",
+    "Data",
+    "DataLend",
+    "DataLendSupply",
+    "DataLendSupplyExtra",
+    "DataLendSupplyExtraText",
+]
+
+
+class DataLendSupplyExtraText(BaseModel):
+    """Human-readable field variants.
+
+    Will not be null when query param `with_text` is `true`.
+    """
+
+    principal: str
+
+
+class DataLendSupplyExtra(BaseModel):
+    text: Optional[DataLendSupplyExtraText] = None
+    """Human-readable field variants.
+
+    Will not be null when query param `with_text` is `true`.
+    """
+
+
+class DataLendSupply(BaseModel):
+    """Supply breakdown for lending markets"""
+
+    extra: DataLendSupplyExtra
+
+    principal: str
+    """Sum USD value of lending principal"""
+
+
+class DataLend(BaseModel):
+    """Lending markets overview"""
+
+    contents: List[LendMarket]
+    """Lending markets"""
+
+    supply: DataLendSupply
+    """Supply breakdown for lending markets"""
 
 
 class Data(BaseModel):
@@ -18,11 +61,11 @@ class Data(BaseModel):
     global_config: GlobalMarketConfig
     """Market runtime parameters"""
 
-    lend: List[LendMarket]
-    """Current lending markets"""
+    lend: DataLend
+    """Lending markets overview"""
 
     tvl: Tvl
-    """Market TVL"""
+    """Oveerall market TVL"""
 
 
 class MarketGetOverviewResponse(BaseModel):

src/neptune_api_v2/types/market_get_tvl_params.py

@@ -15,7 +15,7 @@ class ExtraText(BaseModel):
 
     balance: str
 
-    collateral_sum: str
+    shares: str
 
 
 class ExtraValueExtraText(BaseModel):
@@ -26,11 +26,11 @@ class ExtraValueExtraText(BaseModel):
 
     balance: str
 
-    collateral_sum: str
-
     price: str
     """Text representation of price"""
 
+    shares: str
+
 
 class ExtraValueExtra(BaseModel):
     text: Optional[ExtraValueExtraText] = None
@@ -54,13 +54,13 @@ class ExtraValue(BaseModel):
 
     balance: str
 
-    collateral_sum: str
-
     extra: ExtraValueExtra
 
     price: str
     """Price used in value calculations"""
 
+    shares: str
+
 
 class Extra(BaseModel):
     text: Optional[ExtraText] = None
@@ -87,7 +87,7 @@ class Extra(BaseModel):
 class BorrowCollateralState(BaseModel):
     balance: str
 
-    collateral_sum: str
-    """Total amount of this asset which is actively collateralized"""
-
     extra: Extra
+
+    shares: str
+    """Total amount of this asset which is actively collateralized"""