feat(api): disable series pagn, update example requests

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-3e68b318eeaab1241ee6ed696300829c9eae836a937905e7389788413f9daa8a.yml
 openapi_spec_hash: b76569f104863b1e7b3c5271f53df840
-config_hash: a6c5cf005205fb3c675ac298b416cf14
+config_hash: c289d0e2a34fb50fdbd02ca21400d3cd

README.md

@@ -32,8 +32,11 @@ from neptune_api_v2 import NeptuneAPIV2
 
 client = NeptuneAPIV2()
 
-response = client.status.check_health()
-print(response.status)
+response = client.markets.get_overview(
+    with_text=True,
+    with_value=True,
+)
+print(response.data)
 ```
 
 ## Async usage
@@ -48,8 +51,11 @@ client = AsyncNeptuneAPIV2()
 
 
 async def main() -> None:
-    response = await client.status.check_health()
-    print(response.status)
+    response = await client.markets.get_overview(
+        with_text=True,
+        with_value=True,
+    )
+    print(response.data)
 
 
 asyncio.run(main())
@@ -80,8 +86,11 @@ async def main() -> None:
     async with AsyncNeptuneAPIV2(
         http_client=DefaultAioHttpClient(),
     ) as client:
-        response = await client.status.check_health()
-        print(response.status)
+        response = await client.markets.get_overview(
+            with_text=True,
+            with_value=True,
+        )
+        print(response.data)
 
 
 asyncio.run(main())
@@ -107,16 +116,14 @@ from neptune_api_v2 import NeptuneAPIV2
 
 client = NeptuneAPIV2()
 
-all_assets = []
+all_users = []
 # Automatically fetches more pages as needed.
-for asset in client.assets.get_price_history(
-    end=0,
-    period="h",
-    start=0,
+for user in client.user.get_tx_history(
+    address="injvalcons1a03k0ztfyjnd70apawva003pkh0adqmau0a9q0",
 ):
-    # Do something with asset here
-    all_assets.append(asset)
-print(all_assets)
+    # Do something with user here
+    all_users.append(user)
+print(all_users)
 ```
 
 Or, asynchronously:
@@ -129,15 +136,13 @@ client = AsyncNeptuneAPIV2()
 
 
 async def main() -> None:
-    all_assets = []
+    all_users = []
     # Iterate through items across all pages, issuing requests as needed.
