compass_api_sdk 0.1.14__tar.gz → 0.2.1__tar.gz

{compass_api_sdk-0.1.14 → compass_api_sdk-0.2.1}/PKG-INFO

@@ -1,11 +1,10 @@
 Metadata-Version: 2.3
 Name: compass_api_sdk
-Version: 0.1.14
+Version: 0.2.1
 Summary: Compass API Python SDK
 Author: royalnine
-Requires-Python: >=3.9
+Requires-Python: >=3.9.2
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
@@ -135,7 +134,7 @@ with CompassAPISDK(
     api_key_auth="<YOUR_API_KEY_HERE>",
 ) as cas_client:
 
-    res = cas_client.aave_v3.rate(chain=models.AaveRateChain.ARBITRUM_MAINNET, token=models.AaveRateToken.USDC)
+    res = cas_client.aave_v3.reserve_overview(chain=models.AaveReserveOverviewChain.ARBITRUM_MAINNET, token=models.AaveReserveOverviewToken.USDC)
 
     # Handle response
     print(res)
@@ -155,7 +154,7 @@ async def main():
         api_key_auth="<YOUR_API_KEY_HERE>",
     ) as cas_client:
 
-        res = await cas_client.aave_v3.rate_async(chain=models.AaveRateChain.ARBITRUM_MAINNET, token=models.AaveRateToken.USDC)
+        res = await cas_client.aave_v3.reserve_overview_async(chain=models.AaveReserveOverviewChain.ARBITRUM_MAINNET, token=models.AaveReserveOverviewToken.USDC)
 
         # Handle response
         print(res)
@@ -184,7 +183,7 @@ with CompassAPISDK(
     api_key_auth="<YOUR_API_KEY_HERE>",
 ) as cas_client:
 
-    res = cas_client.aave_v3.rate(chain=models.AaveRateChain.ARBITRUM_MAINNET, token=models.AaveRateToken.USDC)
+    res = cas_client.aave_v3.reserve_overview(chain=models.AaveReserveOverviewChain.ARBITRUM_MAINNET, token=models.AaveReserveOverviewToken.USDC)
 
     # Handle response
     print(res)
@@ -200,6 +199,7 @@ with CompassAPISDK(
 
 ### [aave_v3](https://github.com/CompassLabs/mono/blob/master/docs/sdks/aavev3/README.md)
 
+* [reserve_overview](https://github.com/CompassLabs/mono/blob/master/docs/sdks/aavev3/README.md#reserve_overview) - Reserve overview
 * [rate](https://github.com/CompassLabs/mono/blob/master/docs/sdks/aavev3/README.md#rate) - Interest rates
 * [token_price](https://github.com/CompassLabs/mono/blob/master/docs/sdks/aavev3/README.md#token_price) - Token prices
 * [liquidity_change](https://github.com/CompassLabs/mono/blob/master/docs/sdks/aavev3/README.md#liquidity_change) - Liquidity index
@@ -255,6 +255,7 @@ with CompassAPISDK(
 
 * [authorization](https://github.com/CompassLabs/mono/blob/master/docs/sdks/transactionbatching/README.md#authorization) - Get EIP-7702 Authorization
 * [execute](https://github.com/CompassLabs/mono/blob/master/docs/sdks/transactionbatching/README.md#execute) - Execute Tx Batching
+* [aave_loop](https://github.com/CompassLabs/mono/blob/master/docs/sdks/transactionbatching/README.md#aave_loop) - Execute Aave Loop Strategy
 
 ### [uniswap_v3](https://github.com/CompassLabs/mono/blob/master/docs/sdks/uniswapv3/README.md)
 
@@ -298,7 +299,7 @@ with CompassAPISDK(
     api_key_auth="<YOUR_API_KEY_HERE>",
 ) as cas_client:
 
-    res = cas_client.aave_v3.rate(chain=models.AaveRateChain.ARBITRUM_MAINNET, token=models.AaveRateToken.USDC,
+    res = cas_client.aave_v3.reserve_overview(chain=models.AaveReserveOverviewChain.ARBITRUM_MAINNET, token=models.AaveReserveOverviewToken.USDC,
         RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
 
     # Handle response
@@ -317,7 +318,7 @@ with CompassAPISDK(
     api_key_auth="<YOUR_API_KEY_HERE>",
 ) as cas_client:
 
-    res = cas_client.aave_v3.rate(chain=models.AaveRateChain.ARBITRUM_MAINNET, token=models.AaveRateToken.USDC)
+    res = cas_client.aave_v3.reserve_overview(chain=models.AaveReserveOverviewChain.ARBITRUM_MAINNET, token=models.AaveReserveOverviewToken.USDC)
 
     # Handle response
     print(res)
@@ -339,7 +340,7 @@ By default, an API error will raise a errors.APIError exception, which has the f
 | `.raw_response` | *httpx.Response* | The raw HTTP response |
 | `.body`         | *str*            | The response content  |
 
-When custom error responses are specified for an operation, the SDK may also raise their associated exceptions. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `rate_async` method may raise the following exceptions:
+When custom error responses are specified for an operation, the SDK may also raise their associated exceptions. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `reserve_overview_async` method may raise the following exceptions:
 
 | Error Type                 | Status Code | Content Type     |
 | -------------------------- | ----------- | ---------------- |
@@ -358,7 +359,7 @@ with CompassAPISDK(
     res = None
     try:
 
-        res = cas_client.aave_v3.rate(chain=models.AaveRateChain.ARBITRUM_MAINNET, token=models.AaveRateToken.USDC)
+        res = cas_client.aave_v3.reserve_overview(chain=models.AaveReserveOverviewChain.ARBITRUM_MAINNET, token=models.AaveReserveOverviewToken.USDC)
 
         # Handle response
         print(res)
@@ -387,7 +388,7 @@ with CompassAPISDK(
     api_key_auth="<YOUR_API_KEY_HERE>",
 ) as cas_client:
 
-    res = cas_client.aave_v3.rate(chain=models.AaveRateChain.ARBITRUM_MAINNET, token=models.AaveRateToken.USDC)
+    res = cas_client.aave_v3.reserve_overview(chain=models.AaveReserveOverviewChain.ARBITRUM_MAINNET, token=models.AaveReserveOverviewToken.USDC)
 
     # Handle response
     print(res)

{compass_api_sdk-0.1.14 → compass_api_sdk-0.2.1}/README-PYPI.md

@@ -118,7 +118,7 @@ with CompassAPISDK(
     api_key_auth="<YOUR_API_KEY_HERE>",
 ) as cas_client:
 
-    res = cas_client.aave_v3.rate(chain=models.AaveRateChain.ARBITRUM_MAINNET, token=models.AaveRateToken.USDC)
+    res = cas_client.aave_v3.reserve_overview(chain=models.AaveReserveOverviewChain.ARBITRUM_MAINNET, token=models.AaveReserveOverviewToken.USDC)
 
     # Handle response
     print(res)
@@ -138,7 +138,7 @@ async def main():
         api_key_auth="<YOUR_API_KEY_HERE>",
     ) as cas_client:
 
-        res = await cas_client.aave_v3.rate_async(chain=models.AaveRateChain.ARBITRUM_MAINNET, token=models.AaveRateToken.USDC)
+        res = await cas_client.aave_v3.reserve_overview_async(chain=models.AaveReserveOverviewChain.ARBITRUM_MAINNET, token=models.AaveReserveOverviewToken.USDC)
 
         # Handle response
         print(res)
@@ -167,7 +167,7 @@ with CompassAPISDK(
     api_key_auth="<YOUR_API_KEY_HERE>",
 ) as cas_client:
 
-    res = cas_client.aave_v3.rate(chain=models.AaveRateChain.ARBITRUM_MAINNET, token=models.AaveRateToken.USDC)
+    res = cas_client.aave_v3.reserve_overview(chain=models.AaveReserveOverviewChain.ARBITRUM_MAINNET, token=models.AaveReserveOverviewToken.USDC)
 
     # Handle response
     print(res)
@@ -183,6 +183,7 @@ with CompassAPISDK(
 
 ### [aave_v3](https://github.com/CompassLabs/mono/blob/master/docs/sdks/aavev3/README.md)
 
+* [reserve_overview](https://github.com/CompassLabs/mono/blob/master/docs/sdks/aavev3/README.md#reserve_overview) - Reserve overview
 * [rate](https://github.com/CompassLabs/mono/blob/master/docs/sdks/aavev3/README.md#rate) - Interest rates
 * [token_price](https://github.com/CompassLabs/mono/blob/master/docs/sdks/aavev3/README.md#token_price) - Token prices
 * [liquidity_change](https://github.com/CompassLabs/mono/blob/master/docs/sdks/aavev3/README.md#liquidity_change) - Liquidity index
@@ -238,6 +239,7 @@ with CompassAPISDK(
 
 * [authorization](https://github.com/CompassLabs/mono/blob/master/docs/sdks/transactionbatching/README.md#authorization) - Get EIP-7702 Authorization
 * [execute](https://github.com/CompassLabs/mono/blob/master/docs/sdks/transactionbatching/README.md#execute) - Execute Tx Batching
+* [aave_loop](https://github.com/CompassLabs/mono/blob/master/docs/sdks/transactionbatching/README.md#aave_loop) - Execute Aave Loop Strategy
 
 ### [uniswap_v3](https://github.com/CompassLabs/mono/blob/master/docs/sdks/uniswapv3/README.md)
 
@@ -281,7 +283,7 @@ with CompassAPISDK(
     api_key_auth="<YOUR_API_KEY_HERE>",
 ) as cas_client:
 
-    res = cas_client.aave_v3.rate(chain=models.AaveRateChain.ARBITRUM_MAINNET, token=models.AaveRateToken.USDC,
+    res = cas_client.aave_v3.reserve_overview(chain=models.AaveReserveOverviewChain.ARBITRUM_MAINNET, token=models.AaveReserveOverviewToken.USDC,
         RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
 
     # Handle response
@@ -300,7 +302,7 @@ with CompassAPISDK(
     api_key_auth="<YOUR_API_KEY_HERE>",
 ) as cas_client:
 
-    res = cas_client.aave_v3.rate(chain=models.AaveRateChain.ARBITRUM_MAINNET, token=models.AaveRateToken.USDC)
+    res = cas_client.aave_v3.reserve_overview(chain=models.AaveReserveOverviewChain.ARBITRUM_MAINNET, token=models.AaveReserveOverviewToken.USDC)
 
     # Handle response
     print(res)
@@ -322,7 +324,7 @@ By default, an API error will raise a errors.APIError exception, which has the f
 | `.raw_response` | *httpx.Response* | The raw HTTP response |
 | `.body`         | *str*            | The response content  |
 
-When custom error responses are specified for an operation, the SDK may also raise their associated exceptions. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `rate_async` method may raise the following exceptions:
+When custom error responses are specified for an operation, the SDK may also raise their associated exceptions. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `reserve_overview_async` method may raise the following exceptions:
 
 | Error Type                 | Status Code | Content Type     |
 | -------------------------- | ----------- | ---------------- |
@@ -341,7 +343,7 @@ with CompassAPISDK(
     res = None
     try:
 
-        res = cas_client.aave_v3.rate(chain=models.AaveRateChain.ARBITRUM_MAINNET, token=models.AaveRateToken.USDC)
+        res = cas_client.aave_v3.reserve_overview(chain=models.AaveReserveOverviewChain.ARBITRUM_MAINNET, token=models.AaveReserveOverviewToken.USDC)
 
         # Handle response
         print(res)
@@ -370,7 +372,7 @@ with CompassAPISDK(
     api_key_auth="<YOUR_API_KEY_HERE>",
 ) as cas_client:
 
-    res = cas_client.aave_v3.rate(chain=models.AaveRateChain.ARBITRUM_MAINNET, token=models.AaveRateToken.USDC)
+    res = cas_client.aave_v3.reserve_overview(chain=models.AaveReserveOverviewChain.ARBITRUM_MAINNET, token=models.AaveReserveOverviewToken.USDC)
 
     # Handle response
     print(res)

{compass_api_sdk-0.1.14 → compass_api_sdk-0.2.1}/pyproject.toml

@@ -1,10 +1,10 @@
 [project]
 name = "compass_api_sdk"
-version = "0.1.14"
+version = "0.2.1"
 description = "Compass API Python SDK"
 authors = [{ name = "royalnine" },]
 readme = "README-PYPI.md"
-requires-python = ">=3.9"
+requires-python = ">=3.9.2"
 dependencies = [
     "httpx >=0.28.1",
     "pydantic >=2.11.2",

{compass_api_sdk-0.1.14 → compass_api_sdk-0.2.1}/src/compass_api_sdk/_version.py

@@ -3,10 +3,10 @@
 import importlib.metadata
 
 __title__: str = "compass_api_sdk"
-__version__: str = "0.1.14"
+__version__: str = "0.2.1"
 __openapi_doc_version__: str = "0.0.1"
-__gen_version__: str = "2.598.22"
-__user_agent__: str = "speakeasy-sdk/python 0.1.14 2.598.22 0.0.1 compass_api_sdk"
+__gen_version__: str = "2.599.0"
+__user_agent__: str = "speakeasy-sdk/python 0.2.1 2.599.0 0.0.1 compass_api_sdk"
 
 try:
     if __package__ is not None:

{compass_api_sdk-0.1.14 → compass_api_sdk-0.2.1}/src/compass_api_sdk/aave_v3.py

@@ -8,6 +8,220 @@ from typing import Any, Mapping, Optional, Union
 
 
 class AaveV3(BaseSDK):
+    def reserve_overview(
+        self,
+        *,
+        chain: models.AaveReserveOverviewChain = models.AaveReserveOverviewChain.ARBITRUM_MAINNET,
+        token: models.AaveReserveOverviewToken = models.AaveReserveOverviewToken.USDC,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.AaveReserveOverviewResponse:
+        r"""Reserve overview
+
+        Returns key metrics for Aave Reserves:
+        - Total Supplied (TVL) in USD
+        - Total Borrowed in USD
+        - Utilization Ratio
+
+        See below for more info:
+
+        :param chain: The chain to use.
+        :param token: A class representing the token.  This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = models.AaveReserveOverviewRequest(
+            chain=chain,
+            token=token,
+        )
+
+        req = self._build_request(
+            method="GET",
+            path="/v0/aave/reserve_overview/get",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=False,
+            request_has_path_params=False,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            security=self.sdk_configuration.security,
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = self.do_request(
+            hook_ctx=HookContext(
+                base_url=base_url or "",
+                operation_id="aave_reserve_overview",
+                oauth2_scopes=[],
+                security_source=self.sdk_configuration.security,
+            ),
+            request=req,
+            error_status_codes=["422", "4XX", "5XX"],
+            retry_config=retry_config,
+        )
+
+        response_data: Any = None
+        if utils.match_response(http_res, "200", "application/json"):
+            return utils.unmarshal_json(
+                http_res.text, models.AaveReserveOverviewResponse
+            )
+        if utils.match_response(http_res, "422", "application/json"):
+            response_data = utils.unmarshal_json(
+                http_res.text, errors.HTTPValidationErrorData
+            )
+            raise errors.HTTPValidationError(data=response_data)
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.APIError(
+                "API error occurred", http_res.status_code, http_res_text, http_res
+            )
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.APIError(
+                "API error occurred", http_res.status_code, http_res_text, http_res
+            )
+
+        content_type = http_res.headers.get("Content-Type")
+        http_res_text = utils.stream_to_text(http_res)
+        raise errors.APIError(
+            f"Unexpected response received (code: {http_res.status_code}, type: {content_type})",
+            http_res.status_code,
+            http_res_text,
+            http_res,
+        )
+
+    async def reserve_overview_async(
+        self,
+        *,
+        chain: models.AaveReserveOverviewChain = models.AaveReserveOverviewChain.ARBITRUM_MAINNET,
+        token: models.AaveReserveOverviewToken = models.AaveReserveOverviewToken.USDC,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.AaveReserveOverviewResponse:
+        r"""Reserve overview
+
+        Returns key metrics for Aave Reserves:
+        - Total Supplied (TVL) in USD
+        - Total Borrowed in USD
+        - Utilization Ratio
+
+        See below for more info:
+
+        :param chain: The chain to use.
+        :param token: A class representing the token.  This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = models.AaveReserveOverviewRequest(
+            chain=chain,
+            token=token,
+        )
+
+        req = self._build_request_async(
+            method="GET",
+            path="/v0/aave/reserve_overview/get",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=False,
+            request_has_path_params=False,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            security=self.sdk_configuration.security,
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = await self.do_request_async(
+            hook_ctx=HookContext(
+                base_url=base_url or "",
+                operation_id="aave_reserve_overview",
+                oauth2_scopes=[],
+                security_source=self.sdk_configuration.security,
+            ),
+            request=req,
+            error_status_codes=["422", "4XX", "5XX"],
+            retry_config=retry_config,
+        )
+
+        response_data: Any = None
+        if utils.match_response(http_res, "200", "application/json"):
+            return utils.unmarshal_json(
+                http_res.text, models.AaveReserveOverviewResponse
+            )
+        if utils.match_response(http_res, "422", "application/json"):
+            response_data = utils.unmarshal_json(
+                http_res.text, errors.HTTPValidationErrorData
+            )
+            raise errors.HTTPValidationError(data=response_data)
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.APIError(
+                "API error occurred", http_res.status_code, http_res_text, http_res
+            )
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.APIError(
+                "API error occurred", http_res.status_code, http_res_text, http_res
+            )
+
+        content_type = http_res.headers.get("Content-Type")
+        http_res_text = await utils.stream_to_text_async(http_res)
+        raise errors.APIError(
+            f"Unexpected response received (code: {http_res.status_code}, type: {content_type})",
+            http_res.status_code,
+            http_res_text,
+            http_res,
+        )
+
     def rate(
         self,
         *,