-    async for asset in client.assets.get_price_history(
-        end=0,
-        period="h",
-        start=0,
+    async for user in client.user.get_tx_history(
+        address="injvalcons1a03k0ztfyjnd70apawva003pkh0adqmau0a9q0",
     ):
-        all_assets.append(asset)
-    print(all_assets)
+        all_users.append(user)
+    print(all_users)
 
 
 asyncio.run(main())
@@ -146,33 +151,27 @@ asyncio.run(main())
 Alternatively, you can use the `.has_next_page()`, `.next_page_info()`, or `.get_next_page()` methods for more granular control working with pages:
 
 ```python
-first_page = await client.assets.get_price_history(
-    end=0,
-    period="h",
-    start=0,
+first_page = await client.user.get_tx_history(
+    address="injvalcons1a03k0ztfyjnd70apawva003pkh0adqmau0a9q0",
 )
 if first_page.has_next_page():
     print(f"will fetch next page using these details: {first_page.next_page_info()}")
     next_page = await first_page.get_next_page()
-    print(f"number of items we just fetched: {len(next_page.data.series)}")
+    print(f"number of items we just fetched: {len(next_page.data)}")
 
 # Remove `await` for non-async usage.
 ```
 
 Or just work directly with the returned data:
 
 ```python
-first_page = await client.assets.get_price_history(
-    end=0,
-    period="h",
-    start=0,
+first_page = await client.user.get_tx_history(
+    address="injvalcons1a03k0ztfyjnd70apawva003pkh0adqmau0a9q0",
 )
 
-print(
-    f"the current start offset for this page: {first_page.data.pagination.next_offset}"
-)  # => "the current start offset for this page: 1"
-for asset in first_page.data.series:
-    print(asset.asset)
+print(f"next page cursor: {first_page.prev_event_uuid}")  # => "next page cursor: ..."
+for user in first_page.data:
+    print(user.event_uuid)
 
 # Remove `await` for non-async usage.
 ```
@@ -193,7 +192,10 @@ from neptune_api_v2 import NeptuneAPIV2
 client = NeptuneAPIV2()
 
 try:
-    client.status.check_health()
+    client.markets.get_overview(
+        with_text=True,
+        with_value=True,
+    )
 except neptune_api_v2.APIConnectionError as e:
     print("The server could not be reached")
     print(e.__cause__)  # an underlying Exception, likely raised within httpx.
@@ -236,7 +238,10 @@ client = NeptuneAPIV2(
 )
 
 # Or, configure per-request:
-client.with_options(max_retries=5).status.check_health()
+client.with_options(max_retries=5).markets.get_overview(
+    with_text=True,
+    with_value=True,
+)
 ```
 
 ### Timeouts
@@ -259,7 +264,10 @@ client = NeptuneAPIV2(
 )
 
 # Override per-request:
-client.with_options(timeout=5.0).status.check_health()
+client.with_options(timeout=5.0).markets.get_overview(
+    with_text=True,
+    with_value=True,
+)
 ```
 
 On timeout, an `APITimeoutError` is thrown.
@@ -300,11 +308,14 @@ The "raw" Response object can be accessed by prefixing `.with_raw_response.` to
 from neptune_api_v2 import NeptuneAPIV2
 
 client = NeptuneAPIV2()
-response = client.status.with_raw_response.check_health()
+response = client.markets.with_raw_response.get_overview(
+    with_text=True,
+    with_value=True,
+)
 print(response.headers.get('X-My-Header'))
 
-status = response.parse()  # get the object that `status.check_health()` would have returned
-print(status.status)
+market = response.parse()  # get the object that `markets.get_overview()` would have returned
+print(market.data)
 ```
 
 These methods return an [`APIResponse`](https://github.com/cryptechdev/neptune-api-v2-python/tree/main/src/neptune_api_v2/_response.py) object.
@@ -318,7 +329,10 @@ The above interface eagerly reads the full response body when you make the reque
 To stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.
 
 ```python
-with client.status.with_streaming_response.check_health() as response:
+with client.markets.with_streaming_response.get_overview(
+    with_text=True,
+    with_value=True,
+) as response:
     print(response.headers.get("X-My-Header"))
 
     for line in response.iter_lines():

api.md

@@ -43,14 +43,15 @@ from neptune_api_v2.types import (
     AssetRateHistory,
     AssetSpec,
     AssetListResponse,
+    AssetGetPriceHistoryResponse,
     AssetListPricesResponse,
 )
 ```
 
 Methods:
 
 - <code title="get /api/v1/assets">client.assets.<a href="./src/neptune_api_v2/resources/assets.py">list</a>() -> <a href="./src/neptune_api_v2/types/asset_list_response.py">AssetListResponse</a></code>
-- <code title="get /api/v1/assets/price-history">client.assets.<a href="./src/neptune_api_v2/resources/assets.py">get_price_history</a>(\*\*<a href="src/neptune_api_v2/types/asset_get_price_history_params.py">params</a>) -> SyncIntervalMultiPage[Series]</code>
+- <code title="get /api/v1/assets/price-history">client.assets.<a href="./src/neptune_api_v2/resources/assets.py">get_price_history</a>(\*\*<a href="src/neptune_api_v2/types/asset_get_price_history_params.py">params</a>) -> <a href="./src/neptune_api_v2/types/asset_get_price_history_response.py">AssetGetPriceHistoryResponse</a></code>
 - <code title="get /api/v1/assets/prices">client.assets.<a href="./src/neptune_api_v2/resources/assets.py">list_prices</a>(\*\*<a href="src/neptune_api_v2/types/asset_list_prices_params.py">params</a>) -> <a href="./src/neptune_api_v2/types/asset_list_prices_response.py">AssetListPricesResponse</a></code>
 
 # Markets
@@ -87,27 +88,32 @@ from neptune_api_v2.types.markets import (
     LendMarketState,
     LendListResponse,
     LendGetByAssetResponse,
+    LendGetRateHistoryResponse,
 )
 ```
 
 Methods:
 
 - <code title="get /api/v1/markets/lend">client.markets.lend.<a href="./src/neptune_api_v2/resources/markets/lend.py">list</a>(\*\*<a href="src/neptune_api_v2/types/markets/lend_list_params.py">params</a>) -> <a href="./src/neptune_api_v2/types/markets/lend_list_response.py">LendListResponse</a></code>
 - <code title="get /api/v1/markets/lend/lookup">client.markets.lend.<a href="./src/neptune_api_v2/resources/markets/lend.py">get_by_asset</a>(\*\*<a href="src/neptune_api_v2/types/markets/lend_get_by_asset_params.py">params</a>) -> <a href="./src/neptune_api_v2/types/markets/lend_get_by_asset_response.py">LendGetByAssetResponse</a></code>
-- <code title="get /api/v1/markets/lend/rate-history">client.markets.lend.<a href="./src/neptune_api_v2/resources/markets/lend.py">get_rate_history</a>(\*\*<a href="src/neptune_api_v2/types/markets/lend_get_rate_history_params.py">params</a>) -> SyncIntervalMultiPage[Series]</code>
+- <code title="get /api/v1/markets/lend/rate-history">client.markets.lend.<a href="./src/neptune_api_v2/resources/markets/lend.py">get_rate_history</a>(\*\*<a href="src/neptune_api_v2/types/markets/lend_get_rate_history_params.py">params</a>) -> <a href="./src/neptune_api_v2/types/markets/lend_get_rate_history_response.py">LendGetRateHistoryResponse</a></code>
 
 ## Borrow
 
 Types:
 
 ```python
-from neptune_api_v2.types.markets import BorrowMarketOverview, BorrowGetOverviewResponse
+from neptune_api_v2.types.markets import (
+    BorrowMarketOverview,
+    BorrowGetOverviewResponse,
+    BorrowGetRateHistoryResponse,
+)
 ```
 
 Methods:
 
 - <code title="get /api/v1/markets/borrow">client.markets.borrow.<a href="./src/neptune_api_v2/resources/markets/borrow/borrow.py">get_overview</a>(\*\*<a href="src/neptune_api_v2/types/markets/borrow_get_overview_params.py">params</a>) -> <a href="./src/neptune_api_v2/types/markets/borrow_get_overview_response.py">BorrowGetOverviewResponse</a></code>
-- <code title="get /api/v1/markets/borrow/rate-history">client.markets.borrow.<a href="./src/neptune_api_v2/resources/markets/borrow/borrow.py">get_rate_history</a>(\*\*<a href="src/neptune_api_v2/types/markets/borrow_get_rate_history_params.py">params</a>) -> SyncIntervalMultiPage[Series]</code>
+- <code title="get /api/v1/markets/borrow/rate-history">client.markets.borrow.<a href="./src/neptune_api_v2/resources/markets/borrow/borrow.py">get_rate_history</a>(\*\*<a href="src/neptune_api_v2/types/markets/borrow_get_rate_history_params.py">params</a>) -> <a href="./src/neptune_api_v2/types/markets/borrow_get_rate_history_response.py">BorrowGetRateHistoryResponse</a></code>
 
 ### Collaterals
 
@@ -369,7 +375,7 @@ from neptune_api_v2.types.analytics.market import (
 Methods:
 
 - <code title="get /api/v1/analytics/market/history/loans-originated">client.analytics.market.history.<a href="./src/neptune_api_v2/resources/analytics/market/history.py">get_loans_originated</a>(\*\*<a href="src/neptune_api_v2/types/analytics/market/history_get_loans_originated_params.py">params</a>) -> <a href="./src/neptune_api_v2/types/analytics/market/history_get_loans_originated_response.py">SyncIntervalSinglePage[HistoryGetLoansOriginatedResponse]</a></code>
-- <code title="get /api/v1/analytics/market/history/loans-originated/by-asset">client.analytics.market.history.<a href="./src/neptune_api_v2/resources/analytics/market/history.py">get_loans_originated_by_asset</a>(\*\*<a href="src/neptune_api_v2/types/analytics/market/history_get_loans_originated_by_asset_params.py">params</a>) -> <a href="./src/neptune_api_v2/types/analytics/market/history_get_loans_originated_by_asset_response.py">SyncIntervalMultiPage[HistoryGetLoansOriginatedByAssetResponse]</a></code>
+- <code title="get /api/v1/analytics/market/history/loans-originated/by-asset">client.analytics.market.history.<a href="./src/neptune_api_v2/resources/analytics/market/history.py">get_loans_originated_by_asset</a>(\*\*<a href="src/neptune_api_v2/types/analytics/market/history_get_loans_originated_by_asset_params.py">params</a>) -> <a href="./src/neptune_api_v2/types/analytics/market/history_get_loans_originated_by_asset_response.py">HistoryGetLoansOriginatedByAssetResponse</a></code>
 
 ## Nept
 

src/neptune_api_v2/resources/analytics/market/history.py

@@ -8,7 +8,7 @@
 
 from ....types import IntervalUnit
 from ...._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
-from ...._utils import maybe_transform
+from ...._utils import maybe_transform, async_maybe_transform
 from ...._compat import cached_property
 from ...._resource import SyncAPIResource, AsyncAPIResource
 from ...._response import (
@@ -17,12 +17,7 @@
     async_to_raw_response_wrapper,
     async_to_streamed_response_wrapper,
 )
-from ....pagination import (
-    SyncIntervalMultiPage,
-    AsyncIntervalMultiPage,
-    SyncIntervalSinglePage,
-    AsyncIntervalSinglePage,
-)
+from ....pagination import SyncIntervalSinglePage, AsyncIntervalSinglePage
 from ...._base_client import AsyncPaginator, make_request_options
 from ....types.interval_unit import IntervalUnit
 from ....types.analytics.market import history_get_loans_originated_params, history_get_loans_originated_by_asset_params
@@ -155,7 +150,7 @@ def get_loans_originated_by_asset(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> SyncIntervalMultiPage[HistoryGetLoansOriginatedByAssetResponse]:
+    ) -> HistoryGetLoansOriginatedByAssetResponse:
         """
         Get cumulative lending value history assets
 
@@ -205,9 +200,8 @@ def get_loans_originated_by_asset(
 
           timeout: Override the client-level default timeout for this request, in seconds
         """
-        return self._get_api_list(
+        return self._get(
             "/api/v1/analytics/market/history/loans-originated/by-asset",
-            page=SyncIntervalMultiPage[HistoryGetLoansOriginatedByAssetResponse],
             options=make_request_options(
                 extra_headers=extra_headers,
                 extra_query=extra_query,
@@ -226,7 +220,7 @@ def get_loans_originated_by_asset(
                     history_get_loans_originated_by_asset_params.HistoryGetLoansOriginatedByAssetParams,
                 ),
             ),
-            model=HistoryGetLoansOriginatedByAssetResponse,
+            cast_to=HistoryGetLoansOriginatedByAssetResponse,
         )
 
 
@@ -335,7 +329,7 @@ def get_loans_originated(
             model=HistoryGetLoansOriginatedResponse,
         )
 
-    def get_loans_originated_by_asset(
+    async def get_loans_originated_by_asset(
         self,
         *,
         end: int,
@@ -351,9 +345,7 @@ def get_loans_originated_by_asset(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> AsyncPaginator[
-        HistoryGetLoansOriginatedByAssetResponse, AsyncIntervalMultiPage[HistoryGetLoansOriginatedByAssetResponse]
-    ]:
+    ) -> HistoryGetLoansOriginatedByAssetResponse:
         """
         Get cumulative lending value history assets
 
@@ -403,15 +395,14 @@ def get_loans_originated_by_asset(
 
           timeout: Override the client-level default timeout for this request, in seconds
         """
-        return self._get_api_list(
+        return await self._get(
             "/api/v1/analytics/market/history/loans-originated/by-asset",
-            page=AsyncIntervalMultiPage[HistoryGetLoansOriginatedByAssetResponse],
             options=make_request_options(
                 extra_headers=extra_headers,
                 extra_query=extra_query,
                 extra_body=extra_body,
                 timeout=timeout,
-                query=maybe_transform(
+                query=await async_maybe_transform(
                     {
                         "end": end,
                         "period": period,
@@ -424,7 +415,7 @@ def get_loans_originated_by_asset(
                     history_get_loans_originated_by_asset_params.HistoryGetLoansOriginatedByAssetParams,
                 ),
             ),
-            model=HistoryGetLoansOriginatedByAssetResponse,
+            cast_to=HistoryGetLoansOriginatedByAssetResponse,
         )